Re: [RFC] Move tools sources to the tools directory (was Re: [PATCH v2] MAINTAINERS: Fix the location of tools manuals)

[John Snow]

On 2/4/21 9:22 AM, Wainer dos Santos Moschetta wrote:
> On 2/4/21 10:59 AM, Philippe Mathieu-Daudé wrote:
> > On 2/4/21 2:54 PM, Wainer dos Santos Moschetta wrote:
> > > The qemu-img.rst, qemu-nbd.rst, virtfs-proxy-helper.rst, 
> > > qemu-trace-stap.rst,
> > > and virtiofsd.rst manuals were moved to docs/tools, so this update 
> > > MAINTAINERS
> > > accordingly.
> > >
> > > Fixes: a08b4a9fe6c ("docs: Move tools documentation to tools manual")
> > > Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
> > > ---
> > > v1: was "MAINTAINERS: Fix the location of virtiofsd.rst"
> > > v2: Fixed the location of all files [philmd]
> > >
> > >   MAINTAINERS | 10 +++++-----
> > >   1 file changed, 5 insertions(+), 5 deletions(-)
> > >
> > > diff --git a/MAINTAINERS b/MAINTAINERS
> > > index 00626941f1..174425a941 100644
> > > --- a/MAINTAINERS
> > > +++ b/MAINTAINERS
> > > @@ -1829,7 +1829,7 @@ S: Odd Fixes
> > >   F: hw/9pfs/
> > >   X: hw/9pfs/xen-9p*
> > >   F: fsdev/
> > > -F: docs/interop/virtfs-proxy-helper.rst
> > > +F: docs/tools/virtfs-proxy-helper.rst
> > Unrelated, but Paolo once said helpers are not tools.
>
> Unrelated too, but allow me to ask:
>
> Should we move the tools (qemu-img, qemu-io, qemu-nbd...etc) to the 
> tools directory (virtiofsd seems to feel alone there)?

Only smiles and cheers from me. I recommend a README.rst that can go in 
the tools/ directory that explains the purpose of the directory and 
standards for inclusion, etc.

Very small blurbs explaining what, broadly, the tools are, could be nice 
for passers-by on gitlab while browsing the source structure.

This would allow us to codify much of what happened later in this thread 
(what goes here, why? do we support it? etc.)

--js