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

[PATCH] Make <identifier> lowercase in Documentation

From
Michael J Gruber <git@drmicha.warpmail.net>
Date
Feb 17, 2011, 07:48 UTC
Message-ID
<d8246b3c2afe48505db13da63e01c0084346ade9.1297928789.git.git@drmicha.warpmail.net>
In-Reply-To
<7vbp2birzi.fsf@alter.siamese.dyndns.org>

Leaving uppercase abbreviations (e.g. URL) and an identifier named after an upercase env variable (CVSROOT) in place, this adjusts the few remaining cases and fixes an unidentified identifier along the way.

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
---
 Documentation/git-remote-ext.txt     |   14 +++++++-------
 Documentation/git-remote-helpers.txt |    6 +++---
 Documentation/git-svn.txt            |    6 +++---
 3 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/Documentation/git-remote-ext.txt b/Documentation/git-remote-ext.txt
index 2d65cfe..68263a6 100644
--- a/Documentation/git-remote-ext.txt
+++ b/Documentation/git-remote-ext.txt
@@ -7,17 +7,17 @@ git-remote-ext - Bridge smart transport to external command.
 
 SYNOPSIS
 --------
-git remote add nick "ext::<command>[ <arguments>...]"
+git remote add <nick> "ext::<command>[ <arguments>...]"
 
 DESCRIPTION
 -----------
-This remote helper uses the specified 'program' to connect
+This remote helper uses the specified '<command>' to connect
 to a remote git server.
 
-Data written to stdin of this specified 'program' is assumed
+Data written to stdin of the specified '<command>' is assumed
 to be sent to a git:// server, git-upload-pack, git-receive-pack
 or git-upload-archive (depending on situation), and data read
-from stdout of this program is assumed to be received from
+from stdout of <command> is assumed to be received from
 the same service.
 
 Command and arguments are separated by an unescaped space.
@@ -40,7 +40,7 @@ The following sequences have a special meaning:
 	git wants to invoke.
 
 '%G' (must be the first characters in an argument)::
-	This argument will not be passed to 'program'. Instead, it
+	This argument will not be passed to '<command>'. Instead, it
 	will cause the helper to start by sending git:// service requests to
 	the remote side with the service field set to an appropriate value and
 	the repository field set to rest of the argument. Default is not to send
@@ -50,7 +50,7 @@ This is useful if remote side is git:// server accessed over
 some tunnel.
 
 '%V' (must be first characters in argument)::
-	This argument will not be passed to 'program'. Instead it sets
+	This argument will not be passed to '<command>'. Instead it sets
 	the vhost field in the git:// service request (to rest of the argument).
 	Default is not to send vhost in such request (if sent).
 
@@ -76,7 +76,7 @@ EXAMPLES:
 ---------
 This remote helper is transparently used by git when
 you use commands such as "git fetch <URL>", "git clone <URL>",
-, "git push <URL>" or "git remote add nick <URL>", where <URL>
+, "git push <URL>" or "git remote add <nick> <URL>", where <URL>
 begins with `ext::`.  Examples:
 
 "ext::ssh -i /home/foo/.ssh/somekey user&#64;host.example %S 'foo/repo'"::
diff --git a/Documentation/git-remote-helpers.txt b/Documentation/git-remote-helpers.txt
index 3a23477..51de895 100644
--- a/Documentation/git-remote-helpers.txt
+++ b/Documentation/git-remote-helpers.txt
@@ -201,12 +201,12 @@ REF LIST ATTRIBUTES
 
 OPTIONS
 -------
-'option verbosity' <N>::
+'option verbosity' <n>::
 	Changes the verbosity of messages displayed by the helper.
-	A value of 0 for N means that processes operate
+	A value of 0 for <n> means that processes operate
 	quietly, and the helper produces only error output.
 	1 is the default level of verbosity, and higher values
-	of N correspond to the number of -v flags passed on the
+	of <n> correspond to the number of -v flags passed on the
 	command line.
 
 'option progress' \{'true'|'false'\}::
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 0ade2ce..e161a40 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -66,7 +66,7 @@ COMMANDS
 	Set the 'rewriteRoot' option in the [svn-remote] config.
 --rewrite-uuid=<UUID>;;
 	Set the 'rewriteUUID' option in the [svn-remote] config.
---username=<USER>;;
+--username=<user>;;
 	For transports that SVN handles authentication for (http,
 	https, and plain svn), specify the username.  For other
 	transports (eg svn+ssh://), you must include the username in
@@ -443,8 +443,8 @@ OPTIONS
 	Only used with the 'init' command.
 	These are passed directly to 'git init'.
 
--r <ARG>::
---revision <ARG>::
+-r <arg>::
+--revision <arg>::
 	   Used with the 'fetch' command.
 +
 This allows revision ranges for partial/cauterized history
-- 
1.7.4.1.74.gf39475.dirty
Previous: Junio C HamanoNext: Michael J Gruber
Message 26 of 36 in “Cleaning up --help-all inconsistencies”
  1. 0/7 Cleaning up --help-all inconsistenciesMichael J Gruber, Feb 14, 2011
  2. 1/7 commit,tag: use same wording for -FMichael J Gruber, Feb 14, 2011
  3. Junio C HamanoFeb 14, 2011
  4. 2/7 push: describe --porcelain just like commit and statusMichael J Gruber, Feb 14, 2011
  5. Johannes SixtFeb 14, 2011
  6. Junio C HamanoFeb 14, 2011
  7. Sverre RabbelierFeb 14, 2011
  8. Michael J GruberFeb 15, 2011
  9. 3/7 clone,init: describe --template using the same wordingMichael J Gruber, Feb 14, 2011
  10. Junio C HamanoFeb 14, 2011
  11. 4/7 merge,tag: describe -m just like commitMichael J Gruber, Feb 14, 2011
  12. Junio C HamanoFeb 14, 2011
  13. Michael J GruberFeb 15, 2011
  14. Junio C HamanoFeb 15, 2011
  15. 5/7 add: describe --patch like checkout, resetMichael J Gruber, Feb 14, 2011
  16. 6/7 commit,status: describe -u likewiseMichael J Gruber, Feb 14, 2011
  17. Junio C HamanoFeb 14, 2011
  18. Michael J GruberFeb 15, 2011
  19. Jeff KingFeb 15, 2011
  20. 7/7 git-tag.txt: list all modes in the descriptionMichael J Gruber, Feb 14, 2011
  21. Junio C HamanoFeb 14, 2011
  22. 00/10 Cleaning up --help-all inconsistenciesMichael J Gruber, Feb 15, 2011
  23. Junio C HamanoFeb 15, 2011
  24. Michael J GruberFeb 16, 2011
  25. Junio C HamanoFeb 16, 2011
  26. Make <identifier> lowercase in DocumentationMichael J Gruber, Feb 17, 2011
  27. 01/10 commit,tag: use same wording for -FMichael J Gruber, Feb 15, 2011
  28. 02/10 commit,status: describe --porcelain just like pushMichael J Gruber, Feb 15, 2011
  29. 03/10 clone,init: describe --template using the same wordingMichael J Gruber, Feb 15, 2011
  30. 04/10 commit,merge,tag: describe -m likewiseMichael J Gruber, Feb 15, 2011
  31. 05/10 add: describe --patch like checkout, resetMichael J Gruber, Feb 15, 2011
  32. 06/10 commit,status: describe -u likewiseMichael J Gruber, Feb 15, 2011
  33. 07/10 git-tag.txt: list all modes in the descriptionMichael J Gruber, Feb 15, 2011
  34. 08/10 Make <identifier> lowercase as per CodingGuidelinesMichael J Gruber, Feb 15, 2011
  35. 09/10 Make <identifier> lowercase as per CodingGuidelinesMichael J Gruber, Feb 15, 2011
  36. 10/10 Make <identifier> lowercase as per CodingGuidelinesMichael J Gruber, Feb 15, 2011

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.