[yocto] docs: how to spell "bitbake", and docbook semantic markup for user input

Richard Purdie richard.purdie at linuxfoundation.org
Thu Jul 14 02:31:28 PDT 2011


On Wed, 2011-07-13 at 06:57 -0400, Robert P. J. Day wrote:
> just perusing the documentation in my typically pedantic fashion and
> a couple questions about style.  first, is the proper spelling
> "Bitbake" or "BitBake" since the doc source seems to bounce back and
> forth and it really should be consistent.
> 
>   and second, this just doesn't seem right as semantic docbook markup:
> 
>     "When the <filename>bitbake</filename> command completes ..."
> 
> in that context, bitbake is not a filename, it's "userinput".  is
> there a reason all user input like that is marked up as "filename"?

I guess it could have been so certain parts appeared in bold but I
suspect there isn't a good reason.

Cheers,

Richard




More information about the yocto mailing list