Skip to content

Commit 9891340

Browse files
mchehabgregkh
authored andcommitted
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: Srinivas Kandagatla <srinivas.kandagatla@linaro.org> Acked-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/467a0dfbcdf00db710a629d3fe4a2563750339d8.1604042072.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
1 parent c7e45ea commit 9891340

16 files changed

Lines changed: 179 additions & 103 deletions

Documentation/ABI/stable/firewire-cdev

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,14 @@ Description:
1414
Each /dev/fw* is associated with one IEEE 1394 node, which can
1515
be remote or local nodes. Operations on a /dev/fw* file have
1616
different scope:
17+
1718
- The 1394 node which is associated with the file:
1819
- Asynchronous request transmission
1920
- Get the Configuration ROM
2021
- Query node ID
2122
- Query maximum speed of the path between this node
2223
and local node
24+
2325
- The 1394 bus (i.e. "card") to which the node is attached to:
2426
- Isochronous stream transmission and reception
2527
- Asynchronous stream transmission and reception
@@ -31,6 +33,7 @@ Description:
3133
manager
3234
- Query cycle time
3335
- Bus reset initiation, bus reset event reception
36+
3437
- All 1394 buses:
3538
- Allocation of IEEE 1212 address ranges on the local
3639
link layers, reception of inbound requests to such
@@ -43,6 +46,7 @@ Description:
4346
userland implement different access permission models, some
4447
operations are restricted to /dev/fw* files that are associated
4548
with a local node:
49+
4650
- Addition of descriptors or directories to the local
4751
nodes' Configuration ROM
4852
- PHY packet transmission and reception

Documentation/ABI/stable/sysfs-acpi-pmprofile

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,21 @@ Description: The ACPI pm_profile sysfs interface exports the platform
66
power management (and performance) requirement expectations
77
as provided by BIOS. The integer value is directly passed as
88
retrieved from the FADT ACPI table.
9-
Values: For possible values see ACPI specification:
9+
10+
Values: For possible values see ACPI specification:
1011
5.2.9 Fixed ACPI Description Table (FADT)
1112
Field: Preferred_PM_Profile
1213

1314
Currently these values are defined by spec:
14-
0 Unspecified
15-
1 Desktop
16-
2 Mobile
17-
3 Workstation
18-
4 Enterprise Server
19-
5 SOHO Server
20-
6 Appliance PC
21-
7 Performance Server
15+
16+
== =================
17+
0 Unspecified
18+
1 Desktop
19+
2 Mobile
20+
3 Workstation
21+
4 Enterprise Server
22+
5 SOHO Server
23+
6 Appliance PC
24+
7 Performance Server
2225
>7 Reserved
26+
== =================

Documentation/ABI/stable/sysfs-bus-firewire

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Description:
4747
IEEE 1394 node device attribute.
4848
Read-only and immutable.
4949
Values: 1: The sysfs entry represents a local node (a controller card).
50+
5051
0: The sysfs entry represents a remote node.
5152

5253

@@ -125,7 +126,9 @@ Description:
125126
Read-only attribute, immutable during the target's lifetime.
126127
Format, as exposed by firewire-sbp2 since 2.6.22, May 2007:
127128
Colon-separated hexadecimal string representations of
129+
128130
u64 EUI-64 : u24 directory_ID : u16 LUN
131+
129132
without 0x prefixes, without whitespace. The former sbp2 driver
130133
(removed in 2.6.37 after being superseded by firewire-sbp2) used
131134
a somewhat shorter format which was not as close to SAM.

Documentation/ABI/stable/sysfs-bus-nvmem

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,14 @@ Description:
99
Note: This file is only present if CONFIG_NVMEM_SYSFS
1010
is enabled
1111

12-
ex:
13-
hexdump /sys/bus/nvmem/devices/qfprom0/nvmem
12+
ex::
1413

15-
0000000 0000 0000 0000 0000 0000 0000 0000 0000
16-
*
17-
00000a0 db10 2240 0000 e000 0c00 0c00 0000 0c00
18-
0000000 0000 0000 0000 0000 0000 0000 0000 0000
19-
...
20-
*
21-
0001000
14+
hexdump /sys/bus/nvmem/devices/qfprom0/nvmem
15+
16+
0000000 0000 0000 0000 0000 0000 0000 0000 0000
17+
*
18+
00000a0 db10 2240 0000 e000 0c00 0c00 0000 0c00
19+
0000000 0000 0000 0000 0000 0000 0000 0000 0000
20+
...
21+
*
22+
0001000

Documentation/ABI/stable/sysfs-bus-usb

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,10 @@ Description:
5050

5151
Tools can use this file and the connected_duration file to
5252
compute the percentage of time that a device has been active.
53-
For example,
54-
echo $((100 * `cat active_duration` / `cat connected_duration`))
53+
For example::
54+
55+
echo $((100 * `cat active_duration` / `cat connected_duration`))
56+
5557
will give an integer percentage. Note that this does not
5658
account for counter wrap.
5759
Users:

Documentation/ABI/stable/sysfs-class-backlight

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ KernelVersion: 2.6.12
44
Contact: Richard Purdie <rpurdie@rpsys.net>
55
Description:
66
Control BACKLIGHT power, values are FB_BLANK_* from fb.h
7+
78
- FB_BLANK_UNBLANK (0) : power on.
89
- FB_BLANK_POWERDOWN (4) : power off
910
Users: HAL

0 commit comments

Comments
 (0)