diff mbox series

[v6,2/2] c-test-api: Documentation updated

Message ID 20221109193819.875478-3-alessandro.carminati@gmail.com
State Accepted
Headers show
Series tst_find_backing_dev: fix stat fails /dev/root | expand

Commit Message

Alessandro Carminati Nov. 9, 2022, 7:38 p.m. UTC
Since the tst_find_backing_dev logic is changed, the doc is updated
accordingly.

Signed-off-by: Alessandro Carminati <alessandro.carminati@gmail.com>
---
 doc/c-test-api.txt | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

Comments

Richard Palethorpe Nov. 10, 2022, 11:29 a.m. UTC | #1
Hello,

Merged, thanks!

I removed some trailing whitespace.

Alessandro Carminati <alessandro.carminati@gmail.com> writes:

> Since the tst_find_backing_dev logic is changed, the doc is updated
> accordingly.
>
> Signed-off-by: Alessandro Carminati <alessandro.carminati@gmail.com>
> ---
>  doc/c-test-api.txt | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
>
> diff --git a/doc/c-test-api.txt b/doc/c-test-api.txt
> index 64ee3397f..a7888c242 100644
> --- a/doc/c-test-api.txt
> +++ b/doc/c-test-api.txt
> @@ -1071,8 +1071,11 @@ voud tst_find_backing_dev(const char *path, char *dev);
>  -------------------------------------------------------------------------------
>  
>  This function finds the block dev that this path belongs to, it uses stat function
> -to get the major/minor number of the path. Then scan them in '/proc/self/mountinfo'
> -and list 2th column value after ' - ' string as its block dev if match succeeds.
> +to get the major/minor number of the path. 
> +This function finds the block dev that this path belongs to, it uses the unevent

There are trailing whitespace on these lines

> +file in sysfs to find the device name. It needs to discriminate between btrfs
> +and not btrfs. For non btrfs filesystems it uses the minor, major numbers. For
> +btrfs it uses the fs uuid.
>  
>  [source,c]
>  -------------------------------------------------------------------------------
diff mbox series

Patch

diff --git a/doc/c-test-api.txt b/doc/c-test-api.txt
index 64ee3397f..a7888c242 100644
--- a/doc/c-test-api.txt
+++ b/doc/c-test-api.txt
@@ -1071,8 +1071,11 @@  voud tst_find_backing_dev(const char *path, char *dev);
 -------------------------------------------------------------------------------
 
 This function finds the block dev that this path belongs to, it uses stat function
-to get the major/minor number of the path. Then scan them in '/proc/self/mountinfo'
-and list 2th column value after ' - ' string as its block dev if match succeeds.
+to get the major/minor number of the path. 
+This function finds the block dev that this path belongs to, it uses the unevent 
+file in sysfs to find the device name. It needs to discriminate between btrfs
+and not btrfs. For non btrfs filesystems it uses the minor, major numbers. For
+btrfs it uses the fs uuid.
 
 [source,c]
 -------------------------------------------------------------------------------