diff options
| author | Karel Zak | 2018-04-26 11:04:07 +0200 |
|---|---|---|
| committer | Karel Zak | 2018-04-26 11:04:07 +0200 |
| commit | f4375df0fd528dbf8eed72adb83f08308c0387b7 (patch) | |
| tree | 232fa1a7ca7ca43621fcd6489c0c990b517bc2c1 /libmount | |
| parent | libblkid: add BitLocker detection (diff) | |
| download | kernel-qcow2-util-linux-f4375df0fd528dbf8eed72adb83f08308c0387b7.tar.gz kernel-qcow2-util-linux-f4375df0fd528dbf8eed72adb83f08308c0387b7.tar.xz kernel-qcow2-util-linux-f4375df0fd528dbf8eed72adb83f08308c0387b7.zip | |
libmount: improve docs about mnt_context_mount() return codes
Signed-off-by: Karel Zak <kzak@redhat.com>
Diffstat (limited to 'libmount')
| -rw-r--r-- | libmount/src/context_mount.c | 34 |
1 files changed, 31 insertions, 3 deletions
diff --git a/libmount/src/context_mount.c b/libmount/src/context_mount.c index fc07ca184..a6de36178 100644 --- a/libmount/src/context_mount.c +++ b/libmount/src/context_mount.c @@ -961,8 +961,9 @@ int mnt_context_prepare_mount(struct libmnt_context *cxt) * WARNING: non-zero return code does not mean that mount(2) syscall or * mount.type helper wasn't successfully called. * - * Check mnt_context_get_status() after error! -* + * Check mnt_context_get_status() after error! See mnt_context_mount() for more + * details about errors and warnings. + * * Returns: 0 on success; * >0 in case of mount(2) error (returns syscall errno), * <0 in case of other errors. @@ -1086,7 +1087,32 @@ int mnt_context_finalize_mount(struct libmnt_context *cxt) * WARNING: non-zero return code does not mean that mount(2) syscall or * mount.type helper wasn't successfully called. * - * Check mnt_context_get_status() after error! + * Always use mnt_context_get_status(): + * + * <informalexample> + * <programlisting> + * rc = mnt_context_mount(cxt); + * + * if (mnt_context_helper_executed(cxt)) + * return mnt_context_get_helper_status(cxt); + * if (rc == 0 && mnt_context_get_status(cxt) == 1) + * return MNT_EX_SUCCESS; + * return MNT_EX_FAIL; + * </programlisting> + * </informalexample> + * + * or mnt_context_get_excode() to generate mount(8) compatible error + * or warning message: + * + * <informalexample> + * <programlisting> + * rc = mnt_context_mount(cxt); + * rc = mnt_context_get_excode(cxt, rc, buf, sizeof(buf)); + * if (buf) + * warnx(_("%s: %s"), mnt_context_get_target(cxt), buf); + * return rc; // MNT_EX_* + * </programlisting> + * </informalexample> * * Returns: 0 on success; * >0 in case of mount(2) error (returns syscall errno), @@ -1163,6 +1189,8 @@ again: * Use also mnt_context_get_status() to check if the filesystem was * successfully mounted. * + * See mnt_context_mount() for more details about errors and warnings. + * * Returns: 0 on success, * <0 in case of error (!= mount(2) errors) * 1 at the end of the list. |