git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: git@vger.kernel.org
Cc: Elijah Newren <newren@gmail.com>
Subject: [PATCH v4 2/6] doc: prepare for a world without whatchanged
Date: Mon, 12 May 2025 12:03:07 -0700	[thread overview]
Message-ID: <20250512190311.1451556-3-gitster@pobox.com> (raw)
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


  parent reply	other threads:[~2025-05-12 19:03 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-01 21:34 [PATCH 0/2] Nominating "whatchanged" for removal Junio C Hamano
2025-05-01 21:34 ` [PATCH 1/2] you-still-use-that??: help deprecating commands " Junio C Hamano
2025-05-01 21:34 ` [PATCH 2/2] whatchanged: require --i-still-use-this Junio C Hamano
2025-05-01 22:23   ` Junio C Hamano
2025-05-01 22:59 ` [PATCH v2 0/2] Nominating "whatchanged" for removal Junio C Hamano
2025-05-01 22:59   ` [PATCH v2 1/2] you-still-use-that??: help deprecating commands " Junio C Hamano
2025-05-01 22:59   ` [PATCH v2 2/2] whatchanged: require --i-still-use-this Junio C Hamano
2025-05-02  9:08     ` Patrick Steinhardt
2025-05-02 16:49       ` Junio C Hamano
2025-05-05  6:10         ` Patrick Steinhardt
2025-05-02  9:08   ` [PATCH v2 0/2] Nominating "whatchanged" for removal Patrick Steinhardt
2025-05-02 16:46     ` Junio C Hamano
2025-05-03  0:58   ` [PATCH v3 0/6] " Junio C Hamano
2025-05-03  0:58     ` [PATCH v3 1/6] you-still-use-that??: help deprecating commands " Junio C Hamano
2025-05-12 17:35       ` Elijah Newren
2025-05-03  0:58     ` [PATCH v3 2/6] doc: prepare for a world without whatchanged Junio C Hamano
2025-05-12 17:36       ` Elijah Newren
2025-05-03  0:58     ` [PATCH v3 3/6] tests: " Junio C Hamano
2025-05-05  6:56       ` Patrick Steinhardt
2025-05-12 17:36       ` Elijah Newren
2025-05-03  0:58     ` [PATCH v3 4/6] whatchanged: require --i-still-use-this Junio C Hamano
2025-05-05  6:56       ` Patrick Steinhardt
2025-05-05 20:49         ` Junio C Hamano
2025-05-03  0:58     ` [PATCH v3 5/6] whatchanged: remove when built with WITH_BREAKING_CHANGES Junio C Hamano
2025-05-05  6:56       ` Patrick Steinhardt
2025-05-05 20:57         ` Junio C Hamano
2025-05-03  0:58     ` [PATCH v3 6/6] whatschanged: list it in BreakingChanges document Junio C Hamano
2025-05-12 17:36       ` Elijah Newren
2025-05-12 18:35         ` Junio C Hamano
2025-05-12 19:03     ` [PATCH v4 0/6] Nominating "whatchanged" for removal Junio C Hamano
2025-05-12 19:03       ` [PATCH v4 1/6] you-still-use-that??: help deprecating commands " Junio C Hamano
2025-05-12 19:03       ` Junio C Hamano [this message]
2025-05-12 19:03       ` [PATCH v4 3/6] tests: prepare for a world without whatchanged Junio C Hamano
2025-05-12 19:03       ` [PATCH v4 4/6] whatchanged: require --i-still-use-this Junio C Hamano
2025-05-14 13:38         ` Junio C Hamano
2025-05-12 19:03       ` [PATCH v4 5/6] whatchanged: remove when built with WITH_BREAKING_CHANGES Junio C Hamano
2025-05-12 19:03       ` [PATCH v4 6/6] whatschanged: list it in BreakingChanges document Junio C Hamano
2025-05-12 21:21       ` [PATCH v4 0/6] Nominating "whatchanged" for removal Elijah Newren
2025-05-12 22:42         ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250512190311.1451556-3-gitster@pobox.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=newren@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).