Skip to content

Commit 906e4af

Browse files
mchehabgregkh
authored andcommitted
docs: ABI: sysfs-uevent: make it compatible with ReST output
- Replace " by ``, in order to use monospaced fonts; - mark literal blocks as such. Acked-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/63904cc9b6a8581c5fc2ea1dca5d925874c67372.1604042072.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
1 parent 3443333 commit 906e4af

1 file changed

Lines changed: 16 additions & 12 deletions

File tree

Documentation/ABI/testing/sysfs-uevent

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,42 +6,46 @@ Description:
66
Enable passing additional variables for synthetic uevents that
77
are generated by writing /sys/.../uevent file.
88

9-
Recognized extended format is ACTION [UUID [KEY=VALUE ...].
9+
Recognized extended format is::
1010

11-
The ACTION is compulsory - it is the name of the uevent action
12-
("add", "change", "remove"). There is no change compared to
13-
previous functionality here. The rest of the extended format
14-
is optional.
11+
ACTION [UUID [KEY=VALUE ...]
12+
13+
The ACTION is compulsory - it is the name of the uevent
14+
action (``add``, ``change``, ``remove``). There is no change
15+
compared to previous functionality here. The rest of the
16+
extended format is optional.
1517

1618
You need to pass UUID first before any KEY=VALUE pairs.
17-
The UUID must be in "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
19+
The UUID must be in ``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``
1820
format where 'x' is a hex digit. The UUID is considered to be
1921
a transaction identifier so it's possible to use the same UUID
2022
value for one or more synthetic uevents in which case we
2123
logically group these uevents together for any userspace
2224
listeners. The UUID value appears in uevent as
23-
"SYNTH_UUID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" environment
25+
``SYNTH_UUID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`` environment
2426
variable.
2527

2628
If UUID is not passed in, the generated synthetic uevent gains
27-
"SYNTH_UUID=0" environment variable automatically.
29+
``SYNTH_UUID=0`` environment variable automatically.
2830

2931
The KEY=VALUE pairs can contain alphanumeric characters only.
32+
3033
It's possible to define zero or more pairs - each pair is then
3134
delimited by a space character ' '. Each pair appears in
32-
synthetic uevent as "SYNTH_ARG_KEY=VALUE". That means the KEY
33-
name gains "SYNTH_ARG_" prefix to avoid possible collisions
35+
synthetic uevent as ``SYNTH_ARG_KEY=VALUE``. That means the KEY
36+
name gains ``SYNTH_ARG_`` prefix to avoid possible collisions
3437
with existing variables.
3538

36-
Example of valid sequence written to the uevent file:
39+
Example of valid sequence written to the uevent file::
3740

3841
add fe4d7c9d-b8c6-4a70-9ef1-3d8a58d18eed A=1 B=abc
3942

40-
This generates synthetic uevent including these variables:
43+
This generates synthetic uevent including these variables::
4144

4245
ACTION=add
4346
SYNTH_ARG_A=1
4447
SYNTH_ARG_B=abc
4548
SYNTH_UUID=fe4d7c9d-b8c6-4a70-9ef1-3d8a58d18eed
49+
4650
Users:
4751
udev, userspace tools generating synthetic uevents

0 commit comments

Comments
 (0)