All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Catalin Marinas <catalin.marinas@arm.com>,
	Will Deacon <will@kernel.org>,
	linux-arm-kernel@lists.infradead.org
Subject: [PATCH v2 12/33] docs: amu: supress some Sphinx warnings
Date: Tue, 14 Apr 2020 18:48:38 +0200	[thread overview]
Message-ID: <ab0881638fc41ed790b3307a8e022ec84b7cce7e.1586881715.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1586881715.git.mchehab+huawei@kernel.org>

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


WARNING: multiple messages have this Message-ID (diff)
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
	Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Catalin Marinas <catalin.marinas@arm.com>,
	linux-kernel@vger.kernel.org, Will Deacon <will@kernel.org>,
	linux-arm-kernel@lists.infradead.org
Subject: [PATCH v2 12/33] docs: amu: supress some Sphinx warnings
Date: Tue, 14 Apr 2020 18:48:38 +0200	[thread overview]
Message-ID: <ab0881638fc41ed790b3307a8e022ec84b7cce7e.1586881715.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1586881715.git.mchehab+huawei@kernel.org>

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


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  parent reply	other threads:[~2020-04-14 16:56 UTC|newest]

Thread overview: 81+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-14 16:48 [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` [Ocfs2-devel] " Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 01/33] scripts: kernel-doc: proper handle @foo->bar() Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 02/33] scripts: kernel-doc: accept negation like !@var Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 03/33] scripts: kernel-doc: accept blank lines on parameter description Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 04/33] docs: update recommended Sphinx version to 2.4.4 Mauro Carvalho Chehab
2020-04-20 21:27   ` Jonathan Corbet
2020-04-20 22:12     ` Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 05/33] docs: LaTeX/PDF: drop list of documents Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 06/33] MAINTAINERS: dt: update display/allwinner file entry Mauro Carvalho Chehab
2020-04-16 21:14   ` Rob Herring
2020-04-14 16:48 ` [PATCH v2 07/33] MAINTAINERS: dt: fix pointers for ARM Integrator, Versatile and RealView Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 08/33] docs: dt: fix broken reference to phy-cadence-torrent.yaml Mauro Carvalho Chehab
2020-04-14 21:01   ` Rob Herring
2020-04-14 16:48 ` [PATCH v2 09/33] docs: fix broken references to text files Mauro Carvalho Chehab
2020-04-14 16:48   ` Mauro Carvalho Chehab
2020-04-14 16:48   ` Mauro Carvalho Chehab
2020-04-14 16:48   ` Mauro Carvalho Chehab
2020-04-14 16:48   ` Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 10/33] docs: fix broken references for ReST files that moved around Mauro Carvalho Chehab
2020-04-14 16:48   ` Mauro Carvalho Chehab
2020-04-16  8:31   ` Corentin Labbe
2020-04-16  8:31     ` Corentin Labbe
2020-04-14 16:48 ` [PATCH v2 11/33] docs: filesystems: fix renamed references Mauro Carvalho Chehab
2020-04-14 16:48   ` Mauro Carvalho Chehab
2020-04-14 16:48   ` Mauro Carvalho Chehab
2020-04-14 16:48   ` Mauro Carvalho Chehab
2020-04-14 16:48   ` [Ocfs2-devel] " Mauro Carvalho Chehab
2020-04-14 16:48 ` Mauro Carvalho Chehab [this message]
2020-04-14 16:48   ` [PATCH v2 12/33] docs: amu: supress some Sphinx warnings Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 13/33] docs: arm64: booting.rst: get rid of some warnings Mauro Carvalho Chehab
2020-04-14 16:48   ` Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 14/33] docs: pci: boot-interrupts.rst: improve html output Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 15/33] docs: ras: get rid of some warnings Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 16/33] docs: ras: don't need to repeat twice the same thing Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 17/33] docs: infiniband: verbs.c: fix some documentation warnings Mauro Carvalho Chehab
2020-04-14 19:33   ` Jason Gunthorpe
2020-04-14 16:48 ` [PATCH v2 18/33] docs: spi: spi.h: fix a doc building warning Mauro Carvalho Chehab
2020-04-14 16:54   ` Mark Brown
2020-04-14 16:48 ` [PATCH v2 19/33] docs: drivers: fix some warnings at base/platform.c when building docs Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 20/33] docs: mm: userfaultfd.rst: use ``foo`` for literals Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 21/33] docs: mm: userfaultfd.rst: use a cross-reference for a section Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 22/33] docs: vm: index.rst: add an orphan doc to the building system Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 23/33] docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file Mauro Carvalho Chehab
2020-04-14 21:01   ` Rob Herring
2020-04-14 16:48 ` [PATCH v2 24/33] docs: dt: fix a broken reference for a file converted to json Mauro Carvalho Chehab
2020-04-14 21:02   ` Rob Herring
2020-04-14 16:48 ` [PATCH v2 25/33] docs: powerpc: cxl.rst: mark two section titles as such Mauro Carvalho Chehab
2020-04-14 16:48   ` Mauro Carvalho Chehab
2020-04-15  0:16   ` Andrew Donnellan
2020-04-15  0:16     ` Andrew Donnellan
2020-04-14 16:48 ` [PATCH v2 26/33] docs: i2c: rename i2c.svg to i2c_bus.svg Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 27/33] docs: Makefile: place final pdf docs on a separate dir Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 28/33] docs: dt: rockchip,dwc3.txt: fix a pointer to a renamed file Mauro Carvalho Chehab
2020-04-14 16:48   ` [PATCH v2 28/33] docs: dt: rockchip, dwc3.txt: " Mauro Carvalho Chehab
2020-04-14 16:48   ` Mauro Carvalho Chehab
2020-04-14 21:02   ` [PATCH v2 28/33] docs: dt: rockchip,dwc3.txt: " Rob Herring
2020-04-14 21:02     ` [PATCH v2 28/33] docs: dt: rockchip, dwc3.txt: " Rob Herring
2020-04-14 21:02     ` Rob Herring
2020-04-14 16:48 ` [PATCH v2 29/33] ata: libata-core: fix a doc warning Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 30/33] firewire: firewire-cdev.hL get rid of a docs warning Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 31/33] fs: inode.c: get rid of docs warnings Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 32/33] futex: get rid of a kernel-docs build warning Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 33/33] lib: bitmap.c: get rid of some doc warnings Mauro Carvalho Chehab
2020-04-24 17:30   ` Peter Lister
2020-04-20 21:43 ` [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Jonathan Corbet
2020-04-20 21:43   ` Jonathan Corbet
2020-04-20 21:43   ` Jonathan Corbet
2020-04-20 21:43   ` Jonathan Corbet
2020-04-20 21:43   ` Jonathan Corbet
2020-04-20 21:43   ` Jonathan Corbet
2020-04-20 21:43   ` Jonathan Corbet
2020-04-20 21:43   ` [Ocfs2-devel] " Jonathan Corbet
2020-04-20 21:43   ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ab0881638fc41ed790b3307a8e022ec84b7cce7e.1586881715.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=catalin.marinas@arm.com \
    --cc=corbet@lwn.net \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=will@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.