git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] Documentation: add a new man page for "git-help" and -i|--info option.

From
VJVäinö Järvelä <v@pp.inet.fi>
Date
Dec 5, 2007, 08:19 UTC
Message-ID
<178B37CE-9B28-4CE2-B8A0-FCA28CF85E12@pp.inet.fi>
In-Reply-To
<20071204064429.1b5007b2.chriscool@tuxfamily.org>
Patch attached to fix header error in this patch.
(Attached because Mail.app mangles inline patches)

-- Väinö

On Dec 4, 2007, at 07:44, Christian Couder wrote:
Show 104 quoted lines
> Option -i|--info for "git-help" is documented only in the new
> "git-help.txt" man page, but this new man page is referenced
> from the "--help" option documentation in the "git.txt" man page.
>
> Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
> ---
> Documentation/git-help.txt |   53 +++++++++++++++++++++++++++++++++++ 
> +++++++++
> Documentation/git.txt      |   11 ++++++--
> 2 files changed, 61 insertions(+), 3 deletions(-)
> create mode 100644 Documentation/git-help.txt
>
> 	This is a first documentation patch in my git-help
> 	improvement series.
>
> diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
> new file mode 100644
> index 0000000..232daae
> --- /dev/null
> +++ b/Documentation/git-help.txt
> @@ -0,0 +1,53 @@
> +git-help(1)
> +======
> +
> +NAME
> +----
> +git-help - display help information about git
> +
> +SYNOPSIS
> +--------
> +'git help' [-a|--all|-i|--info] [COMMAND]
> +
> +DESCRIPTION
> +-----------
> +
> +With no options and no COMMAND given, the synopsis of the 'git'
> +command and a list of the most commonly used git commands are printed
> +on the standard output.
> +
> +If the option '--all' or '-a' is given, then all available commands  
> are
> +printed on the standard output.
> +
> +If a git command is named, a manual page for that command is brought
> +up. The 'man' program is used by default for this purpose, but this
> +can be overriden by other options.
> +
> +Note that 'git --help ...' is identical as 'git help ...' because the
> +former is internally converted into the latter.
> +
> +OPTIONS
> +-------
> +-a|--all::
> +
> +	Prints all the available commands on the standard output. This
> +	option superseeds any other option.
> +
> +-i|--info::
> +	Use the 'info' program to display the manual page, instead of
> +	the 'man' program that is used by default.
> +
> +Author
> +------
> +Written by Junio C Hamano <gitster@pobox.com> and the git-list
> +<git@vger.kernel.org>.
> +
> +Documentation
> +-------------
> +Initial documentation was part of the gitlink:git[7] man page.
> +Christian Couder <chriscool@tuxfamily.org> extracted and rewrote it a
> +little. Maintenance is done by the git-list <git@vger.kernel.org>.
> +
> +GIT
> +---
> +Part of the gitlink:git[7] suite
> diff --git a/Documentation/git.txt b/Documentation/git.txt
> index 5460201..f8d1eef 100644
> --- a/Documentation/git.txt
> +++ b/Documentation/git.txt
> @@ -100,9 +100,14 @@ OPTIONS
>
> --help::
> 	Prints the synopsis and a list of the most commonly used
> -	commands.  If a git command is named this option will bring up
> -	the man-page for that command. If the option '--all' or '-a' is
> -	given then all available commands are printed.
> +	commands. If the option '--all' or '-a' is given then all
> +	available commands are printed. If a git command is named this
> +	option will bring up the manual page for that command.
> +
> +	Other options are available to control how the manual page is
> +	displayed. See gitlink:git-help[1] for more information,
> +	because 'git --help ...' is converted internally into 'git
> +	help ...'.
>
> --exec-path::
> 	Path to wherever your core git programs are installed.
> -- 
> 1.5.3.6.1993.g154f-dirty
>
> -
> To unsubscribe from this list: send the line "unsubscribe git" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
From 6d9fa82be1074a9fe6bf3fad36a838c1142966ca Mon Sep 17 00:00:00 2001
From: =?utf-8?q?V=C3=A4in=C3=B6=20J=C3=A4rvel=C3=A4?= <v@pp.inet.fi>
Date: Wed, 5 Dec 2007 10:05:48 +0200
Subject: [PATCH] Fixed git-help.txt header error
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Väinö Järvelä <v@pp.inet.fi>
---
 Documentation/git-help.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 232daae..c94e27b 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -1,5 +1,5 @@
 git-help(1)
-======
+===========
 
 NAME
 ----
-- 
1.5.3.7.2115.geb80
Previous: Junio C HamanoNext: Wincent Colaiuta
Message 3 of 7 in “Documentation: add a new man page for "git-help" and -i|--info option.”
  1. Documentation: add a new man page for "git-help" and -i|--info option.Christian Couder, Dec 4, 2007
  2. Junio C HamanoDec 4, 2007
  3. Väinö JärveläDec 5, 2007
  4. Wincent ColaiutaDec 5, 2007
  5. Väinö JärveläDec 5, 2007
  6. Junio C HamanoDec 5, 2007
  7. Väinö JärveläDec 5, 2007

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.