2020-07-18 16:52:46

by Daniel Almeida

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

From: Daniel W. S. Almeida <[email protected]>

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 <[email protected]>
---
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


2020-07-18 16:53:52

by Daniel Almeida

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

From: Daniel W. S. Almeida <[email protected]>

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 <[email protected]>
---
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

2020-07-18 16:53:55

by Daniel Almeida

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

From: Daniel W. S. Almeida <[email protected]>

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 <[email protected]>
---
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

2020-07-18 16:54:53

by Daniel Almeida

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

From: Daniel W. S. Almeida <[email protected]>

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 <[email protected]>
---
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

2020-07-18 16:55:16

by Daniel Almeida

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

From: Daniel W. S. Almeida <[email protected]>

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 <[email protected]>
---
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

2020-07-18 16:55:16

by Daniel Almeida

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

From: Daniel W. S. Almeida <[email protected]>

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 <[email protected]>
---
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

2020-07-18 16:55:24

by Daniel Almeida

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

From: Daniel W. S. Almeida <[email protected]>

Fix the following warnings:

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

Signed-off-by: Daniel W. S. Almeida <[email protected]>
---
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

2020-07-18 16:57:12

by Daniel Almeida

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

From: "Daniel W. S. Almeida" <[email protected]>

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 <[email protected]>
---
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

2020-07-20 01:02:44

by Kees Cook

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

On Sat, Jul 18, 2020 at 01:51:03PM -0300, Daniel W. S. Almeida wrote:
> From: Daniel W. S. Almeida <[email protected]>
>
> 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 <[email protected]>

Whoops! Thank you. :)

Acked-by: Kees Cook <[email protected]>

--
Kees Cook

2020-07-20 01:05:50

by Kees Cook

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

On Sat, Jul 18, 2020 at 01:50:59PM -0300, Daniel W. S. Almeida wrote:
> From: Daniel W. S. Almeida <[email protected]>
>
> 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 <[email protected]>

Reviewed-by: Kees Cook <[email protected]>

--
Kees Cook

2020-07-20 13:15:50

by Stephen Kitt

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

On Sat, 18 Jul 2020 13:50:59 -0300, "Daniel W. S. Almeida"
<[email protected]> wrote:

> From: Daniel W. S. Almeida <[email protected]>
>
> 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 <[email protected]>

Fixes: c9b54d6f362c ("docs: move other kAPI documents to core-api")
Reviewed-by: Stephen Kitt <[email protected]>


Attachments:
(No filename) (849.00 B)
OpenPGP digital signature

2020-07-23 20:16:56

by Jonathan Corbet

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

On Sat, 18 Jul 2020 13:51:06 -0300
"Daniel W. S. Almeida" <[email protected]> wrote:

> From: Daniel W. S. Almeida <[email protected]>
>
> 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 <[email protected]>
> ---
> 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

2020-07-23 20:21:03

by Jonathan Corbet

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

On Sat, 18 Jul 2020 13:51:03 -0300
"Daniel W. S. Almeida" <[email protected]> wrote:

> From: Daniel W. S. Almeida <[email protected]>
>
> 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 <[email protected]>
> ---
> Documentation/admin-guide/index.rst | 1 +
> 1 file changed, 1 insertion(+)

Applied, thanks.

jon

2020-07-23 20:23:41

by Jonathan Corbet

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

On Sat, 18 Jul 2020 13:50:56 -0300
"Daniel W. S. Almeida" <[email protected]> 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

2020-07-23 20:24:41

by Jonathan Corbet

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

On Sat, 18 Jul 2020 13:50:55 -0300
"Daniel W. S. Almeida" <[email protected]> wrote:

> From: Daniel W. S. Almeida <[email protected]>
>
> 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 <[email protected]>
> ---
> Documentation/admin-guide/mm/index.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)

Applied, thanks.

jon

2020-07-23 20:25:45

by Jonathan Corbet

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

On Sat, 18 Jul 2020 13:50:58 -0300
"Daniel W. S. Almeida" <[email protected]> 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

2020-07-23 20:27:17

by Jonathan Corbet

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

On Sat, 18 Jul 2020 13:50:59 -0300
"Daniel W. S. Almeida" <[email protected]> wrote:

> From: Daniel W. S. Almeida <[email protected]>
>
> 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 <[email protected]>
> ---
> 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