summaryrefslogtreecommitdiffstats
path: root/drivers/rapidio
diff options
context:
space:
mode:
authorMauro Carvalho Chehab2019-04-18 16:38:26 +0200
committerMauro Carvalho Chehab2019-07-15 14:20:26 +0200
commit5c04dceaa152d9dd9fe94dec6594965069e19e9e (patch)
tree7ffe8164c81596ad04a913e9da22f1cedb88d9e3 /drivers/rapidio
parentdocs: ioctl-number.txt: convert it to ReST format (diff)
downloadkernel-qcow2-linux-5c04dceaa152d9dd9fe94dec6594965069e19e9e.tar.gz
kernel-qcow2-linux-5c04dceaa152d9dd9fe94dec6594965069e19e9e.tar.xz
kernel-qcow2-linux-5c04dceaa152d9dd9fe94dec6594965069e19e9e.zip
docs: ioctl: convert to ReST
Rename the iio documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. The cdrom.txt and hdio.txt have their own particular syntax. In order to speedup the conversion, I used a small ancillary perl script: my $d; $d .= $_ while(<>); $d =~ s/(\nCDROM\S+)\s+(\w[^\n]*)/$1\n\t$2\n/g; $d =~ s/(\nHDIO\S+)\s+(\w[^\n]*)/$1\n\t$2\n/g; $d =~ s/(\n\s*usage:)[\s\n]*(\w[^\n]*)/$1:\n\n\t $2\n/g; $d =~ s/(\n\s*)(E\w+[\s\n]*\w[^\n]*)/$1- $2/g; $d =~ s/(\n\s*)(inputs|outputs|notes):\s*(\w[^\n]*)/$1$2:\n\t\t$3\n/g; print $d; It basically add blank lines on a few interesting places. The script is not perfect: still several things require manual work, but it saved quite some time doing some obvious stuff. 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>
Diffstat (limited to 'drivers/rapidio')
0 files changed, 0 insertions, 0 deletions