Hi Junio,
> Le 2 août 2020 à 18:05, Junio C Hamano <gitster@xxxxxxxxx> a écrit :
>
> Junio C Hamano <gitster@xxxxxxxxx> writes:
>
>> "Philippe Blain via GitGitGadget" <gitgitgadget@xxxxxxxxx> writes:
>>
>>> From: Philippe Blain <levraiphilippeblain@xxxxxxxxx>
>>>
>>> Not all guides are mentioned in the 'git(1)' documentation,
>>> which makes the missing ones somewhat hard to find.
>>>
>>> Add a list of the guides to git(1).
>>>
>>> Tweak `Documentation/cmd-list.perl` so that it also generates
>>> a file `cmds-guide.txt` which gets included in git.txt.
>>
>> Who cleans this? Do we need a change to Makefile?
Oups! I checked /.gitignore, but forgot to thoroughly check the Makefile.
>
> A band-aid patch would look like this, BUT.
>
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index 39f6fc8de7..616449da88 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -295,6 +295,7 @@ cmds_txt = cmds-ancillaryinterrogators.txt \
> cmds-plumbingmanipulators.txt \
> cmds-synchingrepositories.txt \
> cmds-synchelpers.txt \
> + cmds-guide.txt \
> cmds-purehelpers.txt \
> cmds-foreignscminterface.txt
>
> I think with a bit more work, we can be at a lot better place. How
> about something along the following line (untested)?
>
> Documentation/Makefile | 3 ++-
> Documentation/cmd-list.perl | 21 ++++++++-------------
> 2 files changed, 10 insertions(+), 14 deletions(-)
>
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index 39f6fc8de7..80d1908a44 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -295,6 +295,7 @@ cmds_txt = cmds-ancillaryinterrogators.txt \
> cmds-plumbingmanipulators.txt \
> cmds-synchingrepositories.txt \
> cmds-synchelpers.txt \
> + cmds-guide.txt \
> cmds-purehelpers.txt \
> cmds-foreignscminterface.txt
>
> @@ -302,7 +303,7 @@ $(cmds_txt): cmd-list.made
>
> cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
> $(QUIET_GEN)$(RM) $@ && \
> - $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
> + $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(cmds_txt) $(QUIET_STDERR) && \
> date >$@
>
> mergetools_txt = mergetools-diff.txt mergetools-merge.txt
> diff --git a/Documentation/cmd-list.perl b/Documentation/cmd-list.perl
> index 99f01a0910..af5da45d28 100755
> --- a/Documentation/cmd-list.perl
> +++ b/Documentation/cmd-list.perl
> @@ -43,12 +43,15 @@ sub format_one {
> }
> }
>
> -while (<>) {
> +my ($input, @categories) = @ARGV;
> +
> +open IN, "<$input";
> +while (<IN>) {
> last if /^### command list/;
> }
>
> my %cmds = ();
> -for (sort <>) {
> +for (sort <IN>) {
> next if /^#/;
>
> chomp;
> @@ -56,18 +59,10 @@ sub format_one {
> $attr = '' unless defined $attr;
> push @{$cmds{$cat}}, [$name, " $attr "];
> }
> +close IN;
>
> -for my $cat (qw(ancillaryinterrogators
> - ancillarymanipulators
> - mainporcelain
> - plumbinginterrogators
> - plumbingmanipulators
> - synchingrepositories
> - foreignscminterface
> - purehelpers
> - synchelpers
> - guide)) {
> - my $out = "cmds-$cat.txt";
> +for my $out (@categories) {
> + my ($cat) = $out =~ /^cmds-(.*)\.txt$/;
> open O, '>', "$out+" or die "Cannot open output file $out+";
> for (@{$cmds{$cat}}) {
> format_one(\*O, $_);
Thanks for the suggestion. I tested it and it works correctly.
I've incorporated it to v2.
Philippe.
