[pacman-dev,1/1] pacman.conf.5: use unified presentation for paths

Message ID 20180214180350.21503-1-list@eworm.de
State Superseded, archived
Headers show
Series
  • [pacman-dev,1/1] pacman.conf.5: use unified presentation for paths
Related show

Commit Message

Christian Hesse Feb. 14, 2018, 6:03 p.m.
From: Christian Hesse <mail@eworm.de>

Signed-off-by: Christian Hesse <mail@eworm.de>
---
 doc/pacman.conf.5.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Allan McRae March 14, 2018, 2:43 a.m. | #1
On 15/02/18 04:03, Christian Hesse wrote:
> From: Christian Hesse <mail@eworm.de>
> 
> Signed-off-by: Christian Hesse <mail@eworm.de>
> ---
>  doc/pacman.conf.5.txt | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.txt
> index f92ee207..3d7aace7 100644
> --- a/doc/pacman.conf.5.txt
> +++ b/doc/pacman.conf.5.txt
> @@ -89,7 +89,7 @@ Options
>  	*NOTE*: this is an absolute path, the root path is not automatically
>  	prepended.
>  
> -*LogFile =* /path/to/file::
> +*LogFile =* path/to/file::
>  	Overrides the default location of the pacman log file. The default
>  	is +{localstatedir}/log/pacman.log+. This is an absolute path and the root directory
>  	is not prepended.
> @@ -108,7 +108,7 @@ Options
>  	group when performing a '\--sysupgrade'. Shell-style glob patterns are
>  	allowed.
>  
> -*Include =* path::
> +*Include =* path/to/file::
>  	Include another configuration file. This file can include repositories or
>  	general configuration options. Wildcards in the specified paths will get
>  	expanded based on linkman:glob[7] rules.
> @@ -121,7 +121,7 @@ Options
>  	architecture 'any' can always be installed, as they are meant to be
>  	architecture independent.
>  
> -*XferCommand =* /path/to/command %u::
> +*XferCommand =* path/to/command %u::

I think this should definitely have a leading "/".

In fact, would it be better if all paths had a leading "/"?  That would
match the examples given in pacman.conf.

A
Christian Hesse March 14, 2018, 8:10 p.m. | #2
Allan McRae <allan@archlinux.org> on Wed, 2018/03/14 12:43:
> On 15/02/18 04:03, Christian Hesse wrote:
> > From: Christian Hesse <mail@eworm.de>
> > 
> > Signed-off-by: Christian Hesse <mail@eworm.de>
> > ---
> >  doc/pacman.conf.5.txt | 8 ++++----
> >  1 file changed, 4 insertions(+), 4 deletions(-)
> > 
> > diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.txt
> > index f92ee207..3d7aace7 100644
> > --- a/doc/pacman.conf.5.txt
> > +++ b/doc/pacman.conf.5.txt
> > @@ -89,7 +89,7 @@ Options
> >  	*NOTE*: this is an absolute path, the root path is not
> > automatically prepended.
> >  
> > -*LogFile =* /path/to/file::
> > +*LogFile =* path/to/file::
> >  	Overrides the default location of the pacman log file. The
> > default is +{localstatedir}/log/pacman.log+. This is an absolute path and
> > the root directory is not prepended.
> > @@ -108,7 +108,7 @@ Options
> >  	group when performing a '\--sysupgrade'. Shell-style glob
> > patterns are allowed.
> >  
> > -*Include =* path::
> > +*Include =* path/to/file::
> >  	Include another configuration file. This file can include
> > repositories or general configuration options. Wildcards in the specified
> > paths will get expanded based on linkman:glob[7] rules.
> > @@ -121,7 +121,7 @@ Options
> >  	architecture 'any' can always be installed, as they are meant to
> > be architecture independent.
> >  
> > -*XferCommand =* /path/to/command %u::
> > +*XferCommand =* path/to/command %u::  
> 
> I think this should definitely have a leading "/".
> 
> In fact, would it be better if all paths had a leading "/"?  That would
> match the examples given in pacman.conf.

We have more paths without leading slash, so I removed the remaining. I am
fine with adding the leading slash everywhere. But IMHO this should be
consistent.

Patch

diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.txt
index f92ee207..3d7aace7 100644
--- a/doc/pacman.conf.5.txt
+++ b/doc/pacman.conf.5.txt
@@ -89,7 +89,7 @@  Options
 	*NOTE*: this is an absolute path, the root path is not automatically
 	prepended.
 
-*LogFile =* /path/to/file::
+*LogFile =* path/to/file::
 	Overrides the default location of the pacman log file. The default
 	is +{localstatedir}/log/pacman.log+. This is an absolute path and the root directory
 	is not prepended.
@@ -108,7 +108,7 @@  Options
 	group when performing a '\--sysupgrade'. Shell-style glob patterns are
 	allowed.
 
-*Include =* path::
+*Include =* path/to/file::
 	Include another configuration file. This file can include repositories or
 	general configuration options. Wildcards in the specified paths will get
 	expanded based on linkman:glob[7] rules.
@@ -121,7 +121,7 @@  Options
 	architecture 'any' can always be installed, as they are meant to be
 	architecture independent.
 
-*XferCommand =* /path/to/command %u::
+*XferCommand =* path/to/command %u::
 	If set, an external program will be used to download all remote files.
 	All instances of `%u` will be replaced with the download URL. If present,
 	instances of `%o` will be replaced with the local filename, plus a
@@ -241,7 +241,7 @@  listed first will take precedence over those listed later in the file when
 packages in two repositories have identical names, regardless of version
 number.
 
-*Include =* path::
+*Include =* path/to/file::
 	Include another config file. This file can include repositories or
 	general configuration options. Wildcards in the specified paths will get
 	expanded based on linkman:glob[7] rules.