Skip to content

Commit 69516fe

Browse files
nasamuffingitster
authored andcommitted
documentation: add tutorial for object walking
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>
1 parent 3e6c6b7 commit 69516fe

File tree

2 files changed

+906
-0
lines changed

2 files changed

+906
-0
lines changed

Documentation/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technica
7777
SP_ARTICLES += $(API_DOCS)
7878

7979
TECH_DOCS += MyFirstContribution
80+
TECH_DOCS += MyFirstRevWalk
8081
TECH_DOCS += SubmittingPatches
8182
TECH_DOCS += technical/hash-function-transition
8283
TECH_DOCS += technical/http-protocol

0 commit comments

Comments
 (0)