On 07/26/17 20:20, Jordan Justen wrote: > On 2017-07-26 10:45:41, Kinney, Michael D wrote: >> Hi Jordan, >> >> Not sure I understand the 'whitespace' usage. > > Previously I had given some examples of the style guide: > > * whitespace: Change indentation to 5 spaces > > * case: All functions must now use StUdLyCaPs > > If it was instead: > > * ch5: Change indentation to 5 spaces > > * ch8: All functions must now use StUdLyCaPs > > I don't think we are getting much value in adding the chapter number. > You'd have to go look up what chapter 5 and 8 are to get the context. > Also, what if a chapter is inserted or deleted? Then looking back > through the log may require even more investigation to determine the > context.
I also commented on this earlier elsewhere. I think that the chapter/section should be identified if possible, but not by numbering. Let me make up some examples for the coding std spec: intro/glossary: define FOOBAR principles/recommendations: don't drink and drive quickref/formatting: never say never naming/general: add "init, uninit" to common opposites Some examples for the INF spec: overview/binaries: document LIB filetype BuildOptions: correct typo in BNF etc. Thanks Laszlo _______________________________________________ edk2-devel mailing list [email protected] https://lists.01.org/mailman/listinfo/edk2-devel
