Re: [PATCH v1 06/11] Documentation: pstore/blk: blkoops: create document for pstore_blk

From: Randy Dunlap <rdunlap@infradead.org>
To: liaoweixiong <liaoweixiong@allwinnertech.com>,
	Kees Cook <keescook@chromium.org>,
	Anton Vorontsov <anton@enomsg.org>,
	Colin Cross <ccross@android.com>, Tony Luck <tony.luck@intel.com>,
	Jonathan Corbet <corbet@lwn.net>,
	Miquel Raynal <miquel.raynal@bootlin.com>,
	Richard Weinberger <richard@nod.at>,
	Vignesh Raghavendra <vigneshr@ti.com>,
	Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	"David S. Miller" <davem@davemloft.net>,
	Rob Herring <robh@kernel.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: linux-mtd@lists.infradead.org, linux-kernel@vger.kernel.org,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH v1 06/11] Documentation: pstore/blk: blkoops: create document for pstore_blk
Date: Tue, 21 Jan 2020 07:34:38 -0800	[thread overview]
Message-ID: <597e2b49-667a-490e-91b6-641ca25401d8@infradead.org> (raw)
In-Reply-To: <3337f687-a668-c058-178b-a1438641c519@allwinnertech.com>

On 1/21/20 12:19 AM, liaoweixiong wrote:
> hi Randy Dunlap,
> 
> On 2020/1/21 2:36 PM, Randy Dunlap wrote:
>> On 1/20/20 9:23 PM, liaoweixiong wrote:
>>> hi Randy Dunlap,
>>>
>>> On 2020/1/21 PM12:13, Randy Dunlap wrote:
>>>> Hi,
>>>>
>>>> I have some documentation comments for you:
>>>>
>>>>
>>>> On 1/19/20 5:03 PM, WeiXiong Liao wrote:
>>>>> The document, at Documentation/admin-guide/pstore-block.rst, tells us
>>>>> how to use pstore/blk and blkoops.
>>>>>
>>>>> Signed-off-by: WeiXiong Liao <liaoweixiong@allwinnertech.com>
>>>>> ---
>>>>>   Documentation/admin-guide/pstore-block.rst | 278 +++++++++++++++++++++++++++++
>>>>>   MAINTAINERS                                |   1 +
>>>>>   fs/pstore/Kconfig                          |   2 +
>>>>>   3 files changed, 281 insertions(+)
>>>>>   create mode 100644 Documentation/admin-guide/pstore-block.rst
>>>>>
>>>>> diff --git a/Documentation/admin-guide/pstore-block.rst b/Documentation/admin-guide/pstore-block.rst
>>>>> new file mode 100644
>>>>> index 000000000000..58418d429c55
>>>>> --- /dev/null
>>>>> +++ b/Documentation/admin-guide/pstore-block.rst
>>>>> +
>>>>> +
>>>>> +dmesg_size
>>>>> +~~~~~~~~~~
>>>>> +
>>>>> +The chunk size in bytes for dmesg(oops/panic). It **MUST** be a multiple of
>>>>> +4096. If you don't need it, safely set it 0 or ignore it.
>>>>
>>>>                                        set it to 0 or ignore it.
>>>>
>>>
>>> I will fix it, thank you.
>>>
>>>> The example above is:  blkoops.dmesg_size=64
>>>> where 64 is not a multiple of 4096. (?)
>>>>
>>>
>>> The module parameter dmesg_size is in unit KB.
>>
>> I didn't see that documented anywhere.
>>
> 
> Oh, sorry, that is my oversight. It seems that not only the other size introductions but also introductions on Kconfig should be corrected. Thank you very much and is the following modification OK?
> 
> The chunk size in KB for dmesg(oops/panic). It **MUST** be a multiple of 4.

OK.

>>>>> +Compression and header
>>>>> +----------------------
>>>>> +
>>>>> +Block device is large enough for uncompressed dmesg data. Actually we do not
>>>>> +recommend data compression because pstore/blk will insert some information into
>>>>> +the first line of dmesg data. For example::
>>>>> +
>>>>> +        Panic: Total 16 times
>>>>> +
>>>>> +It means that it's the 16th times panic log since the first booting. Sometimes
>>>>
>>>>                                 time of a panic log since ...
>>>>
>>>
>>> Should it be like this?
>>> It means the time of a panic log since the first booting.
>>
>> That sounds like clock time, not the number of instances or occurrences.
>>
> 
> It is an oops/panic counter too. How about this?
> 
> It means that it's OOPS/PANIC for the 16th time since the first booting.

                                                  since the last booting {or boot}.

thanks.
-- 
~Randy

______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/