[PATCH] Documentation/merge-options.txt: group "ff" related options together
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Feb 22, 2012, 22:27 UTC
- Message-ID
- <7vmx8a8pxg.fsf_-_@alter.siamese.dyndns.org>
- In-Reply-To
- <7vr4xm8qin.fsf@alter.siamese.dyndns.org>
The --ff-only option was not described next to --ff and --no-ff options in "git merge" documentation, even though these three are logically together, describing one option that takes one of three values.
Also the description for '--ff' and '--no-ff' discussed what '--ff' means, and mentioned '--no-ff' as if it were a side-note to '--ff'.
Make them into three top-level entries and list them together. This way, it would be more clear that the user can choose one from these three.
Signed-off-by: Junio C Hamano <gitster@pobox.com> ---
* Perhaps a patch like this would be an improvement to make it easier to find the options.
Documentation/merge-options.txt | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt index f2f1d0f..0bcbe0a 100644 --- a/Documentation/merge-options.txt +++ b/Documentation/merge-options.txt @@ -24,13 +24,18 @@ updated behaviour, the environment variable `GIT_MERGE_AUTOEDIT` can be set to `no` at the beginning of them. --ff:: + When the merge resolves as a fast-forward, only update the branch + pointer, without creating a merge commit. This is the default + behavior. + --no-ff:: - Do not generate a merge commit if the merge resolved as - a fast-forward, only update the branch pointer. This is - the default behavior of git-merge. -+ -With --no-ff Generate a merge commit even if the merge -resolved as a fast-forward. + Create a merge commit even when the merge resolves as a + fast-forward. + +--ff-only:: + Refuse to merge and exit with a non-zero status unless the + current `HEAD` is already up-to-date or the merge can be + resolved as a fast-forward. --log[=<n>]:: --no-log:: @@ -65,11 +70,6 @@ merge. With --no-squash perform the merge and commit the result. This option can be used to override --squash. ---ff-only:: - Refuse to merge and exit with a non-zero status unless the - current `HEAD` is already up-to-date or the merge can be - resolved as a fast-forward. - -s <strategy>:: --strategy=<strategy>:: Use the given merge strategy; can be supplied more than