Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
MIME-Version: 1.0
References: <20220627151819.22694-1-lukas.bulwahn@gmail.com> <c7c21381-fa1c-a67a-e5e0-ac590fe0612f@gmail.com>
In-Reply-To: <c7c21381-fa1c-a67a-e5e0-ac590fe0612f@gmail.com>
From:   Lukas Bulwahn <lukas.bulwahn@gmail.com>
Date:   Tue, 28 Jun 2022 06:52:20 +0200
Message-ID: <CAKXUXMyyT_yj4c-EH06Ln0W19oJ=9Vtg97ZKki4y5tzEgWgSOQ@mail.gmail.com>
Subject: Re: [RFC PATCH 00/11] docs: remove submitting-drivers.rst
To:     Bagas Sanjaya <bagasdotme@gmail.com>
Cc:     Jonathan Corbet <corbet@lwn.net>,
        Federico Vaga <federico.vaga@vaga.pv.it>,
        Alex Shi <alexs@kernel.org>,
        Yanteng Si <siyanteng@loongson.cn>,
        Hu Haowen <src.res@email.cn>,
        "open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
        linux-doc-tw-discuss@lists.sourceforge.net,
        Jean Delvare <jdelvare@suse.com>,
        Guenter Roeck <linux@roeck-us.net>,
        linux-hwmon@vger.kernel.org,
        kernel-janitors <kernel-janitors@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Tue, Jun 28, 2022 at 4:50 AM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>
> On 6/27/22 22:18, Lukas Bulwahn wrote:
> > As future work---with this one submitting checklist gone---I see the harder
> > follow-up task to synchronize and clean up the various submission hints/
> > guidelines/checklists in the remaining kernel documentation that partly
> > overlap and differ in detail, their structure (unstructured, unordered
> > lists vs. sections and subsections) and their state of being outdated:
> >
> >   Documentation/process/submit-checklist.rst
> >   Documentation/process/submitting-patches.rst
> >   MAINTAINERS#Tips for patch submitters
> >
> > My next task at hand is to read through all three documents, figure out
> > what still applies and what is outdated, determine a good common structure
> > for all three documents, include cross-links and make them to some extent
> > follow a clear consistent policy. E.g., one document is a more detailed
> > description of everything mentioned in the short list of another document.
> > I will try to work through that in the next months or motivate and guide
> > some colleague or mentee to work together with me on that.
> >
>
> Hi,
>
> I think MAINTAINERS#Tips for patch submitters contains redundant info
> compared to other submission guidelines, and some tips there are outdated
> (like using `diff -u` instead of git). For consistency, that section can
> be removed (in your next RFC series).
>

Thanks for the suggestion. I noticed the outdated hint on 'diff -u' as well.
I was considering replacing it with 'Use git format-patch and git
send-email to get submitting patches via email right.'. (or to avoid
some pitfalls when submitting patches, I have not decided yet).

But let us first clean up the submitting-drivers with this patch
series and get this done.

Lukas

> --
> An old man doll... just what I always wanted! - Clara