diff mbox series

docs: power: fix docs for ioctls that return loff_t via pointer

Message ID 20200308032216.998068-1-ebiggers@kernel.org (mailing list archive)
State Mainlined, archived
Headers show
Series docs: power: fix docs for ioctls that return loff_t via pointer | expand

Commit Message

Eric Biggers March 8, 2020, 3:22 a.m. UTC
From: Eric Biggers <ebiggers@google.com>

Correctly document how the SNAPSHOT_GET_IMAGE_SIZE and
SNAPSHOT_AVAIL_SWAP_SIZE ioctls return their result.

Signed-off-by: Eric Biggers <ebiggers@google.com>
---
 Documentation/power/userland-swsusp.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

Comments

Rafael J. Wysocki March 14, 2020, 10:53 a.m. UTC | #1
On Sunday, March 8, 2020 4:22:16 AM CET Eric Biggers wrote:
> From: Eric Biggers <ebiggers@google.com>
> 
> Correctly document how the SNAPSHOT_GET_IMAGE_SIZE and
> SNAPSHOT_AVAIL_SWAP_SIZE ioctls return their result.
> 
> Signed-off-by: Eric Biggers <ebiggers@google.com>
> ---
>  Documentation/power/userland-swsusp.rst | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/power/userland-swsusp.rst b/Documentation/power/userland-swsusp.rst
> index a0fa51bb1a4d..1cf62d80a9ca 100644
> --- a/Documentation/power/userland-swsusp.rst
> +++ b/Documentation/power/userland-swsusp.rst
> @@ -69,11 +69,13 @@ SNAPSHOT_PREF_IMAGE_SIZE
>  
>  SNAPSHOT_GET_IMAGE_SIZE
>  	return the actual size of the hibernation image
> +	(the last argument should be a pointer to a loff_t variable that
> +	will contain the result if the call is successful)
>  
>  SNAPSHOT_AVAIL_SWAP_SIZE
> -	return the amount of available swap in bytes (the
> -	last argument should be a pointer to an unsigned int variable that will
> -	contain the result if the call is successful).
> +	return the amount of available swap in bytes
> +	(the last argument should be a pointer to a loff_t variable that
> +	will contain the result if the call is successful)
>  
>  SNAPSHOT_ALLOC_SWAP_PAGE
>  	allocate a swap page from the resume partition
> 

Applied as 5.7 material, thanks!
diff mbox series

Patch

diff --git a/Documentation/power/userland-swsusp.rst b/Documentation/power/userland-swsusp.rst
index a0fa51bb1a4d..1cf62d80a9ca 100644
--- a/Documentation/power/userland-swsusp.rst
+++ b/Documentation/power/userland-swsusp.rst
@@ -69,11 +69,13 @@  SNAPSHOT_PREF_IMAGE_SIZE
 
 SNAPSHOT_GET_IMAGE_SIZE
 	return the actual size of the hibernation image
+	(the last argument should be a pointer to a loff_t variable that
+	will contain the result if the call is successful)
 
 SNAPSHOT_AVAIL_SWAP_SIZE
-	return the amount of available swap in bytes (the
-	last argument should be a pointer to an unsigned int variable that will
-	contain the result if the call is successful).
+	return the amount of available swap in bytes
+	(the last argument should be a pointer to a loff_t variable that
+	will contain the result if the call is successful)
 
 SNAPSHOT_ALLOC_SWAP_PAGE
 	allocate a swap page from the resume partition