Re: linux-next: build warning after merge of the origin tree

Re: linux-next: build warning after merge of the origin tree

[Akira Yokosawa]

[+CC: linux-doc]

Stephen Rothwell wrote:
> Hi all,
> 
> Today's linux-next build (htmldocs) produced this warning:
> 
> Documentation/power/video.rst:213: WARNING: Footnote [#] is not referenced. [ref.footnote]
> 
> This warning has presumably been there for a long time.
> 
> I don't know what causes it - maybe it needs a space before the opening
> bracket?

Stephen, fhve you upgraded your Sphinx recently?

In "Bugs Fixed" section of Sphinx 8.1.0 changelog [1], there is an item which
reads:

    - #12730: The UnreferencedFootnotesDetector transform has been improved
      to more consistently detect unreferenced footnotes. Note, the priority
      of the transform has been changed from 200 to 622, so that it now runs
      after the docutils Footnotes resolution transform. Patch by Chris Sewell.

So the above warning is real and prior versions of Sphinx just can't flag it.

To silence it, you need to get rid of the unreferenced footnote, I guess.

[1]: https://www.sphinx-doc.org/en/master/changes/8.1.html#id3

        HTH, Akira

> 
> Introduced by commit
> 
>   151f4e2bdc7a ("docs: power: convert docs to ReST and rename to *.rst")
> 
> from v5.3-rc1
> 
> I am just going over left over warnings in he documentation.
> 
> -- 
> Cheers,
> Stephen Rothwell

Re: linux-next: build warning after merge of the origin tree

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 1439 bytes --]

On Wed, Jan 22, 2025 at 07:00:43PM +0900, Akira Yokosawa wrote:
> [+CC: linux-doc]
> 
> Stephen Rothwell wrote:
> > Hi all,
> > 
> > Today's linux-next build (htmldocs) produced this warning:
> > 
> > Documentation/power/video.rst:213: WARNING: Footnote [#] is not referenced. [ref.footnote]
> > 
> > This warning has presumably been there for a long time.
> > 
> > I don't know what causes it - maybe it needs a space before the opening
> > bracket?
> 
> Stephen, fhve you upgraded your Sphinx recently?
> 
> In "Bugs Fixed" section of Sphinx 8.1.0 changelog [1], there is an item which
> reads:
> 
>     - #12730: The UnreferencedFootnotesDetector transform has been improved
>       to more consistently detect unreferenced footnotes. Note, the priority
>       of the transform has been changed from 200 to 622, so that it now runs
>       after the docutils Footnotes resolution transform. Patch by Chris Sewell.
> 
> So the above warning is real and prior versions of Sphinx just can't flag it.
> 
> To silence it, you need to get rid of the unreferenced footnote, I guess.

Hi Akira,

I think the culprit [#f3] footnote (that triggers the warning) refers to
Toshiba Satellite P10-554 notebook, where s3_bios and s3_resume work only on
uniprocessor kernel. The proper fix will be probably adding a space before
the footnote.

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: linux-next: build warning after merge of the origin tree

[Akira Yokosawa]

Bagas Sanjaya wrote:
> On Wed, Jan 22, 2025 at 07:00:43PM +0900, Akira Yokosawa wrote:
>> [+CC: linux-doc]
>>
>> Stephen Rothwell wrote:
>>> Hi all,
>>>
>>> Today's linux-next build (htmldocs) produced this warning:
>>>
>>> Documentation/power/video.rst:213: WARNING: Footnote [#] is not referenced. [ref.footnote]
>>>
>>> This warning has presumably been there for a long time.
>>>
>>> I don't know what causes it - maybe it needs a space before the opening
>>> bracket?
>>
>> Stephen, fhve you upgraded your Sphinx recently?
>>
>> In "Bugs Fixed" section of Sphinx 8.1.0 changelog [1], there is an item which
>> reads:
>>
>>     - #12730: The UnreferencedFootnotesDetector transform has been improved
>>       to more consistently detect unreferenced footnotes. Note, the priority
>>       of the transform has been changed from 200 to 622, so that it now runs
>>       after the docutils Footnotes resolution transform. Patch by Chris Sewell.
>>
>> So the above warning is real and prior versions of Sphinx just can't flag it.
>>
>> To silence it, you need to get rid of the unreferenced footnote, I guess.
> 
> Hi Akira,
> 
> I think the culprit [#f3] footnote (that triggers the warning) refers to
> Toshiba Satellite P10-554 notebook, where s3_bios and s3_resume work only on
> uniprocessor kernel. The proper fix will be probably adding a space before
> the footnote.
> 

Ahh, you mean the referencing side of the footnote in that table.

Yes, you are right. I was lazy and didn't look closely at that jumbo change.
Point taken!

Thank you.

        Akira

Re: linux-next: build warning after merge of the origin tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 354 bytes --]

Hi Akira,

On Wed, 22 Jan 2025 19:00:43 +0900 Akira Yokosawa <akiyks@gmail.com> wrote:
>
> Stephen, fhve you upgraded your Sphinx recently?

Yes, I did.  So that explains this report, I guess.  I also have some
left over warnings that appeared before I started reporting them (and
while I have taken vacation).

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: linux-next: build warning after merge of the origin tree

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 1822 bytes --]

On Wed, Jan 22, 2025 at 11:46:46PM +0900, Akira Yokosawa wrote:
> Bagas Sanjaya wrote:
> > On Wed, Jan 22, 2025 at 07:00:43PM +0900, Akira Yokosawa wrote:
> >> [+CC: linux-doc]
> >>
> >> Stephen Rothwell wrote:
> >>> Hi all,
> >>>
> >>> Today's linux-next build (htmldocs) produced this warning:
> >>>
> >>> Documentation/power/video.rst:213: WARNING: Footnote [#] is not referenced. [ref.footnote]
> >>>
> >>> This warning has presumably been there for a long time.
> >>>
> >>> I don't know what causes it - maybe it needs a space before the opening
> >>> bracket?
> >>
> >> Stephen, fhve you upgraded your Sphinx recently?
> >>
> >> In "Bugs Fixed" section of Sphinx 8.1.0 changelog [1], there is an item which
> >> reads:
> >>
> >>     - #12730: The UnreferencedFootnotesDetector transform has been improved
> >>       to more consistently detect unreferenced footnotes. Note, the priority
> >>       of the transform has been changed from 200 to 622, so that it now runs
> >>       after the docutils Footnotes resolution transform. Patch by Chris Sewell.
> >>
> >> So the above warning is real and prior versions of Sphinx just can't flag it.
> >>
> >> To silence it, you need to get rid of the unreferenced footnote, I guess.
> > 
> > Hi Akira,
> > 
> > I think the culprit [#f3] footnote (that triggers the warning) refers to
> > Toshiba Satellite P10-554 notebook, where s3_bios and s3_resume work only on
> > uniprocessor kernel. The proper fix will be probably adding a space before
> > the footnote.
> > 
> 
> Ahh, you mean the referencing side of the footnote in that table.
> 
> Yes, you are right. I was lazy and didn't look closely at that jumbo change.
> Point taken!
> 
> Thank you.

OK, thanks!

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]