[PATCH 0/4] docs: small fixes

[PATCH 0/4] docs: small fixes

[Ioana Ciornei]

From: Ioana Ciornei <ioana.ciornei@nxp.com>

This patch set is just a bundle of small fixes for problems and build
warnings that I stumbled upon when trying to add a new section of
documentation.

Ioana Ciornei (4):
  docs: printk-formats: fix build warning
  docs: kvm: fix build warnings
  docs: kvm: properly format code blocks and lists
  docs: networking: dpaa2: fix chapter title format

 Documentation/core-api/printk-formats.rst     |  1 +
 .../ethernet/freescale/dpaa2/dpio-driver.rst  |  1 +
 Documentation/virt/kvm/api.rst                | 32 +++++++++++--------
 3 files changed, 20 insertions(+), 14 deletions(-)

-- 
2.31.1

[PATCH 1/4] docs: printk-formats: fix build warning

[Ioana Ciornei]

From: Ioana Ciornei <ioana.ciornei@nxp.com>

Add an empty line after the '::' starting the code block so that the
following lines are properly interpreted.

Without this, the following build warnings are visible.

Documentation/core-api/printk-formats.rst:136: WARNING: Unexpected indentation.
Documentation/core-api/printk-formats.rst:137: WARNING: Block quote ends without a blank line; unexpected unindent.

Fixes: 9294523e3768 ("module: add printk formats to add module build ID to stacktraces")
Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
---
 Documentation/core-api/printk-formats.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
index d941717a191b..e08bbe9b0cbf 100644
--- a/Documentation/core-api/printk-formats.rst
+++ b/Documentation/core-api/printk-formats.rst
@@ -130,6 +130,7 @@ printed after the symbol name with an extra ``b`` appended to the end of the
 specifier.
 
 ::
+
 	%pS	versatile_init+0x0/0x110 [module_name]
 	%pSb	versatile_init+0x0/0x110 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e]
 	%pSRb	versatile_init+0x9/0x110 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e]
-- 
2.31.1

Re: [PATCH 1/4] docs: printk-formats: fix build warning

[Petr Mladek]

On Thu 2021-07-22 13:03:53, Ioana Ciornei wrote:
> From: Ioana Ciornei <ioana.ciornei@nxp.com>
> 
> Add an empty line after the '::' starting the code block so that the
> following lines are properly interpreted.
> 
> Without this, the following build warnings are visible.
> 
> Documentation/core-api/printk-formats.rst:136: WARNING: Unexpected indentation.
> Documentation/core-api/printk-formats.rst:137: WARNING: Block quote ends without a blank line; unexpected unindent.
> 
> Fixes: 9294523e3768 ("module: add printk formats to add module build ID to stacktraces")
> Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>

Acked-by: Petr Mladek <pmladek@suse.com>

Best Regards,
Petr

Re: [PATCH 1/4] docs: printk-formats: fix build warning

[Stephen Boyd]

Quoting Ioana Ciornei (2021-07-22 03:03:53)
> From: Ioana Ciornei <ioana.ciornei@nxp.com>
>
> Add an empty line after the '::' starting the code block so that the
> following lines are properly interpreted.
>
> Without this, the following build warnings are visible.
>
> Documentation/core-api/printk-formats.rst:136: WARNING: Unexpected indentation.
> Documentation/core-api/printk-formats.rst:137: WARNING: Block quote ends without a blank line; unexpected unindent.
>
> Fixes: 9294523e3768 ("module: add printk formats to add module build ID to stacktraces")
> Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
> ---

I thought this was already fixed? Either way

Reviewed-by: Stephen Boyd <swboyd@chromium.org>

[PATCH 2/4] docs: kvm: fix build warnings

[Ioana Ciornei]

From: Ioana Ciornei <ioana.ciornei@nxp.com>

Fix some small build warnings. The title underline was too short in some
cases and a code block was not indented.

Documentation/virt/kvm/api.rst:7216: WARNING: Title underline too short.

Fixes: 6dba94035203 ("KVM: x86: Introduce KVM_GET_SREGS2 / KVM_SET_SREGS2")
Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
---
 Documentation/virt/kvm/api.rst | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index c7b165ca70b6..535ac0efd1b0 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -5077,7 +5077,7 @@ of bytes successfully copied is returned. If the call completes successfully
 then ``length`` is returned.
 
 4.131 KVM_GET_SREGS2
-------------------
+--------------------
 
 :Capability: KVM_CAP_SREGS2
 :Architectures: x86
@@ -5090,17 +5090,17 @@ This ioctl (when supported) replaces the KVM_GET_SREGS.
 
 ::
 
-struct kvm_sregs2 {
-	/* out (KVM_GET_SREGS2) / in (KVM_SET_SREGS2) */
-	struct kvm_segment cs, ds, es, fs, gs, ss;
-	struct kvm_segment tr, ldt;
-	struct kvm_dtable gdt, idt;
-	__u64 cr0, cr2, cr3, cr4, cr8;
-	__u64 efer;
-	__u64 apic_base;
-	__u64 flags;
-	__u64 pdptrs[4];
-};
+        struct kvm_sregs2 {
+                /* out (KVM_GET_SREGS2) / in (KVM_SET_SREGS2) */
+                struct kvm_segment cs, ds, es, fs, gs, ss;
+                struct kvm_segment tr, ldt;
+                struct kvm_dtable gdt, idt;
+                __u64 cr0, cr2, cr3, cr4, cr8;
+                __u64 efer;
+                __u64 apic_base;
+                __u64 flags;
+                __u64 pdptrs[4];
+        };
 
 flags values for ``kvm_sregs2``:
 
@@ -5110,7 +5110,7 @@ flags values for ``kvm_sregs2``:
 
 
 4.132 KVM_SET_SREGS2
-------------------
+--------------------
 
 :Capability: KVM_CAP_SREGS2
 :Architectures: x86
@@ -7213,7 +7213,7 @@ supported in the host. A VMM can check whether the service is
 available to the guest on migration.
 
 8.33 KVM_CAP_HYPERV_ENFORCE_CPUID
------------------------------
+---------------------------------
 
 Architectures: x86
 
-- 
2.31.1

[PATCH 3/4] docs: kvm: properly format code blocks and lists

[Ioana Ciornei]

From: Ioana Ciornei <ioana.ciornei@nxp.com>

Add a '::' so that a code block is interpreted properly and also add a
blank line before the start of a list.

Fixes: fdc09ddd4064 ("KVM: stats: Add documentation for binary statistics interface")
Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
---
 Documentation/virt/kvm/api.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 535ac0efd1b0..c8225466f379 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -5201,6 +5201,7 @@ trailing ``'\0'``, is indicated by the ``name_size`` field in the header.
 The descriptors block is only needed to be read once for the lifetime of the
 file descriptor contains a sequence of ``struct kvm_stats_desc``, each followed
 by a string of size ``name_size``.
+::
 
 	#define KVM_STATS_TYPE_SHIFT		0
 	#define KVM_STATS_TYPE_MASK		(0xF << KVM_STATS_TYPE_SHIFT)
@@ -5234,6 +5235,7 @@ by this descriptor. Its endianness is CPU native.
 The following flags are supported:
 
 Bits 0-3 of ``flags`` encode the type:
+
   * ``KVM_STATS_TYPE_CUMULATIVE``
     The statistics data is cumulative. The value of data can only be increased.
     Most of the counters used in KVM are of this type.
@@ -5252,6 +5254,7 @@ Bits 0-3 of ``flags`` encode the type:
     The corresponding ``size`` field for this type is always 1.
 
 Bits 4-7 of ``flags`` encode the unit:
+
   * ``KVM_STATS_UNIT_NONE``
     There is no unit for the value of statistics data. This usually means that
     the value is a simple counter of an event.
@@ -5266,6 +5269,7 @@ Bits 4-7 of ``flags`` encode the unit:
 
 Bits 8-11 of ``flags``, together with ``exponent``, encode the scale of the
 unit:
+
   * ``KVM_STATS_BASE_POW10``
     The scale is based on power of 10. It is used for measurement of time and
     CPU clock cycles.  For example, an exponent of -9 can be used with
-- 
2.31.1

Re: [PATCH 3/4] docs: kvm: properly format code blocks and lists

[Jing Zhang]

On Thu, Jul 22, 2021 at 3:03 AM Ioana Ciornei <ciorneiioana@gmail.com> wrote:
>
> From: Ioana Ciornei <ioana.ciornei@nxp.com>
>
> Add a '::' so that a code block is interpreted properly and also add a
> blank line before the start of a list.
>
> Fixes: fdc09ddd4064 ("KVM: stats: Add documentation for binary statistics interface")
> Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
> ---
>  Documentation/virt/kvm/api.rst | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index 535ac0efd1b0..c8225466f379 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -5201,6 +5201,7 @@ trailing ``'\0'``, is indicated by the ``name_size`` field in the header.
>  The descriptors block is only needed to be read once for the lifetime of the
>  file descriptor contains a sequence of ``struct kvm_stats_desc``, each followed
>  by a string of size ``name_size``.
> +::
>
>         #define KVM_STATS_TYPE_SHIFT            0
>         #define KVM_STATS_TYPE_MASK             (0xF << KVM_STATS_TYPE_SHIFT)
> @@ -5234,6 +5235,7 @@ by this descriptor. Its endianness is CPU native.
>  The following flags are supported:
>
>  Bits 0-3 of ``flags`` encode the type:
> +
>    * ``KVM_STATS_TYPE_CUMULATIVE``
>      The statistics data is cumulative. The value of data can only be increased.
>      Most of the counters used in KVM are of this type.
> @@ -5252,6 +5254,7 @@ Bits 0-3 of ``flags`` encode the type:
>      The corresponding ``size`` field for this type is always 1.
>
>  Bits 4-7 of ``flags`` encode the unit:
> +
>    * ``KVM_STATS_UNIT_NONE``
>      There is no unit for the value of statistics data. This usually means that
>      the value is a simple counter of an event.
> @@ -5266,6 +5269,7 @@ Bits 4-7 of ``flags`` encode the unit:
>
>  Bits 8-11 of ``flags``, together with ``exponent``, encode the scale of the
>  unit:
> +
>    * ``KVM_STATS_BASE_POW10``
>      The scale is based on power of 10. It is used for measurement of time and
>      CPU clock cycles.  For example, an exponent of -9 can be used with
> --
> 2.31.1
>
Reviewed-by: Jing Zhang <jingzhangos@google.com>

Thanks,
Jing

[PATCH 4/4] docs: networking: dpaa2: fix chapter title format

[Ioana Ciornei]

From: Ioana Ciornei <ioana.ciornei@nxp.com>

Fix the DPAA2 DPIO driver chapter title by adding the necessary
overline. Without this, the index page of the DPAA2 documentation
doesn't display properly.

Fixes: d8e516bac73f ("soc: fsl: dpio: Convert DPIO documentation to .rst")
Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
---
 .../device_drivers/ethernet/freescale/dpaa2/dpio-driver.rst      | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/networking/device_drivers/ethernet/freescale/dpaa2/dpio-driver.rst b/Documentation/networking/device_drivers/ethernet/freescale/dpaa2/dpio-driver.rst
index c50fd46631e0..e4ebfe62a183 100644
--- a/Documentation/networking/device_drivers/ethernet/freescale/dpaa2/dpio-driver.rst
+++ b/Documentation/networking/device_drivers/ethernet/freescale/dpaa2/dpio-driver.rst
@@ -1,5 +1,6 @@
 .. include:: <isonum.txt>
 
+===================================
 DPAA2 DPIO (Data Path I/O) Overview
 ===================================
 
-- 
2.31.1

Re: [PATCH 0/4] docs: small fixes

[Jonathan Corbet]

Ioana Ciornei <ciorneiioana@gmail.com> writes:

> From: Ioana Ciornei <ioana.ciornei@nxp.com>
>
> This patch set is just a bundle of small fixes for problems and build
> warnings that I stumbled upon when trying to add a new section of
> documentation.
>
> Ioana Ciornei (4):
>   docs: printk-formats: fix build warning
>   docs: kvm: fix build warnings
>   docs: kvm: properly format code blocks and lists
>   docs: networking: dpaa2: fix chapter title format
>
>  Documentation/core-api/printk-formats.rst     |  1 +
>  .../ethernet/freescale/dpaa2/dpio-driver.rst  |  1 +
>  Documentation/virt/kvm/api.rst                | 32 +++++++++++--------
>  3 files changed, 20 insertions(+), 14 deletions(-)

I've applied the set.

Thanks,

jon