Re: [PATCH 0/6] Restructure kernel-doc.rst

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

 



On 02/13/2018 01:18 PM, Matthew Wilcox wrote:
> On Tue, Feb 13, 2018 at 01:03:18PM -0800, Randy Dunlap wrote:
>> As long as the examples don't dictate style...
>> E.g., Matthew likes to use:
>>
>> +  * @gfp: Memory allocation flags.
>>
>> a. Capitalize the first word after @param:
>> b. end with a period (even though it's not a sentence)
>>
>> I disagree with both of those.
> 
> OK, so which do you think looks better:
> 
> https://www.kernel.org/doc/html/latest/core-api/idr.html#c.idr_get_cursor
> https://www.kernel.org/doc/html/latest/core-api/idr.html#c.idr_alloc_u32

I can't tell. I don't mind your way but I don't think it should be something
that is codified/enforced.

> (yes, I have failed to be consistent.  I shall apply appropriate amounts
> of self-flagellation and fix them shortly.)

TMI :)


-- 
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux