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

Re: [PATCH 3/3] format-patch documentation: Fix formatting

From
Björn Gustavsson <bgustavsson@gmail.com>
Date
Oct 25, 2009, 18:47 UTC
Message-ID
<4AE49D39.7000904@gmail.com>
In-Reply-To
<4AE47546.6040804@gmail.com>
Björn Gustavsson wrote:
> Format git commands and options consistently using back quotes
> (i.e. a fixed font in the resulting HTML document).

I missed a few places. Here is an additional patch to be applied on top of the original patch.

I'll send out a new combined patch later, but I'll wait for comments on the series first.

/Björn
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 86d3d80..14265b8 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -43,19 +43,19 @@ endif::git-format-patch[]
 
 --stat[=width[,name-width]]::
 	Generate a diffstat.  You can override the default
-	output width for 80-column terminal by "--stat=width".
+	output width for 80-column terminal by `--stat=width`.
 	The width of the filename part can be controlled by
 	giving another width to it separated by a comma.
 
 --numstat::
-	Similar to \--stat, but shows number of added and
+	Similar to `\--stat`, but shows number of added and
 	deleted lines in decimal notation and pathname without
 	abbreviation, to make it more machine friendly.  For
 	binary files, outputs two `-` instead of saying
 	`0 0`.
 
 --shortstat::
-	Output only the last line of the --stat format containing total
+	Output only the last line of the `--stat` format containing total
 	number of modified files, as well as number of added and deleted
 	lines.
 
@@ -63,8 +63,8 @@ endif::git-format-patch[]
 	Output the distribution of relative amount of changes (number of lines added or
 	removed) for each sub-directory. Directories with changes below
 	a cut-off percent (3% by default) are not shown. The cut-off percent
-	can be set with "--dirstat=limit". Changes in a child directory is not
-	counted for the parent directory, unless "--cumulative" is used.
+	can be set with `--dirstat=limit`. Changes in a child directory is not
+	counted for the parent directory, unless `--cumulative` is used.
 
 --dirstat-by-file[=limit]::
 	Same as `--dirstat`, but counts changed files instead of lines.
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 79d77f7..f1fd0df 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -160,7 +160,7 @@ will want to ensure that threading is disabled for `git send-email`.
 	Instead of the standard '[PATCH]' prefix in the subject
 	line, instead use '[<Subject-Prefix>]'. This
 	allows for useful naming of a patch series, and can be
-	combined with the --numbered option.
+	combined with the `--numbered` option.
 
 --cc=<email>::
 	Add a `Cc:` header to the email headers. This is in addition
Previous: Björn Gustavsson
Message 2 of 2 in “format-patch documentation: Fix formatting”
  1. 3/3 format-patch documentation: Fix formattingBjörn Gustavsson, Oct 25, 2009
  2. Björn GustavssonOct 25, 2009

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.