linux-toradex.git/Documentation/kernel-hacking/locking.rst, branch v5.7-rc6

docs: locking: Drop :c:func: throughout

2020-03-20T23:16:24+00:00

The kernel doc tooling knows how to do this itself so drop this markup
throughout this file to simplify.

Suggested-by: Jonathan Corbet 
Signed-off-by: Stephen Boyd 
Link: https://lore.kernel.org/r/20200318174133.160206-3-swboyd@chromium.org
Signed-off-by: Jonathan Corbet

docs: locking: Add 'need' to hardirq section

2020-03-20T23:16:19+00:00

Add the missing word to make this sentence read properly.

Signed-off-by: Stephen Boyd 
Link: https://lore.kernel.org/r/20200318174133.160206-2-swboyd@chromium.org
Signed-off-by: Jonathan Corbet

docs: locking: convert docs to ReST and rename to *.rst

2019-07-15T11:53:27+00:00

Convert the locking documents to ReST and add them to the
kernel development book where it belongs.

Most of the stuff here is just to make Sphinx to properly
parse the text file, as they're already in good shape,
not requiring massive changes in order to be parsed.

The conversion is actually:
  - add blank lines and identation in order to identify paragraphs;
  - fix tables markups;
  - add some lists markups;
  - mark literal blocks;
  - adjust title markups.

At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.

Signed-off-by: Mauro Carvalho Chehab 
Acked-by: Federico Vaga

docs: stop suggesting strlcpy

2019-06-20T20:08:49+00:00

Since strlcpy is deprecated, the documentation shouldn't suggest using
it. This patch fixes the examples to use strscpy instead. It also uses
sizeof instead of underlying constants as far as possible, to simplify
future changes to the corresponding data structures.

Signed-off-by: Stephen Kitt 
Acked-by: Kees Cook 
Acked-by: Federico Vaga 
Signed-off-by: Jonathan Corbet

doc:it_IT: translation for kernel-hacking

2018-07-26T22:21:09+00:00

This patch includes the kernel-hacking translation in Italian (both
hacking.rst and locking.rst).

It adds also the anchors for the english kernel-hacking documents.

Signed-off-by: Federico Vaga 
Signed-off-by: Jonathan Corbet

docs: Fix the reference labels in Locking.rst

2018-07-26T22:17:55+00:00

Two jump tags were misspelled, leading to non-working cross-reference
links.

Reported-by: Federico Vaga 
Signed-off-by: Jonathan Corbet

locking.rst: Update some ReST markups

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

Correct a few minor issues with ReST notation used on
this file (produced by an automatic tool).

Signed-off-by: Mauro Carvalho Chehab

locking.rst: add captions to two tables

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

Those tables have a "caption" at the end, but ReST
actually expects it on a different way.

Signed-off-by: Mauro Carvalho Chehab

locking.rst: reformat locking table

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

Use a different markup for this table, in order to make it
smaller when seeing in text mode.

Signed-off-by: Mauro Carvalho Chehab

docs-rst: convert kernel-locking to ReST

2017-05-16T11:00:58+00:00

Use pandoc to convert documentation to ReST by calling
Documentation/sphinx/tmplcvt script.

- Manually adjust tables with got broken by conversion

Signed-off-by: Mauro Carvalho Chehab