Skip to content
Snippets Groups Projects
Commit 94c65f14 authored by Jean-Noël Avila's avatar Jean-Noël Avila
Browse files

update english sources to git v2.25.0

parent 610f2f44
Branches
No related tags found
No related merge requests found
Showing with 193 additions and 59 deletions
GIT_VERSION = 2.24.0 GIT_VERSION = 2.25.0
...@@ -142,7 +142,7 @@ refer to linkgit:gitignore[5] for details. For convenience: ...@@ -142,7 +142,7 @@ refer to linkgit:gitignore[5] for details. For convenience:
`gitdir/i`:: `gitdir/i`::
This is the same as `gitdir` except that matching is done This is the same as `gitdir` except that matching is done
case-insensitively (e.g. on case-insensitive file sytems) case-insensitively (e.g. on case-insensitive file systems)
`onbranch`:: `onbranch`::
The data that follows the keyword `onbranch:` is taken to be a The data that follows the keyword `onbranch:` is taken to be a
......
...@@ -452,14 +452,14 @@ endif::git-format-patch[] ...@@ -452,14 +452,14 @@ endif::git-format-patch[]
create. This serves two purposes: create. This serves two purposes:
+ +
It affects the way a change that amounts to a total rewrite of a file It affects the way a change that amounts to a total rewrite of a file
does not appear as a series of deletion and insertion mixed together not as a series of deletion and insertion mixed together with a very
with a very few lines that happen to match textually as the context, few lines that happen to match textually as the context, but as a
but as a single deletion of everything old followed by a single single deletion of everything old followed by a single insertion of
insertion of everything new, and the number `m` controls this aspect everything new, and the number `m` controls this aspect of the -B
of the -B option (defaults to 60%). `-B/70%` specifies that less than option (defaults to 60%). `-B/70%` specifies that less than 30% of the
30% of the original should remain in the result for Git to consider it original should remain in the result for Git to consider it a total
a total rewrite (i.e. otherwise the resulting patch will be a series rewrite (i.e. otherwise the resulting patch will be a series of
of deletion and insertion mixed together with context lines). deletion and insertion mixed together with context lines).
+ +
When used with -M, a totally-rewritten file is also considered as the When used with -M, a totally-rewritten file is also considered as the
source of a rename (usually -M only considers a file that disappeared source of a rename (usually -M only considers a file that disappeared
......
...@@ -92,6 +92,10 @@ ifndef::git-pull[] ...@@ -92,6 +92,10 @@ ifndef::git-pull[]
Run `git gc --auto` at the end to perform garbage collection Run `git gc --auto` at the end to perform garbage collection
if needed. This is enabled by default. if needed. This is enabled by default.
--[no-]write-commit-graph::
Write a commit-graph after fetching. This overrides the config
setting `fetch.writeCommitGraph`.
-p:: -p::
--prune:: --prune::
Before fetching, remove any remote-tracking references that no Before fetching, remove any remote-tracking references that no
......
...@@ -11,7 +11,8 @@ SYNOPSIS ...@@ -11,7 +11,8 @@ SYNOPSIS
'git add' [--verbose | -v] [--dry-run | -n] [--force | -f] [--interactive | -i] [--patch | -p] 'git add' [--verbose | -v] [--dry-run | -n] [--force | -f] [--interactive | -i] [--patch | -p]
[--edit | -e] [--[no-]all | --[no-]ignore-removal | [--update | -u]] [--edit | -e] [--[no-]all | --[no-]ignore-removal | [--update | -u]]
[--intent-to-add | -N] [--refresh] [--ignore-errors] [--ignore-missing] [--renormalize] [--intent-to-add | -N] [--refresh] [--ignore-errors] [--ignore-missing] [--renormalize]
[--chmod=(+|-)x] [--] [<pathspec>...] [--chmod=(+|-)x] [--pathspec-from-file=<file> [--pathspec-file-nul]]
[--] [<pathspec>...]
DESCRIPTION DESCRIPTION
----------- -----------
...@@ -187,6 +188,19 @@ for "git add --no-all <pathspec>...", i.e. ignored removed files. ...@@ -187,6 +188,19 @@ for "git add --no-all <pathspec>...", i.e. ignored removed files.
bit is only changed in the index, the files on disk are left bit is only changed in the index, the files on disk are left
unchanged. unchanged.
--pathspec-from-file=<file>::
Pathspec is passed in `<file>` instead of commandline args. If
`<file>` is exactly `-` then standard input is used. Pathspec
elements are separated by LF or CR/LF. Pathspec elements can be
quoted as explained for the configuration variable `core.quotePath`
(see linkgit:git-config[1]). See also `--pathspec-file-nul` and
global `--literal-pathspecs`.
--pathspec-file-nul::
Only meaningful with `--pathspec-from-file`. Pathspec elements are
separated with NUL character and all other characters are taken
literally (including newlines and quotes).
\--:: \--::
This option can be used to separate command-line options from This option can be used to separate command-line options from
the list of files, (useful when filenames might be mistaken the list of files, (useful when filenames might be mistaken
......
...@@ -177,7 +177,7 @@ default. You can use `--no-utf8` to override this. ...@@ -177,7 +177,7 @@ default. You can use `--no-utf8` to override this.
untouched. untouched.
--show-current-patch:: --show-current-patch::
Show the patch being applied when "git am" is stopped because Show the entire e-mail message "git am" has stopped at, because
of conflicts. of conflicts.
DISCUSSION DISCUSSION
...@@ -190,8 +190,8 @@ the commit, after stripping common prefix "[PATCH <anything>]". ...@@ -190,8 +190,8 @@ the commit, after stripping common prefix "[PATCH <anything>]".
The "Subject: " line is supposed to concisely describe what the The "Subject: " line is supposed to concisely describe what the
commit is about in one line of text. commit is about in one line of text.
"From: " and "Subject: " lines starting the body override the respective "From: ", "Date: ", and "Subject: " lines starting the body override the
commit author name and title values taken from the headers. respective commit author name and title values taken from the headers.
The commit message is formed by the title taken from the The commit message is formed by the title taken from the
"Subject: ", a blank line and the body of the message up to "Subject: ", a blank line and the body of the message up to
......
...@@ -413,7 +413,7 @@ $ cat ~/test.sh ...@@ -413,7 +413,7 @@ $ cat ~/test.sh
# tweak the working tree by merging the hot-fix branch # tweak the working tree by merging the hot-fix branch
# and then attempt a build # and then attempt a build
if git merge --no-commit hot-fix && if git merge --no-commit --no-ff hot-fix &&
make make
then then
# run project specific test and report its status # run project specific test and report its status
......
...@@ -9,8 +9,8 @@ git-bundle - Move objects and refs by archive ...@@ -9,8 +9,8 @@ git-bundle - Move objects and refs by archive
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git bundle' create <file> <git-rev-list-args> 'git bundle' create [-q | --quiet | --progress | --all-progress] [--all-progress-implied] <file> <git-rev-list-args>
'git bundle' verify <file> 'git bundle' verify [-q | --quiet] <file>
'git bundle' list-heads <file> [<refname>...] 'git bundle' list-heads <file> [<refname>...]
'git bundle' unbundle <file> [<refname>...] 'git bundle' unbundle <file> [<refname>...]
...@@ -20,11 +20,14 @@ DESCRIPTION ...@@ -20,11 +20,14 @@ DESCRIPTION
Some workflows require that one or more branches of development on one Some workflows require that one or more branches of development on one
machine be replicated on another machine, but the two machines cannot machine be replicated on another machine, but the two machines cannot
be directly connected, and therefore the interactive Git protocols (git, be directly connected, and therefore the interactive Git protocols (git,
ssh, http) cannot be used. This command provides support for ssh, http) cannot be used.
'git fetch' and 'git pull' to operate by packaging objects and references
in an archive at the originating machine, then importing those into The 'git bundle' command packages objects and references in an archive
another repository using 'git fetch' and 'git pull' at the originating machine, which can then be imported into another
after moving the archive by some means (e.g., by sneakernet). As no repository using 'git fetch', 'git pull', or 'git clone',
after moving the archive by some means (e.g., by sneakernet).
As no
direct connection between the repositories exists, the user must specify a direct connection between the repositories exists, the user must specify a
basis for the bundle that is held by the destination repository: the basis for the bundle that is held by the destination repository: the
bundle assumes that all objects in the basis are already in the bundle assumes that all objects in the basis are already in the
...@@ -33,9 +36,11 @@ destination repository. ...@@ -33,9 +36,11 @@ destination repository.
OPTIONS OPTIONS
------- -------
create <file>:: create [options] <file> <git-rev-list-args>::
Used to create a bundle named 'file'. This requires the Used to create a bundle named 'file'. This requires the
'git-rev-list-args' arguments to define the bundle contents. '<git-rev-list-args>' arguments to define the bundle contents.
'options' contains the options specific to the 'git bundle create'
subcommand.
verify <file>:: verify <file>::
Used to check that a bundle file is valid and will apply Used to check that a bundle file is valid and will apply
...@@ -75,6 +80,33 @@ unbundle <file>:: ...@@ -75,6 +80,33 @@ unbundle <file>::
necessarily everything in the pack (in this case, 'git bundle' acts necessarily everything in the pack (in this case, 'git bundle' acts
like 'git fetch-pack'). like 'git fetch-pack').
--progress::
Progress status is reported 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.
--all-progress::
When --stdout is specified then progress report is
displayed during the object count and compression phases
but inhibited during the write-out phase. The reason is
that in some cases the output stream is directly linked
to another command which may wish to display progress
status of its own as it processes incoming pack data.
This flag is like --progress except that it forces progress
report for the write-out phase as well even if --stdout is
used.
--all-progress-implied::
This is used to imply --all-progress whenever progress display
is activated. Unlike --all-progress this flag doesn't actually
force any progress display by itself.
-q::
--quiet::
This flag makes the command not to report its progress
on the standard error stream.
SPECIFYING REFERENCES SPECIFYING REFERENCES
--------------------- ---------------------
...@@ -92,6 +124,14 @@ It is okay to err on the side of caution, causing the bundle file ...@@ -92,6 +124,14 @@ It is okay to err on the side of caution, causing the bundle file
to contain objects already in the destination, as these are ignored to contain objects already in the destination, as these are ignored
when unpacking at the destination. when unpacking at the destination.
`git clone` can use any bundle created without negative refspecs
(e.g., `new`, but not `old..new`).
If you want to match `git clone --mirror`, which would include your
refs such as `refs/remotes/*`, use `--all`.
If you want to provide the same set of refs that a clone directly
from the source repository would get, use `--branches --tags` for
the `<git-rev-list-args>`.
EXAMPLES EXAMPLES
-------- --------
......
...@@ -32,7 +32,7 @@ OPTIONS ...@@ -32,7 +32,7 @@ OPTIONS
instead of from the command-line. instead of from the command-line.
-z:: -z::
The output format is modified to be machine-parseable. The output format is modified to be machine-parsable.
If `--stdin` is also given, input paths are separated If `--stdin` is also given, input paths are separated
with a NUL character instead of a linefeed character. with a NUL character instead of a linefeed character.
......
...@@ -39,7 +39,7 @@ OPTIONS ...@@ -39,7 +39,7 @@ OPTIONS
instead of from the command-line. instead of from the command-line.
-z:: -z::
The output format is modified to be machine-parseable (see The output format is modified to be machine-parsable (see
below). If `--stdin` is also given, input paths are separated below). If `--stdin` is also given, input paths are separated
with a NUL character instead of a linefeed character. with a NUL character instead of a linefeed character.
......
...@@ -12,14 +12,14 @@ SYNOPSIS ...@@ -12,14 +12,14 @@ SYNOPSIS
'git checkout' [-q] [-f] [-m] --detach [<branch>] 'git checkout' [-q] [-f] [-m] --detach [<branch>]
'git checkout' [-q] [-f] [-m] [--detach] <commit> 'git checkout' [-q] [-f] [-m] [--detach] <commit>
'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] <new_branch>] [<start_point>] 'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] <new_branch>] [<start_point>]
'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <paths>... 'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>...
'git checkout' [<tree-ish>] [--] <pathspec>... 'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] --pathspec-from-file=<file> [--pathspec-file-nul]
'git checkout' (-p|--patch) [<tree-ish>] [--] [<paths>...] 'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...]
DESCRIPTION DESCRIPTION
----------- -----------
Updates files in the working tree to match the version in the index Updates files in the working tree to match the version in the index
or the specified tree. If no paths are given, 'git checkout' will or the specified tree. If no pathspec was given, 'git checkout' will
also update `HEAD` to set the specified branch as the current also update `HEAD` to set the specified branch as the current
branch. branch.
...@@ -79,13 +79,14 @@ be used to detach `HEAD` at the tip of the branch (`git checkout ...@@ -79,13 +79,14 @@ be used to detach `HEAD` at the tip of the branch (`git checkout
+ +
Omitting `<branch>` detaches `HEAD` at the tip of the current branch. Omitting `<branch>` detaches `HEAD` at the tip of the current branch.
'git checkout' [<tree-ish>] [--] <pathspec>...:: 'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>...::
'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] --pathspec-from-file=<file> [--pathspec-file-nul]::
Overwrite paths in the working tree by replacing with the Overwrite the contents of the files that match the pathspec.
contents in the index or in the `<tree-ish>` (most often a When the `<tree-ish>` (most often a commit) is not given,
commit). When a `<tree-ish>` is given, the paths that overwrite working tree with the contents in the index.
match the `<pathspec>` are updated both in the index and in When the `<tree-ish>` is given, overwrite both the index and
the working tree. the working tree with the contents at the `<tree-ish>`.
+ +
The index may contain unmerged entries because of a previous failed merge. The index may contain unmerged entries because of a previous failed merge.
By default, if you try to check out such an entry from the index, the By default, if you try to check out such an entry from the index, the
...@@ -96,12 +97,10 @@ using `--ours` or `--theirs`. With `-m`, changes made to the working tree ...@@ -96,12 +97,10 @@ using `--ours` or `--theirs`. With `-m`, changes made to the working tree
file can be discarded to re-create the original conflicted merge result. file can be discarded to re-create the original conflicted merge result.
'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...]:: 'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...]::
This is similar to the "check out paths to the working tree This is similar to the previous mode, but lets you use the
from either the index or from a tree-ish" mode described interactive interface to show the "diff" output and choose which
above, but lets you use the interactive interface to show hunks to use in the result. See below for the description of
the "diff" output and choose which hunks to use in the `--patch` option.
result. See below for the description of `--patch` option.
OPTIONS OPTIONS
------- -------
...@@ -309,6 +308,19 @@ Note that this option uses the no overlay mode by default (see also ...@@ -309,6 +308,19 @@ Note that this option uses the no overlay mode by default (see also
working tree, but not in `<tree-ish>` are removed, to make them working tree, but not in `<tree-ish>` are removed, to make them
match `<tree-ish>` exactly. match `<tree-ish>` exactly.
--pathspec-from-file=<file>::
Pathspec is passed in `<file>` instead of commandline args. If
`<file>` is exactly `-` then standard input is used. Pathspec
elements are separated by LF or CR/LF. Pathspec elements can be
quoted as explained for the configuration variable `core.quotePath`
(see linkgit:git-config[1]). See also `--pathspec-file-nul` and
global `--literal-pathspecs`.
--pathspec-file-nul::
Only meaningful with `--pathspec-from-file`. Pathspec elements are
separated with NUL character and all other characters are taken
literally (including newlines and quotes).
<branch>:: <branch>::
Branch to checkout; if it refers to a branch (i.e., a name that, Branch to checkout; if it refers to a branch (i.e., a name that,
when prepended with "refs/heads/", is a valid ref), then that when prepended with "refs/heads/", is a valid ref), then that
...@@ -339,7 +351,13 @@ leave out at most one of `A` and `B`, in which case it defaults to `HEAD`. ...@@ -339,7 +351,13 @@ leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
Tree to checkout from (when paths are given). If not specified, Tree to checkout from (when paths are given). If not specified,
the index will be used. the index will be used.
\--::
Do not interpret any more arguments as options.
<pathspec>...::
Limits the paths affected by the operation.
+
For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
DETACHED HEAD DETACHED HEAD
------------- -------------
......
...@@ -15,7 +15,7 @@ SYNOPSIS ...@@ -15,7 +15,7 @@ SYNOPSIS
[--dissociate] [--separate-git-dir <git dir>] [--dissociate] [--separate-git-dir <git dir>]
[--depth <depth>] [--[no-]single-branch] [--no-tags] [--depth <depth>] [--[no-]single-branch] [--no-tags]
[--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules] [--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]
[--[no-]remote-submodules] [--jobs <n>] [--] <repository> [--[no-]remote-submodules] [--jobs <n>] [--sparse] [--] <repository>
[<directory>] [<directory>]
DESCRIPTION DESCRIPTION
...@@ -156,6 +156,12 @@ objects from the source repository into a pack in the cloned repository. ...@@ -156,6 +156,12 @@ objects from the source repository into a pack in the cloned repository.
used, neither remote-tracking branches nor the related used, neither remote-tracking branches nor the related
configuration variables are created. configuration variables are created.
--sparse::
Initialize the sparse-checkout file so the working
directory starts with only the files in the root
of the repository. The sparse-checkout file can be
modified to grow the working directory as needed.
--mirror:: --mirror::
Set up a mirror of the source repository. This implies `--bare`. Set up a mirror of the source repository. This implies `--bare`.
Compared to `--bare`, `--mirror` not only maps local branches of the Compared to `--bare`, `--mirror` not only maps local branches of the
......
...@@ -13,7 +13,8 @@ SYNOPSIS ...@@ -13,7 +13,8 @@ SYNOPSIS
[-F <file> | -m <msg>] [--reset-author] [--allow-empty] [-F <file> | -m <msg>] [--reset-author] [--allow-empty]
[--allow-empty-message] [--no-verify] [-e] [--author=<author>] [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
[--date=<date>] [--cleanup=<mode>] [--[no-]status] [--date=<date>] [--cleanup=<mode>] [--[no-]status]
[-i | -o] [-S[<keyid>]] [--] [<file>...] [-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]
[-S[<keyid>]] [--] [<pathspec>...]
DESCRIPTION DESCRIPTION
----------- -----------
...@@ -278,6 +279,19 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].) ...@@ -278,6 +279,19 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
already been staged. If used together with `--allow-empty` already been staged. If used together with `--allow-empty`
paths are also not required, and an empty commit will be created. paths are also not required, and an empty commit will be created.
--pathspec-from-file=<file>::
Pathspec is passed in `<file>` instead of commandline args. If
`<file>` is exactly `-` then standard input is used. Pathspec
elements are separated by LF or CR/LF. Pathspec elements can be
quoted as explained for the configuration variable `core.quotePath`
(see linkgit:git-config[1]). See also `--pathspec-file-nul` and
global `--literal-pathspecs`.
--pathspec-file-nul::
Only meaningful with `--pathspec-from-file`. Pathspec elements are
separated with NUL character and all other characters are taken
literally (including newlines and quotes).
-u[<mode>]:: -u[<mode>]::
--untracked-files[=<mode>]:: --untracked-files[=<mode>]::
Show untracked files. Show untracked files.
...@@ -345,12 +359,13 @@ changes to tracked files. ...@@ -345,12 +359,13 @@ changes to tracked files.
\--:: \--::
Do not interpret any more arguments as options. Do not interpret any more arguments as options.
<file>...:: <pathspec>...::
When files are given on the command line, the command When pathspec is given on the command line, commit the contents of
commits the contents of the named files, without the files that match the pathspec without recording the changes
recording the changes already staged. The contents of already added to the index. The contents of these files are also
these files are also staged for the next commit on top staged for the next commit on top of what have been staged before.
of what have been staged before. +
For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
:git-commit: 1 :git-commit: 1
include::date-formats.txt[] include::date-formats.txt[]
......
...@@ -19,8 +19,7 @@ from system-specific helpers, as well as prompting the user for ...@@ -19,8 +19,7 @@ from system-specific helpers, as well as prompting the user for
usernames and passwords. The git-credential command exposes this usernames and passwords. The git-credential command exposes this
interface to scripts which may want to retrieve, store, or prompt for interface to scripts which may want to retrieve, store, or prompt for
credentials in the same manner as Git. The design of this scriptable credentials in the same manner as Git. The design of this scriptable
interface models the internal C API; see interface models the internal C API; see credential.h for more
link:technical/api-credentials.html[the Git credential API] for more
background on the concepts. background on the concepts.
git-credential takes an "action" option on the command-line (one of git-credential takes an "action" option on the command-line (one of
......
...@@ -294,7 +294,7 @@ In `dbDriver` and `dbUser` you can use the following variables: ...@@ -294,7 +294,7 @@ In `dbDriver` and `dbUser` you can use the following variables:
Git directory name Git directory name
%g:: %g::
Git directory name, where all characters except for Git directory name, where all characters except for
alpha-numeric ones, `.`, and `-` are replaced with alphanumeric ones, `.`, and `-` are replaced with
`_` (this should make it easier to use the directory `_` (this should make it easier to use the directory
name in a filename if wanted) name in a filename if wanted)
%m:: %m::
......
...@@ -36,7 +36,7 @@ two blob objects, or changes between two files on disk. ...@@ -36,7 +36,7 @@ two blob objects, or changes between two files on disk.
running the command in a working tree controlled by Git and running the command in a working tree controlled by Git and
at least one of the paths points outside the working tree, at least one of the paths points outside the working tree,
or when running the command outside a working tree or when running the command outside a working tree
controlled by Git. controlled by Git. This form implies `--exit-code`.
'git diff' [<options>] --cached [<commit>] [--] [<path>...]:: 'git diff' [<options>] --cached [<commit>] [--] [<path>...]::
......
...@@ -142,7 +142,7 @@ by keeping the marks the same across runs. ...@@ -142,7 +142,7 @@ by keeping the marks the same across runs.
Specify how to handle `encoding` header in commit objects. When Specify how to handle `encoding` header in commit objects. When
asking to 'abort' (which is the default), this program will die asking to 'abort' (which is the default), this program will die
when encountering such a commit object. With 'yes', the commit when encountering such a commit object. With 'yes', the commit
message will be reencoded into UTF-8. With 'no', the original message will be re-encoded into UTF-8. With 'no', the original
encoding will be preserved. encoding will be preserved.
--refspec:: --refspec::
......
...@@ -51,6 +51,21 @@ OPTIONS ...@@ -51,6 +51,21 @@ OPTIONS
memory used by fast-import during this run. Showing this output memory used by fast-import during this run. Showing this output
is currently the default, but can be disabled with --quiet. is currently the default, but can be disabled with --quiet.
--allow-unsafe-features::
Many command-line options can be provided as part of the
fast-import stream itself by using the `feature` or `option`
commands. However, some of these options are unsafe (e.g.,
allowing fast-import to access the filesystem outside of the
repository). These options are disabled by default, but can be
allowed by providing this option on the command line. This
currently impacts only the `export-marks`, `import-marks`, and
`import-marks-if-exists` feature commands.
+
Only enable this option if you trust the program generating the
fast-import stream! This option is enabled automatically for
remote-helpers that use the `import` capability, as they are
already trusted to run their own code.
Options for Frontends Options for Frontends
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
......
...@@ -536,7 +536,7 @@ repo-filter' also provides ...@@ -536,7 +536,7 @@ repo-filter' also provides
https://github.com/newren/git-filter-repo/blob/master/contrib/filter-repo-demos/filter-lamely[filter-lamely], https://github.com/newren/git-filter-repo/blob/master/contrib/filter-repo-demos/filter-lamely[filter-lamely],
a drop-in git-filter-branch replacement (with a few caveats). While a drop-in git-filter-branch replacement (with a few caveats). While
filter-lamely suffers from all the same safety issues as filter-lamely suffers from all the same safety issues as
git-filter-branch, it at least ameloriates the performance issues a git-filter-branch, it at least ameliorates the performance issues a
little. little.
[[SAFETY]] [[SAFETY]]
...@@ -657,7 +657,7 @@ with: ...@@ -657,7 +657,7 @@ with:
commits from before the filtering operation are also pruned instead commits from before the filtering operation are also pruned instead
of just pruning commits that became empty due to filtering rules. of just pruning commits that became empty due to filtering rules.
* If --prune empty is specified, sometimes empty commits are missed * If --prune-empty is specified, sometimes empty commits are missed
and left around anyway (a somewhat rare bug, but it happens...) and left around anyway (a somewhat rare bug, but it happens...)
* A minor issue, but users who have a goal to update all names and * A minor issue, but users who have a goal to update all names and
......
...@@ -19,6 +19,7 @@ SYNOPSIS ...@@ -19,6 +19,7 @@ SYNOPSIS
[--start-number <n>] [--numbered-files] [--start-number <n>] [--numbered-files]
[--in-reply-to=<message id>] [--suffix=.<sfx>] [--in-reply-to=<message id>] [--suffix=.<sfx>]
[--ignore-if-in-upstream] [--ignore-if-in-upstream]
[--cover-from-description=<mode>]
[--rfc] [--subject-prefix=<subject prefix>] [--rfc] [--subject-prefix=<subject prefix>]
[(--reroll-count|-v) <n>] [(--reroll-count|-v) <n>]
[--to=<email>] [--cc=<email>] [--to=<email>] [--cc=<email>]
...@@ -172,6 +173,26 @@ will want to ensure that threading is disabled for `git send-email`. ...@@ -172,6 +173,26 @@ will want to ensure that threading is disabled for `git send-email`.
patches being generated, and any patch that matches is patches being generated, and any patch that matches is
ignored. ignored.
--cover-from-description=<mode>::
Controls which parts of the cover letter will be automatically
populated using the branch's description.
+
If `<mode>` is `message` or `default`, the cover letter subject will be
populated with placeholder text. The body of the cover letter will be
populated with the branch's description. This is the default mode when
no configuration nor command line option is specified.
+
If `<mode>` is `subject`, the first paragraph of the branch description will
populate the cover letter subject. The remainder of the description will
populate the body of the cover letter.
+
If `<mode>` is `auto`, if the first paragraph of the branch description
is greater than 100 bytes, then the mode will be `message`, otherwise
`subject` will be used.
+
If `<mode>` is `none`, both the cover letter subject and body will be
populated with placeholder text.
--subject-prefix=<subject prefix>:: --subject-prefix=<subject prefix>::
Instead of the standard '[PATCH]' prefix in the subject Instead of the standard '[PATCH]' prefix in the subject
line, instead use '[<subject prefix>]'. This line, instead use '[<subject prefix>]'. This
...@@ -312,11 +333,12 @@ you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`. ...@@ -312,11 +333,12 @@ you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`.
Output an all-zero hash in each patch's From header instead Output an all-zero hash in each patch's From header instead
of the hash of the commit. of the hash of the commit.
--base=<commit>:: --[no-]base[=<commit>]::
Record the base tree information to identify the state the Record the base tree information to identify the state the
patch series applies to. See the BASE TREE INFORMATION section patch series applies to. See the BASE TREE INFORMATION section
below for details. If <commit> is "auto", a base commit is below for details. If <commit> is "auto", a base commit is
automatically chosen. automatically chosen. The `--no-base` option overrides a
`format.useAutoBase` configuration.
--root:: --root::
Treat the revision argument as a <revision range>, even if it Treat the revision argument as a <revision range>, even if it
...@@ -348,6 +370,7 @@ with configuration variables. ...@@ -348,6 +370,7 @@ with configuration variables.
signOff = true signOff = true
outputDirectory = <directory> outputDirectory = <directory>
coverLetter = auto coverLetter = auto
coverFromDescription = auto
------------ ------------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment