Commit 98913408 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Greg Kroah-Hartman
Browse files

docs: ABI: stable: make files ReST compatible 



Several entries at the stable ABI files won't parse if we pass
them directly to the ReST output.

Adjust them, in order to allow adding their contents as-is at
the stable ABI book.

Acked-by: default avatarSrinivas Kandagatla <srinivas.kandagatla@linaro.org>
Acked-by: default avatarJonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/467a0dfbcdf00db710a629d3fe4a2563750339d8.1604042072.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent c7e45ea4

Documentation/ABI/stable/firewire-cdev

+4 −0
Original line number Diff line number Diff line
@@ -14,12 +14,14 @@ Description: 
		Each /dev/fw* is associated with one IEEE 1394 node, which can

		be remote or local nodes.  Operations on a /dev/fw* file have

		different scope:



		  - The 1394 node which is associated with the file:

			  - Asynchronous request transmission

			  - Get the Configuration ROM

			  - Query node ID

			  - Query maximum speed of the path between this node

			    and local node



		  - The 1394 bus (i.e. "card") to which the node is attached to:

			  - Isochronous stream transmission and reception

			  - Asynchronous stream transmission and reception
@@ -31,6 +33,7 @@ Description: 
			    manager

			  - Query cycle time

			  - Bus reset initiation, bus reset event reception



		  - All 1394 buses:

			  - Allocation of IEEE 1212 address ranges on the local

			    link layers, reception of inbound requests to such
@@ -43,6 +46,7 @@ Description: 
		userland implement different access permission models, some

		operations are restricted to /dev/fw* files that are associated

		with a local node:



			  - Addition of descriptors or directories to the local

			    nodes' Configuration ROM

			  - PHY packet transmission and reception

Documentation/ABI/stable/sysfs-acpi-pmprofile

+13 −9
Original line number Diff line number Diff line
@@ -6,11 +6,14 @@ Description: The ACPI pm_profile sysfs interface exports the platform 
		power management (and performance) requirement expectations

		as provided by BIOS. The integer value is directly passed as

		retrieved from the FADT ACPI table.



Values:	        For possible values see ACPI specification:

		5.2.9 Fixed ACPI Description Table (FADT)

		Field: Preferred_PM_Profile



		Currently these values are defined by spec:



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

		0  Unspecified

		1  Desktop

		2  Mobile
@@ -20,3 +23,4 @@ Values: For possible values see ACPI specification: 
		6  Appliance PC

		7  Performance Server

		>7 Reserved

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

Documentation/ABI/stable/sysfs-bus-firewire

+3 −0
Original line number Diff line number Diff line
@@ -47,6 +47,7 @@ Description: 
		IEEE 1394 node device attribute.

		Read-only and immutable.

Values:		1: The sysfs entry represents a local node (a controller card).



		0: The sysfs entry represents a remote node.
@@ -125,7 +126,9 @@ Description: 
		Read-only attribute, immutable during the target's lifetime.

		Format, as exposed by firewire-sbp2 since 2.6.22, May 2007:

		Colon-separated hexadecimal string representations of



			u64 EUI-64 : u24 directory_ID : u16 LUN



		without 0x prefixes, without whitespace.  The former sbp2 driver

		(removed in 2.6.37 after being superseded by firewire-sbp2) used

		a somewhat shorter format which was not as close to SAM.

Documentation/ABI/stable/sysfs-bus-nvmem

+10 −9
Original line number Diff line number Diff line
@@ -9,7 +9,8 @@ Description: 
		Note: This file is only present if CONFIG_NVMEM_SYSFS

		is enabled



		ex:

		ex::



		  hexdump /sys/bus/nvmem/devices/qfprom0/nvmem



		  0000000 0000 0000 0000 0000 0000 0000 0000 0000

Documentation/ABI/stable/sysfs-bus-usb

+4 −2
Original line number Diff line number Diff line
@@ -50,8 +50,10 @@ Description: 


		Tools can use this file and the connected_duration file to

		compute the percentage of time that a device has been active.

		For example,

		For example::



		  echo $((100 * `cat active_duration` / `cat connected_duration`))



		will give an integer percentage.  Note that this does not

		account for counter wrap.

Users:

CRA Git | Maintained and supported by SUSTech CRA and CCSE