docs: reword others "allow to"
Signed-off-by: Karel Zak <kzak@redhat.com>
This commit is contained in:
parent
4f68c8b179
commit
29e204d117
|
@ -77,7 +77,7 @@ libmount (mount/umount)
|
||||||
loop devices, write to /run/mount/utab or /etc/mtab, etc.
|
loop devices, write to /run/mount/utab or /etc/mtab, etc.
|
||||||
|
|
||||||
It would be nice to improve libmount to check for CAP_SYS_ADMIN if suid not
|
It would be nice to improve libmount to check for CAP_SYS_ADMIN if suid not
|
||||||
set and allow to use it for simple tasks where no another operation is
|
set and allow using it for simple tasks where no another operation is
|
||||||
necessary.
|
necessary.
|
||||||
|
|
||||||
partx
|
partx
|
||||||
|
|
|
@ -299,7 +299,7 @@ int loopcxt_set_fd(struct loopdev_cxt *lc, int fd, int mode)
|
||||||
* @lc: context
|
* @lc: context
|
||||||
* @flags: LOOPITER_FL_* flags
|
* @flags: LOOPITER_FL_* flags
|
||||||
*
|
*
|
||||||
* Iterator allows to scan list of the free or used loop devices.
|
* Iterator can be used to scan list of the free or used loop devices.
|
||||||
*
|
*
|
||||||
* Returns: <0 on error, 0 on success
|
* Returns: <0 on error, 0 on success
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -466,7 +466,7 @@ blkid_partition blkid_partlist_add_partition(blkid_partlist ls,
|
||||||
return par;
|
return par;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* allows to modify used partitions numbers (for example for logical partitions) */
|
/* can be used to modify used partitions numbers (for example for logical partitions) */
|
||||||
int blkid_partlist_set_partno(blkid_partlist ls, int partno)
|
int blkid_partlist_set_partno(blkid_partlist ls, int partno)
|
||||||
{
|
{
|
||||||
if (!ls)
|
if (!ls)
|
||||||
|
@ -480,7 +480,7 @@ int blkid_partlist_increment_partno(blkid_partlist ls)
|
||||||
return ls ? ls->next_partno++ : -1;
|
return ls ? ls->next_partno++ : -1;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* allows to set "parent" for the next nested partition */
|
/* can be used to set "parent" for the next nested partition */
|
||||||
static int blkid_partlist_set_parent(blkid_partlist ls, blkid_partition par)
|
static int blkid_partlist_set_parent(blkid_partlist ls, blkid_partition par)
|
||||||
{
|
{
|
||||||
if (!ls)
|
if (!ls)
|
||||||
|
|
|
@ -15,7 +15,7 @@
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Solaris-x86 is always within primary dos partition (nested PT table). The
|
* Solaris-x86 is always within primary dos partition (nested PT table). The
|
||||||
* solaris-x86 vtoc allows to split the entire partition to "slices". The
|
* solaris-x86 vtoc can be used to split the entire partition to "slices". The
|
||||||
* offset (start) of the slice is always relatively to the primary dos
|
* offset (start) of the slice is always relatively to the primary dos
|
||||||
* partition.
|
* partition.
|
||||||
*
|
*
|
||||||
|
|
|
@ -1956,8 +1956,8 @@ size_t blkid_ltrim_whitespace(unsigned char *str)
|
||||||
* wiped area then the signature has been added later and LVM superblock
|
* wiped area then the signature has been added later and LVM superblock
|
||||||
* should be ignore.
|
* should be ignore.
|
||||||
*
|
*
|
||||||
* Note that this heuristic is not 100% reliable, for example "pvcreate --zero
|
* Note that this heuristic is not 100% reliable, for example "pvcreate --zero n"
|
||||||
* n" allows to keep the begin of the device unmodified. It's probably better
|
* can be used to keep the begin of the device unmodified. It's probably better
|
||||||
* to use this heuristic for conflicts between superblocks and partition tables
|
* to use this heuristic for conflicts between superblocks and partition tables
|
||||||
* than for conflicts between filesystem superblocks -- existence of unwanted
|
* than for conflicts between filesystem superblocks -- existence of unwanted
|
||||||
* partition table is very unusual, because PT is pretty visible (parsed and
|
* partition table is very unusual, because PT is pretty visible (parsed and
|
||||||
|
|
|
@ -323,7 +323,7 @@ int fdisk_ask_number_is_relative(struct fdisk_ask *ask)
|
||||||
* fdisk_ask_number_is_wrap_negative:
|
* fdisk_ask_number_is_wrap_negative:
|
||||||
* @ask: ask instance
|
* @ask: ask instance
|
||||||
*
|
*
|
||||||
* The wrap-negative flag allows to accept negative number from user. In this
|
* The wrap-negative flag can be used to accept negative number from user. In this
|
||||||
* case the dialog result is calculated as "high - num" (-N from high limit).
|
* case the dialog result is calculated as "high - num" (-N from high limit).
|
||||||
*
|
*
|
||||||
* Returns: 1 or 0.
|
* Returns: 1 or 0.
|
||||||
|
@ -342,8 +342,8 @@ int fdisk_ask_number_is_wrap_negative(struct fdisk_ask *ask)
|
||||||
* @ask: ask instance
|
* @ask: ask instance
|
||||||
* @relative: 0 or 1
|
* @relative: 0 or 1
|
||||||
*
|
*
|
||||||
* Inform libfdisk that user specified number in relative notation rather than
|
* Inform libfdisk that user can specify the number in relative notation rather than
|
||||||
* by explicit number. This info allows to fdisk do some optimization (e.g.
|
* by explicit number. This is useful for some optimization (e.g.
|
||||||
* align end of partition, etc.)
|
* align end of partition, etc.)
|
||||||
*
|
*
|
||||||
* Returns: 0 on success, <0 on error
|
* Returns: 0 on success, <0 on error
|
||||||
|
|
|
@ -335,7 +335,7 @@ int fdisk_has_protected_bootbits(struct fdisk_context *cxt)
|
||||||
* @enable: 1 or 0
|
* @enable: 1 or 0
|
||||||
*
|
*
|
||||||
* The library zeroizes all the first sector when create a new disk label by
|
* The library zeroizes all the first sector when create a new disk label by
|
||||||
* default. This function allows to control this behavior. For now it's
|
* default. This function can be used to control this behavior. For now it's
|
||||||
* supported for MBR and GPT.
|
* supported for MBR and GPT.
|
||||||
*
|
*
|
||||||
* Returns: 0 on success, < 0 on error.
|
* Returns: 0 on success, < 0 on error.
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
* @short_description: disk label (PT) specific data and functions
|
* @short_description: disk label (PT) specific data and functions
|
||||||
*
|
*
|
||||||
* The fdisk_new_context() initializes all label drivers, and allocate
|
* The fdisk_new_context() initializes all label drivers, and allocate
|
||||||
* per-label specific data struct. This concept allows to store label specific
|
* per-label specific data struct. This concept can be used to store label specific
|
||||||
* settings to the label driver independently on the currently active label
|
* settings to the label driver independently on the currently active label
|
||||||
* driver. Note that label struct cannot be deallocated, so there is no
|
* driver. Note that label struct cannot be deallocated, so there is no
|
||||||
* reference counting for fdisk_label objects. All is destroyed by
|
* reference counting for fdisk_label objects. All is destroyed by
|
||||||
|
|
|
@ -1175,7 +1175,7 @@ static int recount_resize(
|
||||||
rc = fdisk_get_partitions(cxt, &tb);
|
rc = fdisk_get_partitions(cxt, &tb);
|
||||||
if (!rc) {
|
if (!rc) {
|
||||||
/* For resize we do not follow grain to detect free-space, but
|
/* For resize we do not follow grain to detect free-space, but
|
||||||
* we allow to resize with very small granulation. */
|
* we support to resize with very small granulation. */
|
||||||
unsigned long org = cxt->grain;
|
unsigned long org = cxt->grain;
|
||||||
|
|
||||||
cxt->grain = cxt->sector_size;
|
cxt->grain = cxt->sector_size;
|
||||||
|
|
|
@ -9,7 +9,7 @@
|
||||||
* @title: Script
|
* @title: Script
|
||||||
* @short_description: complex way to create and dump partition table
|
* @short_description: complex way to create and dump partition table
|
||||||
*
|
*
|
||||||
* This interface allows to compose in-memory partition table with all details,
|
* This interface can be used to compose in-memory partition table with all details,
|
||||||
* write all partition table description to human readable text file, read it
|
* write all partition table description to human readable text file, read it
|
||||||
* from the file, and apply the script to on-disk label.
|
* from the file, and apply the script to on-disk label.
|
||||||
*
|
*
|
||||||
|
@ -268,7 +268,7 @@ const char *fdisk_script_get_header(struct fdisk_script *dp, const char *name)
|
||||||
* If no @data is specified then the header is removed. If header does not exist
|
* If no @data is specified then the header is removed. If header does not exist
|
||||||
* and @data is specified then a new header is added.
|
* and @data is specified then a new header is added.
|
||||||
*
|
*
|
||||||
* Note that libfdisk allows to specify arbitrary custom header, the default
|
* Note that libfdisk can be used to specify arbitrary custom header, the default
|
||||||
* built-in headers are "unit" and "label", and some label specific headers
|
* built-in headers are "unit" and "label", and some label specific headers
|
||||||
* (for example "uuid" and "name" for GPT).
|
* (for example "uuid" and "name" for GPT).
|
||||||
*
|
*
|
||||||
|
@ -362,7 +362,7 @@ struct fdisk_table *fdisk_script_get_table(struct fdisk_script *dp)
|
||||||
* @tb: table
|
* @tb: table
|
||||||
*
|
*
|
||||||
* Replaces table used by script and creates a new reference to @tb. This
|
* Replaces table used by script and creates a new reference to @tb. This
|
||||||
* function allows to generate a new script table independently on the current
|
* function can be used to generate a new script table independently on the current
|
||||||
* context and without any file reading.
|
* context and without any file reading.
|
||||||
*
|
*
|
||||||
* This is useful for example to create partition table with the same basic
|
* This is useful for example to create partition table with the same basic
|
||||||
|
|
|
@ -153,7 +153,7 @@ void mnt_unref_cache(struct libmnt_cache *cache)
|
||||||
* @cache: cache pointer
|
* @cache: cache pointer
|
||||||
* @mtab: table with already canonicalized mountpoints
|
* @mtab: table with already canonicalized mountpoints
|
||||||
*
|
*
|
||||||
* Add to @cache reference to @mtab. This allows to avoid unnecessary paths
|
* Add to @cache reference to @mtab. This can be used to avoid unnecessary paths
|
||||||
* canonicalization in mnt_resolve_target().
|
* canonicalization in mnt_resolve_target().
|
||||||
*
|
*
|
||||||
* Returns: negative number in case of error, or 0 o success.
|
* Returns: negative number in case of error, or 0 o success.
|
||||||
|
|
|
@ -900,7 +900,7 @@ int mnt_context_is_loopdel(struct libmnt_context *cxt)
|
||||||
* @cxt: mount context
|
* @cxt: mount context
|
||||||
* @fs: filesystem description
|
* @fs: filesystem description
|
||||||
*
|
*
|
||||||
* The mount context uses private @fs by default. This function allows to
|
* The mount context uses private @fs by default. This function can be used to
|
||||||
* overwrite the private @fs with an external instance. This function
|
* overwrite the private @fs with an external instance. This function
|
||||||
* increments @fs reference counter (and decrement reference counter of the
|
* increments @fs reference counter (and decrement reference counter of the
|
||||||
* old fs).
|
* old fs).
|
||||||
|
@ -1190,7 +1190,7 @@ int mnt_context_set_options_pattern(struct libmnt_context *cxt, const char *patt
|
||||||
* @tb: fstab
|
* @tb: fstab
|
||||||
*
|
*
|
||||||
* The mount context reads /etc/fstab to the private struct libmnt_table by default.
|
* The mount context reads /etc/fstab to the private struct libmnt_table by default.
|
||||||
* This function allows to overwrite the private fstab with an external
|
* This function can be used to overwrite the private fstab with an external
|
||||||
* instance.
|
* instance.
|
||||||
*
|
*
|
||||||
* This function modify the @tb reference counter. This function does not set
|
* This function modify the @tb reference counter. This function does not set
|
||||||
|
@ -1493,7 +1493,7 @@ int mnt_context_set_tables_errcb(struct libmnt_context *cxt,
|
||||||
* @cache: cache instance or NULL
|
* @cache: cache instance or NULL
|
||||||
*
|
*
|
||||||
* The mount context maintains a private struct libmnt_cache by default. This
|
* The mount context maintains a private struct libmnt_cache by default. This
|
||||||
* function allows to overwrite the private cache with an external instance.
|
* function can be used to overwrite the private cache with an external instance.
|
||||||
* This function increments cache reference counter.
|
* This function increments cache reference counter.
|
||||||
*
|
*
|
||||||
* If the @cache argument is NULL, then the current cache instance is reset.
|
* If the @cache argument is NULL, then the current cache instance is reset.
|
||||||
|
@ -1611,7 +1611,7 @@ struct libmnt_lock *mnt_context_get_lock(struct libmnt_context *cxt)
|
||||||
*
|
*
|
||||||
* Sets mount flags (see mount(2) man page).
|
* Sets mount flags (see mount(2) man page).
|
||||||
*
|
*
|
||||||
* Note that mount context allows to define mount options by mount flags. It
|
* Note that mount context can be used to define mount options by mount flags. It
|
||||||
* means you can for example use
|
* means you can for example use
|
||||||
*
|
*
|
||||||
* mnt_context_set_mflags(cxt, MS_NOEXEC | MS_NOSUID);
|
* mnt_context_set_mflags(cxt, MS_NOEXEC | MS_NOSUID);
|
||||||
|
@ -1740,7 +1740,7 @@ int mnt_context_get_user_mflags(struct libmnt_context *cxt, unsigned long *flags
|
||||||
* @data: mount(2) data
|
* @data: mount(2) data
|
||||||
*
|
*
|
||||||
* The mount context generates mountdata from mount options by default. This
|
* The mount context generates mountdata from mount options by default. This
|
||||||
* function allows to overwrite this behavior, and @data will be used instead
|
* function can be used to overwrite this behavior, and @data will be used instead
|
||||||
* of mount options.
|
* of mount options.
|
||||||
*
|
*
|
||||||
* The libmount does not deallocate the data by mnt_free_context(). Note that
|
* The libmount does not deallocate the data by mnt_free_context(). Note that
|
||||||
|
|
|
@ -293,8 +293,8 @@ static int fix_optstr(struct libmnt_context *cxt)
|
||||||
se_rem = 1;
|
se_rem = 1;
|
||||||
else if (cxt->mountflags & MS_REMOUNT)
|
else if (cxt->mountflags & MS_REMOUNT)
|
||||||
/*
|
/*
|
||||||
* Linux kernel < 2.6.39 does not allow to remount with any
|
* Linux kernel < 2.6.39 does not support remount operation
|
||||||
* selinux specific mount options.
|
* with any selinux specific mount options.
|
||||||
*
|
*
|
||||||
* Kernel 2.6.39 commits: ff36fe2c845cab2102e4826c1ffa0a6ebf487c65
|
* Kernel 2.6.39 commits: ff36fe2c845cab2102e4826c1ffa0a6ebf487c65
|
||||||
* 026eb167ae77244458fa4b4b9fc171209c079ba7
|
* 026eb167ae77244458fa4b4b9fc171209c079ba7
|
||||||
|
@ -1080,7 +1080,7 @@ int mnt_context_do_mount(struct libmnt_context *cxt)
|
||||||
/*
|
/*
|
||||||
* Mounted by mount(2), do some post-mount checks
|
* Mounted by mount(2), do some post-mount checks
|
||||||
*
|
*
|
||||||
* Kernel allows to use MS_RDONLY for bind mounts, but the
|
* Kernel can be used to use MS_RDONLY for bind mounts, but the
|
||||||
* read-only request could be silently ignored. Check it to
|
* read-only request could be silently ignored. Check it to
|
||||||
* avoid 'ro' in mtab and 'rw' in /proc/mounts.
|
* avoid 'ro' in mtab and 'rw' in /proc/mounts.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -64,7 +64,7 @@ static int __mtab_find_umount_fs(struct libmnt_context *cxt,
|
||||||
/*
|
/*
|
||||||
* The mount table may be huge, and on systems with utab we have to
|
* The mount table may be huge, and on systems with utab we have to
|
||||||
* merge userspace mount options into /proc/self/mountinfo. This all is
|
* merge userspace mount options into /proc/self/mountinfo. This all is
|
||||||
* expensive. The tab filter allows to filter out entries, then a mount
|
* expensive. The tab filter can be used to filter out entries, then a mount
|
||||||
* table and utab are very tiny files.
|
* table and utab are very tiny files.
|
||||||
*
|
*
|
||||||
* The filter uses mnt_fs_streq_{target,srcpath} function where all
|
* The filter uses mnt_fs_streq_{target,srcpath} function where all
|
||||||
|
|
|
@ -383,7 +383,7 @@ int scols_column_set_cmpfunc(struct libscols_column *cl,
|
||||||
* @wrap_nextchunk: function to return next zero terminated data
|
* @wrap_nextchunk: function to return next zero terminated data
|
||||||
* @userdata: optional stuff for callbacks
|
* @userdata: optional stuff for callbacks
|
||||||
*
|
*
|
||||||
* Extends SCOLS_FL_WRAP and allows to set custom wrap function. The default
|
* Extends SCOLS_FL_WRAP and can be used to set custom wrap function. The default
|
||||||
* is to wrap by column size, but you can create functions to wrap for example
|
* is to wrap by column size, but you can create functions to wrap for example
|
||||||
* after \n or after words, etc.
|
* after \n or after words, etc.
|
||||||
*
|
*
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
* @title: Grouping
|
* @title: Grouping
|
||||||
* @short_description: lines grouing
|
* @short_description: lines grouing
|
||||||
*
|
*
|
||||||
* Lines groups manipulation API. The grouping API allows to create M:N
|
* Lines groups manipulation API. The grouping API can be used to create M:N
|
||||||
* relations between lines and on tree-like output it prints extra chart to
|
* relations between lines and on tree-like output it prints extra chart to
|
||||||
* visualize these relations. The group has unlimited number of members and
|
* visualize these relations. The group has unlimited number of members and
|
||||||
* group childs. See libsmartcols/sample/grouping* for more details.
|
* group childs. See libsmartcols/sample/grouping* for more details.
|
||||||
|
|
|
@ -11,7 +11,7 @@
|
||||||
/**
|
/**
|
||||||
* SECTION: symbols
|
* SECTION: symbols
|
||||||
* @title: Symbols
|
* @title: Symbols
|
||||||
* @short_description: allows to overwrite default output chars (for ascii art)
|
* @short_description: can be used to overwrite default output chars (for ascii art)
|
||||||
*
|
*
|
||||||
* An API to access and modify data and information per symbol/symbol group.
|
* An API to access and modify data and information per symbol/symbol group.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -199,7 +199,7 @@ static void timedout(int sig __attribute__ ((__unused__)))
|
||||||
}
|
}
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* This handler allows to inform a shell about signals to login. If you have
|
* This handler can be used to inform a shell about signals to login. If you have
|
||||||
* (root) permissions, you can kill all login children by one signal to the
|
* (root) permissions, you can kill all login children by one signal to the
|
||||||
* login process.
|
* login process.
|
||||||
*
|
*
|
||||||
|
|
|
@ -13,7 +13,7 @@ The file is usually located in /etc, but tools like
|
||||||
.BR hwclock (8)
|
.BR hwclock (8)
|
||||||
or
|
or
|
||||||
.BR rtcwake (8)
|
.BR rtcwake (8)
|
||||||
allow to use alternative location by command line options if write access to
|
can use alternative location by command line options if write access to
|
||||||
/etc is unwanted. The default clock mode is "UTC" if the file is missing.
|
/etc is unwanted. The default clock mode is "UTC" if the file is missing.
|
||||||
.PP
|
.PP
|
||||||
The Hardware Clock is usually not very accurate. However, much of its inaccuracy is completely predictable - it gains
|
The Hardware Clock is usually not very accurate. However, much of its inaccuracy is completely predictable - it gains
|
||||||
|
|
|
@ -1133,8 +1133,8 @@ static int init_kmsg(struct dmesg_control *ctl)
|
||||||
lseek(ctl->kmsg, 0, ctl->end ? SEEK_END : SEEK_DATA);
|
lseek(ctl->kmsg, 0, ctl->end ? SEEK_END : SEEK_DATA);
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Old kernels (<3.5) allow to successfully open /dev/kmsg for
|
* Old kernels (<3.5) can successfully open /dev/kmsg for read-only,
|
||||||
* read-only, but read() returns -EINVAL :-(((
|
* but read() returns -EINVAL :-(((
|
||||||
*
|
*
|
||||||
* Let's try to read the first record. The record is later processed in
|
* Let's try to read the first record. The record is later processed in
|
||||||
* read_kmsg().
|
* read_kmsg().
|
||||||
|
|
Loading…
Reference in New Issue