git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] rebase docs: fix incorrect format of the section Behavioral Differences

From
Johannes Schindelin <johannes.schindelin@gmx.de>
Date
Dec 3, 2018, 20:56 UTC
Message-ID
<nycvar.QRO.7.76.6.1812032156000.41@tvgsbejvaqbjf.bet>
In-Reply-To
<f26b53e3-e7d1-f0fe-cdd3-dd734beb1628@kdbg.org>
Hi Hannes,
On Mon, 3 Dec 2018, Johannes Sixt wrote:
Show 12 quoted lines
> The text body of section Behavioral Differences is typeset as code,
> but should be regular text. Remove the indentation to achieve that.
> 
> While here, prettify the language:
> 
> - use "the x backend" instead of "x-based rebase";
> - use present tense instead of future tense;
> 
> and use subsections instead of a list.
> 
> Signed-off-by: Johannes Sixt <j6t@kdbg.org>
> ---
The changes look sensible to me.

Thanks, Dscho

Show 61 quoted lines
> Cf. https://git-scm.com/docs/git-rebase#_behavioral_differences
> 
> I actually did not test the result, because I don't have the
> infrastructure.
> 
> The sentence "The am backend sometimes does not" is not very useful,
> but is not my fault ;) It would be great if it could be made more
> specific, but I do not know the details.
> 
>  Documentation/git-rebase.txt | 30 +++++++++++++++++-------------
>  1 file changed, 17 insertions(+), 13 deletions(-)
> 
> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
> index 80793bad8d..dff17b3178 100644
> --- a/Documentation/git-rebase.txt
> +++ b/Documentation/git-rebase.txt
> @@ -550,24 +550,28 @@ Other incompatible flag pairs:
>  BEHAVIORAL DIFFERENCES
>  -----------------------
>  
> - * empty commits:
> +There are some subtle differences how the backends behave.
>  
> -    am-based rebase will drop any "empty" commits, whether the
> -    commit started empty (had no changes relative to its parent to
> -    start with) or ended empty (all changes were already applied
> -    upstream in other commits).
> +Empty commits
> +~~~~~~~~~~~~~
> +
> +The am backend drops any "empty" commits, regardless of whether the
> +commit started empty (had no changes relative to its parent to
> +start with) or ended empty (all changes were already applied
> +upstream in other commits).
>  
> -    merge-based rebase does the same.
> +The merge backend does the same.
>  
> -    interactive-based rebase will by default drop commits that
> -    started empty and halt if it hits a commit that ended up empty.
> -    The `--keep-empty` option exists for interactive rebases to allow
> -    it to keep commits that started empty.
> +The interactive backend drops commits by default that
> +started empty and halts if it hits a commit that ended up empty.
> +The `--keep-empty` option exists for the interactive backend to allow
> +it to keep commits that started empty.
>  
> -  * directory rename detection:
> +Directory rename detection
> +~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
> -    merge-based and interactive-based rebases work fine with
> -    directory rename detection.  am-based rebases sometimes do not.
> +The merge and interactive backends work fine with
> +directory rename detection.  The am backend sometimes does not.
>  
>  include::merge-strategies.txt[]
>  
> -- 
> 2.19.1.1133.g2dd3d172d2
> 
Previous: Junio C HamanoNext: Elijah Newren
Message 5 of 18 in “rebase docs: fix incorrect format of the section Behavioral Differences”
  1. rebase docs: fix incorrect format of the section Behavioral DifferencesJohannes Sixt, Dec 3, 2018
  2. Martin ÅgrenDec 3, 2018
  3. Johannes SixtDec 3, 2018
  4. Junio C HamanoDec 4, 2018
  5. Johannes SchindelinDec 3, 2018
  6. Elijah NewrenDec 4, 2018
  7. Johannes SixtDec 4, 2018
  8. Elijah NewrenDec 4, 2018
  9. Junio C HamanoDec 5, 2018
  10. Elijah NewrenDec 5, 2018
  11. Johannes SixtDec 5, 2018
  12. Junio C HamanoDec 5, 2018
  13. Elijah NewrenDec 5, 2018
  14. Johannes SixtDec 5, 2018
  15. Junio C HamanoDec 5, 2018
  16. git-rebase.txt: update note about directory rename detection and amJohannes Sixt, Dec 7, 2018
  17. Elijah NewrenDec 7, 2018
  18. Junio C HamanoDec 9, 2018

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.