Re: [PATCH iproute2-next v1 4/4] rdma: Document IB device renaming option

[Leon Romanovsky <leon@kernel.org>]

[-- Attachment #1: Type: text/plain, Size: 1441 bytes --]

On Fri, Nov 02, 2018 at 10:47:16AM -0600, David Ahern wrote:
> On 10/31/18 1:17 AM, Leon Romanovsky wrote:
> > diff --git a/man/man8/rdma-dev.8 b/man/man8/rdma-dev.8
> > index 461681b6..b2f9964a 100644
> > --- a/man/man8/rdma-dev.8
> > +++ b/man/man8/rdma-dev.8
> > @@ -22,6 +22,12 @@ rdmak-dev \- RDMA device configuration
> >  .B rdma dev show
> >  .RI "[ " DEV " ]"
> >
> > +.ti -8
> > +.B rdma dev set
> > +.RI "[ " DEV " ]"
> > +.BR name
> > +.BR NEWNAME
> > +
> >  .ti -8
> >  .B rdma dev help
> >
> > @@ -33,6 +39,8 @@ rdmak-dev \- RDMA device configuration
> >  - specifies the RDMA device to show.
> >  If this argument is omitted all devices are listed.
> >
> > +.SS rdma dev set - rename rdma device
> > +
>
> 'nroff -u0 -Tlp -man man/man8/rdma-dev.8' shows that you lost the
> spacing between that line and the Examples line.
>
>    rdma dev set - rename rdma device
> EXAMPLES
>        rdma dev
>            Shows the state of all RDMA devices on the system.

Thanks, sending v2 now.

>
> ...
>
>
> >  .SH "EXAMPLES"
> >  .PP
> >  rdma dev
> > @@ -45,6 +53,11 @@ rdma dev show mlx5_3
> >  Shows the state of specified RDMA device.
> >  .RE
> >  .PP
> > +rdma dev set mlx5_3 name rdma_0
> > +.RS 4
> > +Renames the mlx5_3 device to be named rdma_0.
>
> That does not read well. I suggest dropping the 'be named' to make it
> "Renames the mlx5_3 device to rdma_0."
>
> > +.RE
> > +.PP
> >
> >  .SH SEE ALSO
> >  .BR rdma (8),
> >

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 801 bytes --]