[PATCH v4 2/6] doc: prepare for a world without whatchanged
- From
Junio C Hamano <gitster@pobox.com>
- Date
- May 12, 2025, 19:03 UTC
- Message-ID
- <20250512190311.1451556-3-gitster@pobox.com>
- In-Reply-To
- <20250512190311.1451556-1-gitster@pobox.com>
Some documentation examples reference "whatchanged", either as a placeholder command or an example of source structure.
To reduce the need for future edits when `whatchanged` is removed, replace these references with alternatives:
- In `MyFirstObjectWalk.adoc`, use `version` as the nearby anchor point for `walken`, instead of `whatchanged`.
- In `user-manual.adoc`, cite `show` instead of `whatchanged` as a command whose source lives in the same file as `log`.
Helped-by: Elijah Newren <newren@gmail.com> [en: log message] Signed-off-by: Junio C Hamano <gitster@pobox.com> --- Documentation/MyFirstObjectWalk.adoc | 4 ++-- Documentation/user-manual.adoc | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/MyFirstObjectWalk.adoc b/Documentation/MyFirstObjectWalk.adoc index d6e9dfdbbe..102a465a48 100644 --- a/Documentation/MyFirstObjectWalk.adoc +++ b/Documentation/MyFirstObjectWalk.adoc @@ -83,13 +83,13 @@ int cmd_walken(int argc, const char **argv, const char *prefix) } ---- -Also add the relevant line in `builtin.h` near `cmd_whatchanged()`: +Also add the relevant line in `builtin.h` near `cmd_version()`: ---- int cmd_walken(int argc, const char **argv, const char *prefix); ---- -Include the command in `git.c` in `commands[]` near the entry for `whatchanged`, +Include the command in `git.c` in `commands[]` near the entry for `version`, maintaining alphabetical ordering: ---- diff --git a/Documentation/user-manual.adoc b/Documentation/user-manual.adoc index d2b478ad23..7124345966 100644 --- a/Documentation/user-manual.adoc +++ b/Documentation/user-manual.adoc @@ -4240,7 +4240,7 @@ command `git`. The source side of a builtin is - an entry in `BUILTIN_OBJECTS` in the `Makefile`. Sometimes, more than one builtin is contained in one source file. For -example, `cmd_whatchanged()` and `cmd_log()` both reside in `builtin/log.c`, +example, `cmd_show()` and `cmd_log()` both reside in `builtin/log.c`, since they share quite a bit of code. In that case, the commands which are _not_ named like the `.c` file in which they live have to be listed in `BUILT_INS` in the `Makefile`.
-- 2.49.0-674-gc1e4f99c0b