Skip to content

Commit

Permalink
Documentation: firmware: Clarify firmware path usage
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Florian Fainelli authored and Jonathan Corbet committed Apr 11, 2023
1 parent 7332f9e commit b645fc6
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions Documentation/driver-api/firmware/fw_search_path.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit b645fc6

Please sign in to comment.