git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Emily Shaffer <emilyshaffer@google.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 1/3] myfirstcontrib: add 'psuh' to command-list.txt
Date: Fri, 25 Oct 2019 18:08:57 -0700	[thread overview]
Message-ID: <20191026010857.GA39574@google.com> (raw)
In-Reply-To: <20191026005159.98405-2-emilyshaffer@google.com>

Hi,

Emily Shaffer wrote:

> Users can discover commands and their brief usage by running 'git help
> git' or 'git help -a'; both of these pages list all available commands
> based on the contents of 'command-list.txt'. That means adding a new
> command there is an important part of the new command process, and
> therefore belongs in the new command tutorial.

Makes sense.

Not about this patch: is there a way to detect this automatically?
E.g. if a command in git.c::commands doesn't appear in
command-list.txt, could we make Git fail "make test"?

[...]
> --- a/Documentation/MyFirstContribution.txt
> +++ b/Documentation/MyFirstContribution.txt
> @@ -534,6 +534,28 @@ you want to pass as a parameter something which would usually be interpreted as
>  a flag.) `parse_options()` will terminate parsing when it reaches `--` and give
>  you the rest of the options afterwards, untouched.
>  
> +Now that you have a usage hint, you can teach Git how to show it in the general
> +command list shown by `git help git` or `git help -a`, which is generated from
> +`command-list.txt`. Find the line for 'git-pull' so you can add your 'git-psuh'
> +line above it in alphabetical order. Now, we can add some attributes about the
> +command which impacts where it shows up in the aforementioned help commands. The

nit: s/impacts/impact/, to agree with "attributes"

> +top of `command-list.txt` shares some information about what each attribute
> +means; in those help pages, the commands are sorted according to these
> +attributes. `git psuh` is user-facing, or porcelain - so we will mark it as
                                             ^^^^^^^^^

optional: This might be an unfamiliar term to people not thinking of the
plumbing fixture / chrome analogy.  Is there anything we should do to
help them understand what's going on?

E.g. "git help glossary" says

	Porcelains expose more of a SCM interface than the plumbing.

> +"mainporcelain". For "mainporcelain" commands, the comments at the top of
> +`command-list.txt` indicate we can also optionally add an attribute from another
> +list; since `git psuh` shows some information about the user's workspace but
> +doesn't modify anything, let's mark it as "info". Make sure to keep your
> +attributes in the same style as the rest of `command-list.txt` using spaces to
> +align and delineate them:
> +
> +----
> +git-prune-packed                        plumbingmanipulators
> +git-psuh                                mainporcelain		info

tabs snuck in.

> +git-pull                                mainporcelain           remote
> +git-push                                mainporcelain           remote
> +----
> +

The rest looks good.

Thanks,
Jonathan

  reply	other threads:[~2019-10-26  1:09 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-26  0:51 [PATCH 0/3] some clarifications to MyFirstContribution Emily Shaffer
2019-10-26  0:51 ` [PATCH 1/3] myfirstcontrib: add 'psuh' to command-list.txt Emily Shaffer
2019-10-26  1:08   ` Jonathan Nieder [this message]
2019-10-26  8:00     ` SZEDER Gábor
2019-10-28  1:24       ` Junio C Hamano
2019-10-28 11:25         ` SZEDER Gábor
2019-10-29 20:39       ` Johannes Schindelin
2019-10-26  0:51 ` [PATCH 2/3] myfirstcontrib: add dependency installation step Emily Shaffer
2019-10-26  1:12   ` Jonathan Nieder
2019-10-28  1:27     ` Junio C Hamano
2019-10-31 20:58       ` Emily Shaffer
2019-10-26  0:51 ` [PATCH 3/3] myfirstcontrib: hint to find gitgitgadget allower Emily Shaffer
2019-10-26  1:15   ` Jonathan Nieder
2019-10-29 20:43     ` Johannes Schindelin
2019-10-27  1:39   ` Pratyush Yadav
2019-10-26  1:17 ` [PATCH 0/3] some clarifications to MyFirstContribution Jonathan Nieder
2019-10-31 21:03 ` [PATCH v2 " Emily Shaffer
2019-10-31 21:03   ` [PATCH v2 1/3] myfirstcontrib: add 'psuh' to command-list.txt Emily Shaffer
2019-10-31 21:03   ` [PATCH v2 2/3] myfirstcontrib: add dependency installation step Emily Shaffer
2019-10-31 21:03   ` [PATCH v2 3/3] myfirstcontrib: hint to find gitgitgadget allower Emily Shaffer

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=20191026010857.GA39574@google.com \
    --to=jrnieder@gmail.com \
    --cc=emilyshaffer@google.com \
    --cc=git@vger.kernel.org \
    --subject='Re: [PATCH 1/3] myfirstcontrib: add '\''psuh'\'' to command-list.txt' \
    /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

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).