martin.vuk/git-intro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Compare commits

base: martin.vuk:9831b0b5b34569959e3d997f20aeae927924197f
Branches Tags
martin.vuk:master
..
compare: martin.vuk:e1dcc1bf5e93a4fc754e93bc1f65e99be6dafeeb
Branches Tags
martin.vuk:master

4 commits
9831b0b5b3 ... e1dcc1bf5e

Author SHA1 Message Date
Martin Vuk
e1dcc1bf5e Much improved version of the diagram 2025-12-10 06:38:14 +01:00
Martin Vuk
ec79d9e0c7 Reorganize positioning 2025-12-10 04:52:35 +01:00
Martin Vuk
b946ffd6b4 Fiddling with positions 2025-12-10 03:48:19 +01:00
Martin Vuk
68736ff549 Fiddling with positions 2025-12-09 06:27:31 +01:00
2 changed files with 168 additions and 90 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
git-figure.pdf Normal file
View file

Binary file not shown.

258
git-figure.typ
View file

@ -3,112 +3,190 @@
#import "@preview/fletcher:0.5.8" as fletcher: diagram, node, edge #import "@preview/fletcher:0.5.8" as fletcher: diagram, node, edge
#import fletcher.shapes: house, chevron, pill, hexagon #import fletcher.shapes: house, chevron, pill, hexagon
#let commit-node(coord, hash, ..args) = node(coord, raw(hash), shape: pill, fill: orange.lighten(10%), stroke: none, ..args) #let commit-color = green
#let commit-object(coord, hash, name, ..args) = node(coord, align(left, [#text(size: 8pt, gray.darken(50%), raw(hash))\ #name]), corner-radius: 7pt, fill: orange.lighten(10%), stroke: none, ..args) #let tag-color = orange
#let branch-color = purple
#let thin = 0.5pt;
#let thindotted = (thickness: thin, dash: "dotted");
#let thindashed = (thickness: thin, dash: "dashed");
#let commit-node(coord, hash, ..args) = node(
coord, raw(hash), shape: pill, fill: commit-color.lighten(50%), stroke: thin, ..args)
#let commit-object(coord, hash, name, ..args) = node(
coord, align(left, [#text(size: 8pt, gray.darken(50%), raw(hash))\ #name]),
corner-radius: 7pt, fill: commit-color.lighten(50%), stroke: none, ..args)
#let tree-object(coord, hash, ..args) = commit-object(coord, hash, [tree],
width: 2cm, fill: blue.lighten(50%), ..args)
#let file-object(coord, hash, name, ..args) = commit-object(coord, hash, name,
width: 2cm, fill: gray.lighten(50%), ..args)
#diagram(debug: 1, node-stroke: 2pt, edge-stroke: 1pt, #diagram(debug: 1, node-stroke: 2pt, edge-stroke: 1pt,
{ {
let thin = 0.5pt; let x_0 = 2
let thindashed = (thickness: thin, dash: "dashed"); let x_delta = 1
let store = (1, 7) let x_1 = x_0 + 1.5
/*let store = (2cm, 2cm)
let (co1, co2) = {
let x = 2cm
let y = store.at(1)
((x, y+1.5cm), (x, y+1.5cm))
}
let (tree1, tree2) = {
let x = 3.2cm
((x, co1.at(1)), (x, co2.at(1)))
}
let (f1, f2, f3) = {
let x = 4.2cm;
let y = store.at(1)
((x, y), (x, y + 0.5cm), (x, y + 1cm))
}*/
let (A, B, C, D, E, F, G) = ((2, 6), (2, 5), (2, 4), (2, 3), (2, 2), (2, 1), (2, 0)) let (A, B, C, D, E, F, G) = ((2, 6), (2, 5), (2, 4), (2, 3), (2, 2), (2, 1), (2, 0))
let (B1, B2) = ((3, 4.5), (3, 3.5)) let (B1, B2) = ((3, 4.5), (3, 3.5))
let (E1, E2, E3) = ((3, 1.5), (3, 0.5), (3, -0.5)) let (E1, E2, E3) = ((3, 1.5), (3, 0.5), (3, -0.5))
let (Br1, Br2) = ((G.at(0)-0.5, G.at(1)), (E2.at(0)-0.5, E2.at(1))) let (Ah, Bh, Ch, Dh, Eh, Fh, Gh) = ("0a3d36", "ce2d1d", "0459b3", "b62527", "93f4ee", "7b67bd", "a6eb69")
let (T1, T2) = ((E.at(0)-0.5, E.at(1)), (B.at(0)-0.5, B.at(1))) let (B1h, B2h) = ("2e4289", "7ed6de")
let refs = (3, 8) let (E1h, E2h, E3h) = ("aa083c", "3f28d1", "2e9986")
let tree1h = "43e2f7"
//e05dcdcb48cd0772313f")
/*
let refs = (12cm, store.at(1))
let tags = (0.5, 3) let tags = (0.5, 3)
let commit = (3.7, 2.5) let commit = (3.8, 2.5)
let branches = (1.2, -1) let branches = (0.5, 0)
let stage =(3.7, -1) let stage =(3.7, 0)
let mc = (2.5, D.at(1)-0.5) let mc = (2.5, D.at(1)-0.5)
commit-object(store, "e264a1", [second commit]) commit-object(co1, "e264a1", [second commit])
commit-object((store.at(0), store.at(1)+0.3), "16f29", [first commit], width: 2.8cm) commit-object(co2, "16f29", [first commit], width: 2.8cm)
node(store, [Content addressable object store], width: 3cm, stroke: none, tree-object(tree1, "16f29")
enclose:((store.at(0), store.at(1)), (store.at(0)+1, store.at(1)+2))) tree-object(tree2, "16f29")
//node(A, [A 16f299], shape: pill, name: <A>) file-object(f1, "16f29", [`new content`])
commit-node(A, "A 16f299") file-object(f2, "16f29", [`unchanged`])
node(B, [B 16f299], shape: pill) file-object(f3, "16f29", [`first content`])
node(C, [C 16f299], shape: pill)
node(D, [D 16f299], shape: pill) edge(co2, tree2, "->")
node(E, [E 16f299], shape: pill) edge(co1, tree1, "->")
node(F, [F 16f299], shape: pill)
node(G, [16f299], shape: pill)
node(store, stroke: thin, enclose:(co1, f3, f1))
*/
commit-node(A, Ah, name: <A>)
node((rel:(-1, 0), to: <A>), [Initial commit], corner-radius: 10pt, stroke: thin, name:<initial>)
edge(<A>, <initial>, stroke: thindotted)
commit-node(B, Bh, name: <B>)
commit-node(C, Ch, name: <C>)
commit-node(D, Dh, name: <D>)
node((rel: (0.5, -0.5), to: <D>), [Merge commit\ #text(size: 8pt)[commit with two parents]], stroke: thin,
corner-radius: 10pt, name: <merge>)
edge(<merge>, <D>, stroke: thindotted)
commit-node(E, Eh, name: <E>)
commit-node(F, Fh, name: <F>)
// merge commit // merge commit
node(mc, [Merge commit\ #text(size: 8pt)[commit with two parents]], stroke: thin, corner-radius: 10pt)
// merged branch // merged branch
node(B1, [B1 16f299], shape: pill) commit-node((rel: (1, -0.5), to: <B>), B1h, name: <B1>)
node(B2, [B2 16f299], shape: pill) commit-node((rel: (0, -1), to: <B1>), B2h, name: <B2>)
// unmerged branch // unmerged branch
node(E1, [E1 16f299], shape: pill) commit-node((rel: (1, -0.5), to: <E>), E1h, name: <E1>)
node(E2, [E2 16f299], shape: pill) commit-node((rel: (0, -1), to: <E1>), E2h, name: <E2>)
node(E3, [E3 16f299], shape: pill, stroke: (dash: "dashed")) commit-node((rel: (0, -1), to: <E2>), E3h, fill: none, stroke: thindashed, name: <E3>)
// branches // branches
node(Br1, [main], shape: hexagon, stroke: purple) node((rel: (-1, 0), to: <F>), [main], shape: hexagon, stroke: branch-color, name: <main>)
node(Br2, [hotfix], shape: hexagon, stroke: purple) edge(<main>, <F>, "->", stroke: thin)
node((rel: (-2, 0), to: <E2>), [hotfix], shape: hexagon, stroke: branch-color, name: <hotfix>)
edge(<hotfix>, <E2>, "->", stroke: thin)
// tags // tags
node(T1, [v-1.0], shape: chevron, stroke: green) node((rel: (-1, 0), to: <E>), [v-1.0], shape: chevron, stroke: tag-color, name: <v1>)
node(T2, [v-1.1], shape: chevron, stroke: green) edge(<v1>, <E>, "->", stroke: thin)
// refs node((rel: (-1, 0), to: <B>), [v-1.1], shape: chevron, stroke: tag-color, name: <v2>)
node(refs, stroke: none, snap: false, enclose: (refs, (refs.at(0)+2, refs.at(0)+2)), edge(<v2>, <B>, "->", stroke: thin)
table(columns: 1, align: left, [*References* (`.git/refs`)], [*Tags* (`.git/refs/tags`)\ `tag-1`: `8dd6d4b...`], [*Branches* (`.git/refs/heads`) \ `main`: `8dd6d4b...`\ // enclose the tree
`feature-1`: `8dd6d4b...`\ node((rel: (0, -1), to: <F>), [*Version history*\
`hotfix`: `8dd6d4b...`]) #align(left, text(size: 8pt)[
) _Directed Acyclic Graph (DAG)_ describes version history.
node(branches, [#text(stroke: purple.darken(50%))[BRANCH]\ #text[reference that moves when commiting canges]], Commits are nodes in DAG, while an edge connect a commit with its parent.
stroke: thin, corner-radius: 10pt, inset: 0pt, width: 1cm, enclose: ( ])], stroke:none, width: 5cm, name: <history>)
(branches.at(0)-0.5, branches.at(1)), node(snap: false, enclose: (<A>, <history>, <E3>), stroke: thindashed, width: 3cm, fill: gray.lighten(70%))
(branches.at(0)+0.5, branches.at(1)))) // branch cloud
node(tags, [#text(stroke: green.darken(50%))[TAG]\ reference that don't move], node((rel: (-0.5, -1), to: <hotfix>), [#text(branch-color.darken(20%), smallcaps[*Branches*])\ references that moves along when commiting canges],
stroke: thin, corner-radius: 10pt, inset: 0pt, width: 1cm, enclose: ((tags.at(0)-0.5, tags.at(1)), (tags.at(0)+1, tags.at(1)))) stroke: thin, corner-radius: 10pt, inset: 5pt, width: 4cm, name: <branch>)
node(stage, [*Staging area*\ #text(size: 8pt)[filesystem snapshot that will be commited in the next commit]], stroke: thindashed, corner-radius: 10pt, width: 3cm) edge(<branch>, <hotfix>, corner: left, stroke: thindotted)
node(commit, [ edge(<branch>, <main>, corner: left, stroke: thindotted)
*COMMIT*\ snapshot of filesystem tree in object store\ // tag cloud
#rect[ node((rel: (-0.5, 1.5), to: <v1>), [#text(tag-color, smallcaps[*Tags*])\ references that don't move],
``` stroke: thin, corner-radius: 10pt, inset: 5pt, width: 4cm, name: <tag>)
tree 65c47fee... edge(<tag>, <v1>, corner: right, stroke: thindotted)
parent 16f299... edge(<tag>, <v2>, corner: left, stroke: thindotted)
// staging area
node((rel: (1, 0), to: <E3>), [#smallcaps[*Staging area*]\ #text(size: 8pt)[filesystem snapshot that will be commited in
the next commit]], stroke: thindashed, corner-radius: 10pt, width: 3cm, name: <stage>)
edge(<E3>, <stage>, stroke: thindotted)
// commit
node((rel: (1, 0.5), to: <E1>), [
#text(commit-color, smallcaps[*Commit*])\ #align(left)[snapshot of filesystem tree in object store]\
#table(columns: 1, fill: commit-color.lighten(50%), align: left, [commit hash: #raw(E1h)],
raw(block: true, "
tree 65c47fee
parent 16f299
author MV <mv@ex... author MV <mv@ex...
committer MV <mv... committer MV <mv...
Add bar.txt Add bar.txt".replace("16f299", E2h).replace("65c47fee", tree1h)
```] )
], width:5cm, stroke: thin, corner-radius: 10pt) )
node((G.at(0)+0.4, G.at(1) - 0.3), [*Version history*\ ], width:5cm, stroke: thin, corner-radius: 10pt, name: <commit>)
#text(size: 8pt)[ edge(<commit>, <E1>, corner: right, stroke: thindotted)
Commits are nodes in _Directed Acyclic Graph (DAG)_ that describes version history
]], stroke:none, width: 5cm)
node(A, snap: false, enclose: (A, E3), stroke: thindashed, width: 3cm)
let ic = (A.at(0)-0.6, A.at(1)+0.2);
node(ic, [Initial commit], shape: pill, stroke: thin)
edge(ic, A, stroke: thin)
// history
edge(B, A, "->")
edge(C, B, "->")
edge(D, C, "->")
edge(E, D, "->")
edge(F, E, "->")
edge(G, F, "->")
// merged branch
edge(B1, B, "->", layer: 1, label: [parent of], label-angle: auto)
edge(B2, B1, "->")
edge(D, B2, "->")
// unmerged branch
edge(E1, E, "->")
edge(E2, E1, "->")
edge(E3, E2, "->", stroke: (dash: "dashed"))
// refs // refs
edge(Br1, G) /*
edge(Br2, E2) node(refs, stroke: thin, inset:5pt, snap: false, enclose: (refs, (refs.at(0)+1cm, refs.at(1)+1cm)),
edge(T1, E) align(left, [
edge(T2, B) *References* (`.git/refs`)\ *Tags* (`.git/refs/tags`)\ `tag-1`: `8dd6d4b...`\ *Branches* (`.git/refs/heads`) \ `main`: `8dd6d4b...`\
edge(Br1, branches, stroke: thin) `feature-1`: `8dd6d4b...`\
edge(Br2, branches, stroke: thin) `hotfix`: `8dd6d4b...`
edge(T1, tags, stroke: thin) ])
edge(T2, tags, stroke: thin) )
edge(commit, E, stroke: thin) /*, enclose: (
edge(stage, E3, stroke: thindashed) (branches.at(0)-0.5, branches.at(1)),
edge((-0.5, A.at(1)), (-0.5, G.at(1)), "->", label: [time], label-side: left, label-angle: 90deg) (branches.at(0)+1, branches.at(1))))*/
edge(mc, D, stroke: thin) /*, enclose: ((tags.at(0)-0.5, tags.at(1)), (tags.at(0)+1, tags.at(1))))*/
let ic = (A.at(0)+0.7, A.at(1)-0.2);
edge(ic, A, stroke: thindotted)
*/
// history
edge(<B>, <A>, "->")
edge(<C>, <B>, "->")
edge(<D>, <C>, "->")
edge(<E>, <D>, "->")
edge(<F>, <E>, "->")
// merged branch
edge(<B1>, <B>, "->", layer: 1, label: [parent of], label-angle: auto)
edge(<B2>, <B1>, "->")
edge(<D>, <B2>, "->")
// unmerged branch
edge(<E1>, <E>, "->")
edge(<E2>, <E1>, "->")
edge(<E3>, <E2>, "->", stroke: (dash: "dashed"))
// object store
let obj_store = (rel: (-0.5, 1), to: <A>)
node((rel: (4cm, -2.2cm), to: <A>), align(left)[Content addressable object store \ #raw(".git/objects")], stroke: none, snap: false )
commit-object((rel: (1.5, 2), to: <A>), E1h, [second commit], name: <obj-c1>)
commit-object((rel: (1.5, 3), to: <A>), "16f29a", [first commit], width: 2.8cm, name: <obj-c2>)
tree-object((rel:(-1, 0), to: <obj-c1>), tree1h, name:<tree1>)
edge(<obj-c1>, <tree1>, stroke: thin, "->")
tree-object((rel:(-1, 0), to: <obj-c2>), "e05dcd", name: <tree2>)
edge(<obj-c2>, <tree2>, stroke: thin, "->")
file-object((rel:(-1, -1), to: <tree1>), "cb48cd", [`new content`], name: <f1>)
file-object((rel:(-1, 0), to: <tree1>), "077231", [`unchanged`], name: <f2>)
file-object((rel:(-1, 1), to: <tree1>), "d1bc32", [`first content`], name: <f3>)
edge(<tree1>, <f2>, [`bar.txt`], "->", label-angle: auto, stroke: thin)
edge(<tree1>, <f1>, [`foo.txt`], "->", label-angle: auto, stroke: thin)
edge(<tree2>, <f2>, [`bar.txt`], "->", label-angle: auto, stroke: thin)
edge(<tree2>, <f3>, [`foo.txt`], "->", label-angle: auto, stroke: thin)
node((rel: (0, 0.5), to:<A>), enclose: (<obj-c2>, <f1>, <f3>), stroke: thindashed, corner-radius: 5pt,
fill: gray.lighten(70%), snap: false, layer: -2)
// time direction
edge((0.2, 2.5), (0.2, 1), "->", label: [time], label-side: left, label-angle: 90deg,
stroke: thindashed)
edge(<commit>, <obj-c1>, stroke: thin, "->", corner: right)
} }
) )