Re: [PATCH] docs: correct trailer `key_value_separator` description

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

 



Hi Linus

On Sat, Mar 16, 2024 at 1:53 AM Linus Arver <linusa@xxxxxxxxxx> wrote:

> Nit: This line was modified to have " each" at the end. If you did that
> on the next line, then this diff could have been a touch smaller.

Sure -- it looks like this was a result of applying a different
hard-wrap width than the previous author, perhaps? I thought it more
prudent to wrap to a consistent length than to be overly concerned about
the diff given that it was already a fairly trivial patch. That said,
I'm not seeing a recommended wrap width for doc files documented
anywhere either. Is there a documented guideline to follow here, both in
terms of preferred wrap width as well as when it might be appropriate to
stray from it for reasons such as this?

> It's probably not worth re-rolling, but a small suggestion I have is to
> simplify the language a bit to reduce repetition, like so:
> 
>     ** 'key_value_separator=<sep>': specify the separator between
>        the key and value of each trailer. Defaults to ": ". Otherwise it
>        shares the same semantics as 'separator=<sep>' above.
> 

I do prefer the simplified language. I had initially aimed to simply
correct the inaccuracy, but I think that it probably *is* worth a quick
re-roll to make this simplification. I will send that out shortly.

-- 
Thank you,
Brian Lyles





[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux