From: Adam Hassick <ahassick@iol.unh.edu>
To: Aaron Conole <aconole@redhat.com>
Cc: ci@dpdk.org
Subject: Re: [PATCH 1/2] tools: Add script to create artifacts
Date: Tue, 16 Jan 2024 18:41:20 -0500 [thread overview]
Message-ID: <CAC-YWqiB8UZ7knN36+Wh0ocQpEa0pTaw7M6H9+3=OzX_iwaqKg@mail.gmail.com> (raw)
In-Reply-To: <f7to7dl9xnn.fsf@redhat.com>
[-- Attachment #1: Type: text/plain, Size: 1530 bytes --]
Yes, this makes sense. I've read through the Documentation
guidelines and have started writing a document for the tool.
However, I have a couple questions.
Where should the new document be created?
Also, should I create a "doc/api" directory and include files to
build the documentation?
On Tue, Jan 16, 2024 at 9:10 AM Aaron Conole <aconole@redhat.com> wrote:
> 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?
>
>
[-- Attachment #2: Type: text/html, Size: 2274 bytes --]
next prev parent reply other threads:[~2024-01-16 23:40 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-10 14:57 [PATCH 0/2] Add a script to create series artifacts Adam Hassick
2024-01-10 14:57 ` [PATCH 1/2] tools: Add script to create artifacts Adam Hassick
2024-01-10 16:54 ` Aaron Conole
2024-01-10 18:56 ` Patrick Robb
[not found] ` <CAC-YWqhfQAPQ2=yaqpgG+axPSG9n=kScJULkYv9ZybTnSiZUog@mail.gmail.com>
2024-01-16 14:10 ` Aaron Conole
2024-01-16 23:41 ` Adam Hassick [this message]
2024-01-11 11:55 ` Juraj Linkeš
2024-01-10 14:57 ` [PATCH 2/2] config: Add example config file Adam Hassick
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAC-YWqiB8UZ7knN36+Wh0ocQpEa0pTaw7M6H9+3=OzX_iwaqKg@mail.gmail.com' \
--to=ahassick@iol.unh.edu \
--cc=aconole@redhat.com \
--cc=ci@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).