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

[PATCH 10/15] manpages: italicize command names

From
Jonathan Nieder <jrnieder@uchicago.edu>
Date
Jul 3, 2008, 05:37 UTC
Message-ID
<Pine.GSO.4.62.0807030036120.16085@harper.uchicago.edu>
In-Reply-To
<Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu>

This includes nongit commands like RCS 'merge'. This patch only italicizes names of commands if they had no formatting before.

Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
---
	The escaping under "log.date" in config.txt works for me
	with asciidoc 8.2.6 and ASCIIDOC8=YesPlease.  Will it work
	on asciidoc 7?
 Documentation/config.txt          |    4 ++--
 Documentation/git-apply.txt       |    6 +++---
 Documentation/git-merge-file.txt  |    2 +-
 Documentation/git-merge-index.txt |    2 +-
 Documentation/git-rerere.txt      |    4 ++--
 Documentation/gitdiffcore.txt     |    4 ++--
 6 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 5a98a5b..84a0e77 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -568,7 +568,7 @@ diff.external::
 
 diff.renameLimit::
 	The number of files to consider when performing the copy/rename
-	detection; equivalent to the git-diff option '-l'.
+	detection; equivalent to the 'git-diff' option '-l'.
 
 diff.renames::
 	Tells git to detect renames.  If set to any boolean value, it
@@ -849,7 +849,7 @@ instaweb.port::
 
 log.date::
 	Set default date-time mode for the log command. Setting log.date
-	value is similar to using git-log's --date option. The value is one of the
+	value is similar to using 'git-log'\'s --date option. The value is one of the
 	following alternatives: {relative,local,default,iso,rfc,short}.
 	See linkgit:git-log[1].
 
diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt
index fbe1130..b2f909d 100644
--- a/Documentation/git-apply.txt
+++ b/Documentation/git-apply.txt
@@ -18,7 +18,7 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-Reads supplied diff output and applies it on a git index file
+Reads supplied 'diff' output and applies it on a git index file
 and a work tree.
 
 OPTIONS
@@ -165,9 +165,9 @@ behavior:
 * `error-all` is similar to `error` but shows all errors.
 
 --inaccurate-eof::
-	Under certain circumstances, some versions of diff do not correctly
+	Under certain circumstances, some versions of 'diff' do not correctly
 	detect a missing new-line at the end of the file. As a result, patches
-	created by such diff programs do not record incomplete lines
+	created by such 'diff' programs do not record incomplete lines
 	correctly. This option adds support for applying such patches by
 	working around this bug.
 
diff --git a/Documentation/git-merge-file.txt b/Documentation/git-merge-file.txt
index 2a033dd..b5eb630 100644
--- a/Documentation/git-merge-file.txt
+++ b/Documentation/git-merge-file.txt
@@ -93,7 +93,7 @@ Written by Johannes Schindelin <johannes.schindelin@gmx.de>
 Documentation
 --------------
 Documentation by Johannes Schindelin and the git-list <git@vger.kernel.org>,
-with parts copied from the original documentation of RCS merge.
+with parts copied from the original documentation of RCS 'merge'.
 
 GIT
 ---
diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt
index 4368084..4f04bbb 100644
--- a/Documentation/git-merge-index.txt
+++ b/Documentation/git-merge-index.txt
@@ -41,7 +41,7 @@ processes them in turn only stopping if merge returns a non-zero exit
 code.
 
 Typically this is run with a script calling git's imitation of
-the merge command from the RCS package.
+the 'merge' command from the RCS package.
 
 A sample script called `git-merge-one-file` is included in the
 distribution.
diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt
index ae2b2b5..30ec68d 100644
--- a/Documentation/git-rerere.txt
+++ b/Documentation/git-rerere.txt
@@ -7,7 +7,7 @@ git-rerere - Reuse recorded resolution of conflicted merges
 
 SYNOPSIS
 --------
-'git rerere' [clear|diff|status|gc]
+'git rerere' ['clear'|'diff'|'status'|'gc']
 
 DESCRIPTION
 -----------
@@ -49,7 +49,7 @@ conflicts.  Additional arguments are passed directly to the system
 
 'status'::
 
-Like diff, but this only prints the filenames that will be tracked
+Like 'diff', but this only prints the filenames that will be tracked
 for resolutions.
 
 'gc'::
diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt
index 1171b5c..949332b 100644
--- a/Documentation/gitdiffcore.txt
+++ b/Documentation/gitdiffcore.txt
@@ -7,7 +7,7 @@ gitdiffcore - Tweaking diff output (June 2005)
 
 SYNOPSIS
 --------
-git diff *
+'git diff' *
 
 DESCRIPTION
 -----------
@@ -16,7 +16,7 @@ The diff commands `git-diff-index`, `git-diff-files`, and `git-diff-tree`
 can be told to manipulate differences they find in
 unconventional ways before showing `diff` output.  The manipulation
 is collectively called "diffcore transformation".  This short note
-describes what they are and how to use them to produce diff output
+describes what they are and how to use them to produce 'diff' output
 that is easier to understand than the conventional kind.
 
 
-- 
1.5.5.GIT
Previous: Jonathan NiederNext: Jonathan Nieder
Message 35 of 40 in “Some superficial documentation changes”
  1. 0/7 Some superficial documentation changesJonathan Nieder, Jun 30, 2008
  2. 1/7 Documentation: fix links to tutorials and other new manual pagesJonathan Nieder, Jun 30, 2008
  3. Christian CouderJun 30, 2008
  4. 2/7 whitespace fix in Documentation/git-repack.txtJonathan Nieder, Jun 30, 2008
  5. 3/7 Documentation: complicate example of "man git-command"Jonathan Nieder, Jun 30, 2008
  6. Christian CouderJun 30, 2008
  7. J. Bruce FieldsJul 1, 2008
  8. Junio C HamanoJul 1, 2008
  9. J. Bruce FieldsJul 2, 2008
  10. Jonathan NiederJul 3, 2008
  11. J. Bruce FieldsJul 3, 2008
  12. Christian CouderJul 3, 2008
  13. Junio C HamanoJul 3, 2008
  14. 4/7 git-daemon(1): don't assume git-daemon is in /usr/binJonathan Nieder, Jun 30, 2008
  15. 5/7 Documentation: prepare to be consistent about "git-" versus "git "Jonathan Nieder, Jun 30, 2008
  16. 6/7 Documentation: be consistent about "git-" versus "git "Jonathan Nieder, Jun 30, 2008
  17. 7/7 Documentation formatting and cleanupJonathan Nieder, Jun 30, 2008
  18. Olivier MarinJul 1, 2008
  19. Junio C HamanoJul 1, 2008
  20. Jonathan NiederJul 3, 2008
  21. Jonathan NiederJul 3, 2008
  22. Junio C HamanoJul 1, 2008
  23. Jonathan NiederJul 3, 2008
  24. 01/15 git-format-patch(1): fix stray \ in outputJonathan Nieder, Jul 3, 2008
  25. 02/15 Documentation: fix gitlinksJonathan Nieder, Jul 3, 2008
  26. 03/15 manpages: fix bogus whitespaceJonathan Nieder, Jul 3, 2008
  27. Junio C HamanoJul 3, 2008
  28. Jonathan NiederJul 4, 2008
  29. 04/15 git(1): add commaJonathan Nieder, Jul 3, 2008
  30. 05/15 git-commit(1): depersonalize descriptionJonathan Nieder, Jul 3, 2008
  31. 06/15 Documentation: rewrap to prepare for "git-" vs "git " changeJonathan Nieder, Jul 3, 2008
  32. 07/15 Documentation: more "git-" versus "git " changesJonathan Nieder, Jul 3, 2008
  33. 08/15 gitdiffcore(7): fix awkward wordingJonathan Nieder, Jul 3, 2008
  34. 09/15 manpages: italicize command names in synopsesJonathan Nieder, Jul 3, 2008
  35. 10/15 manpages: italicize command namesJonathan Nieder, Jul 3, 2008
  36. 11/15 manpages: italicize git command names (which were in teletype font)Jonathan Nieder, Jul 3, 2008
  37. 12/15 manpages: italicize gitk's name (where it was in teletype font)Jonathan Nieder, Jul 3, 2008
  38. 13/15 manpages: italicize nongit command names (if they are in teletype font)Jonathan Nieder, Jul 3, 2008
  39. 14/15 manpages: italicize git subcommand names (which were in teletype font)Jonathan Nieder, Jul 3, 2008
  40. 15/15 manpages: use teletype font for sample command linesJonathan Nieder, Jul 3, 2008

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.