linu-next next-20201006 document build fixes
Subsystems (5)
cover linu-next next-20201006 document build fixes
This small series fix new warnings introduced on today's linux-next.
Feel free to add the patches on this series at the same tree as the warning was introduced at the first place.
Thanks!
Mauro
Mauro Carvalho Chehab (4):
docs: infrastructure.rst: exclude device_link_state from device.h
docs: zh_CN: amu.rst: fix document title markup
docs: RCU: Requirements.rst: fix a list block
firmware_loader: fix a kernel-doc markup
Documentation/RCU/Design/Requirements/Requirements.rst | 1 + Documentation/driver-api/infrastructure.rst | 1 + Documentation/translations/zh_CN/arm64/amu.rst | 4 ++-- drivers/base/firmware_loader/fallback.c | 2 ++ 4 files changed, 6 insertions(+), 2 deletions(-)
Signature · 1 line
2.26.2
PATCH 1/4 docs: infrastructure.rst: exclude device_link_state from device.h
This is already documented at device_link.rst, causing this warning, due to a broken cross-reference:
.../Documentation/driver-api/device_link.rst: WARNING: Duplicate C declaration, also defined in 'driver-api/infrastructure'. Declaration is 'device_link_state'.
--- Documentation/driver-api/infrastructure.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/driver-api/infrastructure.rst +1 -0
@@ -6,6 +6,7 @@ The Basic Device Driver-Model Structures .. kernel-doc:: include/linux/device.h :internal: + :no-identifiers: device_link_state Device Drivers Base -------------------
Signature · 1 line
2.26.2
PATCH 2/4 docs: zh_CN: amu.rst: fix document title markup
In reply to Mauro Carvalho ChehabAs warned by Sphinx 2.4.4:
.../Documentation/translations/zh_CN/arm64/amu.rst:7: WARNING: Title overline too short.
Increase its size.
--- Documentation/translations/zh_CN/arm64/amu.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/translations/zh_CN/arm64/amu.rst +2 -2
@@ -4,9 +4,9 @@ Translator: Bailu Lin <[email protected]> -================================= +================================== AArch64 Linux 中扩展的活动监控单元 -================================= +================================== 作者: Ionela Voinescu <[email protected]>
Signature · 1 line
2.26.2
PATCH 3/4 docs: RCU: Requirements.rst: fix a list block
In reply to Mauro Carvalho ChehabAs warned by Sphinx:
.../Documentation/RCU/Design/Requirements/Requirements.rst:1959: WARNING: Unexpected indentation.
The list block is missing a space before it, making Sphinx to get it wrong.
--- Documentation/RCU/Design/Requirements/Requirements.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/RCU/Design/Requirements/Requirements.rst +1 -0
@@ -1954,6 +1954,7 @@ offline CPUs. However, as a debugging measure, the FQS loop does splat if offline CPUs block an RCU grace period for too long. An offline CPU's quiescent state will be reported either: + 1. As the CPU goes offline using RCU's hotplug notifier (``rcu_report_dead()``). 2. When grace period initialization (``rcu_gp_init()``) detects a race either with CPU offlining or with a task unblocking on a leaf
Signature · 1 line
2.26.2
Re: [PATCH 3/4] docs: RCU: Requirements.rst: fix a list block
Quoted 8 lines · Mauro Carvalho Chehab
As warned by Sphinx:
.../Documentation/RCU/Design/Requirements/Requirements.rst:1959: WARNING: Unexpected indentation.The list block is missing a space before it, making Sphinx to get it wrong.
Fixes 2a721e5f0b2c ("docs: Update RCU's hotplug requirements with a bit about design")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Applied, thank you!
Thanx, Paul
Quoted 19 lines
--- Documentation/RCU/Design/Requirements/Requirements.rst | 1 + 1 file changed, 1 insertion(+)Documentation/RCU/Design/Requirements/Requirements.rst +1
-0@@ -1954,6 +1954,7 @@ offline CPUs. However, as a debugging measure, the FQS loop does splat if offline CPUs block an RCU grace period for too long. An offline CPU's quiescent state will be reported either: + 1. As the CPU goes offline using RCU's hotplug notifier (``rcu_report_dead()``). 2. When grace period initialization (``rcu_gp_init()``) detects a race either with CPU offlining or with a task unblocking on a leafSignature · 1 line
2.26.2
PATCH 4/4 firmware_loader: fix a kernel-doc markup
In reply to Mauro Carvalho ChehabThe firmware_fallback_sysfs had some changes at their parameters. Those ended by dropping a documentation for such parameter. Re-add it.
--- drivers/base/firmware_loader/fallback.c | 2 ++ 1 file changed, 2 insertions(+)
drivers/base/firmware_loader/fallback.c +2 -0
@@ -623,6 +623,8 @@ static bool fw_run_sysfs_fallback(u32 opt_flags)* @fw: pointer to firmware image * @name: name of firmware file to look for * @device: device for which firmware is being loaded +* @opt_flags: options to control firmware loading behaviour, as defined by +* &enum fw_opt * @ret: return value from direct lookup which triggered the fallback mechanism * * This function is called if direct lookup for the firmware failed, it enables
Signature · 1 line
2.26.2