[PATCH 0/4] linu-next next-20201006 document build fixes

[PATCH 0/4] linu-next next-20201006 document build fixes

[Mauro Carvalho Chehab]

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(-)

-- 
2.26.2

[PATCH 1/4] docs: infrastructure.rst: exclude device_link_state from device.h

[Mauro Carvalho Chehab]

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

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/driver-api/infrastructure.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/driver-api/infrastructure.rst b/Documentation/driver-api/infrastructure.rst
index e38d79be4e16..683bd460e222 100644
--- a/Documentation/driver-api/infrastructure.rst
+++ b/Documentation/driver-api/infrastructure.rst
@@ -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
 -------------------
-- 
2.26.2

[PATCH 2/4] docs: zh_CN: amu.rst: fix document title markup

[Mauro Carvalho Chehab]

As warned by Sphinx 2.4.4:
	.../Documentation/translations/zh_CN/arm64/amu.rst:7: WARNING: Title overline too short.

Increase its size.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/translations/zh_CN/arm64/amu.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/translations/zh_CN/arm64/amu.rst b/Documentation/translations/zh_CN/arm64/amu.rst
index bd875f221330..ab7180f91394 100644
--- a/Documentation/translations/zh_CN/arm64/amu.rst
+++ b/Documentation/translations/zh_CN/arm64/amu.rst
@@ -4,9 +4,9 @@
 
 Translator: Bailu Lin <bailu.lin@vivo.com>
 
-=================================
+==================================
 AArch64 Linux 中扩展的活动监控单元
-=================================
+==================================
 
 作者: Ionela Voinescu <ionela.voinescu@arm.com>
 
-- 
2.26.2

[PATCH 3/4] docs: RCU: Requirements.rst: fix a list block

[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 <mchehab+huawei@kernel.org>
---
 Documentation/RCU/Design/Requirements/Requirements.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/RCU/Design/Requirements/Requirements.rst b/Documentation/RCU/Design/Requirements/Requirements.rst
index 98557fee90cc..9f362827133a 100644
--- a/Documentation/RCU/Design/Requirements/Requirements.rst
+++ b/Documentation/RCU/Design/Requirements/Requirements.rst
@@ -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
-- 
2.26.2

Re: [PATCH 3/4] docs: RCU: Requirements.rst: fix a list block

[Paul E. McKenney]

On Tue, Oct 06, 2020 at 03:21:32PM +0200, Mauro Carvalho Chehab wrote:
> 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 <mchehab+huawei@kernel.org>

Applied, thank you!

							Thanx, Paul

> ---
>  Documentation/RCU/Design/Requirements/Requirements.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/RCU/Design/Requirements/Requirements.rst b/Documentation/RCU/Design/Requirements/Requirements.rst
> index 98557fee90cc..9f362827133a 100644
> --- a/Documentation/RCU/Design/Requirements/Requirements.rst
> +++ b/Documentation/RCU/Design/Requirements/Requirements.rst
> @@ -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
> -- 
> 2.26.2
> 

[PATCH 4/4] firmware_loader: fix a kernel-doc markup

[Mauro Carvalho Chehab]

The firmware_fallback_sysfs had some changes at their
parameters. Those ended by dropping a documentation for
such parameter. Re-add it.

Fixes: 89287c169f8f ("firmware: Store opt_flags in fw_priv")
Fixes: c2c076166b58 ("firmware_loader: change enum fw_opt to u32")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 drivers/base/firmware_loader/fallback.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/drivers/base/firmware_loader/fallback.c b/drivers/base/firmware_loader/fallback.c
index ac09aea3d797..4dec4b79ae06 100644
--- a/drivers/base/firmware_loader/fallback.c
+++ b/drivers/base/firmware_loader/fallback.c
@@ -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
-- 
2.26.2