* [PATCH 00/17] Address several documentation build warnings
@ 2020-03-17 14:54 Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 01/17] docs: amu: supress some Sphinx warnings Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 02/17] docs: arm64: booting.rst: get rid of some warnings Mauro Carvalho Chehab
0 siblings, 2 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2020-03-17 14:54 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Andrew Lunn, Wolfram Sang, Peter Zijlstra, Catalin Marinas,
Linus Walleij, Lai Jiangshan, Liam Girdwood, linux-ide, linux-i2c,
Joel Fernandes, linux1394-devel, Will Deacon, Jason Gunthorpe,
Florian Fainelli, Jonathan Corbet, Mauro Carvalho Chehab,
Russell King, Chanwoo Choi, Doug Ledford, MyungJoo Ham, linux-pci,
Darren Hart, Niranjana Vishwanathapura, Paul E. McKenney,
linux-pm, Josh Triplett, Steven Rostedt, rcu, linux-gpio,
Mark Brown, Mathieu Desnoyers, Alexander Viro, Jakub Kicinski,
Bjorn Helgaas, Thomas Gleixner, Ingo Molnar, linux-arm-kernel,
Jens Axboe, netdev, Dennis Dalessandro, linux-kernel, linux-rdma,
Kyungmin Park, Stefan Richter, linux-fsdevel, Bartosz Golaszewski,
David S. Miller, Heiner Kallweit
This patch series is against next-20200317. It addresses several warnings on
random places.
It is worth noticing patch 07/17: It changes kernel-doc parser to accept a
very common pattern on kernel-doc markups. This reduces a lot of
warnings all over the tree.
The remaining patches are just random fixes with the hope to address most
warnings that are shown in red when building the documentation.
Mauro Carvalho Chehab (17):
docs: amu: supress some Sphinx warnings
docs: arm64: booting.rst: get rid of some warnings
docs: pci: boot-interrupts.rst: improve html output
kernel: futex.c: get rid of a docs build warning
devfreq: devfreq.h: get rid of some doc warnings
firewire: firewire-cdev.hL get rid of a docs warning
scripts: kernel-doc: proper handle @foo->bar()
lib: bitmap.c: get rid of some doc warnings
rcu: update.c: get rid of some doc warnings
net: phy: sfp-bus.c: get rid of docs warnings
net: core: dev.c: fix a documentation warning
gpio: gpiolib.c: fix a doc warning
i2c: include/linux/i2c.h: fix a doc warning
infiniband: pa_vnic_encap.h: get rid of a warning
ata: libata-core: fix a doc warning
fs: inode.c: get rid of docs warnings
regulator: driver.h: fix regulator_map_* function names
Documentation/PCI/boot-interrupts.rst | 34 ++++++++++--------
Documentation/arm64/amu.rst | 5 +++
Documentation/arm64/booting.rst | 36 +++++++++++--------
drivers/ata/libata-core.c | 2 +-
drivers/gpio/gpiolib.c | 2 +-
.../infiniband/ulp/opa_vnic/opa_vnic_encap.h | 2 +-
drivers/net/phy/sfp-bus.c | 32 +++++++++--------
fs/inode.c | 6 ++--
include/linux/devfreq.h | 6 ++--
include/linux/i2c.h | 4 +--
include/linux/regulator/driver.h | 4 +--
include/uapi/linux/firewire-cdev.h | 2 +-
kernel/futex.c | 3 +-
kernel/rcu/update.c | 8 ++---
lib/bitmap.c | 27 +++++++-------
net/core/dev.c | 2 +-
scripts/kernel-doc | 2 ++
17 files changed, 101 insertions(+), 76 deletions(-)
--
2.24.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists•infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH 01/17] docs: amu: supress some Sphinx warnings
2020-03-17 14:54 [PATCH 00/17] Address several documentation build warnings Mauro Carvalho Chehab
@ 2020-03-17 14:54 ` Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 02/17] docs: arm64: booting.rst: get rid of some warnings Mauro Carvalho Chehab
1 sibling, 0 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2020-03-17 14:54 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Jonathan Corbet, Mauro Carvalho Chehab, Catalin Marinas,
linux-kernel, Will Deacon, linux-arm-kernel
Add extra blank lines on some places, in order to avoid those
warnings when building the docs:
Documentation/arm64/amu.rst:26: WARNING: Unexpected indentation.
Documentation/arm64/amu.rst:60: WARNING: Unexpected indentation.
Documentation/arm64/amu.rst:81: WARNING: Unexpected indentation.
Documentation/arm64/amu.rst:108: WARNING: Unexpected indentation.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel•org>
---
Documentation/arm64/amu.rst | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/Documentation/arm64/amu.rst b/Documentation/arm64/amu.rst
index 5057b11100ed..452ec8b115c2 100644
--- a/Documentation/arm64/amu.rst
+++ b/Documentation/arm64/amu.rst
@@ -23,6 +23,7 @@ optional external memory-mapped interface.
Version 1 of the Activity Monitors architecture implements a counter group
of four fixed and architecturally defined 64-bit event counters.
+
- CPU cycle counter: increments at the frequency of the CPU.
- Constant counter: increments at the fixed frequency of the system
clock.
@@ -57,6 +58,7 @@ counters, only the presence of the extension.
Firmware (code running at higher exception levels, e.g. arm-tf) support is
needed to:
+
- Enable access for lower exception levels (EL2 and EL1) to the AMU
registers.
- Enable the counters. If not enabled these will read as 0.
@@ -78,6 +80,7 @@ are not trapped in EL2/EL3.
The fixed counters of AMUv1 are accessible though the following system
register definitions:
+
- SYS_AMEVCNTR0_CORE_EL0
- SYS_AMEVCNTR0_CONST_EL0
- SYS_AMEVCNTR0_INST_RET_EL0
@@ -93,6 +96,7 @@ Userspace access
----------------
Currently, access from userspace to the AMU registers is disabled due to:
+
- Security reasons: they might expose information about code executed in
secure mode.
- Purpose: AMU counters are intended for system management use.
@@ -105,6 +109,7 @@ Virtualization
Currently, access from userspace (EL0) and kernelspace (EL1) on the KVM
guest side is disabled due to:
+
- Security reasons: they might expose information about code executed
by other guests or the host.
--
2.24.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists•infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [PATCH 02/17] docs: arm64: booting.rst: get rid of some warnings
2020-03-17 14:54 [PATCH 00/17] Address several documentation build warnings Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 01/17] docs: amu: supress some Sphinx warnings Mauro Carvalho Chehab
@ 2020-03-17 14:54 ` Mauro Carvalho Chehab
1 sibling, 0 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2020-03-17 14:54 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Jonathan Corbet, Mauro Carvalho Chehab, Catalin Marinas,
linux-kernel, Will Deacon, linux-arm-kernel
Get rid of those warnings:
Documentation/arm64/booting.rst:253: WARNING: Unexpected indentation.
Documentation/arm64/booting.rst:259: WARNING: Block quote ends without a blank line; unexpected unindent.
By adding an extra blank lines where needed.
While here, use list markups on some places, as otherwise Sphinx
will consider the next lines as continuation of the privious ones.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel•org>
---
Documentation/arm64/booting.rst | 36 ++++++++++++++++++++-------------
1 file changed, 22 insertions(+), 14 deletions(-)
diff --git a/Documentation/arm64/booting.rst b/Documentation/arm64/booting.rst
index a3f1a47b6f1c..e50186092948 100644
--- a/Documentation/arm64/booting.rst
+++ b/Documentation/arm64/booting.rst
@@ -173,7 +173,9 @@ Before jumping into the kernel, the following conditions must be met:
- Caches, MMUs
The MMU must be off.
+
Instruction cache may be on or off.
+
The address range corresponding to the loaded kernel image must be
cleaned to the PoC. In the presence of a system cache or other
coherent masters with caches enabled, this will typically require
@@ -238,6 +240,7 @@ Before jumping into the kernel, the following conditions must be met:
- The DT or ACPI tables must describe a GICv2 interrupt controller.
For CPUs with pointer authentication functionality:
+
- If EL3 is present:
- SCR_EL3.APK (bit 16) must be initialised to 0b1
@@ -249,18 +252,22 @@ Before jumping into the kernel, the following conditions must be met:
- HCR_EL2.API (bit 41) must be initialised to 0b1
For CPUs with Activity Monitors Unit v1 (AMUv1) extension present:
+
- If EL3 is present:
- CPTR_EL3.TAM (bit 30) must be initialised to 0b0
- CPTR_EL2.TAM (bit 30) must be initialised to 0b0
- AMCNTENSET0_EL0 must be initialised to 0b1111
- AMCNTENSET1_EL0 must be initialised to a platform specific value
- having 0b1 set for the corresponding bit for each of the auxiliary
- counters present.
+
+ - CPTR_EL3.TAM (bit 30) must be initialised to 0b0
+ - CPTR_EL2.TAM (bit 30) must be initialised to 0b0
+ - AMCNTENSET0_EL0 must be initialised to 0b1111
+ - AMCNTENSET1_EL0 must be initialised to a platform specific value
+ having 0b1 set for the corresponding bit for each of the auxiliary
+ counters present.
+
- If the kernel is entered at EL1:
- AMCNTENSET0_EL0 must be initialised to 0b1111
- AMCNTENSET1_EL0 must be initialised to a platform specific value
- having 0b1 set for the corresponding bit for each of the auxiliary
- counters present.
+
+ - AMCNTENSET0_EL0 must be initialised to 0b1111
+ - AMCNTENSET1_EL0 must be initialised to a platform specific value
+ having 0b1 set for the corresponding bit for each of the auxiliary
+ counters present.
The requirements described above for CPU mode, caches, MMUs, architected
timers, coherency and system registers apply to all CPUs. All CPUs must
@@ -304,7 +311,8 @@ following manner:
Documentation/devicetree/bindings/arm/psci.yaml.
- Secondary CPU general-purpose register settings
- x0 = 0 (reserved for future use)
- x1 = 0 (reserved for future use)
- x2 = 0 (reserved for future use)
- x3 = 0 (reserved for future use)
+
+ - x0 = 0 (reserved for future use)
+ - x1 = 0 (reserved for future use)
+ - x2 = 0 (reserved for future use)
+ - x3 = 0 (reserved for future use)
--
2.24.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists•infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
^ permalink raw reply related [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-03-17 14:55 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-03-17 14:54 [PATCH 00/17] Address several documentation build warnings Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 01/17] docs: amu: supress some Sphinx warnings Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 02/17] docs: arm64: booting.rst: get rid of some warnings Mauro Carvalho Chehab
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox