Re: [PATCH 0/6] Unify argument and option notation in the docs

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

 



I had to fix up the whitespace damage in the rerolled 2/6 but otherwise
looked good.

Thanks, both.  It might make sense to outline the rules applied somewhere in
CodingGuidelines to help people who add to our documents.  Something along
the lines of...

 - A placeholder is spelled inside angle brackets, e.g. <file>, <object>.

 - Choosing one from many is written with possible choices separated with
   a vertical bar and the whole thing enclosed in parentheses, e.g.
   answer=(yes|no|true|false)

 - Repetition of zero or more times of X is spelled as [(X)...], e.g.
   [(-p <parent>)...]


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


[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]