linux-toradex.git/Documentation/process/kernel-docs.rst, branch v5.11-rc6

Documentation: fix typos in process/kernel-docs.rst

2020-12-03T22:54:17+00:00

Fix two typos in kernel-docs.rst

Signed-off-by: Andrew Klychkov 
Acked-by: Randy Dunlap 
Link: https://lore.kernel.org/r/20201202074938.GA35075@spblnx124.lan
Signed-off-by: Jonathan Corbet

Replace HTTP links with HTTPS ones: Documentation/process

2020-06-26T17:19:43+00:00

Rationale:
Reduces attack surface on kernel devs opening the links for MITM
as HTTPS traffic is much harder to manipulate.

Deterministic algorithm:
For each file:
  If not .svg:
    For each line:
      If doesn't contain `\bxmlns\b`:
        For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`:
          If both the HTTP and HTTPS versions
          return 200 OK and serve the same content:
            Replace HTTP with HTTPS.

Signed-off-by: Alexander A. Klimov 
Acked-by: Miguel Ojeda 
Link: https://lore.kernel.org/r/20200621133630.46435-1-grandmaster@al2klimov.de
Signed-off-by: Jonathan Corbet

docs: kernel-docs: Remove "Here is its" at the end of lines

2020-03-02T19:52:24+00:00

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 
Link: https://lore.kernel.org/r/20200228204147.8622-1-j.neuschaefer@gmx.net
Signed-off-by: Jonathan Corbet

Documentation: kernel-docs: Remove entry for vfs.txt

2019-04-08T22:05:18+00:00

It's unnecessary to point to an external mirror of the Documentation
directory.

Jonathan Corbet writes in favor of removing this entry, instead of
moving it under "Docs at the Linux Kernel tree":

> We don't want to turn kernel-docs.rst into yet another out-of-date
> index for the rest of Documentation/, and the removal of the external
> URL takes away the only bit of additional information that this entry
> offers.

Signed-off-by: Jonathan Neuschäfer 
Signed-off-by: Jonathan Corbet

doc: Change LXR references to elixir.bootlin.com

2019-02-01T23:05:03+00:00

Recently, Free Electrons was renamed to Bootlin[1]. Less recently, the
Linux Cross Reference (LXR) at lxr.free-electrons.com was replaced by
Elixir[2], and lxr.free-electrons.com redirected first to
elixir.free-electrons.com and now to elixir.bootlin.com.

[1]: https://bootlin.com/blog/free-electrons-becomes-bootlin/
[2]: https://github.com/free-electrons/elixir

Signed-off-by: Jonathan Neuschäfer 
Reviewed-by: Martin Kepplinger 
Acked-by: Federico Vaga 
Signed-off-by: Jonathan Corbet

Fix broken link in Documentation/process/kernel-docs.rst

2018-02-01T19:08:18+00:00

Kernel Glossary has moved from /Glossary to /KernelGlossary
on kernelnewbies.org. This patch corrects this link.

Signed-off-by: Grigory Shipunov 
Signed-off-by: Jonathan Corbet

docs: update old references for DocBook from the documentation

2017-05-16T11:44:19+00:00

DocBook is mentioned several times at the documentation. Update
the obsolete references from it at the DocBook.

Acked-by: SeongJae Park 
Signed-off-by: Mauro Carvalho Chehab

docs-rst: add documents to development-process

2016-10-24T10:12:35+00:00

Add several documents to the development-process ReST book.

As we don't want renames, use symlinks instead, keeping those
documents on their original place.

Acked-by: Greg Kroah-Hartman 
Signed-off-by: Mauro Carvalho Chehab