Linux Manual Pages development
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx@kernel.org>
To: linux-man@vger.kernel.org, branden@debian.org,
	cjwatson@debian.org, "Günther Noack" <gnoack@google.com>,
	"Jiri Olsa" <jolsa@kernel.org>
Cc: groff@gnu.org
Subject: Re: [PATCH] CONTRIBUTING.d/patches: Document new features alongside the features
Date: Sun, 3 Nov 2024 00:17:08 +0100	[thread overview]
Message-ID: <20241102231150.tjhrq6ugdjr2jri3@devuan> (raw)
In-Reply-To: <20241102231018.18979-1-alx@kernel.org>


[-- Attachment #1.1.1: Type: text/plain, Size: 2222 bytes --]

Oops, this was sent by accident.  :)

On Sun, Nov 03, 2024 at 12:10:18AM +0100, Alejandro Colomar wrote:
> Link: <https://lwn.net/Articles/989380/>
> Cc: Jiri Olsa <jolsa@kernel.org>
> Cc: Günther Noack <gnoack@google.com>
> Signed-off-by: Alejandro Colomar <alx@kernel.org>
> ---
> 
> [offlist]
> 
> Hi Günther, Jiri,
> 
> I've prepared a draft of this contributing process that we talked about.
> I won't officially post it until the other situation (sponsoring) is
> resolved, but we can discuss it in private if you want.
> 
> 
> Have a lovely night!
> Alex
> 
>  CONTRIBUTING.d/patches | 23 +++++++++++++++++++++++
>  1 file changed, 23 insertions(+)
> 
> diff --git a/CONTRIBUTING.d/patches b/CONTRIBUTING.d/patches
> index fedb163d3..0562ded66 100644
> --- a/CONTRIBUTING.d/patches
> +++ b/CONTRIBUTING.d/patches
> @@ -131,6 +131,26 @@ Description
>         to the list.  See also <CONTRIBUTING.d/git> for instructions for
>         configuring git-send-email(1) to use neomutt(1) as a driver.
>  
> +   New kernel/libc features
> +       If you write a new kernel or libc feature, you should document it
> +       in the same patch set that adds the feature, including any
> +       patches to the manual pages.  The entire patch set consisting of
> +       both the feature and its manual page should be sent to all
> +       recipients for a better review process.  That can be done with
> +       the following procedure:
> +
> +       1)  Generate the kernel or libc patch set, with a cover letter,
> +           and using --thread in git-format-patch(1) (as specified in
> +           our ./CONTRIBUTING.d/git).  This will generate a Message-ID
> +           header field in the cover letter.
> +
> +       2)  Generate the man-pages patch set using
> +           --in-reply-to="<message-id>", where <message-id> is the value
> +           of the header field of the cover letter.
> +
> +       3)  Send first the kernel/libc patch set, and then the man-pages
> +           one, so that they have a consistent order.
> +
>  See also
>         CONTRIBUTING
>         CONTRIBUTING.d/*
> -- 
> 2.39.2
> 



-- 
<https://www.alejandro-colomar.es/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  reply	other threads:[~2024-11-02 23:17 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-15 21:17 [PATCH v2 1/3] proc_pid_fdinfo.5: Reduce indent for most of the page Ian Rogers
2024-10-15 21:17 ` [PATCH v2 2/3] proc_pid_fdinfo.5: Add subsection headers for different fd types Ian Rogers
2024-10-15 21:17 ` [PATCH v2 3/3] proc_pid_fdinfo.5: Add DRM subsection Ian Rogers
2024-11-01 13:24 ` [PATCH v2 1/3] proc_pid_fdinfo.5: Reduce indent for most of the page Alejandro Colomar
2024-11-01 18:19   ` Ian Rogers
2024-11-01 20:07     ` Alejandro Colomar
2024-11-02 10:08       ` G. Branden Robinson
2024-11-02 10:39         ` Alejandro Colomar
2024-11-02 21:36           ` Alejandro Colomar
2024-11-02 23:47             ` Colin Watson
2024-11-03  0:05               ` Alejandro Colomar
2024-11-03  0:07                 ` Alejandro Colomar
2024-11-03  0:24                 ` Colin Watson
2024-11-03  0:42                   ` Alejandro Colomar
2024-11-03  0:47                 ` Colin Watson
2024-11-03  1:09                   ` G. Branden Robinson
2024-11-03  1:18                     ` Colin Watson
2024-11-03  1:59                   ` Alejandro Colomar
2024-11-03 14:32                     ` Colin Watson
2024-11-03  4:05           ` G. Branden Robinson
2024-11-02 19:06         ` Colin Watson
2024-11-03  0:50           ` G. Branden Robinson
2024-11-03  1:55             ` Colin Watson
2024-11-02 23:10     ` [PATCH 0/3] Add mansect(1) program and manual page Alejandro Colomar
2024-11-02 23:10       ` [PATCH] CONTRIBUTING.d/patches: Document new features alongside the features Alejandro Colomar
2024-11-02 23:17         ` Alejandro Colomar [this message]
2024-11-02 23:10       ` [PATCH 1/3] signal.7: Better description for SIGFPE Alejandro Colomar
2024-11-02 23:17         ` Alejandro Colomar
2024-11-02 23:10       ` [PATCH 2/3] src/bin/mansect, mansect.1: Add program and its manual page Alejandro Colomar
2024-11-02 23:10       ` [PATCH 3/3] scripts/bash_aliases: man_section(), man_lsfunc(), man_lsvar(): Use mansect(1) Alejandro Colomar
2024-11-03  1:16       ` [PATCH v2 0/4] Add mansect(1) Alejandro Colomar
2024-11-03  1:16         ` [PATCH v2 1/4] src/bin/mansect, mansect.1: Add program and its manual page Alejandro Colomar
2024-11-03  1:17         ` [PATCH v2 2/4] scripts/bash_aliases: man_lsfunc(), man_lsvar(): Use mansect(1) Alejandro Colomar
2024-11-03  1:17         ` [PATCH v2 3/4] scripts/bash_aliases: man_lsfunc(), man_lsvar(): Use pcre2grep(1) instead of pcregrep(1) Alejandro Colomar
2024-11-03  1:17         ` [PATCH v2 4/4] src/bin/mansect: Preprocess with preconv(1) Alejandro Colomar

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=20241102231150.tjhrq6ugdjr2jri3@devuan \
    --to=alx@kernel.org \
    --cc=branden@debian.org \
    --cc=cjwatson@debian.org \
    --cc=gnoack@google.com \
    --cc=groff@gnu.org \
    --cc=jolsa@kernel.org \
    --cc=linux-man@vger.kernel.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