git/Documentation/MyFirstObjectWalk.txt, branch gitk-resize-error

docs: add headers in MyFirstObjectWalk

2021-10-29T20:02:51Z

In several places, headers need to be included or else the code won't compile. Since this is the first object walk, it would be nice to include them in the tutorial to make it easier to follow. Signed-off-by: John Cai Signed-off-by: Junio C Hamano

docs: fix places that break compilation in MyFirstObjectWalk

2021-10-29T20:02:45Z

Two errors in the example code caused compilation failures due to a missing semicolon as well as initialization with an empty struct. This commit fixes that to make the MyFirstObjectWalk tutorial easier to follow. Signed-off-by: John Cai Signed-off-by: Junio C Hamano

Merge branch 'es/walken-tutorial-fix'

2021-09-10T18:46:23Z

Typofix. * es/walken-tutorial-fix: doc: fix syntax error and the format of printf

doc: fix syntax error and the format of printf

2021-08-30T16:30:32Z

Fix syntax and correct the format of printf in MyFirstObjectWalk.txt Signed-off-by: Zoker Signed-off-by: Junio C Hamano

MyFirstObjectWalk: drop `init_walken_defaults()`

2020-11-30T21:55:54Z

In a recent commit, we stopped calling `init_grep_defaults()` from this function. Thus, by the end of the tutorial, we still haven't added any contents to this function. Let's remove it for simplicity. Signed-off-by: Martin Ågren Signed-off-by: Junio C Hamano

grep: use designated initializers for `grep_defaults`

2020-11-21T22:50:33Z

In 15fabd1bbd ("builtin/grep.c: make configuration callback more reusable", 2012-10-09), we learned to fill a `static struct grep_opt grep_defaults` which we can use as a blueprint for other such structs. At the time, we didn't consider designated initializers to be widely useable, but these days, we do. (See, e.g., cbc0f81d96 ("strbuf: use designated initializers in STRBUF_INIT", 2017-07-10).) Use designated initializers to let the compiler set up the struct and so that we don't need to remember to call `init_grep_defaults()`. Signed-off-by: Martin Ågren Signed-off-by: Junio C Hamano

grep: don't set up a "default" repo for grep

2020-11-21T22:50:29Z

`init_grep_defaults()` fills a `static struct grep_opt grep_defaults`. This struct is then used by `grep_init()` as a blueprint for other such structs. Notably, `grep_init()` takes a `struct repo *` and assigns it into the target struct. As a result, it is unnecessary for us to take a `struct repo *` in `init_grep_defaults()` as well. We assign it into the default struct and never look at it again. And in light of how we return early if we have already set up the default struct, it's not just unnecessary, but is also a bit confusing: If we are called twice and with different repos, is it a bug or a feature that we ignore the second repo? Drop the repo parameter for `init_grep_defaults()`. Signed-off-by: Martin Ågren Signed-off-by: Junio C Hamano

MyFirstObjectWalk: remove unnecessary conditional statement

2020-03-30T18:16:41Z

In the given example, `commit` cannot be `NULL` (because this is the loop condition: if it was `NULL`, the loop body would not be entered at all). It took this developer a moment or two to see that this is therefore dead code. Let's remove it, to avoid puzzling future readers. Signed-off-by: Johannes Schindelin Reviewed-by: Emily Shaffer Signed-off-by: Junio C Hamano

cache: move doc to cache.h

2019-11-18T06:21:29Z

Move the documentation from Documentation/technical/api-allocation-growing.txt to cache.h as it's easier for the developers to find the usage information beside the code instead of looking for it in another doc file. Also documentation/technical/api-allocation-growing.txt is removed because the information it has is now redundant and it'll be hard to keep it up to date and synchronized with the documentation in the header file. Signed-off-by: Heba Waly Signed-off-by: Junio C Hamano

revision: move doc to revision.h

2019-11-18T06:21:28Z

Move the documentation from Documentation/technical/api-revision-walking.txt to revision.h as it's easier for the developers to find the usage information beside the code instead of looking for it in another doc file. Also documentation/technical/api-revision-walking.txt is removed because the information it has is now redundant and it'll be hard to keep it up to date and synchronized with the documentation in the header file. Signed-off-by: Heba Waly Signed-off-by: Junio C Hamano