Re: [PATCH 1/2] tools: Add script to create artifacts

[Aaron Conole <aconole@redhat.com>]

Adam Hassick <ahassick@iol.unh.edu> writes:

> On Wed, Jan 10, 2024 at 11:54 AM Aaron Conole <aconole@redhat.com> wrote:
>
>  Adam Hassick <ahassick@iol.unh.edu> writes:
>
>  > This script takes in a URL to a series on Patchwork and emits a
>  > tarball which may be used for running tests.
>  >
>  > Signed-off-by: Adam Hassick <ahassick@iol.unh.edu>
>  > ---
>
>  Just a quick glance.
>
>  Is it possible to include a doc on how it is expected to run this
>  script?  Maybe that could help to also evaluate it as well.
>
> Is there a location in or outside of this repository where
> documentation on tools should be submitted? I have included
> a brief description in the text displayed when the "--help" flag
> is passed in, and in v2 this will include an example.

I think just make a doc/ directory and add a .rst for this tool
(something like we would do for manpages).  I know this is a new thing
that we haven't required in the past, but the project is now growing to
the point that we should have a bit of knowledge shared around.

Does it make sense?