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

Re: [PATCH 2/3] doc: merge-tree: use lower-case variables

From
PWPhillip Wood <phillip.wood123@gmail.com>
Date
Oct 7, 2024, 14:58 UTC
Message-ID
<d18f6fdf-d0ba-40e1-a2b9-2fecfbdadde4@gmail.com>
In-Reply-To
<97f16cb68e059792ddc7d1897ab6e93d536fe19c.1728298931.git.code@khaugsbakk.name>
Hi Kristoffer
On 07/10/2024 12:10, Kristoffer Haugsbakk wrote:
Show 5 quoted lines
> From: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
> 
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
> 
> This is easier to read.

I think that is a matter of taste, one could argue that using uppercase variable names makes them stand out so the user can see which arguments are parameters more clearly.

Best Wishes
Phillip
Show 26 quoted lines
> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
> ---
>   Documentation/git-merge-tree.txt | 8 ++++----
>   1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/git-merge-tree.txt b/Documentation/git-merge-tree.txt
> index 590cbf5df79..10f8ac7f80a 100644
> --- a/Documentation/git-merge-tree.txt
> +++ b/Documentation/git-merge-tree.txt
> @@ -211,12 +211,12 @@ linkgit:git-commit-tree[1], linkgit:git-write-tree[1],
>   linkgit:git-update-ref[1], and linkgit:git-mktag[1].  Thus, it can be
>   used as a part of a series of steps such as:
>   
> -       NEWTREE=$(git merge-tree --write-tree $BRANCH1 $BRANCH2)
> +       newtree=$(git merge-tree --write-tree $branch1 $branch2)
>          test $? -eq 0 || die "There were conflicts..."
> -       NEWCOMMIT=$(git commit-tree $NEWTREE -mMerge -p $BRANCH1 -p $BRANCH2)
> -       git update-ref $BRANCH1 $NEWCOMMIT
> +       newcommit=$(git commit-tree $newtree -mMerge -p $branch1 -p $branch2)
> +       git update-ref $branch1 $newcommit
>   
> -Note that when the exit status is non-zero, `NEWTREE` in this sequence
> +Note that when the exit status is non-zero, `newtree` in this sequence
>   will contain a lot more output than just a tree.
>   
>   For conflicts, the output includes the same information that you'd get
Previous: Kristoffer HaugsbakkNext: Elijah Newren
Message 7 of 27 in “doc: merge-tree: improve the script example”
  1. 0/3 doc: merge-tree: improve the script exampleKristoffer Haugsbakk, Oct 7, 2024
  2. 1/3 doc: merge-tree: provide a commit messageKristoffer Haugsbakk, Oct 7, 2024
  3. Kristoffer HaugsbakkOct 7, 2024
  4. Elijah NewrenOct 7, 2024
  5. Kristoffer HaugsbakkOct 7, 2024
  6. 2/3 doc: merge-tree: use lower-case variablesKristoffer Haugsbakk, Oct 7, 2024
  7. Phillip WoodOct 7, 2024
  8. Elijah NewrenOct 7, 2024
  9. 3/3 doc: merge-tree: use || directlyKristoffer Haugsbakk, Oct 7, 2024
  10. Elijah NewrenOct 7, 2024
  11. Kristoffer HaugsbakkOct 7, 2024
  12. Phillip WoodOct 7, 2024
  13. Kristoffer HaugsbakkOct 7, 2024
  14. 0/2 doc: merge-tree: improve the script exampleKristoffer Haugsbakk, Oct 8, 2024
  15. 1/2 doc: merge-tree: provide a commit messageKristoffer Haugsbakk, Oct 8, 2024
  16. Junio C HamanoOct 8, 2024
  17. Kristoffer HaugsbakkOct 8, 2024
  18. Kristoffer HaugsbakkOct 9, 2024
  19. Junio C HamanoOct 9, 2024
  20. Andreas SchwabOct 9, 2024
  21. 2/2 doc: merge-tree: use || directlyKristoffer Haugsbakk, Oct 8, 2024
  22. Junio C HamanoOct 8, 2024
  23. Kristoffer HaugsbakkOct 8, 2024
  24. 0/1 doc: merge-tree: improve the script exampleKristoffer Haugsbakk, Oct 9, 2024
  25. 1/1 doc: merge-tree: improve example scriptKristoffer Haugsbakk, Oct 9, 2024
  26. Elijah NewrenOct 9, 2024
  27. Junio C HamanoOct 10, 2024

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.