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

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: 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