Commit e9bb6275 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

docs: w1: convert to ReST and add to the kAPI group of docs 



The 1wire documentation was written with w1 developers in
mind, so, it makes sense to add it together with the driver-api
set.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent f139291c

Documentation/ABI/stable/sysfs-bus-w1

+1 −1
Original line number Diff line number Diff line
@@ -6,6 +6,6 @@ Description: Bus scanning interval, microseconds component. 
		control systems are attached/generate presence for as short as

		100 ms - hence the tens-to-hundreds milliseconds scan intervals

		are required.

		see Documentation/w1/w1.generic for detailed information.

		see Documentation/w1/w1-generic.rst for detailed information.

Users:		any user space application which wants to know bus scanning

		interval

Documentation/ABI/stable/sysfs-driver-w1_ds28e04

+2 −2
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ What: /sys/bus/w1/devices/.../pio 
Date:		May 2012

Contact:	Markus Franke <franm@hrz.tu-chemnitz.de>

Description:	read/write the contents of the two PIO's of the DS28E04-100

		see Documentation/w1/slaves/w1_ds28e04 for detailed information

		see Documentation/w1/slaves/w1_ds28e04.rst for detailed information

Users:		any user space application which wants to communicate with DS28E04-100
@@ -11,5 +11,5 @@ What: /sys/bus/w1/devices/.../eeprom 
Date:		May 2012

Contact:	Markus Franke <franm@hrz.tu-chemnitz.de>

Description:	read/write the contents of the EEPROM memory of the DS28E04-100

		see Documentation/w1/slaves/w1_ds28e04 for detailed information

		see Documentation/w1/slaves/w1_ds28e04.rst for detailed information

Users:		any user space application which wants to communicate with DS28E04-100

Documentation/ABI/stable/sysfs-driver-w1_ds28ea00

+1 −1
Original line number Diff line number Diff line
@@ -2,5 +2,5 @@ What: /sys/bus/w1/devices/.../w1_seq 
Date:		Apr 2015

Contact:	Matt Campbell <mattrcampbell@gmail.com>

Description:	Support for the DS28EA00 chain sequence function

		see Documentation/w1/slaves/w1_therm for detailed information

		see Documentation/w1/slaves/w1_therm.rst for detailed information

Users:		any user space application which wants to communicate with DS28EA00

Documentation/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -117,6 +117,7 @@ needed). 
   target/index

   timers/index

   spi/index

   w1/index

   watchdog/index

   virtual/index

   input/index

Documentation/w1/index.rst

0 → 100644
+21 −0
Original line number Diff line number Diff line 
. SPDX-License-Identifier: GPL-2.0



================

1-Wire Subsystem

================



.. toctree::

   :maxdepth: 1





   w1-generic.rst

   w1-netlink.rst

   masters/index

   slaves/index



.. only::  subproject and html



   Indices

   =======



   * :ref:`genindex`

CRA Git | Maintained and supported by SUSTech CRA and CCSE