Re: [RFC PATCH 00/11] docs: remove submitting-drivers.rst
From: Lukas Bulwahn
Date: Tue Jun 28 2022 - 00:52:36 EST
On Tue, Jun 28, 2022 at 4:50 AM Bagas Sanjaya <bagasdotme@xxxxxxxxx> 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