threads / patch / 34542

patchconfig doc: quote paths, fixing tilde-interpretation

Subject: [PATCH] config doc: quote paths, fixing tilde-interpretation

## tl;dr

2 messages between Jul 26, 2013 and Jul 26, 2013. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

Ramkumar Ramachandra· Jul 26, 2013, 10:42 UTC · lore
The --global section of git-config(1) currently reads like:
  For writing options: write to global /.gitconfig file rather than the
                                       ^
				       start tilde
  repository .git/config, write to $XDG_CONFIG_HOME/git/config file if
  this file exists and the/.gitconfig file doesn’t.
                          ^
			  end tilde

Instead of tilde (~) being interpreted literally, asciidoc subscripts the text between the two tildes. To fix this problem, use backticks (`) to quote all the paths in the file uniformly, just like config.txt does.

Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
 Candidate for maint?
 Documentation/git-config.txt | 26 ++++++++++++++------------
 1 file changed, 14 insertions(+), 12 deletions(-)
Show changes to Documentation/git-config.txt +14 −12
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 34b0894..2dbe486 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -96,29 +96,31 @@ OPTIONS
 	names are not.
 
 --global::
-	For writing options: write to global ~/.gitconfig file rather than
-	the repository .git/config, write to $XDG_CONFIG_HOME/git/config file
-	if this file exists and the ~/.gitconfig file doesn't.
+	For writing options: write to global `~/.gitconfig` file
+	rather than the repository `.git/config`, write to
+	`$XDG_CONFIG_HOME/git/config` file if this file exists and the
+	`~/.gitconfig` file doesn't.
 +
-For reading options: read only from global ~/.gitconfig and from
-$XDG_CONFIG_HOME/git/config rather than from all available files.
+For reading options: read only from global `~/.gitconfig` and from
+`$XDG_CONFIG_HOME/git/config` rather than from all available files.
 +
 See also <<FILES>>.
 
 --system::
-	For writing options: write to system-wide $(prefix)/etc/gitconfig
-	rather than the repository .git/config.
+	For writing options: write to system-wide
+	`$(prefix)/etc/gitconfig` rather than the repository
+	`.git/config`.
 +
-For reading options: read only from system-wide $(prefix)/etc/gitconfig
+For reading options: read only from system-wide `$(prefix)/etc/gitconfig`
 rather than from all available files.
 +
 See also <<FILES>>.
 
 --local::
-	For writing options: write to the repository .git/config file.
+	For writing options: write to the repository `.git/config` file.
 	This is	the default behavior.
 +
-For reading options: read only from the repository .git/config rather than
+For reading options: read only from the repository `.git/config` rather than
 from all available files.
 +
 See also <<FILES>>.
@@ -218,9 +220,9 @@ $(prefix)/etc/gitconfig::
 
 $XDG_CONFIG_HOME/git/config::
 	Second user-specific configuration file. If $XDG_CONFIG_HOME is not set
-	or empty, $HOME/.config/git/config will be used. Any single-valued
+	or empty, `$HOME/.config/git/config` will be used. Any single-valued
 	variable set in this file will be overwritten by whatever is in
-	~/.gitconfig.  It is a good idea not to create this file if
+	`~/.gitconfig`.  It is a good idea not to create this file if
 	you sometimes use older versions of Git, as support for this
 	file was added fairly recently.
 
-- 
1.8.3.3.820.ge3d4493.dirty
Junio C Hamano· Jul 26, 2013, 15:45 UTC · re: Ramkumar Ramachandra · lore

Re: [PATCH] config doc: quote paths, fixing tilde-interpretation

Ramkumar Ramachandra <artagnon@gmail.com> writes:
Show 18 quoted lines
> The --global section of git-config(1) currently reads like:
>
>   For writing options: write to global /.gitconfig file rather than the
>                                        ^
> 				       start tilde
>
>   repository .git/config, write to $XDG_CONFIG_HOME/git/config file if
>   this file exists and the/.gitconfig file doesn’t.
>                           ^
> 			  end tilde
>
> Instead of tilde (~) being interpreted literally, asciidoc subscripts
> the text between the two tildes.  To fix this problem, use backticks (`)
> to quote all the paths in the file uniformly, just like config.txt does.
>
> Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
> ---
>  Candidate for maint?
Surely; thanks for sharp eyes.
Show 60 quoted lines
>  Documentation/git-config.txt | 26 ++++++++++++++------------
>  1 file changed, 14 insertions(+), 12 deletions(-)
>
> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
> index 34b0894..2dbe486 100644
> --- a/Documentation/git-config.txt
> +++ b/Documentation/git-config.txt
> @@ -96,29 +96,31 @@ OPTIONS
>  	names are not.
>  
>  --global::
> -	For writing options: write to global ~/.gitconfig file rather than
> -	the repository .git/config, write to $XDG_CONFIG_HOME/git/config file
> -	if this file exists and the ~/.gitconfig file doesn't.
> +	For writing options: write to global `~/.gitconfig` file
> +	rather than the repository `.git/config`, write to
> +	`$XDG_CONFIG_HOME/git/config` file if this file exists and the
> +	`~/.gitconfig` file doesn't.
>  +
> -For reading options: read only from global ~/.gitconfig and from
> -$XDG_CONFIG_HOME/git/config rather than from all available files.
> +For reading options: read only from global `~/.gitconfig` and from
> +`$XDG_CONFIG_HOME/git/config` rather than from all available files.
>  +
>  See also <<FILES>>.
>  
>  --system::
> -	For writing options: write to system-wide $(prefix)/etc/gitconfig
> -	rather than the repository .git/config.
> +	For writing options: write to system-wide
> +	`$(prefix)/etc/gitconfig` rather than the repository
> +	`.git/config`.
>  +
> -For reading options: read only from system-wide $(prefix)/etc/gitconfig
> +For reading options: read only from system-wide `$(prefix)/etc/gitconfig`
>  rather than from all available files.
>  +
>  See also <<FILES>>.
>  
>  --local::
> -	For writing options: write to the repository .git/config file.
> +	For writing options: write to the repository `.git/config` file.
>  	This is	the default behavior.
>  +
> -For reading options: read only from the repository .git/config rather than
> +For reading options: read only from the repository `.git/config` rather than
>  from all available files.
>  +
>  See also <<FILES>>.
> @@ -218,9 +220,9 @@ $(prefix)/etc/gitconfig::
>  
>  $XDG_CONFIG_HOME/git/config::
>  	Second user-specific configuration file. If $XDG_CONFIG_HOME is not set
> -	or empty, $HOME/.config/git/config will be used. Any single-valued
> +	or empty, `$HOME/.config/git/config` will be used. Any single-valued
>  	variable set in this file will be overwritten by whatever is in
> -	~/.gitconfig.  It is a good idea not to create this file if
> +	`~/.gitconfig`.  It is a good idea not to create this file if
>  	you sometimes use older versions of Git, as support for this
>  	file was added fairly recently.

← back to recent threads