git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Sébastien Guimmara" <sebastien.guimmara@gmail.com>
To: git@vger.kernel.org, gitster@pobox.com, sunshine@sunshineco.com
Cc: "Sébastien Guimmara" <sebastien.guimmara@gmail.com>
Subject: [PATCH v7 1/5] command-list.txt: prepare with [commands] header
Date: Fri, 15 May 2015 20:35:00 +0200	[thread overview]
Message-ID: <1431714904-16599-2-git-send-email-sebastien.guimmara@gmail.com> (raw)
In-Reply-To: <1431714904-16599-1-git-send-email-sebastien.guimmara@gmail.com>

Add a [commands] header before the actual command list, then make the
following files ignore this header in their parsing:

	* cmd-list.perl
	* Makefile (check-docks target)

Helped-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Sébastien Guimmara <sebastien.guimmara@gmail.com>
---
 Documentation/cmd-list.perl         | 4 ++++
 Documentation/howto/new-command.txt | 4 +++-
 Makefile                            | 3 ++-
 command-list.txt                    | 1 +
 4 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/Documentation/cmd-list.perl b/Documentation/cmd-list.perl
index 04f9977..06a5fd6 100755
--- a/Documentation/cmd-list.perl
+++ b/Documentation/cmd-list.perl
@@ -38,6 +38,10 @@ sub format_one {
 	}
 }
 
+while (<>) {
+	last if /^\[commands\]/;
+}
+
 my %cmds = ();
 for (sort <>) {
 	next if /^#/;
diff --git a/Documentation/howto/new-command.txt b/Documentation/howto/new-command.txt
index d7de5a3..6d772bd 100644
--- a/Documentation/howto/new-command.txt
+++ b/Documentation/howto/new-command.txt
@@ -95,7 +95,9 @@ your language, document it in the INSTALL file.
 that categorizes commands by type, so they can be listed in appropriate
 subsections in the documentation's summary command list.  Add an entry
 for yours.  To understand the categories, look at git-commands.txt
-in the main directory.
+in the main directory.  If the new command is part of the typical Git
+workflow and you believe it common enough to be mentioned in 'git help',
+map this command to a common group in the column [common].
 
 7. Give the maintainer one paragraph to include in the RelNotes file
 to describe the new feature; a good place to do so is in the cover
diff --git a/Makefile b/Makefile
index 25a453b..0cb2045 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,/^\[commands\]/d' -e '/^#/d' <command-list.txt | \
 		grep -q "^$$v[ 	]" || \
 		case "$$v" in \
 		git) ;; \
@@ -2463,6 +2463,7 @@ check-docs::
 	done; \
 	( \
 		sed -e '/^#/d' \
+		    -e '1,/^\[commands\]/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..caed872 100644
--- a/command-list.txt
+++ b/command-list.txt
@@ -1,5 +1,6 @@
 # List of known git commands.
 # command name                          category [deprecated] [common]
+[commands]
 git-add                                 mainporcelain common
 git-am                                  mainporcelain
 git-annotate                            ancillaryinterrogators
-- 
2.4.0

  reply	other threads:[~2015-05-15 18:35 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-15 18:34 [PATCH v7 0/5] git help: group common commands by theme Sébastien Guimmara
2015-05-15 18:35 ` Sébastien Guimmara [this message]
2015-05-15 20:26   ` [PATCH v7 1/5] command-list.txt: prepare with [commands] header Junio C Hamano
2015-05-15 20:33     ` Sébastien Guimmara
2015-05-15 20:44       ` Junio C Hamano
2015-05-15 20:52         ` Eric Sunshine
2015-05-15 22:26           ` Junio C Hamano
2015-05-15 23:55             ` Eric Sunshine
2015-05-18 16:25               ` Sébastien Guimmara
2015-05-15 21:15   ` Eric Sunshine
2015-05-16  9:44   ` Philip Oakley
2015-05-16  9:44     ` Sébastien Guimmara
2015-05-15 18:35 ` [PATCH v7 2/5] command-list.txt: add a [common] block Sébastien Guimmara
2015-05-15 21:31   ` Eric Sunshine
2015-05-15 18:35 ` [PATCH v7 3/5] generate-cmdlist: parse common group commands Sébastien Guimmara
2015-05-15 21:34   ` Eric Sunshine
2015-05-15 18:35 ` [PATCH v7 4/5] command-list.txt: drop the common tag Sébastien Guimmara
2015-05-15 21:41   ` Eric Sunshine
2015-05-15 18:35 ` [PATCH v7 5/5] help.c: output the typical Git workflow Sébastien Guimmara
2015-05-15 21:45   ` Eric Sunshine
2015-05-15 20:41 ` [PATCH v7 0/5] git help: group common commands by theme Eric Sunshine
2015-05-15 20:48   ` Junio C Hamano
2015-05-15 20:50     ` Sébastien Guimmara

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=1431714904-16599-2-git-send-email-sebastien.guimmara@gmail.com \
    --to=sebastien.guimmara@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=sunshine@sunshineco.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).