git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2] cmd-list.perl: fix identifying man sections

From
MÅMartin Ågren <martin.agren@gmail.com>
Date
Sep 23, 2022, 08:07 UTC
Message-ID
<20220923080733.1995862-1-martin.agren@gmail.com>
In-Reply-To
<220923.86wn9u4joo.gmgdl@evledraar.gmail.com>

We attribute each documentation text file to a man section by finding a line in the file that looks like "gitfoo(<digit>)". Commit cc75e556a9 ("scalar: add to 'git help -a' command list", 2022-09-02) updated this logic to look not only for "gitfoo" but also "scalarfoo". In doing so, it forgot to account for the fact that after the updated regex has found a match, the man section is no longer to be found in `$1` but now lives in `$2`.

This makes our git(1) manpage look as follows:
  Main porcelain commands
       git-add(git)
           Add file contents to the index.
  [...]
       gitk(git)
           The Git repository browser.
       scalar(scalar)
           A tool for managing large Git repositories.

Restore the man sections by not capturing the (git|scalar) part of the match into `$1`.

As noted by Ævar [1], we could even match any "foo" rather than just "gitfoo" and "scalarfoo", but that's a larger change. For now, just fix the regression in cc75e556a9.

[1] https://lore.kernel.org/git/220923.86wn9u4joo.gmgdl@evledraar.gmail.com/#t
Helped-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 Thanks Ævar for having a look at v1.
 Documentation/cmd-list.perl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/cmd-list.perl b/Documentation/cmd-list.perl
index 9515a499a3..755a110bc4 100755
--- a/Documentation/cmd-list.perl
+++ b/Documentation/cmd-list.perl
@@ -10,7 +10,7 @@ sub format_one {
 	$state = 0;
 	open I, '<', "$name.txt" or die "No such file $name.txt";
 	while (<I>) {
-		if (/^(git|scalar)[a-z0-9-]*\(([0-9])\)$/) {
+		if (/^(?:git|scalar)[a-z0-9-]*\(([0-9])\)$/) {
 			$mansection = $1;
 			next;
 		}
-- 
2.38.0.rc1.355.g7147cddc23
Previous: Ævar Arnfjörð BjarmasonNext: Ævar Arnfjörð Bjarmason
Message 3 of 10 in “cmd-list.perl: fix identifying man sections”
  1. cmd-list.perl: fix identifying man sectionsMartin Ågren, Sep 23, 2022
  2. Ævar Arnfjörð BjarmasonSep 23, 2022
  3. cmd-list.perl: fix identifying man sectionsMartin Ågren, Sep 23, 2022
  4. Ævar Arnfjörð BjarmasonSep 23, 2022
  5. Martin ÅgrenSep 23, 2022
  6. Junio C HamanoSep 23, 2022
  7. Jeff KingSep 23, 2022
  8. Martin ÅgrenSep 26, 2022
  9. Junio C HamanoSep 26, 2022
  10. Ævar Arnfjörð BjarmasonSep 26, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.