RE: linux-next: build warning after merge of the edac tree

Shiju Jose posted 1 patch 9 months, 3 weeks ago
RE: linux-next: build warning after merge of the edac tree
Posted by Shiju Jose 9 months, 3 weeks ago
>-----Original Message-----
>From: Stephen Rothwell <sfr@canb.auug.org.au>
>Sent: 28 February 2025 07:51
>To: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>; Borislav Petkov
><bp@alien8.de>; Tony Luck <tony.luck@intel.com>
>Cc: Jonathan Cameron <jonathan.cameron@huawei.com>; Shiju Jose
><shiju.jose@huawei.com>; Linux Kernel Mailing List <linux-
>kernel@vger.kernel.org>; Linux Next Mailing List <linux-next@vger.kernel.org>
>Subject: linux-next: build warning after merge of the edac tree
>
>Hi all,
>
>After merging the edac tree, today's linux-next build (htmldocs) produced this
>warning:
>
>Documentation/edac/index.rst: WARNING: document isn't included in any
>toctree
>
>Introduced by commit
>
>  db99ea5f2c03 ("EDAC: Add support for EDAC device features control")

Thanks Stephen for reporting this warning.

Hi All,

Following change fix this warning.

diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index b52ad5b969d4..ff4fe8c936c8 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -71,6 +71,7 @@ Other subsystems
 
    accounting/index
    cpu-freq/index
+   edac/index
    fpga/index
    i2c/index
    iio/index 
>
>--
>Cheers,
>Stephen Rothwell

Thanks,
Shiju
Re: linux-next: build warning after merge of the edac tree
Posted by Borislav Petkov 9 months, 3 weeks ago
On Fri, Feb 28, 2025 at 10:04:57AM +0000, Shiju Jose wrote:
> >Hi all,
> >
> >After merging the edac tree, today's linux-next build (htmldocs) produced this
> >warning:
> >
> >Documentation/edac/index.rst: WARNING: document isn't included in any
> >toctree
> >
> >Introduced by commit
> >
> >  db99ea5f2c03 ("EDAC: Add support for EDAC device features control")
> 
> Thanks Stephen for reporting this warning.
> 
> Hi All,
> 
> Following change fix this warning.

This branch is now public and immutable so you need to send real patches with
commit messages which fix things ontop. But before you do...

> diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
> index b52ad5b969d4..ff4fe8c936c8 100644
> --- a/Documentation/subsystem-apis.rst
> +++ b/Documentation/subsystem-apis.rst
> @@ -71,6 +71,7 @@ Other subsystems
>  
>     accounting/index
>     cpu-freq/index
> +   edac/index
>     fpga/index
>     i2c/index
>     iio/index 
> >
> >--

... let's see what Jon says.

Jon, ack?

Is that the right place to put this in?

Thx.

-- 
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette
Re: linux-next: build warning after merge of the edac tree
Posted by Jonathan Corbet 9 months, 2 weeks ago
Borislav Petkov <bp@alien8.de> writes:

> This branch is now public and immutable so you need to send real patches with
> commit messages which fix things ontop. But before you do...
>
>> diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
>> index b52ad5b969d4..ff4fe8c936c8 100644
>> --- a/Documentation/subsystem-apis.rst
>> +++ b/Documentation/subsystem-apis.rst
>> @@ -71,6 +71,7 @@ Other subsystems
>>  
>>     accounting/index
>>     cpu-freq/index
>> +   edac/index
>>     fpga/index
>>     i2c/index
>>     iio/index 
>> >
>> >--
>
> ... let's see what Jon says.
>
> Jon, ack?
>
> Is that the right place to put this in?

That will solve the problem for now, though that file is kind of a
dumping ground.  I'll clearly have to get back to my project of better
organizing the device docs...

Thanks,

jon
Re: linux-next: build warning after merge of the edac tree
Posted by Borislav Petkov 9 months, 2 weeks ago
On Fri, Feb 28, 2025 at 07:44:30AM -0700, Jonathan Corbet wrote:
> That will solve the problem for now, though that file is kind of a
> dumping ground.  I'll clearly have to get back to my project of better
> organizing the device docs...

If you have an idea for a final resting ground for this one, let us know and
we'll put it there and thus start the conversion.

:-)

Thx.

-- 
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette