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