diff --git a/Documentation/RelNotes/2.54.0.adoc b/Documentation/RelNotes/2.54.0.adoc
index 084b9074c41725..13ff912b3f10f3 100644
--- a/Documentation/RelNotes/2.54.0.adoc
+++ b/Documentation/RelNotes/2.54.0.adoc
@@ -20,6 +20,10 @@ UI, Workflows & Features
* When "git show-index" is run outside a repository, it silently
defaults to SHA-1; the tool now warns when this happens.
+ * "git merge-file" can be run outside a repository, but it ignored
+ all configuration, even the per-user ones. The command now uses
+ available configuration files to find its customization.
+
Performance, Internal Implementation, Development Support etc.
--------------------------------------------------------------
@@ -39,19 +43,22 @@ Performance, Internal Implementation, Development Support etc.
string, you get a const pointer to the substring). Update code
paths that used non-const pointer to receive their results that did
not have to be non-const to adjust.
- (merge fc9fd8065c cf/c23-const-preserving-strchr-updates-0 later to maint).
* Rename three functions around the commit_list data structure.
- (merge 9f18d089c5 ps/commit-list-functions-renamed later to maint).
* Transaction to create objects (or not) is currently tied to the
repository, but in the future a repository can have multiple object
sources, which may have different transaction mechanisms. Make the
odb transaction API per object source.
- (merge 3f67e3d021 jt/odb-transaction-per-source later to maint).
* "git merge-ours" is taught to work better in a sparse checkout.
- (merge fb1b786ebf sb/merge-ours-sparse later to maint).
+
+ * Allow recording process ID of the process that holds the lock next
+ to a lockfile for diagnosis.
+
+ * Reduce dependency on the_repository of xdiff-interface layer.
+
+ * Code clean-up to use the commit_stack API.
Fixes since v2.53
@@ -90,6 +97,10 @@ Fixes since v2.53
"next" branch.
(merge c591c3ceff jc/ci-test-contrib-too later to maint).
+ * A handful of documentation pages have been modernized to use the
+ "synopsis" style.
+ (merge a34d1d53a6 ja/doc-synopsis-style-even-more later to maint).
+
* Other code cleanup, docfix, build fix, etc.
(merge d79fff4a11 jk/remote-tracking-ref-leakfix later to maint).
(merge 7a747f972d dd/t5403-modernise later to maint).
@@ -103,3 +114,9 @@ Fixes since v2.53
(merge 0728012c53 jc/diff-highlight-main-master-testfix later to maint).
(merge 831989ef38 mc/doc-send-email-signed-off-by-cc later to maint).
(merge c44b3f3203 sd/doc-my1c-api-config-reference-fix later to maint).
+ (merge 6c21e53bad rs/version-wo-the-repository later to maint).
+ (merge 10c68d2577 rs/clean-includes later to maint).
+ (merge 168d575719 bk/t2003-modernise later to maint).
+ (merge 6bfef81c9a kh/doc-rerere-options-xref later to maint).
+ (merge aaf3cc3d8d sd/t7003-test-path-is-helpers later to maint).
+ (merge 2668b6bdc4 jc/doc-rerere-update later to maint).
diff --git a/Documentation/asciidoc.conf.in b/Documentation/asciidoc.conf.in
index ff9ea0a2944511..31b883a72c5739 100644
--- a/Documentation/asciidoc.conf.in
+++ b/Documentation/asciidoc.conf.in
@@ -81,12 +81,18 @@ endif::backend-xhtml11[]
ifdef::backend-docbook[]
ifdef::doctype-manpage[]
+[blockdef-open]
+synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!\\0 !g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1\\2 !g;s!<[-a-zA-Z0-9.]\\+>!\\0 !g'"
+
[paradef-default]
synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!\\0 !g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1\\2 !g;s!<[-a-zA-Z0-9.]\\+>!\\0 !g'"
endif::doctype-manpage[]
endif::backend-docbook[]
ifdef::backend-xhtml11[]
+[blockdef-open]
+synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!\\0 !g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1\\2!g;s!<[-a-zA-Z0-9.]\\+>!\\0 !g'"
+
[paradef-default]
synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!\\0 !g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1\\2!g;s!<[-a-zA-Z0-9.]\\+>!\\0 !g'"
endif::backend-xhtml11[]
diff --git a/Documentation/config/core.adoc b/Documentation/config/core.adoc
index 9bc9de29d90ecd..a0ebf03e2eb050 100644
--- a/Documentation/config/core.adoc
+++ b/Documentation/config/core.adoc
@@ -348,6 +348,17 @@ confusion unless you know what you are doing (e.g. you are creating a
read-only snapshot of the same index to a location different from the
repository's usual working tree).
+core.lockfilePid::
+ If true, Git will create a PID file alongside lock files. When a
+ lock acquisition fails and a PID file exists, Git can provide
+ additional diagnostic information about the process holding the
+ lock, including whether it is still running. Defaults to `false`.
++
+The PID file is named by inserting `~pid` before the `.lock` suffix.
+For example, if the lock file is `index.lock`, the PID file will be
+`index~pid.lock`. The file contains a single line in the format
+`pid ` followed by a newline.
+
core.logAllRefUpdates::
Enable the reflog. Updates to a ref [ is logged to the file
"`$GIT_DIR/logs/][`", by appending the new and old
diff --git a/Documentation/for-each-ref-options.adoc b/Documentation/for-each-ref-options.adoc
index f13efb5f2556cf..54e2fa95c2911e 100644
--- a/Documentation/for-each-ref-options.adoc
+++ b/Documentation/for-each-ref-options.adoc
@@ -30,8 +30,8 @@ TAB %(refname)`.
`--color[=]]`::
Respect any colors specified in the `--format` option. The
- _` is absent, behave as if `always` was given).
+ __ field must be one of `always`, `never`, or `auto` (if
+ __ is absent, behave as if `always` was given).
`--shell`::
`--perl`::
diff --git a/Documentation/git-clone.adoc b/Documentation/git-clone.adoc
index 57cdfb7620571c..959ca40733e4ae 100644
--- a/Documentation/git-clone.adoc
+++ b/Documentation/git-clone.adoc
@@ -84,7 +84,7 @@ __.
with the source repository. The resulting repository
starts out without any object of its own.
+
-*NOTE*: this is a possibly dangerous operation; do *not* use
+NOTE: this is a possibly dangerous operation; do *not* use
it unless you understand what it does. If you clone your
repository using this option and then delete branches (or use any
other Git command that makes any existing commit unreferenced) in the
@@ -104,7 +104,8 @@ If you want to break the dependency of a repository cloned with `--shared` on
its source repository, you can simply run `git repack -a` to copy all
objects from the source repository into a pack in the cloned repository.
-`--reference[-if-able] `::
+`--reference=`::
+`--reference-if-able=`::
If the reference __ is on the local machine,
automatically setup `.git/objects/info/alternates` to
obtain objects from the reference __. Using
@@ -115,7 +116,7 @@ objects from the source repository into a pack in the cloned repository.
directory is skipped with a warning instead of aborting
the clone.
+
-*NOTE*: see the NOTE for the `--shared` option, and also the
+NOTE: see the NOTE for the `--shared` option, and also the
`--dissociate` option.
`--dissociate`::
@@ -140,27 +141,28 @@ objects from the source repository into a pack in the cloned repository.
to the standard error stream.
`--progress`::
- Progress status is reported on the standard error stream
- by default when it is attached to a terminal, unless `--quiet`
+ Report progress status on the standard error stream
+ by default when attached to a terminal, unless `--quiet`
is specified. This flag forces progress status even if the
standard error stream is not directed to a terminal.
`--server-option=`::
Transmit the given string to the server when communicating using
- protocol version 2. The given string must not contain a NUL or LF
+ protocol version 2. The given string must not contain a _NUL_ or _LF_
character. The server's handling of server options, including
unknown ones, is server-specific.
When multiple `--server-option= ` are given, they are all
sent to the other side in the order listed on the command line.
- When no ++--server-option=++__ __ is given from the command
+ When no `--server-option= ` is given from the command
line, the values of configuration variable `remote..serverOption`
are used instead.
`-n`::
`--no-checkout`::
- No checkout of `HEAD` is performed after the clone is complete.
+ Do not checkout `HEAD` after the clone is complete.
-`--`[`no-`]`reject-shallow`::
+`--no-reject-shallow`::
+`--reject-shallow`::
Fail if the source repository is a shallow repository.
The `clone.rejectShallow` configuration variable can be used to
specify the default.
@@ -206,18 +208,17 @@ objects from the source repository into a pack in the cloned repository.
that all these refs are overwritten by a `git remote update` in the
target repository.
-`-o` __::
-`--origin` __::
+`-o`::
+`--origin=`::
Instead of using the remote name `origin` to keep track of the upstream
repository, use __. Overrides `clone.defaultRemoteName` from the
config.
-`-b` __::
-`--branch` __::
- Instead of pointing the newly created `HEAD` to the branch pointed
- to by the cloned repository's `HEAD`, point to __ branch
- instead. In a non-bare repository, this is the branch that will
- be checked out.
+`-b`::
+`--branch=`::
+ Point the newly created `HEAD` to __ branch instead of the branch
+ pointed to by the cloned repository's `HEAD`. In a non-bare repository,
+ this is the branch that will be checked out.
`--branch` can also take tags and detaches the `HEAD` at that commit
in the resulting repository.
@@ -230,18 +231,17 @@ objects from the source repository into a pack in the cloned repository.
name.
This option is incompatible with `--branch` and `--mirror`.
-`-u` __::
-`--upload-pack` __::
- When given, and the repository to clone from is accessed
- via ssh, this specifies a non-default path for the command
- run on the other end.
+`-u`::
+`--upload-pack=`::
+ Specify a non-default path for the command run on the other end when the
+ repository to clone from is accessed via ssh.
`--template=`::
Specify the directory from which templates will be used;
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
-`-c` `=`::
-`--config` `=`::
+`-c=`::
+`--config==`::
Set a configuration variable in the newly-created repository;
this takes effect immediately after the repository is
initialized, but before the remote history is fetched or any
@@ -257,7 +257,7 @@ Configuration variables known to not take effect are:
`remote..mirror` and `remote..tagOpt`. Use the
corresponding `--mirror` and `--no-tags` options instead.
-`--depth `::
+`--depth=`::
Create a 'shallow' clone with a history truncated to the
specified number of commits. Implies `--single-branch` unless
`--no-single-branch` is given to fetch the histories near the
@@ -339,8 +339,8 @@ Specify the given ref storage format for the repository. The valid values are:
+
include::ref-storage-format.adoc[]
-`-j` __::
-`--jobs` __::
+`-j`::
+`--jobs=`::
The number of submodules fetched at the same time.
Defaults to the `submodule.fetchJobs` option.
diff --git a/Documentation/git-merge-file.adoc b/Documentation/git-merge-file.adoc
index 71915a00fa472e..9dc5d8a3707a5d 100644
--- a/Documentation/git-merge-file.adoc
+++ b/Documentation/git-merge-file.adoc
@@ -85,6 +85,9 @@ object store and the object ID of its blob is written to standard output.
--zdiff3::
Show conflicts in "zdiff3" style.
++
+The `--diff3` and `--zdiff3` options default to the value of the
+`merge.conflictStyle` configuration variable (see linkgit:git-config[1]).
--ours::
--theirs::
diff --git a/Documentation/git-rerere.adoc b/Documentation/git-rerere.adoc
index 992b469270c004..99f967b7a4c0da 100644
--- a/Documentation/git-rerere.adoc
+++ b/Documentation/git-rerere.adoc
@@ -32,7 +32,7 @@ COMMANDS
--------
Normally, 'git rerere' is run without arguments or user-intervention.
-However, it has several commands that allow it to interact with
+However, it has several commands that allow users to interact with
its working state.
'clear'::
@@ -44,7 +44,7 @@ will automatically invoke this command.
'forget' ::
Reset the conflict resolutions which rerere has recorded for the current
-conflict in .
+conflict in paths that match .
'diff'::
diff --git a/Documentation/git-show.adoc b/Documentation/git-show.adoc
index 51044c814f5d06..3b180e8c7a5844 100644
--- a/Documentation/git-show.adoc
+++ b/Documentation/git-show.adoc
@@ -8,8 +8,8 @@ git-show - Show various types of objects
SYNOPSIS
--------
-[verse]
-'git show' [] [...]
+[synopsis]
+git show [] [...]
DESCRIPTION
-----------
@@ -17,16 +17,16 @@ Shows one or more objects (blobs, trees, tags and commits).
For commits it shows the log message and textual diff. It also
presents the merge commit in a special format as produced by
-'git diff-tree --cc'.
+`git diff-tree --cc`.
For tags, it shows the tag message and the referenced objects.
-For trees, it shows the names (equivalent to 'git ls-tree'
-with --name-only).
+For trees, it shows the names (equivalent to `git ls-tree`
+with `--name-only`).
For plain blobs, it shows the plain contents.
-Some options that 'git log' command understands can be used to
+Some options that `git log` command understands can be used to
control how the changes the commit introduces are shown.
This manual page describes only the most frequently used options.
@@ -34,8 +34,8 @@ This manual page describes only the most frequently used options.
OPTIONS
-------
-...::
- The names of objects to show (defaults to 'HEAD').
+`...`::
+ The names of objects to show (defaults to `HEAD`).
For a more complete list of ways to spell object names, see
"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
diff --git a/Documentation/git-submodule.adoc b/Documentation/git-submodule.adoc
index 95beaee5617b42..722d827908e2ab 100644
--- a/Documentation/git-submodule.adoc
+++ b/Documentation/git-submodule.adoc
@@ -8,19 +8,19 @@ git-submodule - Initialize, update or inspect submodules
SYNOPSIS
--------
-[verse]
-'git submodule' [--quiet] [--cached]
-'git submodule' [--quiet] add [] [--] []
-'git submodule' [--quiet] status [--cached] [--recursive] [--] [...]
-'git submodule' [--quiet] init [--] [...]
-'git submodule' [--quiet] deinit [-f|--force] (--all|[--] ...)
-'git submodule' [--quiet] update [] [--] [...]
-'git submodule' [--quiet] set-branch [] [--]
-'git submodule' [--quiet] set-url [--]
-'git submodule' [--quiet] summary [] [--] [...]
-'git submodule' [--quiet] foreach [--recursive]
-'git submodule' [--quiet] sync [--recursive] [--] [...]
-'git submodule' [--quiet] absorbgitdirs [--] [...]
+[synopsis]
+git submodule [--quiet] [--cached]
+git submodule [--quiet] add [] [--] []
+git submodule [--quiet] status [--cached] [--recursive] [--] [...]
+git submodule [--quiet] init [--] [...]
+git submodule [--quiet] deinit [-f|--force] (--all|[--] ...)
+git submodule [--quiet] update [] [--] [...]
+git submodule [--quiet] set-branch [] [--]
+git submodule [--quiet] set-url [--]
+git submodule [--quiet] summary [] [--] [...]
+git submodule [--quiet] foreach [--recursive]
+git submodule [--quiet] sync [--recursive] [--] [...]
+git submodule [--quiet] absorbgitdirs [--] [...]
DESCRIPTION
@@ -34,34 +34,34 @@ COMMANDS
With no arguments, shows the status of existing submodules. Several
subcommands are available to perform operations on the submodules.
-add [-b ] [-f|--force] [--name ] [--reference ] [--ref-format ] [--depth ] [--] []::
+`add [-b ] [-f | --force] [--name ] [--reference ] [--ref-format ] [--depth ] [--] []`::
Add the given repository as a submodule at the given path
to the changeset to be committed next to the current
project: the current project is termed the "superproject".
+
- is the URL of the new submodule's origin repository.
-This may be either an absolute URL, or (if it begins with ./
-or ../), the location relative to the superproject's default remote
-repository (Please note that to specify a repository 'foo.git'
-which is located right next to a superproject 'bar.git', you'll
+__ is the URL of the new submodule's `origin` repository.
+This may be either an absolute URL, or (if it begins with `./`
+or `../`), the location relative to the superproject's default remote
+repository (Please note that to specify a repository `foo.git`
+which is located right next to a superproject `bar.git`, you'll
have to use `../foo.git` instead of `./foo.git` - as one might expect
when following the rules for relative URLs - because the evaluation
of relative URLs in Git is identical to that of relative directories).
+
The default remote is the remote of the remote-tracking branch
of the current branch. If no such remote-tracking branch exists or
-the HEAD is detached, "origin" is assumed to be the default remote.
+the `HEAD` is detached, `origin` is assumed to be the default remote.
If the superproject doesn't have a default remote configured
the superproject is its own authoritative upstream and the current
working directory is used instead.
+
-The optional argument is the relative location for the cloned
-submodule to exist in the superproject. If is not given, the
-canonical part of the source repository is used ("repo" for
-"/path/to/repo.git" and "foo" for "host.xz:foo/.git"). If
+The optional argument __ is the relative location for the cloned
+submodule to exist in the superproject. If __ is not given, the
+canonical part of the source repository is used (`repo` for
+`/path/to/repo.git` and `foo` for `host.xz:foo/.git`). If __
exists and is already a valid Git repository, then it is staged
-for commit without cloning. The is also used as the submodule's
-logical name in its configuration entries unless `--name` is used
+for commit without cloning. The __ is also used as the submodule's
+logical name in its configuration entries unless `--name ` is used
to specify a logical name.
+
The given URL is recorded into `.gitmodules` for use by subsequent users
@@ -75,10 +75,10 @@ URL in `.gitmodules`.
If `--ref-format ` is specified, the ref storage format of newly
cloned submodules will be set accordingly.
-status [--cached] [--recursive] [--] [...]::
+`status [--cached] [--recursive] [--] [...]`::
Show the status of the submodules. This will print the SHA-1 of the
currently checked out commit for each submodule, along with the
- submodule path and the output of 'git describe' for the
+ submodule path and the output of linkgit:git-describe[1] for the
SHA-1. Each SHA-1 will possibly be prefixed with `-` if the submodule is
not initialized, `+` if the currently checked out submodule commit
does not match the SHA-1 found in the index of the containing
@@ -91,11 +91,11 @@ If `--recursive` is specified, this command will recurse into nested
submodules, and show their status as well.
+
If you are only interested in changes of the currently initialized
-submodules with respect to the commit recorded in the index or the HEAD,
+submodules with respect to the commit recorded in the index or the `HEAD`,
linkgit:git-status[1] and linkgit:git-diff[1] will provide that information
too (and can also report changes to a submodule's work tree).
-init [--] [...]::
+`init [--] [...]`::
Initialize the submodules recorded in the index (which were
added and committed elsewhere) by setting `submodule.$name.url`
in `.git/config`, using the same setting from `.gitmodules` as
@@ -103,7 +103,7 @@ init [--] [...]::
the default remote. If there is no default remote, the current
repository will be assumed to be upstream.
+
-Optional arguments limit which submodules will be initialized.
+Optional __ arguments limit which submodules will be initialized.
If no path is specified and submodule.active has been configured, submodules
configured to be active will be initialized, otherwise all submodules are
initialized.
@@ -116,12 +116,12 @@ that is set to a custom command is *not* copied for security reasons.
You can then customize the submodule clone URLs in `.git/config`
for your local setup and proceed to `git submodule update`;
you can also just use `git submodule update --init` without
-the explicit 'init' step if you do not intend to customize
+the explicit `init` step if you do not intend to customize
any submodule locations.
+
See the add subcommand for the definition of default remote.
-deinit [-f|--force] (--all|[--] ...)::
+`deinit [-f | --force] (--all|[--] ...)`::
Unregister the given submodules, i.e. remove the whole
`submodule.$name` section from .git/config together with their work
tree. Further calls to `git submodule update`, `git submodule foreach`
@@ -139,7 +139,7 @@ If you really want to remove a submodule from the repository and commit
that use linkgit:git-rm[1] instead. See linkgit:gitsubmodules[7] for removal
options.
-update [--init] [--remote] [-N|--no-fetch] [--[no-]recommend-shallow] [-f|--force] [--checkout|--rebase|--merge] [--reference ] [--ref-format ] [--depth ] [--recursive] [--jobs ] [--[no-]single-branch] [--filter ] [--] [...]::
+`update [--init] [--remote] [-N | --no-fetch] [--[no-]recommend-shallow] [-f | --force] [--checkout | --rebase | --merge] [--reference=] [--ref-format=] [--depth=] [--recursive] [--jobs ] [--[no-]single-branch] [--filter=] [--] [...]`::
+
--
Update the registered submodules to match what the superproject
@@ -148,38 +148,38 @@ in submodules and updating the working tree of
the submodules. The "updating" can be done in several ways depending
on command line options and the value of `submodule..update`
configuration variable. The command line option takes precedence over
-the configuration variable. If neither is given, a 'checkout' is performed.
+the configuration variable. If neither is given, a `checkout` is performed.
(note: what is in `.gitmodules` file is irrelevant at this point;
see `git submodule init` above for how `.gitmodules` is used).
-The 'update' procedures supported both from the command line as well as
+The `update` procedures supported both from the command line as well as
through the `submodule..update` configuration are:
- checkout;; the commit recorded in the superproject will be
- checked out in the submodule on a detached HEAD.
+`checkout`;; the commit recorded in the superproject will be
+checked out in the submodule on a detached `HEAD`.
+
If `--force` is specified, the submodule will be checked out (using
`git checkout --force`), even if the commit specified
in the index of the containing repository already matches the commit
checked out in the submodule.
- rebase;; the current branch of the submodule will be rebased
- onto the commit recorded in the superproject.
+`rebase`;; the current branch of the submodule will be rebased
+onto the commit recorded in the superproject.
- merge;; the commit recorded in the superproject will be merged
- into the current branch in the submodule.
+`merge`;; the commit recorded in the superproject will be merged
+into the current branch in the submodule.
The following update procedures have additional limitations:
- custom command;; mechanism for running arbitrary commands with the
- commit ID as an argument. Specifically, if the
- `submodule..update` configuration variable is set to
- `!custom command`, the object name of the commit recorded in the
- superproject for the submodule is appended to the `custom command`
- string and executed. Note that this mechanism is not supported in
- the `.gitmodules` file or on the command line.
+`!`;; mechanism for running arbitrary commands with the
+commit ID as an argument. Specifically, if the
+`submodule..update` configuration variable is set to
+`!`, the object name of the commit recorded in the
+superproject for the submodule is appended to the __
+string and executed. Note that this mechanism is not supported in
+the `.gitmodules` file or on the command line.
- none;; the submodule is not updated. This update procedure is not
- allowed on the command line.
+`none`;; the submodule is not updated. This update procedure is not
+allowed on the command line.
If the submodule is not yet initialized, and you just want to use the
setting as stored in `.gitmodules`, you can automatically initialize the
@@ -195,20 +195,20 @@ If `--filter ` is specified, the given partial clone filter will be
applied to the submodule. See linkgit:git-rev-list[1] for details on filter
specifications.
--
-set-branch (-b|--branch) [--] ::
-set-branch (-d|--default) [--] ::
- Sets the default remote tracking branch for the submodule. The
+`set-branch (-b|--branch) [--] `::
+`set-branch (-d|--default) [--] `::
+ Set the default remote tracking branch for the submodule. The
`--branch` option allows the remote branch to be specified. The
- `--default` option removes the submodule..branch configuration
- key, which causes the tracking branch to default to the remote 'HEAD'.
+ `--default` option removes the `submodule..branch` configuration
+ key, which causes the tracking branch to default to the remote `HEAD`.
-set-url [--] ::
- Sets the URL of the specified submodule to . Then, it will
+`set-url [--] `::
+ Set the URL of the specified submodule to __. Then, it will
automatically synchronize the submodule's new remote URL
configuration.
-summary [--cached|--files] [(-n|--summary-limit) ] [commit] [--] [...]::
- Show commit summary between the given commit (defaults to HEAD) and
+`summary [--cached | --files] [(-n|--summary-limit) ] [commit] [--] [...]`::
+ Show commit summary between the given commit (defaults to `HEAD`) and
working tree/index. For a submodule in question, a series of commits
in the submodule between the given super project commit and the
index or working tree (switched by `--cached`) are shown. If the option
@@ -220,27 +220,31 @@ summary [--cached|--files] [(-n|--summary-limit) ] [commit] [--] [...]:
Using the `--submodule=log` option with linkgit:git-diff[1] will provide that
information too.
-foreach [--recursive] ::
- Evaluates an arbitrary shell command in each checked out submodule.
- The command has access to the variables $name, $sm_path, $displaypath,
- $sha1 and $toplevel:
- $name is the name of the relevant submodule section in `.gitmodules`,
- $sm_path is the path of the submodule as recorded in the immediate
- superproject, $displaypath contains the relative path from the
- current working directory to the submodules root directory,
- $sha1 is the commit as recorded in the immediate
- superproject, and $toplevel is the absolute path to the top-level
- of the immediate superproject.
- Note that to avoid conflicts with '$PATH' on Windows, the '$path'
- variable is now a deprecated synonym of '$sm_path' variable.
- Any submodules defined in the superproject but not checked out are
- ignored by this command. Unless given `--quiet`, foreach prints the name
- of each submodule before evaluating the command.
- If `--recursive` is given, submodules are traversed recursively (i.e.
- the given shell command is evaluated in nested submodules as well).
- A non-zero return from the command in any submodule causes
- the processing to terminate. This can be overridden by adding '|| :'
- to the end of the command.
+`foreach [--recursive] `::
+ Evaluate an arbitrary shell __ in each checked out submodule.
+ The command has access to the variables `$name`, `$sm_path`, `$displaypath`,
+ `$sha1` and `$toplevel`:
++
+--
+`$name`;; the name of the relevant submodule section in `.gitmodules`
+`$sm_path`;; the path of the submodule as recorded in the immediate
+ superproject
+`$displaypath`;; the relative path from the
+ current working directory to the submodules root directory
+`$sha1`;; the commit as recorded in the immediate superproject
+`$toplevel`;; the absolute path to the top-level of the immediate superproject.
+--
++
+Note that to avoid conflicts with `$PATH` on Windows, the `$path`
+variable is now a deprecated synonym of `$sm_path` variable.
+Any submodules defined in the superproject but not checked out are
+ignored by this command. Unless given `--quiet`, foreach prints the name
+of each submodule before evaluating the command.
+If `--recursive` is given, submodules are traversed recursively (i.e.
+the given shell command is evaluated in nested submodules as well).
+A non-zero return from the command in any submodule causes
+the processing to terminate. This can be overridden by adding ++||:++
+to the end of the command.
+
As an example, the command below will show the path and currently
checked out commit for each submodule:
@@ -249,26 +253,26 @@ checked out commit for each submodule:
git submodule foreach 'echo $sm_path `git rev-parse HEAD`'
--------------
-sync [--recursive] [--] [...]::
- Synchronizes submodules' remote URL configuration setting
+`sync [--recursive] [--] [...]`::
+ Synchronize submodules' remote URL configuration setting
to the value specified in `.gitmodules`. It will only affect those
- submodules which already have a URL entry in .git/config (that is the
+ submodules which already have a URL entry in `.git/config` (that is the
case when they are initialized or freshly added). This is useful when
submodule URLs change upstream and you need to update your local
repositories accordingly.
+
`git submodule sync` synchronizes all submodules while
-`git submodule sync -- A` synchronizes submodule "A" only.
+`git submodule sync -- A` synchronizes submodule `A` only.
+
If `--recursive` is specified, this command will recurse into the
registered submodules, and sync any nested submodules within.
-absorbgitdirs::
+`absorbgitdirs`::
If a git directory of a submodule is inside the submodule,
move the git directory of the submodule into its superproject's
`$GIT_DIR/modules` path and then connect the git directory and
its working directory by setting the `core.worktree` and adding
- a .git file pointing to the git directory embedded in the
+ a `.git` file pointing to the git directory embedded in the
superprojects git directory.
+
A repository that was cloned independently and later added as a submodule or
@@ -279,72 +283,70 @@ This command is recursive by default.
OPTIONS
-------
--q::
---quiet::
+`-q`::
+`--quiet`::
Only print error messages.
---progress::
- This option is only valid for add and update commands.
- Progress status is reported on the standard error stream
- by default when it is attached to a terminal, unless -q
+`--progress`::
+ Report progress status on the standard error stream
+ by default when it is attached to a terminal, unless `-q`
is specified. This flag forces progress status even if the
- standard error stream is not directed to a terminal.
+ standard error stream is not directed to a terminal. It is
+ only valid for `add` and `update` commands.
---all::
- This option is only valid for the deinit command. Unregister all
- submodules in the working tree.
+`--all`::
+ Unregister all submodules in the working tree. This option is only
+ valid for the `deinit` command.
--b ::
---branch ::
+`-b`::
+`--branch=`::
Branch of repository to add as submodule.
The name of the branch is recorded as `submodule..branch` in
`.gitmodules` for `update --remote`. A special value of `.` is used to
indicate that the name of the branch in the submodule should be the
same name as the current branch in the current repository. If the
- option is not specified, it defaults to the remote 'HEAD'.
-
--f::
---force::
- This option is only valid for add, deinit and update commands.
- When running add, allow adding an otherwise ignored submodule path.
- This option is also used to bypass a check that the submodule's name
- is not already in use. By default, 'git submodule add' will fail if
- the proposed name (which is derived from the path) is already registered
- for another submodule in the repository. Using '--force' allows the command
- to proceed by automatically generating a unique name by appending a number
- to the conflicting name (e.g., if a submodule named 'child' exists, it will
- try 'child1', and so on).
- When running deinit the submodule working trees will be removed even
- if they contain local changes.
- When running update (only effective with the checkout procedure),
- throw away local changes in submodules when switching to a
- different commit; and always run a checkout operation in the
- submodule, even if the commit listed in the index of the
- containing repository matches the commit checked out in the
- submodule.
-
---cached::
- This option is only valid for status and summary commands. These
- commands typically use the commit found in the submodule HEAD, but
- with this option, the commit stored in the index is used instead.
-
---files::
- This option is only valid for the summary command. This command
- compares the commit in the index with that in the submodule HEAD
- when this option is used.
-
--n::
---summary-limit::
- This option is only valid for the summary command.
- Limit the summary size (number of commits shown in total).
+ option is not specified, it defaults to the remote `HEAD`.
+
+`-f`::
+`--force`::
+ Force the command to proceed, even if it would otherwise fail.
+ This option is only valid for `add`, `deinit` and `update` commands.
+`add`;; allow adding an otherwise ignored submodule path.
+This option is also used to bypass a check that the submodule's name
+is not already in use. By default, `git submodule add` will fail if
+the proposed name (which is derived from the path) is already registered
+for another submodule in the repository. Using `--force` allows the command
+to proceed by automatically generating a unique name by appending a number
+to the conflicting name (e.g., if a submodule named 'child' exists, it will
+try 'child1', and so on).
+`deinit`;; the submodule working trees will be removed even
+if they contain local changes.
+`update`;; (only effective with the checkout procedure),
+throw away local changes in submodules when switching to a
+different commit; and always run a checkout operation in the
+submodule, even if the commit listed in the index of the
+containing repository matches the commit checked out in the
+submodule.
+
+`--cached`::
+ Use the index to determine the commit instead of the `HEAD`.
+ This option is only valid for `status` and `summary` commands.
+
+`--files`::
+ Make the `summary` command compare the commit in the index with that in
+ the submodule `HEAD`.
+
+`-n`::
+`--summary-limit=`::
+ Limit the `summary` size (number of commits shown in total) to __.
Giving 0 will disable the summary; a negative number means unlimited
(the default). This limit only applies to modified submodules. The
size is always limited to 1 for added/deleted/typechanged submodules.
---remote::
- This option is only valid for the update command. Instead of using
- the superproject's recorded SHA-1 to update the submodule, use the
- status of the submodule's remote-tracking branch. The remote used
+`--remote`::
+ Instead of using the superproject's recorded SHA-1 to update the
+ submodule, use the status of the submodule's remote-tracking branch.
+ This option is only valid for the `update` command. The remote used
is branch's remote (`branch..remote`), defaulting to `origin`.
The remote branch used defaults to the remote `HEAD`, but the branch
name may be overridden by setting the `submodule..branch`
@@ -363,7 +365,7 @@ SHA-1. If you don't want to fetch, you should use `submodule update
--remote --no-fetch`.
+
Use this option to integrate changes from the upstream subproject with
-your submodule's current HEAD. Alternatively, you can run `git pull`
+your submodule's current `HEAD`. Alternatively, you can run `git pull`
from the submodule, which is equivalent except for the remote branch
name: `update --remote` uses the default upstream repository and
`submodule..branch`, while `git pull` uses the submodule's
@@ -372,105 +374,106 @@ to distribute the default upstream branch with the superproject and
`branch..merge` if you want a more native feel while working in
the submodule itself.
--N::
---no-fetch::
- This option is only valid for the update command.
+`-N`::
+`--no-fetch`::
Don't fetch new objects from the remote site.
+ This option is only valid for the `update` command.
---checkout::
- This option is only valid for the update command.
- Checkout the commit recorded in the superproject on a detached HEAD
- in the submodule. This is the default behavior, the main use of
- this option is to override `submodule.$name.update` when set to
+`--checkout`::
+ Checkout the commit recorded in the superproject on a detached `HEAD`
+ in the submodule. This option is only valid for the `update` command.
+ This is the default behavior, the main use of
+ this option is to override `submodule..update` when set to
a value other than `checkout`.
- If the key `submodule.$name.update` is either not explicitly set or
+ If the key `submodule..update` is either not explicitly set or
set to `checkout`, this option is implicit.
---merge::
- This option is only valid for the update command.
+`--merge`::
Merge the commit recorded in the superproject into the current branch
- of the submodule. If this option is given, the submodule's HEAD will
+ of the submodule. This option is only valid for the `update` command.
+ If this option is given, the submodule's `HEAD` will
not be detached. If a merge failure prevents this process, you will
have to resolve the resulting conflicts within the submodule with the
usual conflict resolution tools.
- If the key `submodule.$name.update` is set to `merge`, this option is
+ If the key `submodule..update` is set to `merge`, this option is
implicit.
---rebase::
- This option is only valid for the update command.
- Rebase the current branch onto the commit recorded in the
- superproject. If this option is given, the submodule's HEAD will not
+`--rebase`::
+ Rebase the current branch onto the commit recorded in the superproject.
+ This option is only valid for the `update` command. The submodule's `HEAD` will not
be detached. If a merge failure prevents this process, you will have
to resolve these failures with linkgit:git-rebase[1].
- If the key `submodule.$name.update` is set to `rebase`, this option is
+ If the key `submodule..update` is set to `rebase`, this option is
implicit.
---init::
- This option is only valid for the update command.
- Initialize all submodules for which "git submodule init" has not been
- called so far before updating.
+`--init`::
+ Initialize all submodules for which `git submodule init` has not been
+ called so far before updating. This option is only valid for the `update`
+ command.
+
---name::
- This option is only valid for the add command. It sets the submodule's
- name to the given string instead of defaulting to its path. The name
- must be valid as a directory name and may not end with a '/'.
+`--name=`::
+ Set the submodule's name to the given string instead of defaulting to its path. __
+ must be valid as a directory name and may not end with a `/`.
---reference ::
- This option is only valid for add and update commands. These
- commands sometimes need to clone a remote repository. In this case,
+`--reference=`::
+ Pass the local __ as a reference when cloning the submodule.
+ This option is only valid for `add` and `update` commands.
+ These commands sometimes need to clone a remote repository. In this case,
this option will be passed to the linkgit:git-clone[1] command.
+
-*NOTE*: Do *not* use this option unless you have read the note
+NOTE: Do *not* use this option unless you have read the note
for linkgit:git-clone[1]'s `--reference`, `--shared`, and `--dissociate`
options carefully.
---dissociate::
- This option is only valid for add and update commands. These
- commands sometimes need to clone a remote repository. In this case,
+`--dissociate`::
+ After using a reference repository to clone from, do not rely on it anymore.
+ This option is only valid for `add` and `update` commands.
+ These commands sometimes need to clone a remote repository. In this case,
this option will be passed to the linkgit:git-clone[1] command.
+
-*NOTE*: see the NOTE for the `--reference` option.
+NOTE: See the NOTE above for the `--reference` option.
---recursive::
- This option is only valid for foreach, update, status and sync commands.
- Traverse submodules recursively. The operation is performed not
+`--recursive`::
+ Traverse submodules recursively. This option is only valid for `foreach`,
+ `update`, `status` and `sync` commands. The operation is performed not
only in the submodules of the current repo, but also
in any nested submodules inside those submodules (and so on).
---depth::
- This option is valid for add and update commands. Create a 'shallow'
- clone with a history truncated to the specified number of revisions.
- See linkgit:git-clone[1]
+`--depth=`::
+ Create a 'shallow' clone with a history truncated to the __ revisions.
+ This option is valid for `add` and `update` commands. See linkgit:git-clone[1]
---recommend-shallow::
---no-recommend-shallow::
- This option is only valid for the update command.
+`--recommend-shallow`::
+`--no-recommend-shallow`::
+ Recommend or not shallow cloning of submodules.
+ This option is only valid for the `update` command.
The initial clone of a submodule will use the recommended
`submodule..shallow` as provided by the `.gitmodules` file
by default. To ignore the suggestions use `--no-recommend-shallow`.
--j ::
---jobs ::
- This option is only valid for the update command.
- Clone new submodules in parallel with as many jobs.
+`-j`::
+`--jobs=`::
+ Clone new submodules in parallel with __ jobs.
+ This option is only valid for the `update` command.
Defaults to the `submodule.fetchJobs` option.
---single-branch::
---no-single-branch::
- This option is only valid for the update command.
- Clone only one branch during update: HEAD or one specified by --branch.
+`--single-branch`::
+`--no-single-branch`::
+ Clone only one branch during update: `HEAD` or one specified by `--branch`.
+ This option is only valid for the `update` command.
-...::
+`...`::
Paths to submodule(s). When specified this will restrict the command
to only operate on the submodules found at the specified paths.
- (This argument is required with add).
+ (This argument is required with `add`).
FILES
-----
When initializing submodules, a `.gitmodules` file in the top-level directory
-of the containing repository is used to find the url of each submodule.
+of the containing repository is used to find the URL of each submodule.
This file should be formatted in the same way as `$GIT_DIR/config`. The key
-to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5]
+to each submodule URL is `submodule..url`. See linkgit:gitmodules[5]
for details.
SEE ALSO
diff --git a/Documentation/pretty-formats.adoc b/Documentation/pretty-formats.adoc
index 2121e8e1df0507..5405e57a6079c5 100644
--- a/Documentation/pretty-formats.adoc
+++ b/Documentation/pretty-formats.adoc
@@ -18,54 +18,72 @@ config option to either another format name, or a
linkgit:git-config[1]). Here are the details of the
built-in formats:
-* `oneline`
-
-
+`oneline`::
++
+[synopsis]
+--
+
+--
+
This is designed to be as compact as possible.
-* `short`
-
- commit
- Author:
-
-
-
-* `medium`
-
- commit
- Author:
- Date:
-
-
+`short`::
++
+[synopsis]
+--
+commit
+Author:
-
+
+--
-* `full`
+`medium`::
++
+[synopsis]
+--
+commit
+Author:
+Date:
- commit
- Author:
- Commit:
+
-
+
+--
-
+`full`::
++
+[synopsis]
+--
+commit
+Author:
+Commit:
-* `fuller`
+
- commit
- Author:
- AuthorDate:
- Commit:
- CommitDate:
+
+--
-
+`fuller`::
++
+[synopsis]
+--
+commit
+Author:
+AuthorDate:
+Commit:
+CommitDate:
-
+
-* `reference`
+
+--
- (, )
+`reference`::
++
+[synopsis]
+--
+ (, )
+--
+
This format is used to refer to another commit in a commit message and
is the same as ++--pretty=\'format:%C(auto)%h (%s, %ad)'++. By default,
@@ -74,23 +92,24 @@ is explicitly specified. As with any `format:` with format
placeholders, its output is not affected by other options like
`--decorate` and `--walk-reflogs`.
-* `email`
-
- From