From: Philippe Blain <levraiphilippeblain@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com>,
"Git mailing list" <git@vger.kernel.org>,
"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>,
"Philip Oakley" <philipoakley@iee.org>,
"Eric Sunshine" <sunshine@sunshineco.com>,
"SZEDER Gábor" <szeder.dev@gmail.com>
Subject: Re: [PATCH 3/3] git.txt: add list of guides
Date: Mon, 3 Aug 2020 10:16:20 -0400 [thread overview]
Message-ID: <6C571F33-0ACE-4C1C-805C-7E8ADE50D18D@gmail.com> (raw)
In-Reply-To: <xmqqv9i0wvoz.fsf@gitster.c.googlers.com>
Hi Junio,
> Le 2 août 2020 à 18:05, Junio C Hamano <gitster@pobox.com> a écrit :
>
> Junio C Hamano <gitster@pobox.com> writes:
>
>> "Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:
>>
>>> From: Philippe Blain <levraiphilippeblain@gmail.com>
>>>
>>> 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.
next prev parent reply other threads:[~2020-08-03 14:16 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-02 15:20 [PATCH 0/3] [RFC] List all guides in git(1) Philippe Blain via GitGitGadget
2020-08-02 15:20 ` [PATCH 1/3] command-list.txt: add missing 'gitcredentials' and 'gitremote-helpers' Philippe Blain via GitGitGadget
2020-08-02 15:20 ` [PATCH 2/3] help: drop usage of 'common' and 'useful' for guides Philippe Blain via GitGitGadget
2020-08-02 15:20 ` [PATCH 3/3] git.txt: add list of guides Philippe Blain via GitGitGadget
2020-08-02 21:44 ` Junio C Hamano
2020-08-02 22:05 ` Junio C Hamano
2020-08-03 14:16 ` Philippe Blain [this message]
2020-08-04 0:20 ` [PATCH v2 0/3] List all guides in git(1) Philippe Blain via GitGitGadget
2020-08-04 0:20 ` [PATCH v2 1/3] command-list.txt: add missing 'gitcredentials' and 'gitremote-helpers' Philippe Blain via GitGitGadget
2020-08-04 0:20 ` [PATCH v2 2/3] help: drop usage of 'common' and 'useful' for guides Philippe Blain via GitGitGadget
2020-08-04 0:20 ` [PATCH v2 3/3] git.txt: add list of guides Philippe Blain via GitGitGadget
2020-08-04 0:26 ` [PATCH v2 0/3] List all guides in git(1) Junio C Hamano
2020-08-04 13:44 ` Philippe Blain
2020-08-05 1:19 ` [PATCH v3 0/4] " Philippe Blain via GitGitGadget
2020-08-05 1:19 ` [PATCH v3 1/4] command-list.txt: add missing 'gitcredentials' and 'gitremote-helpers' Philippe Blain via GitGitGadget
2020-08-05 1:19 ` [PATCH v3 2/4] help: drop usage of 'common' and 'useful' for guides Philippe Blain via GitGitGadget
2020-08-05 1:19 ` [PATCH v3 3/4] Documentation: don't hardcode command categories twice Junio C Hamano via GitGitGadget
2020-08-05 1:19 ` [PATCH v3 4/4] git.txt: add list of guides Philippe Blain via GitGitGadget
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=6C571F33-0ACE-4C1C-805C-7E8ADE50D18D@gmail.com \
--to=levraiphilippeblain@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=pclouds@gmail.com \
--cc=philipoakley@iee.org \
--cc=sunshine@sunshineco.com \
--cc=szeder.dev@gmail.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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).