diff mbox series

docs: hwmon: Use file modes explicitly

Message ID 20221212141245.52935-1-samsagax@gmail.com
State New
Headers
Series docs: hwmon: Use file modes explicitly |

Commit Message

Joaquín Ignacio Aramendía Dec. 12, 2022, 2:12 p.m. UTC 
  As stated in the mainling list[1] and by checkpatch output, the file modes
for is_visible_func should be returned explicitly. Change that in the
documentation to avoid confusion.

[1]https://lore.kernel.org/linux-hwmon/506a6e7f-4566-2dcf-37f3-0f41f4ce983b@roeck-us.net/

Signed-off-by: Joaquín Ignacio Aramendía <samsagax@gmail.com>
---
 Documentation/hwmon/hwmon-kernel-api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Guenter Roeck Dec. 28, 2022, 3:49 p.m. UTC | #1 
On Mon, Dec 12, 2022 at 11:12:46AM -0300, Joaquín Ignacio Aramendía wrote:
> As stated in the mainling list[1] and by checkpatch output, the file modes
> for is_visible_func should be returned explicitly. Change that in the
> documentation to avoid confusion.
> 
> [1]https://lore.kernel.org/linux-hwmon/506a6e7f-4566-2dcf-37f3-0f41f4ce983b@roeck-us.net/
> 
> Signed-off-by: Joaquín Ignacio Aramendía <samsagax@gmail.com>

Applied to hwmon-next.

Thanks,
Guenter

> ---
>  Documentation/hwmon/hwmon-kernel-api.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/hwmon/hwmon-kernel-api.rst b/Documentation/hwmon/hwmon-kernel-api.rst
> index f3276b3a381a..26cf55303c61 100644
> --- a/Documentation/hwmon/hwmon-kernel-api.rst
> +++ b/Documentation/hwmon/hwmon-kernel-api.rst
> @@ -299,7 +299,7 @@ Parameters:
>  
>  Return value:
>  	The file mode for this attribute. Typically, this will be 0 (the
> -	attribute will not be created), S_IRUGO, or 'S_IRUGO | S_IWUSR'.
> +	attribute will not be created), 0444, or 0644.
>  
>  ::
>
diff mbox series

Patch

diff --git a/Documentation/hwmon/hwmon-kernel-api.rst b/Documentation/hwmon/hwmon-kernel-api.rst
index f3276b3a381a..26cf55303c61 100644
--- a/Documentation/hwmon/hwmon-kernel-api.rst
+++ b/Documentation/hwmon/hwmon-kernel-api.rst
@@ -299,7 +299,7 @@  Parameters:
 
 Return value:
 	The file mode for this attribute. Typically, this will be 0 (the
-	attribute will not be created), S_IRUGO, or 'S_IRUGO | S_IWUSR'.
+	attribute will not be created), 0444, or 0644.
 
 ::