docs: admin-guide/mm/index: Fix reference to nonexistent document
Subsystems (10)
PATCH 1/1 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.
--- Documentation/admin-guide/mm/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/mm/index.rst +1 -1
@@ -31,7 +31,7 @@ the Linux memory management. idle_page_tracking ksm memory-hotplug - nommu-map + nommu-mmap numa_memory_policy numaperf pagemap
Signature · 1 line
2.27.0
PATCH 1/1 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.
--- Documentation/watch_queue.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-)
Documentation/watch_queue.rst +4 -5
@@ -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
Signature · 1 line
2.27.0
Jonathan Corbet
maintainerRe: [PATCH] docs: watch_queue.rst: fix malformed inline literal
Quoted 9 lines · On Sat, 18 Jul 2020 13:50:56 -0300 "Daniel W. S. Almeida"…
To manage a watch list, the following functions are provided:
Documentation/watch_queue.rst +1
-2- * ``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
Documentation/watch_queue.rst The following functions are provided to manage watches: · line 186
Quoted 9 lines
Documentation/watch_queue.rst +3
-3@@ -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 1/1 docs: kvm/api.rst: Fix indentation
In reply to Daniel W. S. AlmeidaFrom: Daniel W. S. Almeida <[email protected]>
Fix the following warnings:
WARNING: Definition list ends without a blank line; unexpected unindent
--- Documentation/virt/kvm/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/api.rst +1 -1
@@ -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;
Signature · 1 line
2.27.0
PATCH 1/1 docs: staging/tee.rst: convert into definition list
In reply to Daniel W. S. AlmeidaFrom: 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.
--- Documentation/staging/tee.rst | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-)
Documentation/staging/tee.rst +11 -7
@@ -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.
Signature · 1 line
2.27.0
Jonathan Corbet
maintainerRe: [PATCH] docs: staging/tee.rst: convert into definition list
Quoted 9 lines · On Sat, 18 Jul 2020 13:50:58 -0300 "Daniel W. S. Almeida"…
TEE bus infrastructure registers following APIs:
--match(): iterates over the client driver UUID table to find a correspondingDocumentation/staging/tee.rst +1
-6- 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. +
Documentation/staging/tee.rst represented as a device identified via Universally Unique Identifier (UUID) and · line 74
Quoted 10 lines
Documentation/staging/tee.rst +10
-0+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 1/1 docs: process/index.rst: Fix reference to nonexistent document
In reply to Daniel W. S. AlmeidaFrom: 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.
--- Documentation/process/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/process/index.rst +2 -2
@@ -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
Signature · 1 line
2.27.0
Re: [PATCH] docs: process/index.rst: Fix reference to nonexistent document
Quoted 10 lines · Daniel W. S. Almeida
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]>
Signature · 1 line
Kees Cook
Re: [PATCH] docs: process/index.rst: Fix reference to nonexistent document
In reply to Daniel W. S. AlmeidaQuoted 10 lines · Daniel W. S. Almeida
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]>
_______________________________________________
linux-riscv mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-riscv
Re: [PATCH] docs: process/index.rst: Fix reference to nonexistent document
In reply to Daniel W. S. AlmeidaQuoted 28 lines · On Sat, 18 Jul 2020 13:50:59 -0300 "Daniel W. S. Almeida"…
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(-)Documentation/process/index.rst +1
-1@@ -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
Documentation/process/index.rst lack of a better place. · line 64
Quoted 5 lines
Documentation/process/index.rst +1
-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 1/1 docs: admin-guide/index.rst: Add pstore-blk.rst
In reply to Daniel W. S. AlmeidaFrom: 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
--- Documentation/admin-guide/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/admin-guide/index.rst +1 -0
@@ -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
Signature · 1 line
2.27.0
Re: [PATCH] docs: admin-guide/index.rst: Add pstore-blk.rst
Quoted 10 lines · Daniel W. S. Almeida
From: Daniel W. S. Almeida <[email protected]>
Fix the following warning:
Documentation/admin-guide/pstore-blk.rst:
WARNING: document isn't included in any toctreeBy adding '
pstore-blk.rst' to the indexSigned-off-by Daniel W. S. Almeida <[email protected]>
Whoops! Thank you. :)
Signature · 1 line
Kees Cook
Re: [PATCH] docs: admin-guide/index.rst: Add pstore-blk.rst
In reply to Daniel W. S. AlmeidaQuoted 7 lines · On Sat, 18 Jul 2020 13:51:03 -0300 "Daniel W. S. Almeida"…
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
Quoted 6 lines
By adding '
pstore-blk.rst' to the indexSigned-off-by Daniel W. S. Almeida <[email protected]>--- Documentation/admin-guide/index.rst | 1 + 1 file changed, 1 insertion(+)
Applied, thanks.
jon
PATCH 1/1 docs: firmware-guide/acpi/index.rst: Add intel-pmc-mux.rst
In reply to Daniel W. S. AlmeidaFrom: "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.
--- Documentation/firmware-guide/acpi/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/firmware-guide/acpi/index.rst +1 -0
@@ -26,3 +26,4 @@ ACPI Support lpit video_extension extcon-intel-int3496 + intel-pmc-mux
Signature · 1 line
2.27.0
PATCH 1/1 docs: trace/index.rst: add histogram-design.rst
In reply to Daniel W. S. AlmeidaFrom: 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.
--- Documentation/trace/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/trace/index.rst +1 -0
@@ -19,6 +19,7 @@ Linux Tracing Technologies events-msr mmiotrace histogram + histogram-design boottime-trace hwlat_detector intel_th
Signature · 1 line
2.27.0
Re: [PATCH] docs: trace/index.rst: add histogram-design.rst
Quoted 19 lines · On Sat, 18 Jul 2020 13:51:06 -0300 "Daniel W. S. Almeida"…
From: Daniel W. S. Almeida <[email protected]>
Fix the following warning:
Documentation/trace/histogram-design.rst:
WARNING: document isn't included in any toctreeBy 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(+)Documentation/trace/index.rst +0
-0
Documentation/trace/index.rst Linux Tracing Technologies · line 23
Quoted 5 lines
Documentation/trace/index.rst +1
-0@@ -19,6 +19,7 @@ Linux Tracing Technologies events-msr mmiotrace histogram + histogram-design boottime-trace
Applied, thanks.
jon
A message that is not in the archive (sent off-list or not yet received): [email protected]
Andy Shevchenko
Acked-byRe: [PATCH] docs: core-api/printk-formats.rst: use literal block syntax
Quoted 8 lines · Daniel W. S. Almeida
From: Daniel W. S. Almeida <[email protected]>
Fix the following warning:
WARNING: Definition list ends without a blank line; unexpected unindent.
By switching to the literal block syntax.
Quoted 26 lines
Signed-off-by Daniel W. S. Almeida <[email protected]>--- Documentation/core-api/printk-formats.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)Documentation/core-api/printk-formats.rst +3
-1@@ -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.Signature · 1 line
2.27.0
Signature · 2 lines
With Best Regards, Andy Shevchenko
Sergey Senozhatsky
Acked-byRe: [PATCH] docs: core-api/printk-formats.rst: use literal block syntax
In reply to a message not in the archiveQuoted 8 lines · Daniel W. S. Almeida
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 <[email protected]>
-ss
Re: [PATCH] docs: core-api/printk-formats.rst: use literal block syntax
In reply to a message not in the archiveQuoted 10 lines · Daniel W. S. Almeida
From: Daniel W. S. Almeida <[email protected]>
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 <[email protected]>
Jonathan, will you route it via the Documentation tree or do you want it to land in the printk tree?
-ss
Jonathan Corbet
maintainerRe: [PATCH] docs: core-api/printk-formats.rst: use literal block syntax
Quoted 2 lines · On Tue, 21 Jul 2020 23:02:46 +0900 Sergey Senozhatsky…
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
Quoted 3 lines · Jonathan Corbet
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
In reply to a message not in the archiveQuoted 17 lines · On Sat, 18 Jul 2020 13:51:02 -0300 "Daniel W. S. Almeida"…
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 <[email protected]>--- Documentation/core-api/printk-formats.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)Documentation/core-api/printk-formats.rst +0
-0
Documentation/core-api/printk-formats.rst Time and date · line 502
Quoted 10 lines
Documentation/core-api/printk-formats.rst +3
-1@@ -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
A message that is not in the archive (sent off-list or not yet received): [email protected]
Jonathan Corbet
maintainerRe: [PATCH] docs: index.rst: Add watch_queue
Quoted 19 lines · On Sat, 18 Jul 2020 13:51:07 -0300 "Daniel W. S. Almeida"…
From: "Daniel W. S. Almeida" <[email protected]>
Fix the following sphinx warning:
Documentation/watch_queue.rst:
WARNING: document isn't included in any toctreeBy adding
watch_queue.rstto the index.Signed-off-by Daniel W. S. Almeida <[email protected]>--- Documentation/index.rst | 1 + 1 file changed, 1 insertion(+)Documentation/index.rst +0
-0
Documentation/index.rst to ReStructured Text format, or are simply too old. · line 196
Quoted 4 lines
Documentation/index.rst +1
-0@@ -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
A message that is not in the archive (sent off-list or not yet received): [email protected]
Re: [PATCH] docs: bpf/index.rst: Add ringbuf.rst
Quoted 21 lines · On Sat, 18 Jul 2020 13:51:04 -0300 "Daniel W. S. Almeida"…
From: Daniel W. S. Almeida <[email protected]>
Fix the following warning
Documentation/bpf/ringbuf.rst: WARNING: document isn't included in any toctreeBy adding it to the index.
Signed-off-by Daniel W. S. Almeida <[email protected]>--- Documentation/bpf/index.rst | 8 ++++++++ 1 file changed, 8 insertions(+)Documentation/bpf/index.rst +0
-0@@ -58,6 +58,14 @@ Testing and debugging BPF s390
Documentation/bpf/index.rst Testing and debugging BPF · line 69
Quoted 10 lines
Documentation/bpf/index.rst +8
-0+Other +===== + +.. toctree:: + :maxdepth: 1 + + ringbuf + .. Links:
Applied, thanks.
jon
Quoted 7 lines · On Sat, 18 Jul 2020 13:50:55 -0300 "Daniel W. S. Almeida"…
From: Daniel W. S. Almeida <[email protected]>
Fix the following warning:
WARNING: toctree contains reference to nonexistent document 'admin-guide/mm/nommu-map'
Quoted 6 lines
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
A message that is not in the archive (sent off-list or not yet received): [email protected]
Re: [PATCH] docs: bpf/bpf_devel_QA.rst: fix reference to nonexistent document
Quoted 17 lines · On Sat, 18 Jul 2020 13:51:00 -0300 "Daniel W. S. Almeida"…
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 <[email protected]>--- Documentation/bpf/bpf_devel_QA.rst | 1 + 1 file changed, 1 insertion(+)Documentation/bpf/bpf_devel_QA.rst +0
-0
Documentation/bpf/bpf_devel_QA.rst when: · line 646
Quoted 4 lines
Documentation/bpf/bpf_devel_QA.rst +1
-0@@ -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
A message that is not in the archive (sent off-list or not yet received): [email protected]
Jonathan Corbet
maintainerRe: [PATCH] docs: bpf/ringbuf.rst: fix reference to nonexistent document
Quoted 18 lines · On Sat, 18 Jul 2020 13:51:01 -0300 "Daniel W. S. Almeida"…
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 <[email protected]>--- Documentation/bpf/ringbuf.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)Documentation/bpf/ringbuf.rst +0
-0
Documentation/bpf/ringbuf.rst a self-pacing notifications of new data being availability. · line 204
Quoted 6 lines
Documentation/bpf/ringbuf.rst +1
-1@@ -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