[dm-devel] [PATCH 1/2] multipathd: Add format options to multipathd man page

[Nitin Yewale]

Hello Ben,

I can try to explain the $format options. Will update bz with the new patch.

Thank you,
Nitin Yewale

On Fri, Jan 13, 2023 at 2:22 PM Martin Wilck <martin.wilck at suse.com> wrote:

> On Thu, 2023-01-12 at 14:28 -0600, Benjamin Marzinski wrote:
> > From: Nitin Yewale <nyewale at redhat.com>
> >
> > Move "multipathd show wildcards" command above the $format commands
> > and
> > also add $format options for "map" and "path" commands to the
> > multipathd
> > man page.
> >
> > Signed-off-by: Benjamin Marzinski <bmarzins at redhat.com>
> > ---
> >  multipathd/multipathd.8 | 16 ++++++++++++----
> >  1 file changed, 12 insertions(+), 4 deletions(-)
> >
> > diff --git a/multipathd/multipathd.8 b/multipathd/multipathd.8
> > index bdf102eb..95d475da 100644
> > --- a/multipathd/multipathd.8
> > +++ b/multipathd/multipathd.8
> > @@ -113,9 +113,17 @@ The following commands can be used in
> > interactive mode:
> >  Show the paths that multipathd is monitoring, and their state.
> >  .
> >  .TP
> > +.B list|show wildcards
> > +Show the format wildcards used in interactive commands taking
> > $format.
> > +.
> > +.TP
> >  .B list|show paths format $format
> >  Show the paths that multipathd is monitoring, using a format string
> > with path
> >  format wildcards.
> > +
> > +path format wildcards:
> > +
> > +%w (uuid), %i (hcil), %d (dev), %D (dev_t), %t (dm_st), %o (dev_st),
> > %T (chk_st), %s (vend/prod/rev), %c (checker), %C (next_check), %p
> > (pri), %S (size), %z (serial), %M (marginal_st), %m (multipath), %N
> > (host WWNN), %n (target WWNN), %R (host WWPN), %r (target WWPN), %a
> > (host adapter), %G (foreign), %g (vpd page data), %0 (failures), %P
> > (protocol)
> >  .
>
> If we do this in the first place, we should explain it better. Terms
> like "dm_st" need explanation. The explanation would grow into a longer
> paragraph, which should be moved to the bottom of the man page with a
> cross reference here.
>
> >  .TP
> >  .B list|show maps|multipaths
> > @@ -125,6 +133,10 @@ Show the multipath devices that the multipathd
> > is monitoring.
> >  .B list|show maps|multipaths format $format
> >  Show the status of all multipath devices that the multipathd is
> > monitoring,
> >  using a format string with multipath format wildcards.
> > +
> > +multipath format wildcards:
> > +
> > +%n (name), %w (uuid), %d (sysfs), %F (failback), %Q (queueing), %N
> > (no. of paths), %r (write_prot), %t (dm-st), %S (size), %f
> > (features), %x (failures), %h (hwhandler), %A (action), %0
> > (path_faults), %1 (switch_grp), %2 (map_loads), %3 (total_q_time), %4
> > (q_timeouts), %s (vend/prod/rev), %v (vend), %p (prod), %e (rev), %G
> > (foreign), %g (vpd page data)
>
> Same comment as above.
>
> Martin
>
> >  .
> >  .TP
> >  .B list|show maps|multipaths status
> > @@ -148,10 +160,6 @@ Show topology of a single multipath device
> > specified by $map, for example
> >  36005076303ffc56200000000000010aa. This map could be obtained from
> > '\fIlist maps\fR'.
> >  .
> >  .TP
> > -.B list|show wildcards
> > -Show the format wildcards used in interactive commands taking
> > $format.
> > -.
> > -.TP
> >  .B list|show config
> >  Show the currently used configuration, derived from default values
> > and values
> >  specified within the configuration file \fI/etc/multipath.conf\fR.
>
>

-- 
Regards,
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/dm-devel/attachments/20230113/a85821d7/attachment.htm>