Re: [PATCH net-next v3 05/12] selftests: ncdevmem: Remove default arguments

[Stanislav Fomichev <stfomichev@gmail.com>]

On 10/12, Mina Almasry wrote:
> On Wed, Oct 9, 2024 at 10:13 AM Stanislav Fomichev <sdf@fomichev.me> wrote:
> >
> > To make it clear what's required and what's not. Also, some of the
> > values don't seem like a good defaults; for example eth1.
> >
> > Move the invocation comment to the top, add missing -s to the client
> > and cleanup the client invocation a bit to make more readable.
> >
> > Cc: Mina Almasry <almasrymina@google.com>
> > Signed-off-by: Stanislav Fomichev <sdf@fomichev.me>
> > ---
> >  tools/testing/selftests/net/ncdevmem.c | 49 ++++++++++++++------------
> >  1 file changed, 27 insertions(+), 22 deletions(-)
> >
> > diff --git a/tools/testing/selftests/net/ncdevmem.c b/tools/testing/selftests/net/ncdevmem.c
> > index 2ee7b4eb9f71..99ae3a595787 100644
> > --- a/tools/testing/selftests/net/ncdevmem.c
> > +++ b/tools/testing/selftests/net/ncdevmem.c
> > @@ -1,4 +1,19 @@
> >  // SPDX-License-Identifier: GPL-2.0
> > +/*
> > + * tcpdevmem netcat. Works similarly to netcat but does device memory TCP
> > + * instead of regular TCP. Uses udmabuf to mock a dmabuf provider.
> > + *
> > + * Usage:
> > + *
> > + *     On server:
> > + *     ncdevmem -s <server IP> [-c <client IP>] -f eth1 -l -p 5201
> > + *
> > + *     On client:
> > + *     echo -n "hello\nworld" | nc -s <server IP> 5201 -p 5201
> > + *
> 
> No need to remove the documentation telling users how to do validation
> when moving these docs. Please have a secondary section that retains
> the docs for the validation:
> 
> * Usage:
> 
> (what you have)
> 
> * Test data validation:
> 
> (What I had before)
> 
> With that:
> 
> Reviewed-by: Mina Almasry <almasrymina@google.com>

SG, will do, thanks!