[PATCH 0/1] docs: fix kernel-driver-statement rendering

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Dear Documentation maintainers,

while browsing the "Kernel driver statement" page on kernel.org [1],
I noticed the name list was split after "J. Bruce Fields" with some extra line
spacing.

The rendered html source shows that the `J.` is interpreted as list item in
`ReST` syntax.

I propose a patch to remove this rendering issue with an escape string
before to still allow doing `git grep` for the name.
I still adds rst only clutters the text though.

I checked the rendered HTML and PDF for both the English and translated
versions to verify it was fixed.
On my local runs the HTML had extra `<p>` tags compared to the webpage so
not sure what was different in the environment.


I found other pages having the same type of issues by grepping the output
for "upperalpha" and checking the inappropriate occurrences.
If it is a class of fixes that is wanted, I could propose other patchsets with
a batch of them.
It may be a good thing to then add the information to a general how to write
documentation document to try preventing it from reappearing.
I would wait for feedback before doing these.


Please keep me in CC as I am not registered on the list.


1: https://www.kernel.org/doc/html/v5.8/process/kernel-driver-statement.html

Best Regards,
Gaëtan Harter


Gaëtan Harter (1):
  docs: fix kernel-driver-statement rendering

 Documentation/process/kernel-driver-statement.rst               | 2 +-
 .../translations/it_IT/process/kernel-driver-statement.rst      | 2 +-
 .../translations/zh_CN/process/kernel-driver-statement.rst      | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)


base-commit: 9f35cf8bd7e3347b0679c3f9b5e0bc5493925a1f
-- 
2.28.0




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux