diff mbox series

[24/24] xfs_mdrestore.8: Add description for the newly introduced -l option

Message ID 20230523090050.373545-25-chandan.babu@oracle.com (mailing list archive)
State New, archived
Headers show
Series Metadump v2 | expand

Commit Message

Chandan Babu R May 23, 2023, 9 a.m. UTC
Signed-off-by: Chandan Babu R <chandan.babu@oracle.com>
---
 man/man8/xfs_mdrestore.8 | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Darrick J. Wong May 23, 2023, 6:10 p.m. UTC | #1
On Tue, May 23, 2023 at 02:30:50PM +0530, Chandan Babu R wrote:
> Signed-off-by: Chandan Babu R <chandan.babu@oracle.com>
> ---
>  man/man8/xfs_mdrestore.8 | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/man/man8/xfs_mdrestore.8 b/man/man8/xfs_mdrestore.8
> index 72f3b2977..a53ac84d0 100644
> --- a/man/man8/xfs_mdrestore.8
> +++ b/man/man8/xfs_mdrestore.8
> @@ -5,6 +5,9 @@ xfs_mdrestore \- restores an XFS metadump image to a filesystem image
>  .B xfs_mdrestore
>  [
>  .B \-gi
> +] [
> +.B \-l
> +.I logdev
>  ]
>  .I source
>  .I target
> @@ -49,6 +52,11 @@ Shows metadump information on stdout.  If no
>  is specified, exits after displaying information.  Older metadumps man not
>  include any descriptive information.
>  .TP
> +.B \-l " logdev"
> +Metadump in v2 format can contain metadata dumped from an external log. In
> +such a scenario, the user has to provide a device to which the log device
> +contents from the metadump file are copied.

Please start sentences on a new line.

Also, this ought to be folded into the previous patch.

Otherwise the manpage additions look reasonable to me.

--D

> +.TP
>  .B \-V
>  Prints the version number and exits.
>  .SH DIAGNOSTICS
> -- 
> 2.39.1
>
Chandan Babu R May 25, 2023, 1:45 p.m. UTC | #2
On Tue, May 23, 2023 at 11:10:56 AM -0700, Darrick J. Wong wrote:
> On Tue, May 23, 2023 at 02:30:50PM +0530, Chandan Babu R wrote:
>> Signed-off-by: Chandan Babu R <chandan.babu@oracle.com>
>> ---
>>  man/man8/xfs_mdrestore.8 | 8 ++++++++
>>  1 file changed, 8 insertions(+)
>> 
>> diff --git a/man/man8/xfs_mdrestore.8 b/man/man8/xfs_mdrestore.8
>> index 72f3b2977..a53ac84d0 100644
>> --- a/man/man8/xfs_mdrestore.8
>> +++ b/man/man8/xfs_mdrestore.8
>> @@ -5,6 +5,9 @@ xfs_mdrestore \- restores an XFS metadump image to a filesystem image
>>  .B xfs_mdrestore
>>  [
>>  .B \-gi
>> +] [
>> +.B \-l
>> +.I logdev
>>  ]
>>  .I source
>>  .I target
>> @@ -49,6 +52,11 @@ Shows metadump information on stdout.  If no
>>  is specified, exits after displaying information.  Older metadumps man not
>>  include any descriptive information.
>>  .TP
>> +.B \-l " logdev"
>> +Metadump in v2 format can contain metadata dumped from an external log. In
>> +such a scenario, the user has to provide a device to which the log device
>> +contents from the metadump file are copied.
>
> Please start sentences on a new line.
>
> Also, this ought to be folded into the previous patch.
>
> Otherwise the manpage additions look reasonable to me.

Thanks for your valuable review comments!
diff mbox series

Patch

diff --git a/man/man8/xfs_mdrestore.8 b/man/man8/xfs_mdrestore.8
index 72f3b2977..a53ac84d0 100644
--- a/man/man8/xfs_mdrestore.8
+++ b/man/man8/xfs_mdrestore.8
@@ -5,6 +5,9 @@  xfs_mdrestore \- restores an XFS metadump image to a filesystem image
 .B xfs_mdrestore
 [
 .B \-gi
+] [
+.B \-l
+.I logdev
 ]
 .I source
 .I target
@@ -49,6 +52,11 @@  Shows metadump information on stdout.  If no
 is specified, exits after displaying information.  Older metadumps man not
 include any descriptive information.
 .TP
+.B \-l " logdev"
+Metadump in v2 format can contain metadata dumped from an external log. In
+such a scenario, the user has to provide a device to which the log device
+contents from the metadump file are copied.
+.TP
 .B \-V
 Prints the version number and exits.
 .SH DIAGNOSTICS