diff mbox series

mkfs: document sample configuration file location

Message ID 20211217203900.GQ27664@magnolia (mailing list archive)
State Accepted
Headers show
Series mkfs: document sample configuration file location | expand

Commit Message

Darrick J. Wong Dec. 17, 2021, 8:39 p.m. UTC 
From: Darrick J. Wong <djwong@kernel.org>

Update the documentation to note where one can find sample configuration
files.

Signed-off-by: Darrick J. Wong <djwong@kernel.org>
---
 man/man8/mkfs.xfs.8 |    1 +
 1 file changed, 1 insertion(+)

Comments

Eric Sandeen Dec. 17, 2021, 9:05 p.m. UTC | #1 
On 12/17/21 2:39 PM, Darrick J. Wong wrote:
> From: Darrick J. Wong <djwong@kernel.org>
> 
> Update the documentation to note where one can find sample configuration
> files.
> 
> Signed-off-by: Darrick J. Wong <djwong@kernel.org>
> ---
>   man/man8/mkfs.xfs.8 |    1 +
>   1 file changed, 1 insertion(+)
> 
> diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8
> index 4d292dbe..7984f818 100644
> --- a/man/man8/mkfs.xfs.8
> +++ b/man/man8/mkfs.xfs.8
> @@ -159,6 +159,7 @@ The configuration options will be sourced from the file specified by the
>   option string.
>   This option can be use either an absolute or relative path to the configuration
>   file to be read.
> +Sample configuration files can be found in /usr/share/xfsprogs/mkfs/.

That path is actually configure-time configurable, right, so ... sorry
for being a PITA but I'm not sure we should cite a definitive location
like that in the manpage ..?

>   .RE
>   .PP
>   .PD 0
>
Darrick J. Wong Dec. 17, 2021, 9:38 p.m. UTC | #2 
On Fri, Dec 17, 2021 at 03:05:38PM -0600, Eric Sandeen wrote:
> 
> 
> On 12/17/21 2:39 PM, Darrick J. Wong wrote:
> > From: Darrick J. Wong <djwong@kernel.org>
> > 
> > Update the documentation to note where one can find sample configuration
> > files.
> > 
> > Signed-off-by: Darrick J. Wong <djwong@kernel.org>
> > ---
> >   man/man8/mkfs.xfs.8 |    1 +
> >   1 file changed, 1 insertion(+)
> > 
> > diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8
> > index 4d292dbe..7984f818 100644
> > --- a/man/man8/mkfs.xfs.8
> > +++ b/man/man8/mkfs.xfs.8
> > @@ -159,6 +159,7 @@ The configuration options will be sourced from the file specified by the
> >   option string.
> >   This option can be use either an absolute or relative path to the configuration
> >   file to be read.
> > +Sample configuration files can be found in /usr/share/xfsprogs/mkfs/.
> 
> That path is actually configure-time configurable, right, so ... sorry
> for being a PITA but I'm not sure we should cite a definitive location
> like that in the manpage ..?

Yeah, you're right, this should be autogenerated via sed or something.

--D

> 
> >   .RE
> >   .PP
> >   .PD 0
> >
diff mbox series

Patch

diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8
index 4d292dbe..7984f818 100644
--- a/man/man8/mkfs.xfs.8
+++ b/man/man8/mkfs.xfs.8
@@ -159,6 +159,7 @@  The configuration options will be sourced from the file specified by the
 option string.
 This option can be use either an absolute or relative path to the configuration
 file to be read.
+Sample configuration files can be found in /usr/share/xfsprogs/mkfs/.
 .RE
 .PP
 .PD 0