Re: [PATCH v2 2/2] Documentation: best practices for using Link trailers

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, Jun 27, 2024 at 05:51:47AM GMT, Thorsten Leemhuis wrote:
> I thought it was documented, but either I was wrong or can't find it.
> But I found process/5.Posting.rst, which provides this example:
> 
>         Link: https://example.com/somewhere.html  optional-other-stuff
> 
> So no "# " there. So to avoid inconsistencies I guess this should not be
> applied, unless that document is changed as well.

This is inconsistent with every other trailer that includes comments.
Currently, there are two mechanisms to provide comments with trailers:

1:

    | Trailer-name: trailer-content # trailer-comment

2:

    | Trailer-name: trailer-content
    | [trailer-comment]

For the sake of consistency, all trailers, including Link, should use one of
these two mechanisms for "optional-other-stuff".

-K




[Index of Archives]     [Linux Samsung SoC]     [Linux Rockchip SoC]     [Linux Actions SoC]     [Linux for Synopsys ARC Processors]     [Linux NFS]     [Linux NILFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]


  Powered by Linux