admin/git
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: prepare for a world without whatchanged

Browse Source 
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>
This commit is contained in:
Junio C Hamano
2025-05-12 12:03:07 -07:00
parent 4511d56e1a
commit ba69a6c66d
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/MyFirstObjectWalk.adoc
View File

@@ -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); 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: maintaining alphabetical ordering:
---- ----

2
Documentation/user-manual.adoc
View File

@@ -4240,7 +4240,7 @@ command `git`. The source side of a builtin is
- an entry in `BUILTIN_OBJECTS` in the `Makefile`. - an entry in `BUILTIN_OBJECTS` in the `Makefile`.
Sometimes, more than one builtin is contained in one source file. For 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 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 _not_ named like the `.c` file in which they live have to be listed in
`BUILT_INS` in the `Makefile`. `BUILT_INS` in the `Makefile`.