Re: [PATCH v11 2/5] command-list.txt: add the common groups block
Eric Sunshine writes: +history grow, mark and tweak your common history +remote collaborate (see also: git help workflows) + +# List of known git commands. >>> >>> This is odd. The above line was removed in 1/5 but then re-appears >>> here in 2/5. I think the intent is that it should remain removed. >>> ### command list (do not change this line) # command name category [deprecated] [common] git-add mainporcelain common >> >> My mistake. This will be corrected in the next version. Thank you for taking >> time to review this series. > > Junio already made these corrections locally when he picked up the > series. Take a look at his 'pu' branch, and you'll find the series > there with the corrections[1]. Thus, no need to re-send. > > [1]: Series currently merged into 'pu' at de905cf0. Yeah, resurrecting "List of known git commands." does look somewhat strange, but looking at what this step does, especially this bit: > diff --git a/command-list.txt b/command-list.txt > index 181a9c2..32ddab3 100644 > --- a/command-list.txt > +++ b/command-list.txt > @@ -1,3 +1,14 @@ > +# common commands are grouped by themes > +# these groups are output by 'git help' in the order declared here. > +# map each common command in the command list to one of these groups. > +### common groups (do not change this line) > +init start a working area (see also: git help tutorial) > +worktree work on the current change (see also: git help everyday) I do not think we would terribly mind an introductory comment that applies to the next "###" block before it, e.g. # list of known git commands; ordered alphabetically # for easy spotting ### command list (do not change this line) For some reason the patch seems to want to spell that comment in all lowercase, so I just imitated it here. In any case, if somebody wants to add such a comment there for symmetry, that can be done as a follow-up patch after dust from these patches settles, I think. Let's have these 5 patches graduate to 'next' without further bikeshedding ;-) -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH v11 2/5] command-list.txt: add the common groups block
[Re-sending this for on-list completeness. It was sent off-list earlier when I was using an email client capable only of HTML messages.] On Mon, May 25, 2015 at 1:31 PM, Sébastien Guimmara wrote: > On 05/21/2015 08:01 PM, Eric Sunshine wrote: >> On Thu, May 21, 2015 at 1:39 PM, Sébastien Guimmara >> wrote: >>> >>> The ultimate goal is for "git help" to display common commands in >>> groups rather than alphabetically. As a first step, define the >>> groups in a new block, and then assign a group to each >>> common command. >>> >>> Signed-off-by: Sébastien Guimmara >>> --- >>> diff --git a/command-list.txt b/command-list.txt >>> index 181a9c2..32ddab3 100644 >>> --- a/command-list.txt >>> +++ b/command-list.txt >>> @@ -1,3 +1,14 @@ >>> +# common commands are grouped by themes >>> +# these groups are output by 'git help' in the order declared here. >>> +# map each common command in the command list to one of these groups. >>> +### common groups (do not change this line) >>> +init start a working area (see also: git help tutorial) >>> +worktree work on the current change (see also: git help everyday) >>> +info examine the history and state (see also: git help >>> revisions) >>> +history grow, mark and tweak your common history >>> +remote collaborate (see also: git help workflows) >>> + >>> +# List of known git commands. >> >> This is odd. The above line was removed in 1/5 but then re-appears >> here in 2/5. I think the intent is that it should remain removed. >> >>> ### command list (do not change this line) >>> # command name category [deprecated] [common] >>> git-add mainporcelain common > > My mistake. This will be corrected in the next version. Thank you for taking > time to review this series. Junio already made these corrections locally when he picked up the series. Take a look at his 'pu' branch, and you'll find the series there with the corrections[1]. Thus, no need to re-send. [1]: Series currently merged into 'pu' at de905cf0. -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH v11 2/5] command-list.txt: add the common groups block
On 05/21/2015 08:01 PM, Eric Sunshine wrote: On Thu, May 21, 2015 at 1:39 PM, Sébastien Guimmara wrote: The ultimate goal is for "git help" to display common commands in groups rather than alphabetically. As a first step, define the groups in a new block, and then assign a group to each common command. Helped-by: Eric Sunshine Helped-by: Junio C Hamano Helped-by: Emma Jane Hogbin Westby Signed-off-by: Sébastien Guimmara --- diff --git a/command-list.txt b/command-list.txt index 181a9c2..32ddab3 100644 --- a/command-list.txt +++ b/command-list.txt @@ -1,3 +1,14 @@ +# common commands are grouped by themes +# these groups are output by 'git help' in the order declared here. +# map each common command in the command list to one of these groups. +### common groups (do not change this line) +init start a working area (see also: git help tutorial) +worktree work on the current change (see also: git help everyday) +info examine the history and state (see also: git help revisions) +history grow, mark and tweak your common history +remote collaborate (see also: git help workflows) + +# List of known git commands. This is odd. The above line was removed in 1/5 but then re-appears here in 2/5. I think the intent is that it should remain removed. ### command list (do not change this line) # command name category [deprecated] [common] git-add mainporcelain common My mistake. This will be corrected in the next version. Thank you for taking time to review this series. Sébastien -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH v11 2/5] command-list.txt: add the common groups block
On Thu, May 21, 2015 at 1:39 PM, Sébastien Guimmara wrote: > The ultimate goal is for "git help" to display common commands in > groups rather than alphabetically. As a first step, define the > groups in a new block, and then assign a group to each > common command. > > Helped-by: Eric Sunshine > Helped-by: Junio C Hamano > Helped-by: Emma Jane Hogbin Westby > Signed-off-by: Sébastien Guimmara > --- > diff --git a/command-list.txt b/command-list.txt > index 181a9c2..32ddab3 100644 > --- a/command-list.txt > +++ b/command-list.txt > @@ -1,3 +1,14 @@ > +# common commands are grouped by themes > +# these groups are output by 'git help' in the order declared here. > +# map each common command in the command list to one of these groups. > +### common groups (do not change this line) > +init start a working area (see also: git help tutorial) > +worktree work on the current change (see also: git help everyday) > +info examine the history and state (see also: git help revisions) > +history grow, mark and tweak your common history > +remote collaborate (see also: git help workflows) > + > +# List of known git commands. This is odd. The above line was removed in 1/5 but then re-appears here in 2/5. I think the intent is that it should remain removed. > ### command list (do not change this line) > # command name category [deprecated] [common] > git-add mainporcelain common -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
[PATCH v11 2/5] command-list.txt: add the common groups block
The ultimate goal is for "git help" to display common commands in groups rather than alphabetically. As a first step, define the groups in a new block, and then assign a group to each common command. Add a block at the beginning of command-list.txt: init start a working area (see also: git help tutorial) worktree work on the current change (see also:[...] info examine the history and state (see also: git [...] history grow, mark and tweak your history remote collaborate (see also: git help workflows) storing information about common commands group, then map each common command to a group: git-add mainporcelaincommon worktree Helped-by: Eric Sunshine Helped-by: Junio C Hamano Helped-by: Emma Jane Hogbin Westby Signed-off-by: Sébastien Guimmara --- Documentation/howto/new-command.txt | 4 ++- command-list.txt| 51 ++--- 2 files changed, 34 insertions(+), 21 deletions(-) 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/command-list.txt b/command-list.txt index 181a9c2..32ddab3 100644 --- a/command-list.txt +++ b/command-list.txt @@ -1,3 +1,14 @@ +# common commands are grouped by themes +# these groups are output by 'git help' in the order declared here. +# map each common command in the command list to one of these groups. +### common groups (do not change this line) +init start a working area (see also: git help tutorial) +worktree work on the current change (see also: git help everyday) +info examine the history and state (see also: git help revisions) +history grow, mark and tweak your common history +remote collaborate (see also: git help workflows) + +# List of known git commands. ### command list (do not change this line) # command name category [deprecated] [common] git-add mainporcelain common @@ -6,24 +17,24 @@ git-annotate ancillaryinterrogators git-apply plumbingmanipulators git-archimport foreignscminterface git-archive mainporcelain -git-bisect mainporcelain common +git-bisect mainporcelain common info git-blame ancillaryinterrogators -git-branch mainporcelain common +git-branch mainporcelain common history git-bundle mainporcelain git-cat-fileplumbinginterrogators git-check-attr purehelpers git-check-ignorepurehelpers git-check-mailmap purehelpers -git-checkoutmainporcelain common +git-checkoutmainporcelain common history git-checkout-index plumbingmanipulators git-check-ref-formatpurehelpers git-cherry ancillaryinterrogators git-cherry-pick mainporcelain git-citool mainporcelain git-clean mainporcelain -git-clone mainporcelain common +git-clone mainporcelain common init git-column purehelpers -git-commit mainporcelain common +git-commit mainporcelain common history git-commit-tree plumbingmanipulators git-config ancillarymanipulators git-count-objects ancillaryinterrogators @@ -35,14 +46,14 @@ git-cvsimport foreignscminterface git-cvsserver foreignscminterface git-daemon synchingrepositories git-describemainporcelain -git-diffmainporcelain common +git-diff
