From: Junio C Hamano <gitster@pobox.com>
To: "Sébastien Guimmara" <sebastien.guimmara@gmail.com>
Cc: git@vger.kernel.org, sunshine@sunshineco.com
Subject: Re: [PATCH v8 5/5] help: respect new common command grouping
Date: Mon, 18 May 2015 14:39:42 -0700 [thread overview]
Message-ID: <xmqqr3qda7kx.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <1431976697-26288-6-git-send-email-sebastien.guimmara@gmail.com> ("Sébastien Guimmara"'s message of "Mon, 18 May 2015 21:18:17 +0200")
Sébastien Guimmara <sebastien.guimmara@gmail.com> writes:
> 'git help' shows common commands in alphabetical order:
>
> The most commonly used git commands are:
> add Add file contents to the index
> bisect Find by binary search the change that introduced a bug
> branch List, create, or delete branches
> checkout Checkout a branch or paths to the working tree
> clone Clone a repository into a new directory
> commit Record changes to the repository
> [...]
>
> without any indication of how commands relate to high-level
> concepts or each other. Revise the output to explain their relationship
> with the typical Git workflow:
>
> The typical Git workflow includes:
>
> start a working area (see also: git help tutorial)
> clone Clone a repository into a new directory
> init Create an empty Git repository or reinitialize [...]
>
> work on the current change (see also: git help everyday)
> add Add file contents to the index
> mv Move or rename a file, a directory, or a symlink
> reset Reset current HEAD to the specified state
> rm Remove files from the working tree and from the index
>
> examine the history and state (see also: git help revisions)
> log Show commit logs
> status Show the working tree status
>
> [...]
>
> Helped-by: Eric Sunshine <sunshine@sunshineco.com>
> Signed-off-by: Sébastien Guimmara <sebastien.guimmara@gmail.com>
> ---
I cannot exactly pinpoint what bothers me, but "The typical Git
workflow includes:" sounds a bit awkward.
What does a workflow "include"? What are components included in a
workflow? Are "starting a repository", "working on a single thing",
"collabolating", etc. components that are incuded in a workflow?
If so, the fact that "clone", "init", etc. are "commands that are
commonly used in each component of the workflow" is a more important
thing to say; in other words, the header does not explain what list
it is presenting the user.
Or does a workflow consists of "clone", "init", "add", "mv", etc.
that are included in it? Then it is left unexplained what the
section headings stand for.
Perhaps something like
These are common Git commands used in various situations:
may lessen the uneasiness I felt above. I dunno.
Other than that, this round looks ready for 'next'.
I am not absolutely sure if new dependency on "awk" will not present
portability issues, though. So far we only used it in scripts in
the fringes and only a few tests.
Thanks.
next prev parent reply other threads:[~2015-05-18 21:39 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-05-18 19:18 [PATCH v8 0/5] group common commands by theme Sébastien Guimmara
2015-05-18 19:18 ` [PATCH v8 1/5] command-list: prepare machinery for upcoming "common groups" section Sébastien Guimmara
2015-05-18 19:18 ` [PATCH v8 2/5] command-list.txt: add the common groups block Sébastien Guimmara
2015-05-18 19:18 ` [PATCH v8 3/5] generate-cmdlist: parse common group commands Sébastien Guimmara
2015-05-18 19:18 ` [PATCH v8 4/5] command-list.txt: drop the "common" tag Sébastien Guimmara
2015-05-18 19:18 ` [PATCH v8 5/5] help: respect new common command grouping Sébastien Guimmara
2015-05-18 21:39 ` Junio C Hamano [this message]
2015-05-19 0:43 ` Eric Sunshine
2015-05-19 16:09 ` Junio C Hamano
2015-05-19 16:35 ` Eric Sunshine
2015-05-19 18:20 ` Junio C Hamano
2015-05-19 17:57 ` 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
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=xmqqr3qda7kx.fsf@gitster.dls.corp.google.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=sebastien.guimmara@gmail.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.
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).