threads / patch / 63709

patchdoc: improve formatting in branch section

Subject: [PATCH] doc: improve formatting in branch section

## tl;dr

2 messages between Jun 29, 2025 and Jun 30, 2025. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

Jakub Ječmínek· Jun 29, 2025, 19:04 UTC · lore

The 'branch' section of the git-config documentation was missing inline code formatting and emphasis for the <name> placeholder.

Both changes improve readability, especially when viewed online.
Signed-off-by: Jakub Ječmínek <kuba@kubajecminek.cz>
---
 Documentation/config/branch.adoc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Show changes to Documentation/config/branch.adoc +2 −2
diff --git a/Documentation/config/branch.adoc b/Documentation/config/branch.adoc
index e35ea7ac64..a4db9fa5c8 100644
--- a/Documentation/config/branch.adoc
+++ b/Documentation/config/branch.adoc
@@ -69,9 +69,9 @@ This option defaults to `never`.
 	`git fetch`) to lookup the default branch for merging. Without
 	this option, `git pull` defaults to merge the first refspec fetched.
 	Specify multiple values to get an octopus merge.
-	If you wish to setup `git pull` so that it merges into <name> from
+	If you wish to setup `git pull` so that it merges into _<name>_ from
 	another branch in the local repository, you can point
-	branch.<name>.merge to the desired branch, and use the relative path
+	`branch.<name>.merge` to the desired branch, and use the relative path
 	setting `.` (a period) for `branch.<name>.remote`.
 
 `branch.<name>.mergeOptions`::
-- 
2.49.0
Junio C Hamano· Jun 30, 2025, 18:17 UTC · re: Jakub Ječmínek · lore

Re: [PATCH] doc: improve formatting in branch section

Jakub Ječmínek <kuba@kubajecminek.cz> writes:
Show 26 quoted lines
> The 'branch' section of the git-config documentation was missing
> inline code formatting and emphasis for the <name> placeholder.
>
> Both changes improve readability, especially when viewed online.
>
> Signed-off-by: Jakub Ječmínek <kuba@kubajecminek.cz>
> ---
>  Documentation/config/branch.adoc | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/config/branch.adoc b/Documentation/config/branch.adoc
> index e35ea7ac64..a4db9fa5c8 100644
> --- a/Documentation/config/branch.adoc
> +++ b/Documentation/config/branch.adoc
> @@ -69,9 +69,9 @@ This option defaults to `never`.
>  	`git fetch`) to lookup the default branch for merging. Without
>  	this option, `git pull` defaults to merge the first refspec fetched.
>  	Specify multiple values to get an octopus merge.
> -	If you wish to setup `git pull` so that it merges into <name> from
> +	If you wish to setup `git pull` so that it merges into _<name>_ from
>  	another branch in the local repository, you can point
> -	branch.<name>.merge to the desired branch, and use the relative path
> +	`branch.<name>.merge` to the desired branch, and use the relative path
>  	setting `.` (a period) for `branch.<name>.remote`.
>  
>  `branch.<name>.mergeOptions`::
Looks good to me.  Thanks.

← back to recent threads