fs-util: adjust punctuation in comments
This commit is contained in:
parent
f20319402a
commit
4293c32b0e
|
@ -732,7 +732,7 @@ int chase_symlinks(const char *path, const char *original_root, unsigned flags,
|
||||||
* process. On each iteration, we move one component from "todo" to "done", processing it's special meaning
|
* process. On each iteration, we move one component from "todo" to "done", processing it's special meaning
|
||||||
* each time. The "todo" path always starts with at least one slash, the "done" path always ends in no
|
* each time. The "todo" path always starts with at least one slash, the "done" path always ends in no
|
||||||
* slash. We always keep an O_PATH fd to the component we are currently processing, thus keeping lookup races
|
* slash. We always keep an O_PATH fd to the component we are currently processing, thus keeping lookup races
|
||||||
* at a minimum.
|
* to a minimum.
|
||||||
*
|
*
|
||||||
* Suggested usage: whenever you want to canonicalize a path, use this function. Pass the absolute path you got
|
* Suggested usage: whenever you want to canonicalize a path, use this function. Pass the absolute path you got
|
||||||
* as-is: fully qualified and relative to your host's root. Optionally, specify the root parameter to tell this
|
* as-is: fully qualified and relative to your host's root. Optionally, specify the root parameter to tell this
|
||||||
|
@ -742,9 +742,9 @@ int chase_symlinks(const char *path, const char *original_root, unsigned flags,
|
||||||
* There are three ways to invoke this function:
|
* There are three ways to invoke this function:
|
||||||
*
|
*
|
||||||
* 1. Without CHASE_STEP or CHASE_OPEN: in this case the path is resolved and the normalized path is returned
|
* 1. Without CHASE_STEP or CHASE_OPEN: in this case the path is resolved and the normalized path is returned
|
||||||
* in `ret`. The return value is < 0 on error. If CHASE_NONEXISTENT is also set 0 is returned if the file
|
* in `ret`. The return value is < 0 on error. If CHASE_NONEXISTENT is also set, 0 is returned if the file
|
||||||
* doesn't exist, > 0 otherwise. If CHASE_NONEXISTENT is not set >= 0 is returned if the destination was
|
* doesn't exist, > 0 otherwise. If CHASE_NONEXISTENT is not set, >= 0 is returned if the destination was
|
||||||
* found, -ENOENT if it doesn't.
|
* found, -ENOENT if it wasn't.
|
||||||
*
|
*
|
||||||
* 2. With CHASE_OPEN: in this case the destination is opened after chasing it as O_PATH and this file
|
* 2. With CHASE_OPEN: in this case the destination is opened after chasing it as O_PATH and this file
|
||||||
* descriptor is returned as return value. This is useful to open files relative to some root
|
* descriptor is returned as return value. This is useful to open files relative to some root
|
||||||
|
@ -760,13 +760,13 @@ int chase_symlinks(const char *path, const char *original_root, unsigned flags,
|
||||||
*
|
*
|
||||||
* 4. With CHASE_SAFE: in this case the path must not contain unsafe transitions, i.e. transitions from
|
* 4. With CHASE_SAFE: in this case the path must not contain unsafe transitions, i.e. transitions from
|
||||||
* unprivileged to privileged files or directories. In such cases the return value is -ENOLINK. If
|
* unprivileged to privileged files or directories. In such cases the return value is -ENOLINK. If
|
||||||
* CHASE_WARN is also set a warning describing the unsafe transition is emitted.
|
* CHASE_WARN is also set, a warning describing the unsafe transition is emitted.
|
||||||
*
|
*
|
||||||
* 5. With CHASE_NO_AUTOFS: in this case if an autofs mount point is encountered, the path normalization is
|
* 5. With CHASE_NO_AUTOFS: in this case if an autofs mount point is encountered, path normalization
|
||||||
* aborted and -EREMOTE is returned. If CHASE_WARN is also set a warning showing the path of the mount point
|
* is aborted and -EREMOTE is returned. If CHASE_WARN is also set, a warning showing the path of
|
||||||
* is emitted.
|
* the mount point is emitted.
|
||||||
*
|
*
|
||||||
* */
|
*/
|
||||||
|
|
||||||
/* A root directory of "/" or "" is identical to none */
|
/* A root directory of "/" or "" is identical to none */
|
||||||
if (empty_or_root(original_root))
|
if (empty_or_root(original_root))
|
||||||
|
|
|
@ -74,14 +74,15 @@ union inotify_event_buffer {
|
||||||
int inotify_add_watch_fd(int fd, int what, uint32_t mask);
|
int inotify_add_watch_fd(int fd, int what, uint32_t mask);
|
||||||
|
|
||||||
enum {
|
enum {
|
||||||
CHASE_PREFIX_ROOT = 1 << 0, /* If set, the specified path will be prefixed by the specified root before beginning the iteration */
|
CHASE_PREFIX_ROOT = 1 << 0, /* The specified path will be prefixed by the specified root before beginning the iteration */
|
||||||
CHASE_NONEXISTENT = 1 << 1, /* If set, it's OK if the path doesn't actually exist. */
|
CHASE_NONEXISTENT = 1 << 1, /* It's OK if the path doesn't actually exist. */
|
||||||
CHASE_NO_AUTOFS = 1 << 2, /* If set, return -EREMOTE if autofs mount point found */
|
CHASE_NO_AUTOFS = 1 << 2, /* Return -EREMOTE if autofs mount point found */
|
||||||
CHASE_SAFE = 1 << 3, /* If set, return EPERM if we ever traverse from unprivileged to privileged files or directories */
|
CHASE_SAFE = 1 << 3, /* Return EPERM if we ever traverse from unprivileged to privileged files or directories */
|
||||||
CHASE_OPEN = 1 << 4, /* If set, return an O_PATH object to the final component */
|
CHASE_OPEN = 1 << 4, /* Return an O_PATH object to the final component */
|
||||||
CHASE_TRAIL_SLASH = 1 << 5, /* If set, any trailing slash will be preserved */
|
CHASE_TRAIL_SLASH = 1 << 5, /* Any trailing slash will be preserved */
|
||||||
CHASE_STEP = 1 << 6, /* If set, just execute a single step of the normalization */
|
CHASE_STEP = 1 << 6, /* Just execute a single step of the normalization */
|
||||||
CHASE_NOFOLLOW = 1 << 7, /* Only valid with CHASE_OPEN: when the path's right-most component refers to symlink return O_PATH fd of the symlink, rather than following it. */
|
CHASE_NOFOLLOW = 1 << 7, /* Only valid with CHASE_OPEN: when the path's right-most component refers to symlink,
|
||||||
|
* return O_PATH fd of the symlink, rather than following it. */
|
||||||
CHASE_WARN = 1 << 8, /* Emit an appropriate warning when an error is encountered */
|
CHASE_WARN = 1 << 8, /* Emit an appropriate warning when an error is encountered */
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue