Skip to contentSkip to conversation

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

PATCH Applied Eric Biggers 2 participants 2 messages Mar 8, 2020 – Mar 15, 2020 Suspend to RAM

lore
Share & tools
lore

Eric Biggers

author
#0 lore raw

PATCH 1/1 docs: power: fix docs for ioctls that return loff_t via pointer

From: Eric Biggers <[email protected]>

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

Signed-off-by Eric Biggers <[email protected]>
---
 Documentation/power/userland-swsusp.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
Documentation/power/userland-swsusp.rst +5 -3
index a0fa51bb1a4d..1cf62d80a9ca 100644
@@ -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
Signature · 1 line
2.25.1
Applied
#1 lore raw
Quoted 22 lines · CET Eric Biggers

From: Eric Biggers <[email protected]>

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

Signed-off-by Eric Biggers <[email protected]>
---
 Documentation/power/userland-swsusp.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
Documentation/power/userland-swsusp.rst +2 -0
index a0fa51bb1a4d..1cf62d80a9ca 100644
@@ -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)

Documentation/power/userland-swsusp.rst SNAPSHOT_PREF_IMAGE_SIZE · line 81

Quoted 10 lines
Documentation/power/userland-swsusp.rst +3 -3
 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!