[PATCH] Documentation/git-merge-tree.txt: document -X

Victoria Dye via GitGitGadget· May 7, 2024, 21:36 UTC · lore

From: Victoria Dye <vdye@github.com>

Add an entry in the 'merge-tree' builtin documentation for -X/--strategy-option (added in 6a4c9e7b32 (merge-tree: add -X strategy option, 2023-09-24)). The same option is documented for 'merge', 'rebase', 'revert', etc. in their respective Documentation/ files, so let's do the same for 'merge-tree'.

Signed-off-by: Victoria Dye <vdye@github.com>
---
    Documentation/git-merge-tree.txt: document -X

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1728%2Fvdye%2Fvdye%2Fmerge-tree-strategy-option-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1728/vdye/vdye/merge-tree-strategy-option-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1728

 Documentation/git-merge-tree.txt | 5 +++++
 1 file changed, 5 insertions(+)

Show changes to Documentation/git-merge-tree.txt +5 −0

diff --git a/Documentation/git-merge-tree.txt b/Documentation/git-merge-tree.txt
index dd388fa21d5..84cb2edf6d0 100644
--- a/Documentation/git-merge-tree.txt
+++ b/Documentation/git-merge-tree.txt
@@ -72,6 +72,11 @@ OPTIONS
 As the merge-base is provided directly, <branch1> and <branch2> do not need
 to specify commits; trees are enough.
 
+-X<option>::
+--strategy-option=<option>::
+	Pass the merge strategy-specific option through to the merge strategy.
+	See linkgit:git-merge[1] for details.
+
 [[OUTPUT]]
 OUTPUT
 ------

base-commit: d4cc1ec35f3bcce816b69986ca41943f6ce21377

-- 
gitgitgadget

Junio C Hamano· May 7, 2024, 22:35 UTC · re: Victoria Dye via GitGitGadget · lore

Re: [PATCH] Documentation/git-merge-tree.txt: document -X

"Victoria Dye via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 18 quoted lines

> From: Victoria Dye <vdye@github.com>
>
> Add an entry in the 'merge-tree' builtin documentation for
> -X/--strategy-option (added in 6a4c9e7b32 (merge-tree: add -X strategy
> option, 2023-09-24)). The same option is documented for 'merge', 'rebase',
> 'revert', etc. in their respective Documentation/ files, so let's do the
> same for 'merge-tree'.
>
> Signed-off-by: Victoria Dye <vdye@github.com>
> ---
>     Documentation/git-merge-tree.txt: document -X
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1728%2Fvdye%2Fvdye%2Fmerge-tree-strategy-option-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1728/vdye/vdye/merge-tree-strategy-option-v1
> Pull-Request: https://github.com/gitgitgadget/git/pull/1728
>
>  Documentation/git-merge-tree.txt | 5 +++++
>  1 file changed, 5 insertions(+)

Makes sense.

I briefly wondered if it is a good occasion to consolidate the four copies of the document pieces into one before you add the fifth one, but the one for "git rebase -X" is significantly different from others, so perhaps we need to live with these duplications for now. The ones in git-cherry-pick.txt, git-revert.txt, merge-options.txt and this new one can be consolidated into a single include::, but then it becomes dubious if we want a new file only to hold just five lines, so ...

Will queue.  Thanks.

Show 18 quoted lines

> diff --git a/Documentation/git-merge-tree.txt b/Documentation/git-merge-tree.txt
> index dd388fa21d5..84cb2edf6d0 100644
> --- a/Documentation/git-merge-tree.txt
> +++ b/Documentation/git-merge-tree.txt
> @@ -72,6 +72,11 @@ OPTIONS
>  As the merge-base is provided directly, <branch1> and <branch2> do not need
>  to specify commits; trees are enough.
>  
> +-X<option>::
> +--strategy-option=<option>::
> +	Pass the merge strategy-specific option through to the merge strategy.
> +	See linkgit:git-merge[1] for details.
> +
>  [[OUTPUT]]
>  OUTPUT
>  ------
>
> base-commit: d4cc1ec35f3bcce816b69986ca41943f6ce21377

patchDocumentation/git-merge-tree.txt: document -X