All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Sébastien Guimmara" <sebastien.guimmara@gmail.com>
To: git@vger.kernel.org
Cc: "Sébastien Guimmara" <sebastien.guimmara@gmail.com>,
	gitster@pobox.com, sunshine@sunshineco.com
Subject: [PATCH 0/3] git help: group common commands by theme
Date: Mon,  4 May 2015 22:28:07 +0200	[thread overview]
Message-ID: <cover.1430770308.git.sebastien.guimmara@gmail.com> (raw)

This v4 includes the following suggestions:

In command-list.txt:
- Add a [groups] block containing names and description for groups:

   [groups]
   init                   starting a working area
   worktree               working on the current change
   remote                 working with others
   info                   examining the history and state
   history                growing, marking and tweaking your history

- Add a [commands] header on top of the known command list, and
  group names as a third column.

   [commands]
   git-add            mainporcelain                common-worktree
   git-am             mainporcelain
   git-annotate       ancillaryinterrogators
   git-apply          plumbingmanipulators
   git-archimport     foreignscminterface
   git-archive        mainporcelain
   git-bisect         mainporcelain
   git-blame          ancillaryinterrogators
   git-branch         mainporcelain                common-history

This produces the following output of $ git help:

[...]
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 [...]

   * working on the current change:
      add        Add file contents to the index
      reset      Reset current HEAD to the specified state

   * working with others:
      fetch      Download objects and refs from another repository
      pull       Fetch from and integrate with another repository [...]
      push       Update remote refs along with associated objects

   * examining the history and state:
      log        Show commit logs
      status     Show the working tree status

   * growing, marking and tweaking your history:
      branch     List, create, or delete branches
      checkout   Checkout a branch or paths to the working tree
      commit     Record changes to the repository
      diff       Show changes between commits, commit and working [...]
      merge      Join two or more development histories together
[...]

I removed from the list of common commands: rebase, rm, mv, bisect 
because [1] they are not really common to an unfamiliar user, [2] to
save vertical space occupied by group headers.

Thanks to Junio and Eric for their suggestions.

Sébastien Guimmara (3):
  command-list.txt: group common commands by theme
  generate-cmdlist.sh: parse common group commands
  git help: group common commands by theme

 command-list.txt    | 64 +++++++++++++++++++++++++++++++----------------------
 generate-cmdlist.sh | 43 +++++++++++++++++++++++++----------
 help.c              | 28 ++++++++++++++++++++++-
 3 files changed, 95 insertions(+), 40 deletions(-)

-- 
2.4.0

             reply	other threads:[~2015-05-04 20:28 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-04 20:28 Sébastien Guimmara [this message]
2015-05-04 20:28 ` [PATCH 1/3] command-list.txt: group common commands by theme Sébastien Guimmara
2015-05-06  6:57   ` Eric Sunshine
2015-05-06 20:58     ` Sébastien Guimmara
2015-05-07 16:50       ` Eric Sunshine
2015-05-07 19:23         ` Johannes Sixt
2015-05-08 10:11           ` Johannes Schindelin
2015-05-08 12:01             ` Andreas Schwab
2015-05-08 13:02               ` Johannes Schindelin
2015-05-08 18:43         ` Sébastien Guimmara
2015-05-08 19:00           ` Eric Sunshine
2015-05-04 20:28 ` [PATCH 2/3] generate-cmdlist.sh: parse common group commands Sébastien Guimmara
2015-05-08  3:20   ` Eric Sunshine
2015-05-08  3:39     ` Eric Sunshine
2015-05-08 20:55     ` Sébastien Guimmara
2015-05-04 20:28 ` [PATCH 3/3] git help: group common commands by theme Sébastien Guimmara
2015-05-06  3:16   ` Eric Sunshine
2015-05-06 20:31     ` Sébastien Guimmara
2015-05-08 21:08     ` Sébastien Guimmara
2015-05-08 21:17       ` Stefan Beller
2015-05-08 21:19         ` Eric Sunshine
2015-05-08 21:20         ` Sébastien Guimmara
2015-05-06  3:08 ` [PATCH 0/3] " Eric Sunshine
2015-05-06 20:26   ` Sébastien Guimmara
2015-05-06 20:49     ` Eric Sunshine
2015-05-06  3:41 ` Junio C Hamano
2015-05-08 18:00   ` Sébastien Guimmara
2015-05-08 18:53     ` Junio C Hamano
2015-05-06  7:59 ` Matthieu Moy
2015-05-06 17:42   ` Junio C Hamano
2015-05-07  8:42     ` Matthieu Moy
2015-05-07 18:44       ` Junio C Hamano
2015-05-08  8:18         ` Matthieu Moy
2015-05-08 16:19           ` Junio C Hamano
2015-05-07  9:31 ` Emma Jane Hogbin Westby
2015-05-08 18:21   ` Sébastien Guimmara
2015-05-08 18:58     ` Junio C Hamano
2015-05-08 20:08       ` Sébastien Guimmara
  -- strict thread matches above, loose matches on Subject: below --
2015-05-01 14:51 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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1430770308.git.sebastien.guimmara@gmail.com \
    --to=sebastien.guimmara@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.