mirror of
https://github.com/Fishwaldo/linux-bl808.git
synced 2025-06-06 22:55:11 +00:00
docs-rst: convert w1 book to ReST
Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab
parent
739aca06a2
commit
b4c1064a76
3 changed files with 71 additions and 101 deletions
|
|
@ -1,101 +0,0 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
||||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
|
|
||||||
|
|
||||||
<book id="w1id">
|
|
||||||
<bookinfo>
|
|
||||||
<title>W1: Dallas' 1-wire bus</title>
|
|
||||||
|
|
||||||
<authorgroup>
|
|
||||||
<author>
|
|
||||||
<firstname>David</firstname>
|
|
||||||
<surname>Fries</surname>
|
|
||||||
<affiliation>
|
|
||||||
<address>
|
|
||||||
<email>David@Fries.net</email>
|
|
||||||
</address>
|
|
||||||
</affiliation>
|
|
||||||
</author>
|
|
||||||
|
|
||||||
</authorgroup>
|
|
||||||
|
|
||||||
<copyright>
|
|
||||||
<year>2013</year>
|
|
||||||
<!--
|
|
||||||
<holder></holder>
|
|
||||||
-->
|
|
||||||
</copyright>
|
|
||||||
|
|
||||||
<legalnotice>
|
|
||||||
<para>
|
|
||||||
This documentation is free software; you can redistribute
|
|
||||||
it and/or modify it under the terms of the GNU General Public
|
|
||||||
License version 2.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
This program is distributed in the hope that it will be
|
|
||||||
useful, but WITHOUT ANY WARRANTY; without even the implied
|
|
||||||
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
||||||
For more details see the file COPYING in the source
|
|
||||||
distribution of Linux.
|
|
||||||
</para>
|
|
||||||
</legalnotice>
|
|
||||||
</bookinfo>
|
|
||||||
|
|
||||||
<toc></toc>
|
|
||||||
|
|
||||||
<chapter id="w1_internal">
|
|
||||||
<title>W1 API internal to the kernel</title>
|
|
||||||
|
|
||||||
<sect1 id="w1_internal_api">
|
|
||||||
<title>W1 API internal to the kernel</title>
|
|
||||||
<sect2 id="w1.h">
|
|
||||||
<title>drivers/w1/w1.h</title>
|
|
||||||
<para>W1 core functions.</para>
|
|
||||||
!Idrivers/w1/w1.h
|
|
||||||
</sect2>
|
|
||||||
|
|
||||||
<sect2 id="w1.c">
|
|
||||||
<title>drivers/w1/w1.c</title>
|
|
||||||
<para>W1 core functions.</para>
|
|
||||||
!Idrivers/w1/w1.c
|
|
||||||
</sect2>
|
|
||||||
|
|
||||||
<sect2 id="w1_family.h">
|
|
||||||
<title>drivers/w1/w1_family.h</title>
|
|
||||||
<para>Allows registering device family operations.</para>
|
|
||||||
!Idrivers/w1/w1_family.h
|
|
||||||
</sect2>
|
|
||||||
|
|
||||||
<sect2 id="w1_family.c">
|
|
||||||
<title>drivers/w1/w1_family.c</title>
|
|
||||||
<para>Allows registering device family operations.</para>
|
|
||||||
!Edrivers/w1/w1_family.c
|
|
||||||
</sect2>
|
|
||||||
|
|
||||||
<sect2 id="w1_int.c">
|
|
||||||
<title>drivers/w1/w1_int.c</title>
|
|
||||||
<para>W1 internal initialization for master devices.</para>
|
|
||||||
!Edrivers/w1/w1_int.c
|
|
||||||
</sect2>
|
|
||||||
|
|
||||||
<sect2 id="w1_netlink.h">
|
|
||||||
<title>drivers/w1/w1_netlink.h</title>
|
|
||||||
<para>W1 external netlink API structures and commands.</para>
|
|
||||||
!Idrivers/w1/w1_netlink.h
|
|
||||||
</sect2>
|
|
||||||
|
|
||||||
<sect2 id="w1_io.c">
|
|
||||||
<title>drivers/w1/w1_io.c</title>
|
|
||||||
<para>W1 input/output.</para>
|
|
||||||
!Edrivers/w1/w1_io.c
|
|
||||||
!Idrivers/w1/w1_io.c
|
|
||||||
</sect2>
|
|
||||||
|
|
||||||
</sect1>
|
|
||||||
|
|
||||||
|
|
||||||
</chapter>
|
|
||||||
|
|
||||||
</book>
|
|
||||||
|
|
@ -35,6 +35,7 @@ available subsections can be seen below.
|
||||||
scsi
|
scsi
|
||||||
libata
|
libata
|
||||||
miscellaneous
|
miscellaneous
|
||||||
|
w1
|
||||||
s390-drivers
|
s390-drivers
|
||||||
vme
|
vme
|
||||||
80211/index
|
80211/index
|
||||||
|
|
|
||||||
70
Documentation/driver-api/w1.rst
Normal file
70
Documentation/driver-api/w1.rst
Normal file
|
|
@ -0,0 +1,70 @@
|
||||||
|
======================
|
||||||
|
W1: Dallas' 1-wire bus
|
||||||
|
======================
|
||||||
|
|
||||||
|
:Author: David Fries
|
||||||
|
|
||||||
|
W1 API internal to the kernel
|
||||||
|
=============================
|
||||||
|
|
||||||
|
W1 API internal to the kernel
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
drivers/w1/w1.h
|
||||||
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
W1 core functions.
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/w1/w1.h
|
||||||
|
:internal:
|
||||||
|
|
||||||
|
drivers/w1/w1.c
|
||||||
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
W1 core functions.
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/w1/w1.c
|
||||||
|
:internal:
|
||||||
|
|
||||||
|
drivers/w1/w1_family.h
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Allows registering device family operations.
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/w1/w1_family.h
|
||||||
|
:internal:
|
||||||
|
|
||||||
|
drivers/w1/w1_family.c
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Allows registering device family operations.
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/w1/w1_family.c
|
||||||
|
:export:
|
||||||
|
|
||||||
|
drivers/w1/w1_int.c
|
||||||
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
W1 internal initialization for master devices.
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/w1/w1_int.c
|
||||||
|
:export:
|
||||||
|
|
||||||
|
drivers/w1/w1_netlink.h
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
W1 external netlink API structures and commands.
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/w1/w1_netlink.h
|
||||||
|
:internal:
|
||||||
|
|
||||||
|
drivers/w1/w1_io.c
|
||||||
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
W1 input/output.
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/w1/w1_io.c
|
||||||
|
:export:
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/w1/w1_io.c
|
||||||
|
:internal:
|
||||||
Loading…
Add table
Reference in a new issue