From: "Sébastien Guimmara" <sebastien.guimmara@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Sébastien Guimmara" <sebastien.guimmara@gmail.com>
Subject: Re: [PATCH v2 1/3] git help: group common commands by theme
Date: Sun, 03 May 2015 15:54:29 +0200 [thread overview]
Message-ID: <55462895.8080108@gmail.com> (raw)
In-Reply-To: <xmqqk2wqwg9f.fsf@gitster.dls.corp.google.com>
On 05/03/2015 05:30 AM, Junio C Hamano wrote:
> What is the target audience? Are they expected to be familiar
> enough with Git that they can guess what the above grouping is based
> on without a group header?
Since this help is not only displayed on '$ git help' but also on
'$ git', we can assume it's directed at people not familiar with
git and/or the command line usage.
We could then display headers this way:
The most commonly used git commands are:
* starting a working area:
clone Clone a repository into a new directory
init Create an empty Git repository or reinitialize an existing one
* examining the history and state:
diff Show changes between commits, commit and working tree, etc
log Show commit logs
show Show various types of objects
status Show the working tree status
bisect Find by binary search the change that introduced a bug
grep Print lines matching a pattern
* working on the current change:
add Add file contents to the index
checkout Checkout a branch or paths to the working tree
reset Reset current HEAD to the specified state
rm Remove files from the working tree and from the index
mv Move or rename a file, a directory, or a symlink
* growing, marking and tweaking your history:
commit Record changes to the repository
rebase Forward-port local commits to the updated upstream head
tag Create, list, delete or verify a tag object signed with GPG
* working with others:
fetch Download objects and refs from another repository
pull Fetch from and integrate with another repository or a local branch
push Update remote refs along with associated objects
* branching and merging histories:
branch List, create, or delete branches
merge Join two or more development histories together
This raises a few questions:
1. Is 'bisect' really a common command (from the target audience standpoint)
2. Does 'Forward-port local commits to the updated upstream head' really help
to grok the idea of 'rebase' ? There are 3 words in this sentence that
an unfamiliar git user may not be comfortable with : 'forward-port',
'upstream' and 'head'. I'm not familiar enough with 'rebase' to think of
a clearer explanation, but what about:
'Rewrite the history of a branch with commits from another branch'
next prev parent reply other threads:[~2015-05-03 13:54 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-05-01 23:01 [PATCH v2 1/3] git help: group common commands by theme Sébastien Guimmara
2015-05-01 23:06 ` [PATCH v2 2/3] " Sébastien Guimmara
2015-05-02 6:32 ` Luke Diamand
2015-05-02 11:09 ` Sébastien Guimmara
2015-05-02 11:43 ` Andreas Schwab
2015-05-02 11:52 ` Sébastien Guimmara
2015-05-02 14:18 ` Sébastien Guimmara
2015-05-01 23:12 ` [PATCH v2 3/3] " Sébastien Guimmara
2015-05-03 0:19 ` [PATCH v3 0/4] git help: group common commands by themes Sébastien Guimmara
2015-05-03 0:21 ` [PATCH v3 1/4] command-list.txt: " Sébastien Guimmara
2015-05-03 0:22 ` [PATCH v3 2/4] generate-cmdlist.sh: parse common command groups Sébastien Guimmara
2015-05-03 17:55 ` Junio C Hamano
2015-05-03 20:40 ` Eric Sunshine
2015-05-03 20:53 ` Sébastien Guimmara
2015-05-03 21:10 ` Eric Sunshine
2015-05-03 19:18 ` Eric Sunshine
2015-05-03 20:10 ` Eric Sunshine
2015-05-03 0:23 ` [PATCH v3 3/4] help.c - group common commands by theme Sébastien Guimmara
2015-05-03 19:44 ` Eric Sunshine
2015-05-03 0:24 ` [PATCH v3 4/4] api-builtin.txt: explain common command groups Sébastien Guimmara
2015-05-03 20:02 ` Eric Sunshine
2015-05-03 20:59 ` Sébastien Guimmara
2015-05-03 21:13 ` Eric Sunshine
[not found] ` <CAHYJk3S3s4RjFMUaomP2wUVBbcTLRGYrAOa-uDjrfsKqUuWPog@mail.gmail.com>
2015-05-03 22:32 ` Sébastien Guimmara
2015-05-03 2:23 ` [PATCH v2 1/3] git help: group common commands by theme Junio C Hamano
2015-05-03 13:54 ` Sébastien Guimmara [this message]
2015-05-03 13:57 ` Sébastien Guimmara
2015-05-03 17:16 ` Junio C Hamano
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=55462895.8080108@gmail.com \
--to=sebastien.guimmara@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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.
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).