Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
From:   Michael Ellerman <mpe@ellerman.id.au>
To:     Hari Bathini <hbathini@linux.ibm.com>,
        Sourabh Jain <sourabhjain@linux.ibm.com>
Cc:     mahesh@linux.vnet.ibm.com, linux-doc@vger.kernel.org,
        linuxppc-dev@lists.ozlabs.org, linux-kernel@vger.kernel.org,
        corbet@lwn.net, gregkh@linuxfoundation.org
Subject: Re: [PATCH v3] powerpc/fadump: sysfs for fadump memory reservation
In-Reply-To: <f8e9cbdd-1926-081d-c8e6-f9d55408fe51@linux.ibm.com>
References: <20190810175905.7761-1-sourabhjain@linux.ibm.com> <53311fa4-2cce-1eb6-1aae-0c835e06eb24@linux.ibm.com> <cf4fdb60-438c-bc4e-d759-1fbb27364c50@linux.ibm.com> <f53e4cfe-57cb-d8a6-385a-fa6243940573@linux.ibm.com> <f8e9cbdd-1926-081d-c8e6-f9d55408fe51@linux.ibm.com>
Date:   Tue, 27 Aug 2019 13:19:35 +1000
Message-ID: <87sgpn2t2w.fsf@concordia.ellerman.id.au>
MIME-Version: 1.0
Content-Type: text/plain
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

Hari Bathini <hbathini@linux.ibm.com> writes:
> On 26/08/19 4:14 PM, Sourabh Jain wrote:
>> On 8/26/19 3:46 PM, Sourabh Jain wrote:
>>> On 8/26/19 3:29 PM, Hari Bathini wrote:
>>>> On 10/08/19 11:29 PM, Sourabh Jain wrote:
>>>>> Add a sys interface to allow querying the memory reserved by
>>>>> fadump for saving the crash dump.
>>>>>
>>>>> Add an ABI doc entry for new sysfs interface.
>>>>>    - /sys/kernel/fadump_mem_reserved
>>>>>
>>>>> Signed-off-by: Sourabh Jain <sourabhjain@linux.ibm.com>
>>>>> ---
>>>>> Changelog:
>>>>> v1 -> v2:
>>>>>   - Added ABI doc for new sysfs interface.
>>>>>
>>>>> v2 -> v3:
>>>>>   - Updated the ABI documentation.
>>>>> ---
>>>>>
>>>>>  Documentation/ABI/testing/sysfs-kernel-fadump    |  6 ++++++
>>>>
>>>> Shouldn't this be Documentation/ABI/testing/sysfs-kernel-fadump_mem_reserved?
>> 
>> How about documenting fadump_mem_reserved and other sysfs attributes suggested
>> by you in a single file Documentation/ABI/testing/sysfs-kernel-fadump?
>
> I wouldn't mind that but please do check if it is breaking a convention..

AIUI a file named like that would hold the documentation for the files
inside a directory called /sys/kernel/fadump.

And in fact that's probably where these files should live, rather than
just dropped directly into /sys/kernel.

cheers