| Message ID | 20210916124709.2824551-2-wesley@schwengle.net (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Document `rebase.forkpoint` in rebase man page | expand |
wesley@schwengle.net writes: > From: Wesley Schwengle <wesley@opperschaap.net> > > The option exists and the rebase behaviour tricked me into thinking > there was a bug with git. This will tell people how they can tweak the > default behavior. This tells readers about almost nothing but your frustration. We, or anybody who will be reading "git log" in 6 months to improve the system, will not need to hear it. Instead we need to understand what the real problem is, what was wrong in the behaviour, or what the expected behaviour was and why the use of the feature was inappropriate in the particular case, without which it is impossible to understand why this sentence was added when a future developer and documenter tries to improve upon this text. > Signed-off-by: Wesley Schwengle <wesley@opperschaap.net> > --- > Documentation/git-rebase.txt | 3 ++- > 1 file changed, 2 insertions(+), 1 deletion(-) > > diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt > index 506345cb0e..8d2bee3365 100644 > --- a/Documentation/git-rebase.txt > +++ b/Documentation/git-rebase.txt > @@ -446,7 +446,8 @@ When --fork-point is active, 'fork_point' will be used instead of > ends up being empty, the <upstream> will be used as a fallback. > + > If <upstream> is given on the command line, then the default is > -`--no-fork-point`, otherwise the default is `--fork-point`. > +`--no-fork-point`, otherwise the default is `--fork-point`. You can override > +this default by setting the configuration option `rebase.forkpoint` to false. We often do: "See also `rebase.forkpoint` in linkgit:git-config[1]." (for example, there is a reference to linkgit:githooks[5] in the same page). Thanks.
Junio C Hamano <gitster@pobox.com> writes: > wesley@schwengle.net writes: > >> From: Wesley Schwengle <wesley@opperschaap.net> >> >> The option exists and the rebase behaviour tricked me into thinking >> there was a bug with git. This will tell people how they can tweak the >> default behavior. > > This tells readers about almost nothing but your frustration. > > We, or anybody who will be reading "git log" in 6 months to improve > the system, will not need to hear it. Instead we need to understand > > what the real problem is, what was wrong in the behaviour, or what > the expected behaviour was and why the use of the feature was > inappropriate in the particular case, without which it is impossible > to understand why this sentence was added when a future developer > and documenter tries to improve upon this text. I misspke a bit here. While hearing only your frustration and nothing else won't help us much, we do need to understand what caused your frustration, to avoid frustrating the next user the same way. All of the "Instead we need to understand ..." are about that. > We often do: > > "See also `rebase.forkpoint` in linkgit:git-config[1]." > > (for example, there is a reference to linkgit:githooks[5] in the > same page). One reason why you didn't find how to tweak the forkpoint feature, other than giving a command line option to countermand it, is because this link pointing at the list of configurations, where the variable is already described, was missing in the doucmentation for the "rebase" command. Thanks.
I've updated the patch and the commit message. I hope this is sufficient to be included. Cheers, Wesley
I failed to include the correct format-patch, 3rd time is a charm :) Cheers, Wesley
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index 506345cb0e..8d2bee3365 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -446,7 +446,8 @@ When --fork-point is active, 'fork_point' will be used instead of ends up being empty, the <upstream> will be used as a fallback. + If <upstream> is given on the command line, then the default is -`--no-fork-point`, otherwise the default is `--fork-point`. +`--no-fork-point`, otherwise the default is `--fork-point`. You can override +this default by setting the configuration option `rebase.forkpoint` to false. + If your branch was based on <upstream> but <upstream> was rewound and your branch contains commits which were dropped, this option can be used