Skip to content

Commit

Permalink
Merge branch 'jk/doc-asciidoc-inline-literal' into maint
Browse files Browse the repository at this point in the history
By Jeff King
* jk/doc-asciidoc-inline-literal:
  docs: stop using asciidoc no-inline-literal
  • Loading branch information
gitster committed May 14, 2012
2 parents 3734dbc + 6cf378f commit badabc0
Show file tree
Hide file tree
Showing 53 changed files with 192 additions and 194 deletions.
2 changes: 1 addition & 1 deletion Documentation/Makefile
Expand Up @@ -82,7 +82,7 @@ endif
#

ifndef ASCIIDOC7
ASCIIDOC_EXTRA += -a asciidoc7compatible -a no-inline-literal
ASCIIDOC_EXTRA += -a asciidoc7compatible
endif
ifdef DOCBOOK_XSL_172
ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
Expand Down
36 changes: 18 additions & 18 deletions Documentation/config.txt
Expand Up @@ -481,8 +481,8 @@ Common unit suffixes of 'k', 'm', or 'g' are supported.
core.excludesfile::
In addition to '.gitignore' (per-directory) and
'.git/info/exclude', git looks into this file for patterns
of files which are not meant to be tracked. "{tilde}/" is expanded
to the value of `$HOME` and "{tilde}user/" to the specified user's
of files which are not meant to be tracked. "`~/`" is expanded
to the value of `$HOME` and "`~user/`" to the specified user's
home directory. See linkgit:gitignore[5].

core.askpass::
Expand Down Expand Up @@ -863,7 +863,7 @@ commit.status::

commit.template::
Specify a file to use as the template for new commit messages.
"{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
specified user's home directory.

credential.helper::
Expand Down Expand Up @@ -988,7 +988,7 @@ format.thread::
a boolean value, or `shallow` or `deep`. `shallow` threading
makes every mail a reply to the head of the series,
where the head is chosen from the cover letter, the
`\--in-reply-to`, and the first patch mail, in this order.
`--in-reply-to`, and the first patch mail, in this order.
`deep` threading makes every mail a reply to the previous one.
A true boolean value is the same as `shallow`, and a false
value disables threading.
Expand Down Expand Up @@ -1419,21 +1419,21 @@ instaweb.port::
interactive.singlekey::
In interactive commands, allow the user to provide one-letter
input with a single key (i.e., without hitting enter).
Currently this is used by the `\--patch` mode of
Currently this is used by the `--patch` mode of
linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
setting is silently ignored if portable keystroke input
is not available.

log.abbrevCommit::
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
override this option with `\--no-abbrev-commit`.
linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
override this option with `--no-abbrev-commit`.

log.date::
Set the default date-time mode for the 'log' command.
Setting a value for log.date is similar to using 'git log''s
`\--date` option. Possible values are `relative`, `local`,
`--date` option. Possible values are `relative`, `local`,
`default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
for details.

Expand Down Expand Up @@ -1623,18 +1623,18 @@ pack.indexVersion::
and this config option ignored whenever the corresponding pack is
larger than 2 GB.
+
If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
If you have an old git that does not understand the version 2 `*.idx` file,
cloning or fetching over a non native protocol (e.g. "http" and "rsync")
that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
that will copy both `*.pack` file and corresponding `*.idx` file from the
other side may give you a repository that cannot be accessed with your
older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
older version of git. If the `*.pack` file is smaller than 2 GB, however,
you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
the `{asterisk}.idx` file.
the `*.idx` file.

pack.packSizeLimit::
The maximum size of a pack. This setting only affects
packing to a file when repacking, i.e. the git:// protocol
is unaffected. It can be overridden by the `\--max-pack-size`
is unaffected. It can be overridden by the `--max-pack-size`
option of linkgit:git-repack[1]. The minimum size allowed is
limited to 1 MiB. The default is unlimited.
Common unit suffixes of 'k', 'm', or 'g' are
Expand All @@ -1644,18 +1644,18 @@ pager.<cmd>::
If the value is boolean, turns on or off pagination of the
output of a particular git subcommand when writing to a tty.
Otherwise, turns on pagination for the subcommand using the
pager specified by the value of `pager.<cmd>`. If `\--paginate`
or `\--no-pager` is specified on the command line, it takes
pager specified by the value of `pager.<cmd>`. If `--paginate`
or `--no-pager` is specified on the command line, it takes
precedence over this option. To disable pagination for all
commands, set `core.pager` or `GIT_PAGER` to `cat`.

pretty.<name>::
Alias for a --pretty= format string, as specified in
linkgit:git-log[1]. Any aliases defined here can be used just
as the built-in pretty formats could. For example,
running `git config pretty.changelog "format:{asterisk} %H %s"`
running `git config pretty.changelog "format:* %H %s"`
would cause the invocation `git log --pretty=changelog`
to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
to be equivalent to running `git log "--pretty=format:* %H %s"`.
Note that an alias with the same name as a built-in format
will be silently ignored.

Expand Down Expand Up @@ -1768,7 +1768,7 @@ remote.<name>.push::

remote.<name>.mirror::
If true, pushing to this remote will automatically behave
as if the `\--mirror` option was given on the command line.
as if the `--mirror` option was given on the command line.

remote.<name>.skipDefaultUpdate::
If true, this remote will be skipped by default when updating
Expand Down
2 changes: 1 addition & 1 deletion Documentation/diff-generate-patch.txt
Expand Up @@ -175,7 +175,7 @@ In the above example output, the function signature was changed
from both files (hence two `-` removals from both file1 and
file2, plus `++` to mean one line that was added does not appear
in either file1 nor file2). Also eight other lines are the same
from file1 but do not appear in file2 (hence prefixed with `{plus}`).
from file1 but do not appear in file2 (hence prefixed with `+`).

When shown by `git diff-tree -c`, it compares the parents of a
merge commit with the merge result (i.e. file1..fileN are the
Expand Down
2 changes: 1 addition & 1 deletion Documentation/diff-options.txt
Expand Up @@ -74,7 +74,7 @@ These parameters can also be set individually with `--stat-width=<width>`,
`--stat-name-width=<name-width>` and `--stat-count=<count>`.

--numstat::
Similar to `\--stat`, but shows number of added and
Similar to `--stat`, but shows number of added and
deleted lines in decimal notation and pathname without
abbreviation, to make it more machine friendly. For
binary files, outputs two `-` instead of saying
Expand Down
4 changes: 2 additions & 2 deletions Documentation/everyday.txt
Expand Up @@ -98,8 +98,8 @@ you originally wrote.
<9> switch to the master branch.
<10> merge a topic branch into your master branch.
<11> review commit logs; other forms to limit output can be
combined and include `\--max-count=10` (show 10 commits),
`\--until=2005-12-10`, etc.
combined and include `--max-count=10` (show 10 commits),
`--until=2005-12-10`, etc.
<12> view only the changes that touch what's in `curses/`
directory, since `v2.43` tag.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-archive.txt
Expand Up @@ -160,7 +160,7 @@ EXAMPLES

Same as above, but the format is inferred from the output file.

`git archive --format=tar --prefix=git-1.4.0/ v1.4.0{caret}\{tree\} | gzip >git-1.4.0.tar.gz`::
`git archive --format=tar --prefix=git-1.4.0/ v1.4.0^{tree} | gzip >git-1.4.0.tar.gz`::

Create a compressed tarball for v1.4.0 release, but without a
global extended pax header.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-blame.txt
Expand Up @@ -160,7 +160,7 @@ introduced the file with:
git log --diff-filter=A --pretty=short -- foo

and then annotate the change between the commit and its
parents, using `commit{caret}!` notation:
parents, using `commit^!` notation:

git blame -C -C -f $commit^! -- foo

Expand Down
8 changes: 4 additions & 4 deletions Documentation/git-bundle.txt
Expand Up @@ -61,7 +61,7 @@ unbundle <file>::
A list of arguments, acceptable to 'git rev-parse' and
'git rev-list' (and containing a named ref, see SPECIFYING REFERENCES
below), that specifies the specific objects and references
to transport. For example, `master{tilde}10..master` causes the
to transport. For example, `master~10..master` causes the
current master reference to be packaged along with all objects
added since its 10th ancestor commit. There is no explicit
limit to the number of references and objects that may be
Expand All @@ -80,12 +80,12 @@ SPECIFYING REFERENCES

'git bundle' will only package references that are shown by
'git show-ref': this includes heads, tags, and remote heads. References
such as `master{tilde}1` cannot be packaged, but are perfectly suitable for
such as `master~1` cannot be packaged, but are perfectly suitable for
defining the basis. More than one reference may be packaged, and more
than one basis can be specified. The objects packaged are those not
contained in the union of the given bases. Each basis can be
specified explicitly (e.g. `^master{tilde}10`), or implicitly (e.g.
`master{tilde}10..master`, `--since=10.days.ago master`).
specified explicitly (e.g. `^master~10`), or implicitly (e.g.
`master~10..master`, `--since=10.days.ago master`).

It is very important that the basis used be held by the destination.
It is okay to err on the side of caution, causing the bundle file
Expand Down
12 changes: 6 additions & 6 deletions Documentation/git-check-ref-format.txt
Expand Up @@ -40,9 +40,9 @@ git imposes the following rules on how references are named:

. They cannot have ASCII control characters (i.e. bytes whose
values are lower than \040, or \177 `DEL`), space, tilde `~`,
caret `{caret}`, or colon `:` anywhere.
caret `^`, or colon `:` anywhere.

. They cannot have question-mark `?`, asterisk `{asterisk}`, or open
. They cannot have question-mark `?`, asterisk `*`, or open
bracket `[` anywhere. See the `--refspec-pattern` option below for
an exception to this rule.

Expand All @@ -62,10 +62,10 @@ unquoted (by mistake), and also avoids ambiguities in certain
reference name expressions (see linkgit:gitrevisions[7]):

. A double-dot `..` is often used as in `ref1..ref2`, and in some
contexts this notation means `{caret}ref1 ref2` (i.e. not in
contexts this notation means `^ref1 ref2` (i.e. not in
`ref1` and in `ref2`).

. A tilde `~` and caret `{caret}` are used to introduce the postfix
. A tilde `~` and caret `^` are used to introduce the postfix
'nth parent' and 'peel onion' operation.

. A colon `:` is used as in `srcref:dstref` to mean "use srcref\'s
Expand All @@ -92,9 +92,9 @@ OPTIONS
--refspec-pattern::
Interpret <refname> as a reference name pattern for a refspec
(as used with remote repositories). If this option is
enabled, <refname> is allowed to contain a single `{asterisk}`
enabled, <refname> is allowed to contain a single `*`
in place of a one full pathname component (e.g.,
`foo/{asterisk}/bar` but not `foo/bar{asterisk}`).
`foo/*/bar` but not `foo/bar*`).

--normalize::
Normalize 'refname' by removing any leading slash (`/`)
Expand Down
8 changes: 4 additions & 4 deletions Documentation/git-checkout.txt
Expand Up @@ -184,7 +184,7 @@ the conflicted merge in the specified paths.
+
This means that you can use `git checkout -p` to selectively discard
edits from your current working tree. See the ``Interactive Mode''
section of linkgit:git-add[1] to learn how to operate the `\--patch` mode.
section of linkgit:git-add[1] to learn how to operate the `--patch` mode.

<branch>::
Branch to checkout; if it refers to a branch (i.e., a name that,
Expand All @@ -193,11 +193,11 @@ section of linkgit:git-add[1] to learn how to operate the `\--patch` mode.
commit, your HEAD becomes "detached" and you are no longer on
any branch (see below for details).
+
As a special case, the `"@\{-N\}"` syntax for the N-th last branch
As a special case, the `"@{-N}"` syntax for the N-th last branch
checks out the branch (instead of detaching). You may also specify
`-` which is synonymous with `"@\{-1\}"`.
`-` which is synonymous with `"@{-1}"`.
+
As a further special case, you may use `"A\...B"` as a shortcut for the
As a further special case, you may use `"A...B"` as a shortcut for the
merge base of `A` and `B` if there is exactly one merge base. You can
leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.

Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-cherry-pick.txt
Expand Up @@ -130,7 +130,7 @@ EXAMPLES
Apply the changes introduced by all commits that are ancestors
of master but not of HEAD to produce new commits.

`git cherry-pick master{tilde}4 master{tilde}2`::
`git cherry-pick master~4 master~2`::

Apply the changes introduced by the fifth and third last
commits pointed to by master and create 2 new commits with
Expand All @@ -151,7 +151,7 @@ EXAMPLES
are in next but not HEAD to the current branch, creating a new
commit for each new change.

`git rev-list --reverse master \-- README | git cherry-pick -n --stdin`::
`git rev-list --reverse master -- README | git cherry-pick -n --stdin`::

Apply the changes introduced by all commits on the master
branch that touched README to the working tree and index,
Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-commit.txt
Expand Up @@ -42,7 +42,7 @@ The content to be added can be specified in several ways:

5. by using the --interactive or --patch switches with the 'commit' command
to decide one by one which files or hunks should be part of the commit,
before finalizing the operation. See the ``Interactive Mode`` section of
before finalizing the operation. See the ``Interactive Mode'' section of
linkgit:git-add[1] to learn how to operate these modes.

The `--dry-run` option can be used to obtain a
Expand Down Expand Up @@ -287,7 +287,7 @@ When recording your own work, the contents of modified files in
your working tree are temporarily stored to a staging area
called the "index" with 'git add'. A file can be
reverted back, only in the index but not in the working tree,
to that of the last commit with `git reset HEAD \-- <file>`,
to that of the last commit with `git reset HEAD -- <file>`,
which effectively reverts 'git add' and prevents the changes to
this file from participating in the next commit. After building
the state to be committed incrementally with these commands,
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-cvsserver.txt
Expand Up @@ -252,7 +252,7 @@ Configuring database backend

'git-cvsserver' uses the Perl DBI module. Please also read
its documentation if changing these variables, especially
about `DBI\->connect()`.
about `DBI->connect()`.

gitcvs.dbname::
Database name. The exact meaning depends on the
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-fast-export.txt
Expand Up @@ -104,7 +104,7 @@ marks the same across runs.
[<git-rev-list-args>...]::
A list of arguments, acceptable to 'git rev-parse' and
'git rev-list', that specifies the specific objects and references
to export. For example, `master{tilde}10..master` causes the
to export. For example, `master~10..master` causes the
current master reference to be exported along with all objects
added since its 10th ancestor commit.

Expand Down
6 changes: 3 additions & 3 deletions Documentation/git-fast-import.txt
Expand Up @@ -478,9 +478,9 @@ current branch value should be written as:
----
from refs/heads/branch^0
----
The `{caret}0` suffix is necessary as fast-import does not permit a branch to
The `^0` suffix is necessary as fast-import does not permit a branch to
start from itself, and the branch is created in memory before the
`from` command is even read from the input. Adding `{caret}0` will force
`from` command is even read from the input. Adding `^0` will force
fast-import to resolve the commit through Git's revision parsing library,
rather than its internal branch table, thereby loading in the
existing value of the branch.
Expand Down Expand Up @@ -975,7 +975,7 @@ Reading from a named tree::

See `filemodify` above for a detailed description of `<path>`.

Output uses the same format as `git ls-tree <tree> {litdd} <path>`:
Output uses the same format as `git ls-tree <tree> -- <path>`:

====
<mode> SP ('blob' | 'tree' | 'commit') SP <dataref> HT <path> LF
Expand Down

0 comments on commit badabc0

Please sign in to comment.