Remove unneeded escape characters from the documentation
There was an incompatible upgrade of asciidoc. The old version of
asciidoc required certain characters to be escaped with a backslash
and when the upgrade to the new version was done all those backslashes
that were used for escaping became visible. These unneeded backslashes
in the documenation are confusing to users, especially since they
mainly appear in syntax examples (where the syntax gets incorrect if
the backslahes are included). With this change all unneded backslashes
are removed from the Gerrit documentation.
Change-Id: I6b71ac558344b07cdbc73c67c472c0186e8f50f2
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
diff --git a/Documentation/access-control.txt b/Documentation/access-control.txt
index b737ea8..7a9558b 100644
--- a/Documentation/access-control.txt
+++ b/Documentation/access-control.txt
@@ -158,13 +158,13 @@
Permissions can be set on a single reference name to match one
branch (e.g. `refs/heads/master`), or on a reference namespace
-(e.g. `refs/heads/\*`) to match any branch starting with that
-prefix. So a permission with `refs/heads/\*` will match
+(e.g. `refs/heads/*`) to match any branch starting with that
+prefix. So a permission with `refs/heads/*` will match
`refs/heads/master` and `refs/heads/experimental`, etc.
Reference names can also be described with a regular expression
-by prefixing the reference name with `\^`. For example
-`\^refs/heads/[a-z]\{1,8\}` matches all lower case branch names
+by prefixing the reference name with `^`. For example
+`^refs/heads/[a-z]{1,8}` matches all lower case branch names
between 1 and 8 characters long. Within a regular expression `.`
is a wildcard matching any character, but may be escaped as `\.`.
The link:http://www.brics.dk/automaton/[dk.brics.automaton library]
@@ -175,7 +175,7 @@
References can have the current user name automatically included,
creating dynamic access controls that change to match the currently
logged in user. For example to provide a personal sandbox space
-to all developers, `refs/heads/sandbox/$\{username\}/*` allowing
+to all developers, `refs/heads/sandbox/${username}/*` allowing
the user 'joe' to use 'refs/heads/sandbox/joe/foo'.
When evaluating a reference-level access right, Gerrit will use
@@ -298,7 +298,7 @@
Ownership over a particular branch subspace may be delegated by
entering a branch pattern. To delegate control over all branches
that begin with `qa/` to the QA group, add `Owner` category
-for reference `refs/heads/qa/\*`. Members of the QA group can
+for reference `refs/heads/qa/*`. Members of the QA group can
further refine access, but only for references that begin with
`refs/heads/qa/`.
@@ -314,13 +314,13 @@
This category has a special behavior, where the per-project ACL is
evaluated before the global all projects ACL. If the per-project
ACL has granted `Read Access -1`, and does not otherwise grant
-`Read Access \+1`, then a `Read Access +1` in the all projects ACL
+`Read Access +1`, then a `Read Access +1` in the all projects ACL
is ignored. This behavior is useful to hide a handful of projects
on an otherwise public server.
For an open source, public Gerrit installation it is common to grant
-`Read Access +1` to `Anonymous Users` in the `\-- All Projects
-\--` ACL, enabling casual browsing of any project's changes,
+`Read Access +1` to `Anonymous Users` in the `-- All Projects
+--` ACL, enabling casual browsing of any project's changes,
as well as fetching any project's repository over SSH or HTTP.
New projects can be temporarily hidden from public view by granting
`Read Access -1` to `Anonymous Users` and granting `Read Access +1`
@@ -349,8 +349,8 @@
implies read access by simply being a higher level of it.
For an open source, public Gerrit installation, it is common to
-grant `Read Access +1..+2` to `Registered Users` in the `\-- All
-Projects \--` ACL. For more private installations, its common to
+grant `Read Access +1..+2` to `Registered Users` in the `-- All
+Projects --` ACL. For more private installations, its common to
simply grant `Read Access +1..+2` to all users of a project.
[[category_READ_3]]
@@ -519,7 +519,7 @@
If a Gerrit installation wants to modify the description text
associated with these category values, the text can be updated
-in the `name` column of the `category_id = \'VRIF'` rows in the
+in the `name` column of the `category_id = 'VRIF'` rows in the
`approval_category_values` table.
Additional values could also be added to this category, to allow it
@@ -594,7 +594,7 @@
If a Gerrit installation wants to modify the description text
associated with these category values, the text can be updated
-in the `name` column of the `category_id = \'CRVW'` rows in the
+in the `name` column of the `category_id = 'CRVW'` rows in the
`approval_category_values` table.
Additional values could be inserted into `approval_category_values`
@@ -637,7 +637,7 @@
Gerrit administrators can also make up their own categories.
See above for descriptions of how `Verified` and `Code Review` work,
-and insert your own category with `function_name = \'MaxWithBlock'`
+and insert your own category with `function_name = 'MaxWithBlock'`
to get the same behavior over your own range of values, in any
category you desire.
diff --git a/Documentation/cmd-show-queue.txt b/Documentation/cmd-show-queue.txt
index 1e97f48..98a954e 100644
--- a/Documentation/cmd-show-queue.txt
+++ b/Documentation/cmd-show-queue.txt
@@ -41,7 +41,7 @@
Task::
Unique task identifier on this server. May be passed into
link:cmd-kill.html[kill] to cancel or terminate the task.
- Task identifiers have a period of 2\^32-1, and start from
+ Task identifiers have a period of 2^32-1, and start from
a random value.
State::
diff --git a/Documentation/config-gerrit.txt b/Documentation/config-gerrit.txt
index 66c8863..7af7d30 100644
--- a/Documentation/config-gerrit.txt
+++ b/Documentation/config-gerrit.txt
@@ -985,7 +985,7 @@
Local filesystem directory holding all Git repositories that
Gerrit knows about and can process changes for. A project
entity in Gerrit maps to a local Git repository by creating
-the path string `"$\{basePath}/$\{project_name}.git"`.
+the path string `"${basePath}/${project_name}.git"`.
+
If relative, the path is resolved relative to `'$site_path'`.
@@ -1063,23 +1063,23 @@
Optional pattern to use for constructing the gitweb URL when pointing
at a specific commit when `custom` is used above.
+
-Valid replacements are `$\{project\}` for the project name in Gerrit
-and `$\{commit\}` for the SHA1 hash for the commit.
+Valid replacements are `${project}` for the project name in Gerrit
+and `${commit}` for the SHA1 hash for the commit.
[[gitweb.type]]gitweb.project::
+
Optional pattern to use for constructing the gitweb URL when pointing
at a specific project when `custom` is used above.
+
-Valid replacements are `$\{project\}` for the project name in Gerrit.
+Valid replacements are `${project}` for the project name in Gerrit.
[[gitweb.type]]gitweb.branch::
+
Optional pattern to use for constructing the gitweb URL when pointing
at a specific branch when `custom` is used above.
+
-Valid replacements are `$\{project\}` for the project name in Gerrit
-and `$\{branch\}` for the name of the branch.
+Valid replacements are `${project}` for the project name in Gerrit
+and `${branch}` for the name of the branch.
[[hooks]]Section hooks
@@ -1141,7 +1141,7 @@
[[httpd.listenUrl]]httpd.listenUrl::
+
Specifies the URLs the internal HTTP daemon should listen for
-connections on. The special hostname '\*' may be used to listen
+connections on. The special hostname '*' may be used to listen
on all local addresses. A context path may optionally be included,
placing Gerrit Code Review's web address within a subdirectory of
the server.
@@ -1391,17 +1391,17 @@
Query pattern to use when searching for a user account. This may be
any valid LDAP query expression, including the standard `(&...)` and
`(|...)` operators. If auth.type is `HTTP_LDAP` then the variable
-`$\{username\}` is replaced with a parameter set to the username
+`${username}` is replaced with a parameter set to the username
that was supplied by the HTTP server. If auth.type is `LDAP` then
-the variable `$\{username\}` is replaced by the string entered by
+the variable `${username}` is replaced by the string entered by
the end user.
+
This pattern is used to search the objects contained directly under
the `ldap.accountBase` tree. A typical setting for this parameter
-is `(uid=$\{username\})` or `(cn=$\{username\})`, but the proper
+is `(uid=${username})` or `(cn=${username})`, but the proper
setting depends on the LDAP schema used by the directory server.
+
-Default is `(uid=$\{username\})` for RFC 2307 servers,
+Default is `(uid=${username})` for RFC 2307 servers,
and `(&(objectClass=user)(sAMAccountName=${username}))`
for Active Directory.
@@ -1414,7 +1414,7 @@
+
Attribute values may be concatenated with literal strings, for
example to join given name and surname together use the pattern
-`$\{givenName\} $\{SN\}`.
+`${givenName} ${SN}`.
+
If set, users will be unable to modify their full name field, as
Gerrit will populate it only from the LDAP data.
@@ -1431,7 +1431,7 @@
Attribute values may be concatenated with literal strings,
for example to set the email address to the lowercase form
of sAMAccountName followed by a constant domain name, use
-`$\{sAMAccountName.toLowerCase\}@example.com`.
+`${sAMAccountName.toLowerCase}@example.com`.
+
If set, the preferred email address will be prefilled from LDAP,
but users may still be able to register additional email address,
@@ -1449,12 +1449,12 @@
SSH clients will default to.
+
Attribute values may also be forced to lowercase, or to uppercase in
-an expression. For example, `$\{sAMAccountName.toLowerCase\}` will
+an expression. For example, `${sAMAccountName.toLowerCase}` will
force the value of sAMAccountName, if defined, to be all lowercase.
The suffix `.toUpperCase` can be used for the other direction.
The suffix `.localPart` can be used to split attribute values of
the form 'user@example.com' and return only the left hand side, for
-example `$\{userPrincipalName.localPart\}` would provide only 'user'.
+example `${userPrincipalName.localPart}` would provide only 'user'.
+
If set, users will be unable to modify their SSH username field, as
Gerrit will populate it only from the LDAP data.
@@ -1492,11 +1492,11 @@
Query pattern used when searching for an LDAP group to connect
to a Gerrit group. This may be any valid LDAP query expression,
including the standard `(&...)` and `(|...)` operators. The variable
-`$\{groupname\}` is replaced with the search term supplied by the
+`${groupname}` is replaced with the search term supplied by the
group owner.
+
-Default is `(cn=$\{groupname\})` for RFC 2307,
-and `(&(objectClass=group)(cn=$\{groupname\}))` for Active Directory.
+Default is `(cn=${groupname})` for RFC 2307,
+and `(&(objectClass=group)(cn=${groupname}))` for Active Directory.
[[ldap.groupMemberPattern]]ldap.groupMemberPattern::
+
@@ -1504,15 +1504,15 @@
account is currently a member of. This may be any valid LDAP query
expression, including the standard `(&...)` and `(|...)` operators.
+
-If auth.type is `HTTP_LDAP` then the variable `$\{username\}` is
+If auth.type is `HTTP_LDAP` then the variable `${username}` is
replaced with a parameter set to the username that was supplied
by the HTTP server. Other variables appearing in the pattern,
-such as `$\{fooBarAttribute\}`, are replaced with the value of the
+such as `${fooBarAttribute}`, are replaced with the value of the
corresponding attribute (in this case, `fooBarAttribute`) as read
from the user's account object matched under `ldap.accountBase`.
-Attributes such as `$\{dn\}` or `$\{uidNumber\}` may be useful.
+Attributes such as `${dn}` or `${uidNumber}` may be useful.
+
-Default is `(memberUid=$\{username\})` for RFC 2307,
+Default is `(memberUid=${username})` for RFC 2307,
and unset (disabled) for Active Directory.
@@ -1524,8 +1524,8 @@
If set to true, files with the MIME type `<name>` will be sent as
direct downloads to the user's browser, rather than being wrapped up
inside of zipped archives. The type name may be a complete type
-name, e.g. `image/gif`, a generic media type, e.g. `image/\*`,
-or the wildcard `\*/*` to match all types.
+name, e.g. `image/gif`, a generic media type, e.g. `image/*`,
+or the wildcard `*/*` to match all types.
+
By default, false for all MIME types.
@@ -1638,7 +1638,7 @@
+
* `MIXED`
+
-Shorthand for `$\{user\} (Code Review) <review@example.com>` where
+Shorthand for `${user} (Code Review) <review@example.com>` where
`review@example.com` is the same as <<user.email,user.email>>.
See below for a description of how the replacement is handled.
+
@@ -1654,7 +1654,7 @@
If set to a name and email address in brackets, Gerrit will use
this name and email address for any messages, overriding the name
that may have been selected for commits by user.name and user.email.
-Optionally, the name portion may contain the placeholder `$\{user\}`,
+Optionally, the name portion may contain the placeholder `${user}`,
which is replaced by the Full Name of the current user.
+
@@ -1737,7 +1737,7 @@
* 'hostname':'port' (for example `review.example.com:29418`)
* 'IPv4':'port' (for example `10.0.0.1:29418`)
* ['IPv6']:'port' (for example `[ff02::1]:29418`)
-* \*:'port' (for example `*:29418`)
+* *:'port' (for example `*:29418`)
+
If multiple values are supplied, the daemon will listen on all
diff --git a/Documentation/config-hooks.txt b/Documentation/config-hooks.txt
index 963b628..058a6bf 100644
--- a/Documentation/config-hooks.txt
+++ b/Documentation/config-hooks.txt
@@ -100,7 +100,7 @@
-------------------
If link:config-gerrit.html#gerrit.canonicalWebUrl[gerrit.canonicalWebUrl]
-is not set in `gerrit.config` the `\--change-url` flag may not be
+is not set in `gerrit.config` the `--change-url` flag may not be
passed to all hooks. Hooks started out of an SSH context (for example
the patchset-created hook) don't know the server's web URL, unless
this variable is configured.
diff --git a/Documentation/config-replication.txt b/Documentation/config-replication.txt
index 3768b6d..3390a4f 100644
--- a/Documentation/config-replication.txt
+++ b/Documentation/config-replication.txt
@@ -84,7 +84,7 @@
threads in the thread pool, Gerrit pushes to all URLs in parallel,
using one thread per URL.
+
-Within each URL value the magic placeholder `$\{name}` is replaced
+Within each URL value the magic placeholder `${name}` is replaced
with the Gerrit project name. This is a Gerrit specific extension
to the otherwise standard Git URL syntax and it must be included
in each URL so that Gerrit can figure out where each project needs
@@ -123,16 +123,16 @@
[[remote.name.push]]remote.<name>.push::
+
Standard Git refspec denoting what should be replicated. Setting this
-to `+refs/heads/\*:refs/heads/\*` would mirror only the active
+to `+refs/heads/*:refs/heads/*` would mirror only the active
branches, but not the change refs under `refs/changes/`, or the tags
under `refs/tags/`.
+
Multiple push keys can be supplied, to specify multiple patterns
to match against. In the example file above, remote "pubmirror"
-uses two push keys to match both `refs/heads/\*` and `refs/tags/*`,
+uses two push keys to match both `refs/heads/*` and `refs/tags/*`,
but excludes all others, including `refs/changes/*`.
+
-Defaults to `+refs/\*:refs/*` (all refs) if not specified.
+Defaults to `+refs/*:refs/*` (all refs) if not specified.
[[remote.name.timeout]]remote.<name>.timeout::
+
diff --git a/Documentation/config-sso.txt b/Documentation/config-sso.txt
index 37f5b05..9aa06be 100644
--- a/Documentation/config-sso.txt
+++ b/Documentation/config-sso.txt
@@ -88,7 +88,7 @@
standard `Authorization` HTTP header.
The auth.emailFormat field ('optional') sets the preferred email
-address during first login. Gerrit will replace `\{0\}` with the
+address during first login. Gerrit will replace `{0}` with the
username, as obtained from the Authorization header. A format such
as shown in the example would be typical, to add the domain name
of the organization.
@@ -152,7 +152,7 @@
single sign-on or security group to ensure the setting is correct.
The auth.emailFormat field ('optional') sets the user's preferred
-email address when they first login. Gerrit will replace `\{0\}`
+email address when they first login. Gerrit will replace `{0}`
with the username, as supplied by Siteminder. A format such as
shown in the example would be typical, to add the domain name of
the organization.
diff --git a/Documentation/project-setup.txt b/Documentation/project-setup.txt
index 9e4f556..edb43dc 100644
--- a/Documentation/project-setup.txt
+++ b/Documentation/project-setup.txt
@@ -68,20 +68,20 @@
* Merge If Necessary
+
-This is the default for a new project (and why `\'M'` is suggested
+This is the default for a new project (and why `'M'` is suggested
above in the insert statement).
+
If the change being submitted is a strict superset of the destination
branch, then the branch is fast-forwarded to the change. If not,
then a merge commit is automatically created. This is identical
-to the classical `git merge` behavior, or `git merge \--ff`.
+to the classical `git merge` behavior, or `git merge --ff`.
* Always Merge
+
Always produce a merge commit, even if the change is a strict
superset of the destination branch. This is identical to the
-behavior of `git merge \--no-ff`, and may be useful if the
-project needs to follow submits with `git log \--first-parent`.
+behavior of `git merge --no-ff`, and may be useful if the
+project needs to follow submits with `git log --first-parent`.
* Cherry Pick
+
diff --git a/Documentation/user-changeid.txt b/Documentation/user-changeid.txt
index 1fa627c..124ec31 100644
--- a/Documentation/user-changeid.txt
+++ b/Documentation/user-changeid.txt
@@ -57,7 +57,7 @@
Change Upload
--------------
-During upload by pushing to a `refs/for/\*` or `refs/heads/\*`
+During upload by pushing to a `refs/for/*` or `refs/heads/*`
branch, Gerrit will use the Change-Id line to:
* Create a new change
@@ -103,7 +103,7 @@
Amending a commit
~~~~~~~~~~~~~~~~~
-When amending a commit with `git commit \--amend`, leave the
+When amending a commit with `git commit --amend`, leave the
Change-Id line unmodified in the commit message. This will allow
Gerrit to automatically update the change with the amended commit.
diff --git a/Documentation/user-search.txt b/Documentation/user-search.txt
index ba031db..c291b89 100644
--- a/Documentation/user-search.txt
+++ b/Documentation/user-search.txt
@@ -181,11 +181,11 @@
anchoring the match to the start of the string. To match all Java
files, use `file:^.*\.java`.
+
-The entire regular expression pattern, including the `\^` character,
+The entire regular expression pattern, including the `^` character,
should be double quoted when using more complex construction (like
ones using a bracket expression). For example, to match all XML
files named like 'name1.xml', 'name2.xml', and 'name3.xml' use
-`\file:"\^name[1-3].xml"`.
+`file:"^name[1-3].xml"`.
+
Currently this operator is only available on a watched project
and may not be used in the search bar.
@@ -314,8 +314,8 @@
`label:CodeReview=+2`::
`label:CodeReview+2`::
+
-Matches changes where there is at least one \+2 score for Code Review.
-The \+ prefix is optional for positive score values. If the + is used,
+Matches changes where there is at least one +2 score for Code Review.
+The + prefix is optional for positive score values. If the + is used,
the = operator is optional.
`label:CodeReview=-2`::
diff --git a/Documentation/user-upload.txt b/Documentation/user-upload.txt
index 8a08317..2e6c86d 100644
--- a/Documentation/user-upload.txt
+++ b/Documentation/user-upload.txt
@@ -150,7 +150,7 @@
git push --receive-pack='git receive-pack --reviewer=a@a.com --cc=b@o.com' tr:kernel/common HEAD:refs/for/experimental
====
-The `\--reviewer='email'` and `\--cc='email'` options may be
+The `--reviewer='email'` and `--cc='email'` options may be
specified as many times as necessary to cover all interested
parties. Gerrit will automatically avoid sending duplicate email
notifications, such as if one of the specified reviewers or CC
@@ -323,7 +323,7 @@
~~~~~~~~~~~~~~~
To replace changes, ensure Change-Id lines were created in the
-commit messages, and just use `repo upload` without the `\--replace`
+commit messages, and just use `repo upload` without the `--replace`
command line flag. Gerrit Code Review will automatically match
the commits back to their original changes by taking advantage of
their Change-Id lines.
@@ -333,7 +333,7 @@
on the web.
If Change-Id lines are not available, then the user must use the much
-more manual mapping technique offered by `repo upload \--replace`.
+more manual mapping technique offered by `repo upload --replace`.
For more about Change-Ids, see link:user-changeid.html[Change-Id Lines].
@@ -345,8 +345,8 @@
own process space, Gerrit maintains complete control over how the
repository is updated, and what responses are sent to the `git push`
client invoked by the end-user, or by `repo upload`. This allows
-Gerrit to provide magical refs, such as `refs/for/\*` for new
-change submission and `refs/changes/\*` for change replacement.
+Gerrit to provide magical refs, such as `refs/for/*` for new
+change submission and `refs/changes/*` for change replacement.
When a push request is received to create a ref in one of these
namespaces Gerrit performs its own logic to update the database,
and then lies to the client about the result of the operation.
