From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 64CBF438E7; Wed, 17 Jan 2024 00:40:21 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 4ACD0402A6; Wed, 17 Jan 2024 00:40:21 +0100 (CET) Received: from mail-yw1-f169.google.com (mail-yw1-f169.google.com [209.85.128.169]) by mails.dpdk.org (Postfix) with ESMTP id 11A6B4028B for ; Wed, 17 Jan 2024 00:40:20 +0100 (CET) Received: by mail-yw1-f169.google.com with SMTP id 00721157ae682-5ff4eb17fcdso13781427b3.0 for ; Tue, 16 Jan 2024 15:40:19 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1705448419; x=1706053219; darn=dpdk.org; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=925Ptc4FcVAtUzqeQkFaEbp9cGeV/xwjH0pMA8NeEac=; b=K0a4lCiGegGA2+y0XuTxbfYnM5/7nqaPxH1LNJhXimux1LhUSiO9vTf0RckOD+70aq Wh7bODNUHjwmqNfIUNruVfnMN8aMH4oh2whYRm2W2i7eXO8PuVaOqAR4hlgrk66AMb9M hKg7q3Wj/kWe96tl3DyX6/8LtjGcHtf8mkVP8= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1705448419; x=1706053219; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=925Ptc4FcVAtUzqeQkFaEbp9cGeV/xwjH0pMA8NeEac=; b=MG9ew13M4Egjoc4ep7LkYPY2/sOonohHJhybTD8ua3ez5mGxjxUBZlytSHIUxEmPa8 63AqN3De2Uaa3jLv9DYh311Ku2iYtbY72Li1GWk5jqExj6vrlw5CKUD+1dL87r0kYzky a+lh2KeqW5yGPuczZvZ82VDTN5jODEMwtfGB+ltxGzvy/NEVJOsoc2aR9p00DRLSp0UP i8auasYPFedWvVlno3Zs27e3i/KyaTZnxjZVB0oaUdt4pe15NsBhgfxBUL99WdUNmR2d mfPQYZS1dhTDFpnih38Zt5Bbc0aYoFEnWFXsDHfUzTAU0izn+OYPVTAhUNEu5zVJWZ3o zo3w== X-Gm-Message-State: AOJu0YxTG0FkXmSIug1uOO10K0Kr71GN0H0Tj6AMONhH7pqZEKo1SaMK LRqJPbdUBVl8j9uAvBXgcs+S+5F/TEB8KV8XfNKoCwGLNxmO6iREsiv4z1UPXNc= X-Google-Smtp-Source: AGHT+IG1iDN12nupenYL+B+s6vFdlPBmNBTUC8wvdDAJDqNgYiH5Q8pD+8xAYLFHqUoX9p/VF7MxfCim3v3BlgFZTo0= X-Received: by 2002:a05:6902:1026:b0:dbf:11e:d09e with SMTP id x6-20020a056902102600b00dbf011ed09emr5749166ybt.54.1705448419170; Tue, 16 Jan 2024 15:40:19 -0800 (PST) MIME-Version: 1.0 References: <20240110145715.28157-1-ahassick@iol.unh.edu> <20240110145715.28157-2-ahassick@iol.unh.edu> In-Reply-To: From: Adam Hassick Date: Tue, 16 Jan 2024 18:41:20 -0500 Message-ID: Subject: Re: [PATCH 1/2] tools: Add script to create artifacts To: Aaron Conole Cc: ci@dpdk.org Content-Type: multipart/alternative; boundary="0000000000003533df060f18a7e5" X-BeenThere: ci@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK CI discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: ci-bounces@dpdk.org --0000000000003533df060f18a7e5 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable 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=E2=80=AFAM Aaron Conole w= rote: > Adam Hassick writes: > > > On Wed, Jan 10, 2024 at 11:54=E2=80=AFAM Aaron Conole > wrote: > > > > Adam Hassick 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 > > > --- > > > > 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? > > --0000000000003533df060f18a7e5 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
Yes, this makes sense. I've read through the= Documentation
guidelines and have started writing a document for the to= ol.
However, I have a couple questions.

Where sh= ould the new document be created?
Also, should I create a "doc/api&= quot; directory and include files to
build the documentation?
<= /div>
O= n Tue, Jan 16, 2024 at 9:10=E2=80=AFAM Aaron Conole <aconole@redhat.com> wrote:
Adam Hassick <ahassick@iol.unh.edu> writes:
> On Wed, Jan 10, 2024 at 11:54=E2=80=AFAM Aaron Conole <aconole@redhat.com> wrot= e:
>
>=C2=A0 Adam Hassick <ahassick@iol.unh.edu> writes:
>
>=C2=A0 > This script takes in a URL to a series on Patchwork and emi= ts a
>=C2=A0 > tarball which may be used for running tests.
>=C2=A0 >
>=C2=A0 > Signed-off-by: Adam Hassick <ahassick@iol.unh.edu>
>=C2=A0 > ---
>
>=C2=A0 Just a quick glance.
>
>=C2=A0 Is it possible to include a doc on how it is expected to run thi= s
>=C2=A0 script?=C2=A0 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).=C2=A0 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?

--0000000000003533df060f18a7e5--