diff mbox series

[1/1] doc: TST_MNTPOINT should be full path

Message ID 20210825071420.5751-1-pvorel@suse.cz
State Accepted
Headers show
Series [1/1] doc: TST_MNTPOINT should be full path | expand

Commit Message

Petr Vorel Aug. 25, 2021, 7:14 a.m. UTC
Document changed behavior in 205a43dfb ("Make argument to tst_umount an
absolute path").

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 doc/shell-test-api.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Leo Liang Aug. 25, 2021, 7:29 a.m. UTC | #1
On Wed, Aug 25, 2021 at 09:14:20AM +0200, Petr Vorel wrote:
> Document changed behavior in 205a43dfb ("Make argument to tst_umount an
> absolute path").
> 
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
>  doc/shell-test-api.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 

Reviewed-by: Leo Yu-Chi Liang <ycliang@andestech.com>
Cyril Hrubis Aug. 25, 2021, 2:54 p.m. UTC | #2
Hi!
> Document changed behavior in 205a43dfb ("Make argument to tst_umount an
> absolute path").
> 
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
>  doc/shell-test-api.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/shell-test-api.txt b/doc/shell-test-api.txt
> index ecdbe9e6a..afc01dd01 100644
> --- a/doc/shell-test-api.txt
> +++ b/doc/shell-test-api.txt
> @@ -515,8 +515,8 @@ The 'tst_mount' mounts '$TST_DEVICE' of '$TST_FS_TYPE' (optional) to
>  '$TST_MNT_PARAMS'. The '$TST_MNTPOINT' directory is created if it didn't
>  exist prior to the function call.
>  
> -If the path passed (optional, defaults to '$TST_MNTPOINT') to the 'tst_umount' is
> -not mounted (present in '/proc/mounts') it's noop.
> +If the path passed (optional, should be full path, defaults to '$TST_MNTPOINT')
                                  ^          ^
				  must     absolute
Petr Vorel Aug. 27, 2021, 7:03 a.m. UTC | #3
Hi Cyril,

> > -If the path passed (optional, defaults to '$TST_MNTPOINT') to the 'tst_umount' is
> > -not mounted (present in '/proc/mounts') it's noop.
> > +If the path passed (optional, should be full path, defaults to '$TST_MNTPOINT')
>                                   ^          ^
> 				  must     absolute

I used 'should' because the warning, but 'must' is more appropriate.
Fixed and merged.

Kind regards,
Petr
diff mbox series

Patch

diff --git a/doc/shell-test-api.txt b/doc/shell-test-api.txt
index ecdbe9e6a..afc01dd01 100644
--- a/doc/shell-test-api.txt
+++ b/doc/shell-test-api.txt
@@ -515,8 +515,8 @@  The 'tst_mount' mounts '$TST_DEVICE' of '$TST_FS_TYPE' (optional) to
 '$TST_MNT_PARAMS'. The '$TST_MNTPOINT' directory is created if it didn't
 exist prior to the function call.
 
-If the path passed (optional, defaults to '$TST_MNTPOINT') to the 'tst_umount' is
-not mounted (present in '/proc/mounts') it's noop.
+If the path passed (optional, should be full path, defaults to '$TST_MNTPOINT')
+to the 'tst_umount' is not mounted (present in '/proc/mounts') it's noop.
 Otherwise it retries to umount the filesystem a few times on failure.
 This is a workaround since there are daemons dumb enough to probe all newly
 mounted filesystems, and prevents them from being umounted shortly after they