Skip to contentSkip to conversation

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

DISCUSSION Stephen Rothwell 3 participants 6 messages Jan 22, 2025 – Jan 23, 2025

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

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?

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.

Signature · 2 lines
Cheers,
Stephen Rothwell
#1 lore raw

[+CC: linux-doc]

Quoted 10 lines · Stephen Rothwell

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

Quoted 12 lines

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.

Signature · 2 lines
Cheers,
Stephen Rothwell
#2 lore raw
Quoted 19 lines · Akira Yokosawa

[+CC: linux-doc]

Quoted 10 lines · Stephen Rothwell

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:

Quoted 8 lines

- #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.

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#3 lore raw
Quoted 27 lines · Bagas Sanjaya
Quoted 26 lines · Akira Yokosawa

[+CC: linux-doc]

Quoted 10 lines · Stephen Rothwell

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.

Quoted 9 lines
Quoted 1 line

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

#4 lore raw
Quoted 38 lines · Akira Yokosawa
Quoted 27 lines · Bagas Sanjaya
Quoted 26 lines · Akira Yokosawa

[+CC: linux-doc]

Quoted 10 lines · Stephen Rothwell

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.

Quoted 9 lines
Quoted 1 line

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.

Quoted 6 lines

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!

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#5 lore raw
In reply to Akira Yokosawa

Hi Akira,

Quoted 2 lines · On Wed, 22 Jan 2025 19:00:43 +0900 Akira Yokosawa <[email protected]> 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).

Signature · 2 lines
Cheers,
Stephen Rothwell