summaryrefslogtreecommitdiff
path: root/Documentation/driver-api
diff options
context:
space:
mode:
authorFlorian Fainelli <f.fainelli@gmail.com>2023-04-02 16:54:14 +0300
committerJonathan Corbet <corbet@lwn.net>2023-04-12 01:20:20 +0300
commitb645fc696bec7653f3396e933015dd8728bbb10f (patch)
tree437a1a9a54d02246530b4707a46219e5ce76d556 /Documentation/driver-api
parent7332f9e45d2e13fa93acd16e2e3f122a765ff965 (diff)
downloadlinux-b645fc696bec7653f3396e933015dd8728bbb10f.tar.xz
Documentation: firmware: Clarify firmware path usage
Newline characters will be taken into account for the firmware search path parameter, warn users about that and provide an example using 'echo -n' such that it clarifies the typical use of that parameter. Signed-off-by: Florian Fainelli <f.fainelli@gmail.com> Link: https://lore.kernel.org/r/20230402135423.3235-1-f.fainelli@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/driver-api')
-rw-r--r--Documentation/driver-api/firmware/fw_search_path.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/Documentation/driver-api/firmware/fw_search_path.rst b/Documentation/driver-api/firmware/fw_search_path.rst
index a360f1009fa3..d7cb1e8f0076 100644
--- a/Documentation/driver-api/firmware/fw_search_path.rst
+++ b/Documentation/driver-api/firmware/fw_search_path.rst
@@ -22,5 +22,10 @@ can use the file:
* /sys/module/firmware_class/parameters/path
-You would echo into it your custom path and firmware requested will be
-searched for there first.
+You would echo into it your custom path and firmware requested will be searched
+for there first. Be aware that newline characters will be taken into account
+and may not produce the intended effects. For instance you might want to use:
+
+echo -n /path/to/script > /sys/module/firmware_class/parameters/path
+
+to ensure that your script is being used.