summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2011-03-16 23:47:25 (GMT)
committerJunio C Hamano <gitster@pobox.com>2011-03-16 23:47:25 (GMT)
commit7633a5ab9a33f90fc0fb912d7403f6c21c5435c1 (patch)
treeb6c3394b841cee89fb3febfe21953da0ae398ae9 /Documentation
parentbd2700dbdf6551c646bc4d68b6230b63ca6eaea3 (diff)
parent3b0d24053b50d8da76de28ea5f0d3947fa3d2194 (diff)
downloadgit-7633a5ab9a33f90fc0fb912d7403f6c21c5435c1.zip
git-7633a5ab9a33f90fc0fb912d7403f6c21c5435c1.tar.gz
git-7633a5ab9a33f90fc0fb912d7403f6c21c5435c1.tar.bz2
Merge branch 'mg/placeholders-are-lowercase' into maint
* mg/placeholders-are-lowercase: Make <identifier> lowercase in Documentation Make <identifier> lowercase as per CodingGuidelines Make <identifier> lowercase as per CodingGuidelines Make <identifier> lowercase as per CodingGuidelines CodingGuidelines: downcase placeholders in usage messages
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/CodingGuidelines2
-rw-r--r--Documentation/git-remote-ext.txt14
-rw-r--r--Documentation/git-remote-helpers.txt6
-rw-r--r--Documentation/git-svn.txt6
4 files changed, 14 insertions, 14 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index ba2006d..fe1c1e5 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -152,7 +152,7 @@ Writing Documentation:
when writing or modifying command usage strings and synopsis sections
in the manual pages:
- Placeholders are enclosed in angle brackets:
+ Placeholders are spelled in lowercase and enclosed in angle brackets:
<file>
--sort=<key>
--abbrev[=<n>]
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