Commit b645fc69 authored by Florian Fainelli's avatar Florian Fainelli Committed by Jonathan Corbet
Browse files

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: default avatarFlorian Fainelli <f.fainelli@gmail.com>
Link: https://lore.kernel.org/r/20230402135423.3235-1-f.fainelli@gmail.com


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 7332f9e4

Documentation/driver-api/firmware/fw_search_path.rst

+7 −2
Original line number Diff line number Diff line
@@ -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.