Re: [for-next][PATCH 12/26] Documentation: bootconfig: Add a doc for extended boot config

From: Masami Hiramatsu
Date: Fri Feb 21 2020 - 05:16:46 EST


On Thu, 20 Feb 2020 16:00:23 +0100
Markus Elfring <Markus.Elfring@xxxxxx> wrote:

> >>> +Currently the maximum config size size is 32KB …
> >>
> >> Would you like to avoid a word duplication here?
> >
> > Oops, still exist.
>
> Is there a need to separate the number from the following unit?

Sorry, I couldn't understand what you pointed here. Would you mean the
number of file size and nodes?

> > Indeed, "node" is not well defined. What about this?
> > ---
> > Each key consists of words separated by dot, and value also consists of
> > values separated by comma. Here, each word and each value is generally
> > called a "node".
>
> I have got still understanding difficulties with such an interpretation.
>
> * Do other contributors find an other word also more appropriate for this use case?

No.

> * How will the influence evolve for naming these items?

Node is used in its API, but from the user's point of view, I think it
is OK to use "key-word" and "value".
Also, since it is hard to count those numbers by manual, I think user
can depend on tools/bootconfig which shows the number of node in the
configuration file now.

> * Is each element just a string (according to specific rules)?

Yes.

> >> Could an other wording be nicer than the abbreviation “a doc for … config”
> >> in the commit subject?
> >
> > OK, I'll try next time.
>
> Will words like “descriptions”and “configuration”be helpful?

Like "descriptions of ..." ?

Thank you,

>
> Regards,
> Markus


--
Masami Hiramatsu <mhiramat@xxxxxxxxxx>