From: Mark O'Donovan <shiftee@posteo.net>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, Mark O'Donovan <shiftee@posteo.net>
Subject: [PATCH] Documentation: Add leading slash to some paths
Date: Tue, 2 Mar 2021 20:25:40 +0000 [thread overview]
Message-ID: <20210302202539.103853-1-shiftee@posteo.net> (raw)
Change multiple sys/xyz to /sys/xyz
Signed-off-by: Mark O'Donovan <shiftee@posteo.net>
---
Documentation/admin-guide/mm/numaperf.rst | 2 +-
Documentation/fb/fbcon.rst | 4 ++--
Documentation/hid/intel-ish-hid.rst | 2 +-
Documentation/leds/leds-lm3556.rst | 28 +++++++++++------------
4 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/Documentation/admin-guide/mm/numaperf.rst b/Documentation/admin-guide/mm/numaperf.rst
index c2f826409bf0..166697325947 100644
--- a/Documentation/admin-guide/mm/numaperf.rst
+++ b/Documentation/admin-guide/mm/numaperf.rst
@@ -151,7 +151,7 @@ Each cache level's directory provides its attributes. For example, the
following shows a single cache level and the attributes available for
software to query::
- # tree sys/devices/system/node/node0/memory_side_cache/
+ # tree /sys/devices/system/node/node0/memory_side_cache/
/sys/devices/system/node/node0/memory_side_cache/
|-- index1
| |-- indexing
diff --git a/Documentation/fb/fbcon.rst b/Documentation/fb/fbcon.rst
index 57f66de2f7e1..212f7003cfba 100644
--- a/Documentation/fb/fbcon.rst
+++ b/Documentation/fb/fbcon.rst
@@ -207,9 +207,9 @@ Documentation/driver-api/console.rst. To summarize:
Echo a value to the bind file that represents the framebuffer console
driver. So assuming vtcon1 represents fbcon, then::
- echo 1 > sys/class/vtconsole/vtcon1/bind - attach framebuffer console to
+ echo 1 > /sys/class/vtconsole/vtcon1/bind - attach framebuffer console to
console layer
- echo 0 > sys/class/vtconsole/vtcon1/bind - detach framebuffer console from
+ echo 0 > /sys/class/vtconsole/vtcon1/bind - detach framebuffer console from
console layer
If fbcon is detached from the console layer, your boot console driver (which is
diff --git a/Documentation/hid/intel-ish-hid.rst b/Documentation/hid/intel-ish-hid.rst
index f6ce44ff611d..7a851252267a 100644
--- a/Documentation/hid/intel-ish-hid.rst
+++ b/Documentation/hid/intel-ish-hid.rst
@@ -345,7 +345,7 @@ Documentation/ABI/testing/sysfs-bus-iio for IIO ABIs to user space.
To debug ISH, event tracing mechanism is used. To enable debug logs::
echo 1 > /sys/kernel/debug/tracing/events/intel_ish/enable
- cat sys/kernel/debug/tracing/trace
+ cat /sys/kernel/debug/tracing/trace
3.8 ISH IIO sysfs Example on Lenovo thinkpad Yoga 260
-----------------------------------------------------
diff --git a/Documentation/leds/leds-lm3556.rst b/Documentation/leds/leds-lm3556.rst
index 1ef17d7d800e..32e3983473ba 100644
--- a/Documentation/leds/leds-lm3556.rst
+++ b/Documentation/leds/leds-lm3556.rst
@@ -23,7 +23,7 @@ from 93.75 mA to 1500 mA.The Flash currents are adjusted via the CURRENT
CONTROL REGISTER(0x09).Flash mode is activated by the ENABLE REGISTER(0x0A),
or by pulling the STROBE pin HIGH.
-LM3556 Flash can be controlled through sys/class/leds/flash/brightness file
+LM3556 Flash can be controlled through /sys/class/leds/flash/brightness file
* if STROBE pin is enabled, below example control brightness only, and
ON / OFF will be controlled by STROBE pin.
@@ -32,17 +32,17 @@ Flash Example:
OFF::
- #echo 0 > sys/class/leds/flash/brightness
+ #echo 0 > /sys/class/leds/flash/brightness
93.75 mA::
- #echo 1 > sys/class/leds/flash/brightness
+ #echo 1 > /sys/class/leds/flash/brightness
...
1500 mA::
- #echo 16 > sys/class/leds/flash/brightness
+ #echo 16 > /sys/class/leds/flash/brightness
Torch Mode
^^^^^^^^^^
@@ -51,7 +51,7 @@ In Torch Mode, the current source(LED) is programmed via the CURRENT CONTROL
REGISTER(0x09).Torch Mode is activated by the ENABLE REGISTER(0x0A) or by the
hardware TORCH input.
-LM3556 torch can be controlled through sys/class/leds/torch/brightness file.
+LM3556 torch can be controlled through /sys/class/leds/torch/brightness file.
* if TORCH pin is enabled, below example control brightness only,
and ON / OFF will be controlled by TORCH pin.
@@ -59,22 +59,22 @@ Torch Example:
OFF::
- #echo 0 > sys/class/leds/torch/brightness
+ #echo 0 > /sys/class/leds/torch/brightness
46.88 mA::
- #echo 1 > sys/class/leds/torch/brightness
+ #echo 1 > /sys/class/leds/torch/brightness
...
375 mA::
- #echo 8 > sys/class/leds/torch/brightness
+ #echo 8 > /sys/class/leds/torch/brightness
Indicator Mode
^^^^^^^^^^^^^^
-Indicator pattern can be set through sys/class/leds/indicator/pattern file,
+Indicator pattern can be set through /sys/class/leds/indicator/pattern file,
and 4 patterns are pre-defined in indicator_pattern array.
According to N-lank, Pulse time and N Period values, different pattern wiill
@@ -87,13 +87,13 @@ Indicator pattern example:
pattern 0::
- #echo 0 > sys/class/leds/indicator/pattern
+ #echo 0 > /sys/class/leds/indicator/pattern
...
pattern 3::
- #echo 3 > sys/class/leds/indicator/pattern
+ #echo 3 > /sys/class/leds/indicator/pattern
Indicator brightness can be controlled through
sys/class/leds/indicator/brightness file.
@@ -102,17 +102,17 @@ Example:
OFF::
- #echo 0 > sys/class/leds/indicator/brightness
+ #echo 0 > /sys/class/leds/indicator/brightness
5.86 mA::
- #echo 1 > sys/class/leds/indicator/brightness
+ #echo 1 > /sys/class/leds/indicator/brightness
...
46.875mA::
- #echo 8 > sys/class/leds/indicator/brightness
+ #echo 8 > /sys/class/leds/indicator/brightness
Notes
-----
--
2.25.1
next reply other threads:[~2021-03-02 22:37 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-02 20:25 Mark O'Donovan [this message]
2021-03-28 15:28 [PATCH] Documentation: Add leading slash to some paths Mark O'Donovan
2021-03-31 19:49 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210302202539.103853-1-shiftee@posteo.net \
--to=shiftee@posteo.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).