* [PATCH] docs: kernel-docs: Remove "Here is its" at the end of lines
@ 2020-02-28 20:41 Jonathan Neuschäfer
2020-03-02 19:53 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: Jonathan Neuschäfer @ 2020-02-28 20:41 UTC (permalink / raw
To: linux-doc; +Cc: Jonathan Neuschäfer, Jonathan Corbet, linux-kernel
Before commit 9e03ea7f683e ("Documentation/kernel-docs.txt: convert it
to ReST markup"), it read:
Description: Linux Journal Kernel Korner article. Here is its
abstract: "..."
In Sphinx' HTML formatting, however, the "Here is its" doesn't make
sense anymore, because the "Abstract:" is clearly separated.
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
Documentation/process/kernel-docs.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/Documentation/process/kernel-docs.rst b/Documentation/process/kernel-docs.rst
index 7a45a8e36ea7..9d6d0ac4fca9 100644
--- a/Documentation/process/kernel-docs.rst
+++ b/Documentation/process/kernel-docs.rst
@@ -313,7 +313,7 @@ On-line docs
:URL: http://www.linuxjournal.com/article.php?sid=2391
:Date: 1997
:Keywords: RAID, MD driver.
- :Description: Linux Journal Kernel Korner article. Here is its
+ :Description: Linux Journal Kernel Korner article.
:Abstract: *A description of the implementation of the RAID-1,
RAID-4 and RAID-5 personalities of the MD device driver in the
Linux kernel, providing users with high performance and reliable,
@@ -338,7 +338,7 @@ On-line docs
:Date: 1996
:Keywords: device driver, module, loading/unloading modules,
allocating resources.
- :Description: Linux Journal Kernel Korner article. Here is its
+ :Description: Linux Journal Kernel Korner article.
:Abstract: *This is the first of a series of four articles
co-authored by Alessandro Rubini and Georg Zezchwitz which present
a practical approach to writing Linux device drivers as kernel
@@ -354,7 +354,7 @@ On-line docs
:Keywords: character driver, init_module, clean_up module,
autodetection, mayor number, minor number, file operations,
open(), close().
- :Description: Linux Journal Kernel Korner article. Here is its
+ :Description: Linux Journal Kernel Korner article.
:Abstract: *This article, the second of four, introduces part of
the actual code to create custom module implementing a character
device driver. It describes the code for module initialization and
@@ -367,7 +367,7 @@ On-line docs
:Date: 1996
:Keywords: read(), write(), select(), ioctl(), blocking/non
blocking mode, interrupt handler.
- :Description: Linux Journal Kernel Korner article. Here is its
+ :Description: Linux Journal Kernel Korner article.
:Abstract: *This article, the third of four on writing character
device drivers, introduces concepts of reading, writing, and using
ioctl-calls*.
@@ -378,7 +378,7 @@ On-line docs
:URL: http://www.linuxjournal.com/article.php?sid=1222
:Date: 1996
:Keywords: interrupts, irqs, DMA, bottom halves, task queues.
- :Description: Linux Journal Kernel Korner article. Here is its
+ :Description: Linux Journal Kernel Korner article.
:Abstract: *This is the fourth in a series of articles about
writing character device drivers as loadable kernel modules. This
month, we further investigate the field of interrupt handling.
--
2.20.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] docs: kernel-docs: Remove "Here is its" at the end of lines
2020-02-28 20:41 [PATCH] docs: kernel-docs: Remove "Here is its" at the end of lines Jonathan Neuschäfer
@ 2020-03-02 19:53 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2020-03-02 19:53 UTC (permalink / raw
To: Jonathan Neuschäfer; +Cc: linux-doc, linux-kernel
On Fri, 28 Feb 2020 21:41:45 +0100
Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote:
> Before commit 9e03ea7f683e ("Documentation/kernel-docs.txt: convert it
> to ReST markup"), it read:
>
> Description: Linux Journal Kernel Korner article. Here is its
> abstract: "..."
>
> In Sphinx' HTML formatting, however, the "Here is its" doesn't make
> sense anymore, because the "Abstract:" is clearly separated.
>
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
I wonder about the value of this file, but while it exists it might as
well make sense. So applied, thanks.
jon
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-03-02 19:53 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-02-28 20:41 [PATCH] docs: kernel-docs: Remove "Here is its" at the end of lines Jonathan Neuschäfer
2020-03-02 19:53 ` Jonathan Corbet
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.