Re: [PATCH v2] Documentation: bootconfig: Update boot configuration documentation

[Randy Dunlap]

On 3/1/20 10:52 PM, Masami Hiramatsu wrote:
> On Fri, 28 Feb 2020 21:59:45 -0800
> Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:
> 
>> On 2/28/20 12:30 AM, Masami Hiramatsu wrote:
>>> Update boot configuration documentation.
>>>
>>>  - Not using "config" abbreviation but configuration or description.
>>>  - Rewrite descriptions of node and its maxinum number.
>>>  - Add a section of use cases of boot configuration.
>>>  - Move how to use bootconfig to earlier section.
>>>  - Fix some typos, indents and format mistakes.
>>>
>>> Signed-off-by: Masami Hiramatsu <mhiramat@xxxxxxxxxx>
>>> ---
>>> Changes in v2:
>>>  - Fixes additional typos (Thanks Markus and Randy!)
>>>  - Change a section title to "Tree Structured Key".
>>> ---
>>>  Documentation/admin-guide/bootconfig.rst |  180 +++++++++++++++++++-----------
>>>  Documentation/trace/boottime-trace.rst   |    2 
>>>  2 files changed, 116 insertions(+), 66 deletions(-)


>>> +Also, some subsystem may depend on the boot configuration, and it has own
>>> +root key. For example, ftrace boot-time tracer uses "ftrace" root key to
>>> +describe its options [2]_. In this case, you need to use the boot
>>> +configuration.
>>
>> Does this say that "ftrace" requires use of bootconfig?
>> It seems to say that.
> 
> Ah, I got it. The last sentence is confusing. How about below?
> 
> "If you want to use the boot-time tracer, you need to use the boot configuration."

Yes, that is better. Thanks.

-- 
~Randy