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 6018A4384F; Tue, 16 Jan 2024 15:10:41 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3BAE340278; Tue, 16 Jan 2024 15:10:41 +0100 (CET) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id D292140042 for ; Tue, 16 Jan 2024 15:10:39 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1705414239; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=mbWrQRjq1wcsxl95DVrQfjKrXSMw/jMOU8Igrpm1uMw=; b=hsC721rv1+4negmNL2T9md6LM6i+0Da3sg7Vh8mJ25B1XGNmX4Ewy5/8fEYZsCEGYX1Yba 4A9InlEETl25lSrkpqMSKWGQlylqWpxmOIgSv6EFLl5wJfu391s+F1C3kWXS2tnJjaekhO 6bJJ49q0Ps9fSBMBDu1sSgZ8m6wEF2E= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-605-d8tEv8e2PCmk10LEL4jSrw-1; Tue, 16 Jan 2024 09:10:37 -0500 X-MC-Unique: d8tEv8e2PCmk10LEL4jSrw-1 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com [10.11.54.3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 95A63868902; Tue, 16 Jan 2024 14:10:37 +0000 (UTC) Received: from RHTPC1VM0NT (unknown [10.22.33.141]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 6D7671121306; Tue, 16 Jan 2024 14:10:37 +0000 (UTC) From: Aaron Conole To: Adam Hassick Cc: ci@dpdk.org Subject: Re: [PATCH 1/2] tools: Add script to create artifacts References: <20240110145715.28157-1-ahassick@iol.unh.edu> <20240110145715.28157-2-ahassick@iol.unh.edu> Date: Tue, 16 Jan 2024 09:10:36 -0500 In-Reply-To: (Adam Hassick's message of "Fri, 12 Jan 2024 11:54:52 -0500") Message-ID: User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.3 (gnu/linux) MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.3 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable 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 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?