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

[PATCH v8 1/5] command-list: prepare machinery for upcoming "common groups" section

From
Sébastien Guimmara <sebastien.guimmara@gmail.com>
Date
May 18, 2015, 19:18 UTC
Message-ID
<1431976697-26288-2-git-send-email-sebastien.guimmara@gmail.com>
In-Reply-To
<1431976697-26288-1-git-send-email-sebastien.guimmara@gmail.com>
From: Eric Sunshine <sunshine@sunshineco.com>

The ultimate goal is for "git help" to classify common commands by group. Toward this end, a subsequent patch will add a new "common groups" section to command-list.txt preceding the actual command list. As preparation, teach existing command-list.txt parsing machinery, which doesn't care about grouping, to skip over this upcoming "common groups" section.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Sébastien Guimmara <sebastien.guimmara@gmail.com>
---
 Documentation/cmd-list.perl | 4 ++++
 Makefile                    | 5 +++--
 command-list.txt            | 3 ++-
 3 files changed, 9 insertions(+), 3 deletions(-)
diff --git a/Documentation/cmd-list.perl b/Documentation/cmd-list.perl
index 04f9977..5aa73cf 100755
--- a/Documentation/cmd-list.perl
+++ b/Documentation/cmd-list.perl
@@ -38,6 +38,10 @@ sub format_one {
 	}
 }
 
+while (<>) {
+	last if /^### command list/;
+}
+
 my %cmds = ();
 for (sort <>) {
 	next if /^#/;
diff --git a/Makefile b/Makefile
index 25a453b..5ed0acf 100644
--- a/Makefile
+++ b/Makefile
@@ -2454,7 +2454,7 @@ check-docs::
 		esac ; \
 		test -f "Documentation/$$v.txt" || \
 		echo "no doc: $$v"; \
-		sed -e '/^#/d' command-list.txt | \
+		sed -e '1,/^### command list/d' -e '/^#/d' command-list.txt | \
 		grep -q "^$$v[ 	]" || \
 		case "$$v" in \
 		git) ;; \
@@ -2462,7 +2462,8 @@ check-docs::
 		esac ; \
 	done; \
 	( \
-		sed -e '/^#/d' \
+		sed -e '1,/^### command list/d' \
+		    -e '/^#/d' \
 		    -e 's/[ 	].*//' \
 		    -e 's/^/listed /' command-list.txt; \
 		$(MAKE) -C Documentation print-man1 | \
diff --git a/command-list.txt b/command-list.txt
index 54d8d21..609b344 100644
--- a/command-list.txt
+++ b/command-list.txt
@@ -1,4 +1,5 @@
-# List of known git commands.
+# do not molest the next line
+### command list
 # command name                          category [deprecated] [common]
 git-add                                 mainporcelain common
 git-am                                  mainporcelain
-- 
2.4.0.GIT
Previous: Sébastien GuimmaraNext: Sébastien Guimmara
Message 2 of 12 in “group common commands by theme”
  1. 0/5 group common commands by themeSébastien Guimmara, May 18, 2015
  2. 1/5 command-list: prepare machinery for upcoming "common groups" sectionSébastien Guimmara, May 18, 2015
  3. 2/5 command-list.txt: add the common groups blockSébastien Guimmara, May 18, 2015
  4. 3/5 generate-cmdlist: parse common group commandsSébastien Guimmara, May 18, 2015
  5. 4/5 command-list.txt: drop the "common" tagSébastien Guimmara, May 18, 2015
  6. 5/5 help: respect new common command groupingSébastien Guimmara, May 18, 2015
  7. Junio C HamanoMay 18, 2015
  8. Eric SunshineMay 19, 2015
  9. Junio C HamanoMay 19, 2015
  10. Eric SunshineMay 19, 2015
  11. Junio C HamanoMay 19, 2015
  12. Sébastien GuimmaraMay 19, 2015

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.