git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Michael J Gruber <git@drmicha.warpmail.net>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH] Make <identifier> lowercase in Documentation
Date: Thu, 17 Feb 2011 08:48:06 +0100	[thread overview]
Message-ID: <d8246b3c2afe48505db13da63e01c0084346ade9.1297928789.git.git@drmicha.warpmail.net> (raw)
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

  reply	other threads:[~2011-02-17  7:51 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-02-14 15:10 [PATCH 0/7] Cleaning up --help-all inconsistencies Michael J Gruber
2011-02-14 15:10 ` [PATCH 1/7] commit,tag: use same wording for -F Michael J Gruber
2011-02-14 19:49   ` Junio C Hamano
2011-02-14 15:10 ` [PATCH 2/7] push: describe --porcelain just like commit and status Michael J Gruber
2011-02-14 19:42   ` Johannes Sixt
2011-02-14 19:53   ` Junio C Hamano
2011-02-14 22:25     ` Sverre Rabbelier
2011-02-15  6:50     ` Michael J Gruber
2011-02-14 15:10 ` [PATCH 3/7] clone,init: describe --template using the same wording Michael J Gruber
2011-02-14 19:54   ` Junio C Hamano
2011-02-14 15:10 ` [PATCH 4/7] merge,tag: describe -m just like commit Michael J Gruber
2011-02-14 20:08   ` Junio C Hamano
2011-02-15  7:08     ` Michael J Gruber
2011-02-15 18:14       ` Junio C Hamano
2011-02-14 15:10 ` [PATCH 5/7] add: describe --patch like checkout, reset Michael J Gruber
2011-02-14 15:10 ` [PATCH 6/7] commit,status: describe -u likewise Michael J Gruber
2011-02-14 19:57   ` Junio C Hamano
2011-02-15  6:53     ` Michael J Gruber
2011-02-15  7:21       ` Jeff King
2011-02-14 15:10 ` [PATCH 7/7] git-tag.txt: list all modes in the description Michael J Gruber
2011-02-14 20:03   ` Junio C Hamano
2011-02-15 13:09 ` [PATCHv2 00/10] Cleaning up --help-all inconsistencies Michael J Gruber
2011-02-15 19:02   ` Junio C Hamano
2011-02-16  7:46     ` Michael J Gruber
2011-02-16 21:34       ` Junio C Hamano
2011-02-17  7:48         ` Michael J Gruber [this message]
     [not found] ` <cover.1297775122.git.git@drmicha.warpmail.net>
2011-02-15 13:09   ` [PATCHv2 01/10] commit,tag: use same wording for -F Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 02/10] commit,status: describe --porcelain just like push Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 03/10] clone,init: describe --template using the same wording Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 04/10] commit,merge,tag: describe -m likewise Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 05/10] add: describe --patch like checkout, reset Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 06/10] commit,status: describe -u likewise Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 07/10] git-tag.txt: list all modes in the description Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 08/10] Make <identifier> lowercase as per CodingGuidelines Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 09/10] " Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 10/10] " Michael J Gruber

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=d8246b3c2afe48505db13da63e01c0084346ade9.1297928789.git.git@drmicha.warpmail.net \
    --to=git@drmicha.warpmail.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).