From b645fc696bec7653f3396e933015dd8728bbb10f Mon Sep 17 00:00:00 2001 From: Florian Fainelli Date: Sun, 2 Apr 2023 06:54:14 -0700 Subject: 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 Link: https://lore.kernel.org/r/20230402135423.3235-1-f.fainelli@gmail.com Signed-off-by: Jonathan Corbet --- Documentation/driver-api/firmware/fw_search_path.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'Documentation/driver-api') 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. -- cgit v1.2.3