docs: hwmon: Suppress Sphinx warning
Subsystems (2)
PATCH 1/1 docs: hwmon: Suppress Sphinx warning
When generating documentation output Sphinx outputs a warning for not including the page 'inspur-ipsps1.rst' in 'index.rst'. Assuming this documentation is useful it should be included in the index
--- Documentation/hwmon/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/hwmon/index.rst +1 -0
@@ -7,6 +7,7 @@ Linux Hardware Monitoring hwmon-kernel-api pmbus-core + inspur-ipsps1 submitting-patches sysfs-interface userspace-tools
Signature · 1 line
2.21.0
Jonathan Corbet
maintainerQuoted 7 lines · On Sun, 15 Sep 2019 18:27:18 +1000 Adam Zerella <[email protected]> wrote:
When generating documentation output Sphinx outputs a warning for not including the page '
inspur-ipsps1.rst' in 'index.rst'. Assuming this documentation is useful it should be included in the indexSigned-off-by Adam Zerella <[email protected]>
Thanks for working to improve the docs! A couple of quick notes...
- "suppress a warning" is not a particularly helpful subject line. Something like "include inspur-ipsps1.rst in the docs build" says a lot more about what you're actually doing.
Documentation/hwmon/index.rst Linux Hardware Monitoring · line 10
Quoted 12 lines
Documentation/hwmon/index.rst | 1 + 1 file changed, 1 insertion(+)Documentation/hwmon/index.rst +1
-0@@ -7,6 +7,7 @@ Linux Hardware Monitoring hwmon-kernel-api pmbus-core + inspur-ipsps1
- Which tree is this against? I don't even have that file, and mainline doesn't either. If this is in linux-next, the fix should probably go in via the same tree.
Documentation/hwmon/index.rst Linux Hardware Monitoring · line 13
Quoted 3 lines
Documentation/hwmon/index.rst +0
-0submitting-patches sysfs-interface userspace-tools
Thanks,
jon
Quoted 16 lines · Adam Zerella
When generating documentation output Sphinx outputs a warning for not including the page '
inspur-ipsps1.rst' in 'index.rst'. Assuming this documentation is useful it should be included in the indexSigned-off-by Adam Zerella <[email protected]>--- Documentation/hwmon/index.rst | 1 + 1 file changed, 1 insertion(+)Documentation/hwmon/index.rst +0
-0
Documentation/hwmon/index.rst Linux Hardware Monitoring · line 13
Quoted 7 lines
Documentation/hwmon/index.rst +1
-0@@ -7,6 +7,7 @@ Linux Hardware Monitoring hwmon-kernel-api pmbus-core + inspur-ipsps1 submitting-patches sysfs-interface userspace-tools
I suggest Cc'ing the linux-hwmon mailing list for any documentation patch touching files under Documentation/hwmon.
Signature · 2 lines
Jean Delvare SUSE L3 Support