bianbu-repo-mirror/bianbu-linux-6.6-fh
1
0
Fork 0
mirror of https://gitee.com/bianbu-linux/linux-6.6-fh synced 2025-04-25 23:47:06 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source 
Convert the TCM docs to ReST format and add them to the
bookset.

This has a mix of userspace-faced and Kernelspace faced
docs. Still, it sounds a better candidate to be added at
the kernel API set of docs.

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 <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2019-06-12 14:52:59 -03:00 • committed by Jonathan Corbet
parent bdf3a950fb
commit 4ca9bc225e
6 changed files with 325 additions and 267 deletions
Download patch file Download diff file Expand all files Collapse all files

2
scripts/documentation-file-ref-check
View file

@ -124,7 +124,7 @@ while (<IN>) {
# Remove sched-pelt false-positive
next if ($fulref =~ m,^Documentation/scheduler/sched-pelt$,);
# Discard some build examples from Documentation/target/tcm_mod_builder.txt
# Discard some build examples from Documentation/target/tcm_mod_builder.rst
next if ($fulref =~ m,mnt/sdb/lio-core-2.6.git/Documentation/target,);
# Check if exists, evaluating wildcards