Re: [PATCH -next] docs: submitting-patches: Fix section structure around DCO

[weibu]

Maybe it would be better to send this as a follow-up patch after the 
original patch is merged, to avoid unnecessary churn.

Thanks,
Akiyoshi Kurita


2026-07-09 06:04 に Randy Dunlap さんは書きました:
> Hi,
>
> On 7/2/26 3:44 AM, Akira Yokosawa wrote:
> > Commit 5903019b2a5e ("Documentation/SubmittingPatches: convert it to
> > ReST markup") made "DCO 1.1" a subsection under the section "Sign your
> > work - ...".  However, the DCO text is meant to be referenced in the
> > section.
> >
> > Furthermore, in HTML and PDF docs, paragraphs following the DCO:
> >
> >     then you just add a line saying:
> >
> >         Signed-off-by: [...]
> >
> >     [...]
> >     as it was propagated to the maintainers and ultimately to Linus, 
> > with
> >     the first SoB entry signalling primary authorship of a single 
> > author.
> >
> > appear to belong to the DCO, rather than to "Sign your work - ..."
> > where it should.
> >
> > In reST (and other documentation tools), once you start a subsection
> > under a section, there is no way to go back to the section.
> >
> > Fix the section structure by making the DCO a literal block, with
> > indent changes made in commit 5903019b2a5e reverted.
>
> I don't see much difference in the before and after HTML
> other than the use of literal blocks, which do make it a
> small bit clearer where the DCO/Reviewer's blocks are.
>
> Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>
> Thanks.
>
> > While at it, fix the same issue at "Reviewer's statement of
> > oversight".
> >
> > Signed-off-by: Akira Yokosawa <akiyks@xxxxxxxxx>
> > ---
> >  Documentation/process/submitting-patches.rst | 14 ++++++--------
> >  1 file changed, 6 insertions(+), 8 deletions(-)