On 04.12.2023 20:05, Julien Grall wrote: > On 04/12/2023 09:39, Jan Beulich wrote: >> On 01.12.2023 19:49, Julien Grall wrote: >>> +Naming convention >>> +----------------- >>> + >>> +'-' should be used to separate words in commandline options and filenames. >>> +E.g. timer-works. >>> + >>> +Note that some of the options and filenames are using '_'. This is now >>> +deprecated. >> >> I certainly appreciate and second the intent, yet I'm afraid "Naming >> convention" >> in the doc would (to me at least) first and foremost talk about identifiers >> used >> in the various source files. If this really is to be about only file names >> and >> command line options, then I think the heading would better say so. >> Alternatively >> a clear indication would want adding that text about identifiers is supposed >> to >> be here, but is yet to be written. (The text itself, for the intended >> purpose, > reads fine to me, fwiw.) > > Right now, I don't have any plan to document the naming convention for > identifiers. In fact, I don't know if we have one... > > So how about renaming the section to: > > "Naming convention for files and comand line options"
That would be fine with me (with - nit - "command"). Then Acked-by: Jan Beulich <[email protected]> Jan
