From mboxrd@z Thu Jan 1 00:00:00 1970 From: =?UTF-8?q?S=C3=A9bastien=20Guimmara?= Subject: [PATCH v5 3/6] command-list.txt: group common commands by theme Date: Sat, 9 May 2015 19:17:33 +0200 Message-ID: <1431191856-10949-4-git-send-email-sebastien.guimmara@gmail.com> References: <1431191856-10949-1-git-send-email-sebastien.guimmara@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: QUOTED-PRINTABLE Cc: =?UTF-8?q?S=C3=A9bastien=20Guimmara?= To: git@vger.kernel.org X-From: git-owner@vger.kernel.org Sat May 09 19:18:39 2015 Return-path: Envelope-to: gcvg-git-2@plane.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Yr8Od-0000bm-11 for gcvg-git-2@plane.gmane.org; Sat, 09 May 2015 19:18:39 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751242AbbEIRSe convert rfc822-to-quoted-printable (ORCPT ); Sat, 9 May 2015 13:18:34 -0400 Received: from mail-wi0-f177.google.com ([209.85.212.177]:33757 "EHLO mail-wi0-f177.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750994AbbEIRSd (ORCPT ); Sat, 9 May 2015 13:18:33 -0400 Received: by wief7 with SMTP id f7so56938820wie.0 for ; Sat, 09 May 2015 10:18:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-type:content-transfer-encoding; bh=PQ9apEdFNqBOko3itPykNcRf3/YH2Tsp2JGxXy3cNnE=; b=ja2hIW+sLO3zw870aZ5QBi8SfiA/bM3+9S90JmX/V/uGcNwqCjgP42I9rXBU6y242X tJRTqXIsQtzlqhbcFXlWVAVOIcOR6zRdZYTTf5dGKBc3h5dBb2UqLXpiilxeUXjqrpmK 5ytwKWrYv8EjQ6YVEY3+QfWuFIJSBjizGw1Inw5pGbPghkxW2r6qrPjI0PXdqRTKeEzK +poCqTzd8PXb0kyz5ljFoiR44s8mNbSheA8f6fhk8qd3VVpD4qDo8JJmVNmlK4WRtfCP TkICrm5S54d2fTzd3EuB/xHm1xbXPaMURic9Hlad7FJ5opPVcay2b45hEk4c8R94NhJA V9Gw== X-Received: by 10.180.74.208 with SMTP id w16mr6142995wiv.31.1431191912179; Sat, 09 May 2015 10:18:32 -0700 (PDT) Received: from localhost.localdomain (bd231-1-88-176-208-17.fbx.proxad.net. [88.176.208.17]) by mx.google.com with ESMTPSA id fo7sm4710675wic.1.2015.05.09.10.18.30 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Sat, 09 May 2015 10:18:31 -0700 (PDT) X-Mailer: git-send-email 2.4.0 In-Reply-To: <1431191856-10949-1-git-send-email-sebastien.guimmara@gmail.com> Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: Declare groups for common commands in the [common] block, followed by group names and descriptions: [common] init start a working area (see also: git help tutorial) worktree work on the current change (see also: git [...] info examine the history and state (see also: git [...] history grow, mark and tweak your history remote collaborate (see also: git help workflows) Some descriptions include a 'see also' to redirect user to more detailed documentation. Then, in the [commands] block, map all common commands with a group: [commands] git-add mainporcelain worktree git-branch mainporcelain history git-checkout mainporcelain history [...] So that 'git help' outputs those commands in headered groups. Helped-by: Junio C Hamano Helped-by: Emma Jane Hogbin Westby Signed-off-by: S=C3=A9bastien Guimmara --- command-list.txt | 56 ++++++++++++++++++++++++++++++++++--------------= -------- 1 file changed, 34 insertions(+), 22 deletions(-) diff --git a/command-list.txt b/command-list.txt index f1eae08..7e7ce53 100644 --- a/command-list.txt +++ b/command-list.txt @@ -1,29 +1,41 @@ +# common commands are grouped by themes +# this order is the same that output by 'git help' +# map each common commands in the [commands] list to one of the groups= =2E +# a command should not be marked both [deprecated] and [common] +[common] +init start a working area (see also: git help tutorial) +worktree work on the current change (see also: git help everyday) +info examine the history and state (see also: git help revisio= ns) +history grow, mark and tweak your history +remote collaborate (see also: git help workflows) + # List of known git commands. -# command name category [deprecated] [common] -git-add mainporcelain common +# command name [deprecated] category [commo= n] +[commands] +git-add mainporcelain worktr= ee git-am mainporcelain git-annotate ancillaryinterrogators git-apply plumbingmanipulators git-archimport foreignscminterface git-archive mainporcelain -git-bisect mainporcelain common +git-bisect mainporcelain info git-blame ancillaryinterrogators -git-branch mainporcelain common +git-branch mainporcelain histor= y git-bundle mainporcelain git-cat-file plumbinginterrogators git-check-attr purehelpers git-check-ignore purehelpers git-check-mailmap purehelpers -git-checkout mainporcelain common +git-checkout mainporcelain histor= y git-checkout-index plumbingmanipulators git-check-ref-format purehelpers git-cherry ancillaryinterrogators git-cherry-pick mainporcelain git-citool mainporcelain git-clean mainporcelain -git-clone mainporcelain common +git-clone mainporcelain init git-column purehelpers -git-commit mainporcelain common +git-commit mainporcelain histor= y git-commit-tree plumbingmanipulators git-config ancillarymanipulators git-count-objects ancillaryinterrogators @@ -35,14 +47,14 @@ git-cvsimport foreignscmi= nterface git-cvsserver foreignscminterface git-daemon synchingrepositories git-describe mainporcelain -git-diff mainporcelain common +git-diff mainporcelain histor= y git-diff-files plumbinginterrogators git-diff-index plumbinginterrogators git-diff-tree plumbinginterrogators git-difftool ancillaryinterrogators git-fast-export ancillarymanipulators git-fast-import ancillarymanipulators -git-fetch mainporcelain common +git-fetch mainporcelain remote git-fetch-pack synchingrepositories git-filter-branch ancillarymanipulators git-fmt-merge-msg purehelpers @@ -51,7 +63,7 @@ git-format-patch mainporcelain git-fsck ancillaryinterrogators git-gc mainporcelain git-get-tar-commit-id ancillaryinterrogators -git-grep mainporcelain common +git-grep mainporcelain info git-gui mainporcelain git-hash-object plumbingmanipulators git-help ancillaryinterrogators @@ -60,17 +72,17 @@ git-http-fetch synchelpers git-http-push synchelpers git-imap-send foreignscminterface git-index-pack plumbingmanipulators -git-init mainporcelain common +git-init mainporcelain init git-instaweb ancillaryinterrogators git-interpret-trailers purehelpers gitk mainporcelain -git-log mainporcelain common +git-log mainporcelain info git-ls-files plumbinginterrogators git-ls-remote plumbinginterrogators git-ls-tree plumbinginterrogators git-mailinfo purehelpers git-mailsplit purehelpers -git-merge mainporcelain common +git-merge mainporcelain histor= y git-merge-base plumbinginterrogators git-merge-file plumbingmanipulators git-merge-index plumbingmanipulators @@ -79,7 +91,7 @@ git-mergetool ancillarymani= pulators git-merge-tree ancillaryinterrogators git-mktag plumbingmanipulators git-mktree plumbingmanipulators -git-mv mainporcelain common +git-mv mainporcelain worktr= ee git-name-rev plumbinginterrogators git-notes mainporcelain git-p4 foreignscminterface @@ -90,11 +102,11 @@ git-parse-remote synchelper= s git-patch-id purehelpers git-prune ancillarymanipulators git-prune-packed plumbingmanipulators -git-pull mainporcelain common -git-push mainporcelain common +git-pull mainporcelain remote +git-push mainporcelain remote git-quiltimport foreignscminterface git-read-tree plumbingmanipulators -git-rebase mainporcelain common +git-rebase mainporcelain histor= y git-receive-pack synchelpers git-reflog ancillarymanipulators git-relink ancillarymanipulators @@ -103,28 +115,28 @@ git-repack ancillary= manipulators git-replace ancillarymanipulators git-request-pull foreignscminterface git-rerere ancillaryinterrogators -git-reset mainporcelain common +git-reset mainporcelain worktr= ee git-revert mainporcelain git-rev-list plumbinginterrogators git-rev-parse ancillaryinterrogators -git-rm mainporcelain common +git-rm mainporcelain worktr= ee git-send-email foreignscminterface git-send-pack synchingrepositories git-shell synchelpers git-shortlog mainporcelain -git-show mainporcelain common +git-show mainporcelain info git-show-branch ancillaryinterrogators git-show-index plumbinginterrogators git-show-ref plumbinginterrogators git-sh-i18n purehelpers git-sh-setup purehelpers git-stash mainporcelain -git-status mainporcelain common +git-status mainporcelain info git-stripspace purehelpers git-submodule mainporcelain git-svn foreignscminterface git-symbolic-ref plumbingmanipulators -git-tag mainporcelain common +git-tag mainporcelain histor= y git-unpack-file plumbinginterrogators git-unpack-objects plumbingmanipulators git-update-index plumbingmanipulators --=20 2.4.0