* This is the base handle that is needed to open and create objects such as
* volume groups and logical volumes. In addition, this handle provides a
* context for error handling information, saving any error number (see
- * lvm_errno) and error message (see lvm_errmsg) that any function may
+ * lvm_errno()) and error message (see lvm_errmsg()) that any function may
* generate.
*/
typedef struct lvm *lvm_t;
*
* \memberof lvm_t
*
- * Once all LVM operations have been completed, use lvm_quit to release
+ * Once all LVM operations have been completed, use lvm_quit() to release
* the handle and any associated resources.
*
* \param system_dir
* \return
* A valid LVM handle is returned or NULL if there has been a
* memory allocation problem. You have to check if an error occured
- * with the lvm_error function.
+ * with the lvm_error() function.
*/
lvm_t lvm_init(const char *system_dir);
*
* \memberof lvm_t
*
- * This function may be used in conjunction with lvm_errno to obtain more
+ * This function may be used in conjunction with lvm_errno() to obtain more
* specific error information for a function that is known to have failed.
*
* \param libh
* \memberof lvm_t
*
* The memory allocated for the list is tied to the lvm_t handle and will be
- * released when lvm_quit is called.
+ * released when lvm_quit() is called.
*
* NOTE: This function normally does not scan devices in the system for LVM
- * metadata. To scan the system, use lvm_scan.
+ * metadata. To scan the system, use lvm_scan().
*
* To process the list, use the dm_list iterator functions. For example:
* vg_t vg;
* \memberof lvm_t
*
* The memory allocated for the list is tied to the lvm_t handle and will be
- * released when lvm_quit is called.
+ * released when lvm_quit() is called.
*
* NOTE: This function normally does not scan devices in the system for LVM
- * metadata. To scan the system, use lvm_scan.
+ * metadata. To scan the system, use lvm_scan().
*
* \param libh
* Handle obtained from lvm_init().
* \memberof lvm_t
*
* The memory allocated for the name is tied to the lvm_t handle and will be
- * released when lvm_quit is called.
+ * released when lvm_quit() is called.
*
* NOTE: This function may scan devices in the system for LVM metadata.
*
* \memberof lvm_t
*
* The memory allocated for the name is tied to the lvm_t handle and will be
- * released when lvm_quit is called.
+ * released when lvm_quit() is called.
*
* NOTE: This function may scan devices in the system for LVM metadata.
*
* \memberof vg_t
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* A list of lvm_lv_list structures containing lv handles for this vg.
* \memberof vg_t
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* A list of lvm_pv_list structures containing pv handles for this vg.
* with lvm_vg_close().
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* 0 (success) or -1 (failure).
* calling lvm_vg_write() to commit the removal to disk.
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* 0 (success) or -1 (failure).
* handle.
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* 0 (success) or -1 (failure).
* If the device is not initialized for LVM use, it will be initialized
* before adding to the VG. Although some internal checks are done,
* the caller should be sure the device is not in use by other subsystems
- * before calling lvm_vg_extend.
+ * before calling lvm_vg_extend().
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \param device
* Absolute pathname of device to add to VG.
* lvm_vg_close().
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \param device
* Name of device to remove from VG.
* with lvm_vg_close().
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \param tag
* Tag to add to the VG.
* with lvm_vg_close().
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \param tag
* Tag to remove from VG.
* handle with lvm_vg_close().
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \param new_size
* New extent size in bytes.
* \memberof vg_t
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* 1 if the VG is clustered, 0 if not
* \memberof vg_t
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* 1 if the VG is exported, 0 if not
* group.
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* 1 if the VG is PVs, 0 if not
* have changed from a prior query.
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* Metadata sequence number.
* released when lvm_vg_close() is called.
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* Copy of the uuid string.
* released when lvm_vg_close() is called.
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* Copy of the name.
* \memberof vg_t
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* Size in bytes.
* \memberof vg_t
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* Free size in bytes.
* \memberof vg_t
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* Extent size in bytes.
* \memberof vg_t
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* Extent count.
* \memberof vg_t
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* Free extent count.
* \memberof vg_t
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* Physical volume count.
* \memberof vg_t
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* Maximum number of physical volumes allowed in a volume group.
* \memberof vg_t
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \return
* Maximum number of logical volumes allowed in a volume group.
* as the API is developed.
*
* \param vg
- * VG handle obtained from lvm_vg_create or lvm_vg_open().
+ * VG handle obtained from lvm_vg_create() or lvm_vg_open().
*
* \param name
* Name of logical volume to create.
*
* \memberof lv_t
*
- * The memory allocated for the uuid is tied to the vg_t handle and will be
+ * The memory allocated for the name is tied to the vg_t handle and will be
* released when lvm_vg_close() is called.
*
* \param lv
*
* \memberof pv_t
*
- * The memory allocated for the uuid is tied to the vg_t handle and will be
+ * The memory allocated for the name is tied to the vg_t handle and will be
* released when lvm_vg_close() is called.
*
* \param pv