diff options
| author |  Emily Shaffer <emilyshaffer@google.com> | 2019-10-11 16:55:54 -0700 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2019-10-12 10:29:15 +0900 |
| commit | e0479fa07387a7f84dad04a258cd2dc2861c9df9 (patch) | |
| tree | 741b82b9be9a0f73a93188c046d16a787e5e6df4 /Documentation/Makefile | |
| parent | Merge branch 'cc/first-contrib-tutorial' (diff) | |
| download | tgif-e0479fa07387a7f84dad04a258cd2dc2861c9df9.tar.xz | |
documentation: add tutorial for object walking
Existing documentation on object walks seems to be primarily intended
as a reference for those already familiar with the procedure. This
tutorial attempts to give an entry-level guide to a couple of bare-bones
object walks so that new Git contributors can learn the concepts
without having to wade through options parsing or special casing.
The target audience is a Git contributor who is just getting started
with the concept of object walking. The goal is to prepare this
contributor to be able to understand and modify existing commands which
perform revision walks more easily, although it will also prepare
contributors to create new commands which perform walks.
The tutorial covers a basic overview of the structs involved during
object walk, setting up a basic commit walk, setting up a basic
all-object walk, and adding some configuration changes to both walk
types. It intentionally does not cover how to create new commands or
search for options from the command line or gitconfigs.
There is an associated patchset at
https://github.com/nasamuffin/git/tree/revwalk that contains a reference
implementation of the code generated by this tutorial.
Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
Helped-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/Makefile')
| -rw-r--r-- | Documentation/Makefile | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index 76f2ecfc1b..f267a5b7fa 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -77,6 +77,7 @@ API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technica SP_ARTICLES += $(API_DOCS) TECH_DOCS += MyFirstContribution +TECH_DOCS += MyFirstObjectWalk TECH_DOCS += SubmittingPatches TECH_DOCS += technical/hash-function-transition TECH_DOCS += technical/http-protocol |