[PATCH v3 4/4] dir: point treat_leading_path() warning to the right place

From: Jeff King via GitGitGadget <gitgitgadget@gmail.com>
Date: Jan 16, 2020, 20:21 UTC
Message-ID: <9d346f8b6bf8ba59e5dcb5460048934030634c1d.1579206117.git.gitgitgadget@gmail.com>
In-Reply-To: <pull.692.v3.git.git.1579206117.gitgitgadget@gmail.com>

From: Jeff King <peff@peff.net>

Commit 777b420347 (dir: synchronize treat_leading_path() and read_directory_recursive(), 2019-12-19) tried to add two warning comments in those functions, pointing at each other. But the one in treat_leading_path() just points at itself.

Let's fix that. Since the comment also redirects the reader for more details to "the commit that added this warning", and since we're now modifying the warning (creating a new commit without those details), let's mention the actual commit id.

Signed-off-by: Jeff King <peff@peff.net>
Reviewed-by: Elijah Newren <newren@gmail.com>
---
 dir.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/dir.c b/dir.c
index 8437030006..b460211e61 100644
--- a/dir.c
+++ b/dir.c
@@ -2310,9 +2310,9 @@ static int treat_leading_path(struct dir_struct *dir,
 	 * WARNING WARNING WARNING:
 	 *
 	 * Any updates to the traversal logic here may need corresponding
-	 * updates in treat_leading_path().  See the commit message for the
-	 * commit adding this warning as well as the commit preceding it
-	 * for details.
+	 * updates in read_directory_recursive().  See 777b420347 (dir:
+	 * synchronize treat_leading_path() and read_directory_recursive(),
+	 * 2019-12-19) and its parent commit for details.
 	 */
 
 	struct strbuf sb = STRBUF_INIT;

-- 
gitgitgadget