[PATCH] docs: admin-guide/mm/index: Fix reference to nonexistent document

[PATCH] docs: admin-guide/mm/index: Fix reference to nonexistent document

[Daniel W. S. Almeida]

From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Fix the following warning:

WARNING: toctree contains reference to nonexistent document
'admin-guide/mm/nommu-map'

This was due to a typo.

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/admin-guide/mm/index.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst
index 774dad6d3d291..cd727cfc1b040 100644
--- a/Documentation/admin-guide/mm/index.rst
+++ b/Documentation/admin-guide/mm/index.rst
@@ -31,7 +31,7 @@ the Linux memory management.
    idle_page_tracking
    ksm
    memory-hotplug
-   nommu-map
+   nommu-mmap
    numa_memory_policy
    numaperf
    pagemap
-- 
2.27.0

[PATCH] docs: watch_queue.rst: fix malformed inline literal

[Daniel W. S. Almeida]

From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Fix the following warnings:

watch_queue.rst:107: WARNING: Inline literal start-string
without end-string.

watch_queue.rst:107: WARNING: Inline emphasis start-string
without end-string

watch_queue.rst:184: WARNING: Inline literal start-string
without end-string.

watch_queue.rst:184: WARNING: Inline emphasis start-string
without end-string

Multiline inline literals are not supported.

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/watch_queue.rst | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/Documentation/watch_queue.rst b/Documentation/watch_queue.rst
index 81d9d322b1c8b..d98af4f11804e 100644
--- a/Documentation/watch_queue.rst
+++ b/Documentation/watch_queue.rst
@@ -106,8 +106,7 @@ watch that specific key).
 
 To manage a watch list, the following functions are provided:
 
-  * ``void init_watch_list(struct watch_list *wlist,
-			   void (*release_watch)(struct watch *wlist));``
+  * ``void init_watch_list(struct watch_list *wlist, void (*release_watch)(struct watch *wlist));``
 
     Initialise a watch list.  If ``release_watch`` is not NULL, then this
     indicates a function that should be called when the watch_list object is
@@ -182,9 +181,9 @@ The following functions are provided to manage watches:
     driver-settable fields in the watch struct must have been set before this
     is called.
 
-  * ``int remove_watch_from_object(struct watch_list *wlist,
-				   struct watch_queue *wqueue,
-				   u64 id, false);``
+  * ``int remove_watch_from_object(struct watch_list *wlist,``
+				 ``struct watch_queue *wqueue,``
+				 ``u64 id, false);``
 
     Remove a watch from a watch list, where the watch must match the specified
     watch queue (``wqueue``) and object identifier (``id``).  A notification
-- 
2.27.0

Re: [PATCH] docs: watch_queue.rst: fix malformed inline literal

[Jonathan Corbet]

On Sat, 18 Jul 2020 13:50:56 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

>  To manage a watch list, the following functions are provided:
>  
> -  * ``void init_watch_list(struct watch_list *wlist,
> -			   void (*release_watch)(struct watch *wlist));``
> +  * ``void init_watch_list(struct watch_list *wlist, void (*release_watch)(struct watch *wlist));``
>  
>      Initialise a watch list.  If ``release_watch`` is not NULL, then this
>      indicates a function that should be called when the watch_list object is
> @@ -182,9 +181,9 @@ The following functions are provided to manage watches:
>      driver-settable fields in the watch struct must have been set before this
>      is called.
>  
> -  * ``int remove_watch_from_object(struct watch_list *wlist,
> -				   struct watch_queue *wqueue,
> -				   u64 id, false);``
> +  * ``int remove_watch_from_object(struct watch_list *wlist,``
> +				 ``struct watch_queue *wqueue,``
> +				 ``u64 id, false);``

This is very much the wrong fix; please just put the text into a literal
block instead.

Thanks,

jon

[PATCH] docs: kvm/api.rst: Fix indentation

[Daniel W. S. Almeida]

From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Fix the following warnings:

WARNING: Definition list ends without a blank line; unexpected unindent

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/virt/kvm/api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index cdfd981553111..7f24af2760ccd 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -4340,7 +4340,7 @@ Errors:
   #define KVM_STATE_NESTED_VMX_SMM_GUEST_MODE	0x00000001
   #define KVM_STATE_NESTED_VMX_SMM_VMXON	0x00000002
 
-#define KVM_STATE_VMX_PREEMPTION_TIMER_DEADLINE 0x00000001
+  #define KVM_STATE_VMX_PREEMPTION_TIMER_DEADLINE 0x00000001
 
   struct kvm_vmx_nested_state_hdr {
 	__u64 vmxon_pa;
-- 
2.27.0

[PATCH] docs: staging/tee.rst: convert into definition list

[Daniel W. S. Almeida]

From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Fix the following warnings:

tee.rst:65: WARNING: Unexpected indentation.

tee.rst:69: WARNING: Block quote ends without a
blank line; unexpected unindent.

By switching to the 'definition list' syntax.

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/staging/tee.rst | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/Documentation/staging/tee.rst b/Documentation/staging/tee.rst
index 62e8ba64d04f9..4d4b5f8896032 100644
--- a/Documentation/staging/tee.rst
+++ b/Documentation/staging/tee.rst
@@ -61,13 +61,17 @@ represented as a device identified via Universally Unique Identifier (UUID) and
 client drivers register a table of supported device UUIDs.
 
 TEE bus infrastructure registers following APIs:
--  match(): iterates over the client driver UUID table to find a corresponding
-   match for device UUID. If a match is found, then this particular device is
-   probed via corresponding probe API registered by the client driver. This
-   process happens whenever a device or a client driver is registered with TEE
-   bus.
--  uevent(): notifies user-space (udev) whenever a new device is registered on
-   TEE bus for auto-loading of modularized client drivers.
+
+match():
+  iterates over the client driver UUID table to find a corresponding
+  match for device UUID. If a match is found, then this particular device is
+  probed via corresponding probe API registered by the client driver. This
+  process happens whenever a device or a client driver is registered with TEE
+  bus.
+
+uevent():
+  notifies user-space (udev) whenever a new device is registered on
+  TEE bus for auto-loading of modularized client drivers.
 
 TEE bus device enumeration is specific to underlying TEE implementation, so it
 is left open for TEE drivers to provide corresponding implementation.
-- 
2.27.0

Re: [PATCH] docs: staging/tee.rst: convert into definition list

[Jonathan Corbet]

On Sat, 18 Jul 2020 13:50:58 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

>  TEE bus infrastructure registers following APIs:
> --  match(): iterates over the client driver UUID table to find a corresponding
> -   match for device UUID. If a match is found, then this particular device is
> -   probed via corresponding probe API registered by the client driver. This
> -   process happens whenever a device or a client driver is registered with TEE
> -   bus.
> --  uevent(): notifies user-space (udev) whenever a new device is registered on
> -   TEE bus for auto-loading of modularized client drivers.
> +
> +match():
> +  iterates over the client driver UUID table to find a corresponding
> +  match for device UUID. If a match is found, then this particular device is
> +  probed via corresponding probe API registered by the client driver. This
> +  process happens whenever a device or a client driver is registered with TEE
> +  bus.
> +
> +uevent():
> +  notifies user-space (udev) whenever a new device is registered on
> +  TEE bus for auto-loading of modularized client drivers.

Just FWIW, this could have been fixed by adding a blank line between the
two bulleted entries.  This fix is fine too, though, applied, thanks.

jon

[PATCH] docs: process/index.rst: Fix reference to nonexistent document

[Daniel W. S. Almeida]

From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Fix the following warning:

WARNING: toctree contains reference to nonexistent document
'process/unaligned-memory-access'

The path to the document was wrong.

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/process/index.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst
index f07c9250c3acb..dd231ffc8422d 100644
--- a/Documentation/process/index.rst
+++ b/Documentation/process/index.rst
@@ -32,7 +32,7 @@ Below are the essential guides that every developer should read.
    kernel-enforcement-statement
    kernel-driver-statement
 
-Other guides to the community that are of interest to most developers are: 
+Other guides to the community that are of interest to most developers are:
 
 .. toctree::
    :maxdepth: 1
@@ -61,7 +61,7 @@ lack of a better place.
    botching-up-ioctls
    clang-format
    ../riscv/patch-acceptance
-   unaligned-memory-access
+   ../core-api/unaligned-memory-access
 
 .. only::  subproject and html
 
-- 
2.27.0

Re: [PATCH] docs: process/index.rst: Fix reference to nonexistent document

[Kees Cook]

On Sat, Jul 18, 2020 at 01:50:59PM -0300, Daniel W. S. Almeida wrote:
> From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> 
> Fix the following warning:
> 
> WARNING: toctree contains reference to nonexistent document
> 'process/unaligned-memory-access'
> 
> The path to the document was wrong.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Reviewed-by: Kees Cook <keescook@chromium.org>

-- 
Kees Cook

Re: [PATCH] docs: process/index.rst: Fix reference to nonexistent document

[Stephen Kitt]

[-- Attachment #1: Type: text/plain, Size: 510 bytes --]

On Sat, 18 Jul 2020 13:50:59 -0300, "Daniel W. S. Almeida"
<dwlsalmeida@gmail.com> wrote:

> From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> 
> Fix the following warning:
> 
> WARNING: toctree contains reference to nonexistent document
> 'process/unaligned-memory-access'
> 
> The path to the document was wrong.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Fixes: c9b54d6f362c ("docs: move other kAPI documents to core-api")
Reviewed-by: Stephen Kitt <steve@sk2.org>

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH] docs: process/index.rst: Fix reference to nonexistent document

[Jonathan Corbet]

On Sat, 18 Jul 2020 13:50:59 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> 
> Fix the following warning:
> 
> WARNING: toctree contains reference to nonexistent document
> 'process/unaligned-memory-access'
> 
> The path to the document was wrong.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> ---
>  Documentation/process/index.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst
> index f07c9250c3acb..dd231ffc8422d 100644
> --- a/Documentation/process/index.rst
> +++ b/Documentation/process/index.rst
> @@ -32,7 +32,7 @@ Below are the essential guides that every developer should read.
>     kernel-enforcement-statement
>     kernel-driver-statement
>  
> -Other guides to the community that are of interest to most developers are: 
> +Other guides to the community that are of interest to most developers are:
>  
>  .. toctree::
>     :maxdepth: 1
> @@ -61,7 +61,7 @@ lack of a better place.
>     botching-up-ioctls
>     clang-format
>     ../riscv/patch-acceptance
> -   unaligned-memory-access
> +   ../core-api/unaligned-memory-access

Applied, but the right solution is probably just to list it in the
core-api book rather than here.

Thanks,

jon

[PATCH] docs: admin-guide/index.rst: Add pstore-blk.rst

[Daniel W. S. Almeida]

From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Fix the following warning:

Documentation/admin-guide/pstore-blk.rst:
WARNING: document isn't included in any toctree

By adding 'pstore-blk.rst' to the index

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/admin-guide/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 58c7f9fc2396c..ed1cf94ea50c2 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -41,6 +41,7 @@ problems and bugs in particular.
    init
    kdump/index
    perf/index
+   pstore-blk
 
 This is the beginning of a section with information of interest to
 application developers.  Documents covering various aspects of the kernel
-- 
2.27.0

Re: [PATCH] docs: admin-guide/index.rst: Add pstore-blk.rst

[Kees Cook]

On Sat, Jul 18, 2020 at 01:51:03PM -0300, Daniel W. S. Almeida wrote:
> From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> 
> Fix the following warning:
> 
> Documentation/admin-guide/pstore-blk.rst:
> WARNING: document isn't included in any toctree
> 
> By adding 'pstore-blk.rst' to the index
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Whoops! Thank you. :)

Acked-by: Kees Cook <keescook@chromium.org>

-- 
Kees Cook

Re: [PATCH] docs: admin-guide/index.rst: Add pstore-blk.rst

[Jonathan Corbet]

On Sat, 18 Jul 2020 13:51:03 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> 
> Fix the following warning:
> 
> Documentation/admin-guide/pstore-blk.rst:
> WARNING: document isn't included in any toctree
> 
> By adding 'pstore-blk.rst' to the index
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> ---
>  Documentation/admin-guide/index.rst | 1 +
>  1 file changed, 1 insertion(+)

Applied, thanks.

jon

[PATCH] docs: firmware-guide/acpi/index.rst: Add intel-pmc-mux.rst

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning:

Documentation/firmware-guide/acpi/intel-pmc-mux.rst:
WARNING: document isn't included in any toctree

By adding 'intel-pmc-mux.rst' to the index.

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/firmware-guide/acpi/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst
index ad3b5afdae77e..f72b5f1769fb2 100644
--- a/Documentation/firmware-guide/acpi/index.rst
+++ b/Documentation/firmware-guide/acpi/index.rst
@@ -26,3 +26,4 @@ ACPI Support
    lpit
    video_extension
    extcon-intel-int3496
+   intel-pmc-mux
-- 
2.27.0

[PATCH] docs: trace/index.rst: add histogram-design.rst

[Daniel W. S. Almeida]

From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Fix the following warning:

Documentation/trace/histogram-design.rst:
WARNING: document isn't included in any toctree

By adding 'histogram-design.rst' to the index.

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/trace/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
index 7d83156c9ac1f..f44794c8fd840 100644
--- a/Documentation/trace/index.rst
+++ b/Documentation/trace/index.rst
@@ -19,6 +19,7 @@ Linux Tracing Technologies
    events-msr
    mmiotrace
    histogram
+   histogram-design
    boottime-trace
    hwlat_detector
    intel_th
-- 
2.27.0

Re: [PATCH] docs: trace/index.rst: add histogram-design.rst

[Jonathan Corbet]

On Sat, 18 Jul 2020 13:51:06 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> 
> Fix the following warning:
> 
> Documentation/trace/histogram-design.rst:
> WARNING: document isn't included in any toctree
> 
> By adding 'histogram-design.rst' to the index.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> ---
>  Documentation/trace/index.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
> index 7d83156c9ac1f..f44794c8fd840 100644
> --- a/Documentation/trace/index.rst
> +++ b/Documentation/trace/index.rst
> @@ -19,6 +19,7 @@ Linux Tracing Technologies
>     events-msr
>     mmiotrace
>     histogram
> +   histogram-design
>     boottime-trace

Applied, thanks.

jon

Re: [PATCH] docs: core-api/printk-formats.rst: use literal block syntax

[Andy Shevchenko]

On Sat, Jul 18, 2020 at 01:51:02PM -0300, Daniel W. S. Almeida wrote:
> From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> 
> Fix the following warning:
> 
> WARNING: Definition list ends without a blank line;
> unexpected unindent.
> 
> By switching to the literal block syntax.

Acked-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> ---
>  Documentation/core-api/printk-formats.rst | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
> index 1beac4719e437..6d26c5c6ac485 100644
> --- a/Documentation/core-api/printk-formats.rst
> +++ b/Documentation/core-api/printk-formats.rst
> @@ -494,9 +494,11 @@ Time and date
>  	%pt[RT]t		HH:MM:SS
>  	%pt[RT][dt][r]
>  
> -For printing date and time as represented by
> +For printing date and time as represented by::
> +
>  	R  struct rtc_time structure
>  	T  time64_t type
> +
>  in human readable format.
>  
>  By default year will be incremented by 1900 and month by 1.
> -- 
> 2.27.0
> 

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH] docs: core-api/printk-formats.rst: use literal block syntax

[Sergey Senozhatsky]

On (20/07/18 13:51), Daniel W. S. Almeida wrote:
> Fix the following warning:
> 
> WARNING: Definition list ends without a blank line;
> unexpected unindent.
> 
> By switching to the literal block syntax.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Acked-by: Sergey Senozhatsky <sergey.senozhatsky@gmail.com>

	-ss

Re: [PATCH] docs: core-api/printk-formats.rst: use literal block syntax

[Sergey Senozhatsky]

On (20/07/18 13:51), Daniel W. S. Almeida wrote:
> From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> 
> Fix the following warning:
> 
> WARNING: Definition list ends without a blank line;
> unexpected unindent.
> 
> By switching to the literal block syntax.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Jonathan, will you route it via the Documentation tree or do
you want it to land in the printk tree?

	-ss

Re: [PATCH] docs: core-api/printk-formats.rst: use literal block syntax

[Jonathan Corbet]

On Tue, 21 Jul 2020 23:02:46 +0900
Sergey Senozhatsky <sergey.senozhatsky@gmail.com> wrote:

> Jonathan, will you route it via the Documentation tree or do
> you want it to land in the printk tree?

I'm happy either way.  I'll grab it unless you tell me you'd rather pick
it up.

Thanks,

jon

Re: [PATCH] docs: core-api/printk-formats.rst: use literal block syntax

[Sergey Senozhatsky]

On (20/07/21 08:24), Jonathan Corbet wrote:
> On Tue, 21 Jul 2020 23:02:46 +0900
> 
> I'm happy either way.  I'll grab it

Please go ahead.

	-ss

Re: [PATCH] docs: core-api/printk-formats.rst: use literal block syntax

[Jonathan Corbet]

On Sat, 18 Jul 2020 13:51:02 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> Fix the following warning:
> 
> WARNING: Definition list ends without a blank line;
> unexpected unindent.
> 
> By switching to the literal block syntax.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> ---
>  Documentation/core-api/printk-formats.rst | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
> index 1beac4719e437..6d26c5c6ac485 100644
> --- a/Documentation/core-api/printk-formats.rst
> +++ b/Documentation/core-api/printk-formats.rst
> @@ -494,9 +494,11 @@ Time and date
>  	%pt[RT]t		HH:MM:SS
>  	%pt[RT][dt][r]
>  
> -For printing date and time as represented by
> +For printing date and time as represented by::
> +
>  	R  struct rtc_time structure
>  	T  time64_t type
> +
>  in human readable format.

Applied, thanks.

jon

Re: [PATCH] docs: index.rst: Add watch_queue

[Jonathan Corbet]

On Sat, 18 Jul 2020 13:51:07 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
> 
> Fix the following sphinx warning:
> 
> Documentation/watch_queue.rst:
> WARNING: document isn't included in any toctree
> 
> By adding watch_queue.rst to the index.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> ---
>  Documentation/index.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 3b491af0122de..57719744774c2 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -193,6 +193,7 @@ to ReStructured Text format, or are simply too old.
>     :maxdepth: 2
>  
>     staging/index
> +   watch_queue

Thanks, I've applied this, but it isn't really the right fix - this
document should not be at the top level of Documentation/.  I'd be
inclined to move it under userspace-api/, even though there's a strange
mixture of user-space and kernel material here...

jon

Re: [PATCH] docs: bpf/index.rst: Add ringbuf.rst

[Jonathan Corbet]

On Sat, 18 Jul 2020 13:51:04 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> 
> Fix the following warning
> 
> Documentation/bpf/ringbuf.rst: WARNING: document isn't
> included in any toctree
> 
> By adding it to the index.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> ---
>  Documentation/bpf/index.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst
> index 38b4db8be7a2b..0f60b95e83c40 100644
> --- a/Documentation/bpf/index.rst
> +++ b/Documentation/bpf/index.rst
> @@ -58,6 +58,14 @@ Testing and debugging BPF
>     s390
>  
>  
> +Other
> +=====
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   ringbuf
> +
>  .. Links:

Applied, thanks.

jon

Re: [PATCH] docs: admin-guide/mm/index: Fix reference to nonexistent document

[Jonathan Corbet]

On Sat, 18 Jul 2020 13:50:55 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> From: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> 
> Fix the following warning:
> 
> WARNING: toctree contains reference to nonexistent document
> 'admin-guide/mm/nommu-map'
> 
> This was due to a typo.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> ---
>  Documentation/admin-guide/mm/index.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Applied, thanks.

jon

Re: [PATCH] docs: bpf/bpf_devel_QA.rst: fix reference to nonexistent document

[Jonathan Corbet]

On Sat, 18 Jul 2020 13:51:00 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> Fix the following sphinx warning:
> 
> bpf_devel_QA.rst:444: WARNING: Unknown target name:
> "documentation/bpf/btf.rst"
> 
> No target was defined for 'btf.rst' in the document. Fix it.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> ---
>  Documentation/bpf/bpf_devel_QA.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
> index 0b3db91dc1002..a26aa1b9b2595 100644
> --- a/Documentation/bpf/bpf_devel_QA.rst
> +++ b/Documentation/bpf/bpf_devel_QA.rst
> @@ -643,5 +643,6 @@ when:
>  .. _selftests: ../../tools/testing/selftests/bpf/
>  .. _Documentation/dev-tools/kselftest.rst:
>     https://www.kernel.org/doc/html/latest/dev-tools/kselftest.html
> +.. _Documentation/bpf/btf.rst: btf.rst

Applied, thanks.

jon

Re: [PATCH] docs: bpf/ringbuf.rst: fix reference to nonexistent document

[Jonathan Corbet]

On Sat, 18 Jul 2020 13:51:01 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> Fix the following warnings:
> 
> ringbuf.rst:197: WARNING: Unknown target name: "bench_ringbuf.c"
> 
> There was no target defined for 'bench_ringbuf.c'. Also, the
> syntax used was wrong, in the sense that it would not highlight
> the entire path in the browser.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> ---
>  Documentation/bpf/ringbuf.rst | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/bpf/ringbuf.rst b/Documentation/bpf/ringbuf.rst
> index 75f943f0009df..8e7c15a927740 100644
> --- a/Documentation/bpf/ringbuf.rst
> +++ b/Documentation/bpf/ringbuf.rst
> @@ -200,10 +200,13 @@ a self-pacing notifications of new data being availability.
>  being available after commit only if consumer has already caught up right up to
>  the record being committed. If not, consumer still has to catch up and thus
>  will see new data anyways without needing an extra poll notification.
> -Benchmarks (see tools/testing/selftests/bpf/benchs/bench_ringbuf.c_) show that
> +Benchmarks (see `tools/testing/selftests/bpf/benchs/bench_ringbufs.c`_) show that
>  this allows to achieve a very high throughput without having to resort to

But this still doesn't lead to anything useful, right?  That file is not
part of the documentation...  It seems better just to take out the "_"...

Thanks,

jon