[PATCH] Document powerpc nvram parameters

Murilo Opsfelder Ara├║jo muriloo at linux.vnet.ibm.com
Fri Jun 3 00:26:23 AEST 2016


On 06/02/2016 03:40 AM, Samuel Mendoza-Jonas wrote:
[...]
> Thanks Murilo! I like the idea of documenting these options *somewhere*,
> but I'm not sure inline in the array is the place, it adds a lot of
> height to the declaration. Perhaps it could go above the array slightly
> compressed instead?

I like that too.

> I suppose the question is, who is the intended audience for this
> information.

I believe the audience is whoever reads the source code, be them
developers or not.

> If it's for developers, perhaps each parameter can be
> described in the function that interprets it.

I confess I'm more inclined to document the purpose of a variable close
to its declaration.

> If it's for users (which for 90% of cases it probably shouldn't be)
> then maybe it could go in some other documentation, whether a file
> in the source tree, or on a website.

What about in man/pb-discover.8 under DESCRIPTION section?  Or even in
man/petitboot.8?

-- 
Murilo



More information about the Petitboot mailing list