Skip to content

Commit ba69a6c

Browse files
committed
doc: prepare for a world without whatchanged
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 <[email protected]> [en: log message] Signed-off-by: Junio C Hamano <[email protected]>
1 parent 4511d56 commit ba69a6c

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

Documentation/MyFirstObjectWalk.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,13 @@ int cmd_walken(int argc, const char **argv, const char *prefix)
8383
}
8484
----
8585

86-
Also add the relevant line in `builtin.h` near `cmd_whatchanged()`:
86+
Also add the relevant line in `builtin.h` near `cmd_version()`:
8787

8888
----
8989
int cmd_walken(int argc, const char **argv, const char *prefix);
9090
----
9191

92-
Include the command in `git.c` in `commands[]` near the entry for `whatchanged`,
92+
Include the command in `git.c` in `commands[]` near the entry for `version`,
9393
maintaining alphabetical ordering:
9494

9595
----

Documentation/user-manual.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4240,7 +4240,7 @@ command `git`. The source side of a builtin is
42404240
- an entry in `BUILTIN_OBJECTS` in the `Makefile`.
42414241

42424242
Sometimes, more than one builtin is contained in one source file. For
4243-
example, `cmd_whatchanged()` and `cmd_log()` both reside in `builtin/log.c`,
4243+
example, `cmd_show()` and `cmd_log()` both reside in `builtin/log.c`,
42444244
since they share quite a bit of code. In that case, the commands which are
42454245
_not_ named like the `.c` file in which they live have to be listed in
42464246
`BUILT_INS` in the `Makefile`.

0 commit comments

Comments
 (0)