Signed-off-by: Tony Asleson <***@redhat.com>
---
c_binding/include/libstoragemgmt/libstoragemgmt.h | 4 +-
.../libstoragemgmt/libstoragemgmt_plug_interface.h | 28 +++++-----
.../libstoragemgmt/libstoragemgmt_targetport.h | 2 +-
c_binding/lsm_convert.cpp | 5 --
c_binding/lsm_convert.hpp | 8 +--
c_binding/lsm_datatypes.cpp | 1 +
doc/doxygen.conf.in | 2 +-
python_binding/lsm/_client.py | 63 ++++++++++++----------
8 files changed, 60 insertions(+), 53 deletions(-)
diff --git a/c_binding/include/libstoragemgmt/libstoragemgmt.h b/c_binding/include/libstoragemgmt/libstoragemgmt.h
index 764b70f..6c68c3d 100644
--- a/c_binding/include/libstoragemgmt/libstoragemgmt.h
+++ b/c_binding/include/libstoragemgmt/libstoragemgmt.h
@@ -476,7 +476,7 @@ extern "C" {
/**
* Set the username password for CHAP authentication, inbound and outbound.
* @param conn Valid connection pointer
- * @param initiator Initiator ID
+ * @param init_id Initiator ID
* @param in_user inbound user name
* @param in_password inbound password
* @param out_user outbound user name
@@ -488,7 +488,7 @@ extern "C" {
const char *init_id,
const char *in_user,
const char *in_password,
- const char * out_user,
+ const char *out_user,
const char *out_password,
lsm_flag flags);
diff --git a/c_binding/include/libstoragemgmt/libstoragemgmt_plug_interface.h b/c_binding/include/libstoragemgmt/libstoragemgmt_plug_interface.h
index 1702632..1e9fe99 100644
--- a/c_binding/include/libstoragemgmt/libstoragemgmt_plug_interface.h
+++ b/c_binding/include/libstoragemgmt/libstoragemgmt_plug_interface.h
@@ -218,7 +218,7 @@ typedef int (*lsm_plug_disk_list)( lsm_plugin_ptr c, const char *search_key,
* @param[in] c Valid lsm plugin-in pointer
* @param[in] search_key Search key
* @param[in] search_value Search value
- * @parma[out] target_port_array Array of target port pointers
+ * @param[out] target_port_array Array of target port pointers
* @param[out] count Number of target ports
* @param[in] flags Reserved
* @return LSM_ERR_OK, else error reason
@@ -1000,7 +1000,7 @@ void LSM_DLL_EXPORT lsm_pool_free_space_set(lsm_pool *p, uint64_t free_space);
* Helper function to allocate a pool record.
* @param id System unique identifier
* @param name Human readable name
- * @param usage A bit field which states what the pool can be used to
+ * @param element_type A bit field which states what the pool can be used to
* create
* @param total_space Total space
* @param free_space Space available
@@ -1097,7 +1097,7 @@ lsm_system LSM_DLL_EXPORT **lsm_system_record_array_alloc( uint32_t size );
* @param[in] id Id
* @param[in] name System name (human readable)
* @param[in] status Status of the system
- * @oaram[in] status_info Additional text for status
+ * @param[in] status_info Additional text for status
* @param[in] plugin_data Private plugin data
* @return Allocated memory or NULL on error.
*/
@@ -1127,6 +1127,7 @@ lsm_access_group LSM_DLL_EXPORT **lsm_access_group_record_array_alloc( uint32_t
* @param id ID of access group
* @param name Name of access group
* @param initiators List of initiators, can be NULL
+ * @param init_type Initiator group type
* @param system_id System id
* @param plugin_data Reserved for plug-in use only
* @return NULL on error, else valid lsm_access_group pointer.
@@ -1174,7 +1175,7 @@ lsm_fs LSM_DLL_EXPORT **lsm_fs_record_array_alloc( uint32_t size );
/**
* Used to retrieve the plug-in private data for a specific pool
- * @param p Pool to retrieve plug-in private data for
+ * @param fs FS to retrieve plug-in private data for
* @return NULL if doesn't exist, else data.
*/
const char *lsm_fs_plugin_data_get(lsm_fs *fs);
@@ -1201,7 +1202,7 @@ lsm_fs_ss LSM_DLL_EXPORT **lsm_fs_ss_record_array_alloc( uint32_t size );
/**
* Retrieve private data from fs_ss.
- * @param exp Valid fs_ss record
+ * @param fs_ss Valid fs_ss record
* @return Private data, else NULL
*/
const char LSM_DLL_EXPORT *lsm_fs_ss_plugin_data_get( lsm_fs_ss *fs_ss );
@@ -1238,12 +1239,13 @@ lsm_storage_capabilities LSM_DLL_EXPORT *lsm_capability_record_alloc(char const
/**
* Convenience function for plug-in writer.
* Note: Make sure to free returned items to prevent memory leaks.
- * @param[in] uri
- * @param[out] scheme
- * @param[out] user
- * @param[out] server
- * @param[out] port
- * @param[out] query_params
+ * @param[in] uri URI to parse
+ * @param[out] scheme returned scheme
+ * @param[out] user returned user
+ * @param[out] server returned server
+ * @param[out] port returned port
+ * @param[out] path returned path
+ * @param[out] query_params returned query params
* @return LSM_ERR_OK on successful parse, else error reason.
*/
int LSM_DLL_EXPORT lsm_uri_parse(const char *uri, char **scheme, char **user,
@@ -1293,7 +1295,7 @@ void LSM_DLL_EXPORT lsm_plug_disk_search_filter(const char *search_key,
* Note: Filters in place removing and freeing those that don't match.
* @param search_key Search field
* @param search_value Search value
- * @param[in,out] disks Array to filter
+ * @param[in,out] ag Array to filter
* @param[in,out] count Number of access groups to filter, number remain
*/
void LSM_DLL_EXPORT lsm_plug_access_group_search_filter(const char *search_key,
@@ -1317,7 +1319,7 @@ void LSM_DLL_EXPORT lsm_plug_fs_search_filter(const char *search_key,
* Note: Filters in place removing and freeing those that don't match.
* @param search_key Search field
* @param search_value Search value
- * @param[in,out] fs Array to filter
+ * @param[in,out] exports Array to filter
* @param[in,out] count Number of nfs exports to filter, number remain
*/
void LSM_DLL_EXPORT lsm_plug_nfs_export_search_filter(const char *search_key,
diff --git a/c_binding/include/libstoragemgmt/libstoragemgmt_targetport.h b/c_binding/include/libstoragemgmt/libstoragemgmt_targetport.h
index 7902f56..d10f1d8 100644
--- a/c_binding/include/libstoragemgmt/libstoragemgmt_targetport.h
+++ b/c_binding/include/libstoragemgmt/libstoragemgmt_targetport.h
@@ -37,7 +37,7 @@ lsm_target_port LSM_DLL_EXPORT *lsm_target_port_copy(lsm_target_port *tp);
/**
* Frees the resources for a lsm_system
- * @param s Record to release
+ * @param tp Record to release
* @return LSM_ERR_OK on success, else error reason.
*/
int LSM_DLL_EXPORT lsm_target_port_record_free(lsm_target_port *tp);
diff --git a/c_binding/lsm_convert.cpp b/c_binding/lsm_convert.cpp
index 428cb16..c149738 100644
--- a/c_binding/lsm_convert.cpp
+++ b/c_binding/lsm_convert.cpp
@@ -598,11 +598,6 @@ lsm_target_port *value_to_target_port(Value &tp)
return rc;
}
-/**
- * Converts a lsm_target_port to a value
- * @param cap lsm_target_port to convert to value
- * @return Value
- */
Value target_port_to_value(lsm_target_port *tp)
{
if( LSM_IS_TARGET_PORT(tp) ) {
diff --git a/c_binding/lsm_convert.hpp b/c_binding/lsm_convert.hpp
index afacf9b..b0c7586 100644
--- a/c_binding/lsm_convert.hpp
+++ b/c_binding/lsm_convert.hpp
@@ -78,9 +78,9 @@ Value disk_to_value(lsm_disk *disk);
/**
* Converts a vector of disk values to an array.
- * @param disks Vector of values that represents disks
- * @param disks An array of disk pointers
- * @param count Number of disks
+ * @param[in] disk_values Vector of values that represents disks
+ * @param[out] disks An array of disk pointers
+ * @param[out] count Number of disks
* @return LSM_ERR_OK on success, else error reason.
*/
int value_array_to_disks(Value &disk_values, lsm_disk **disks[],
@@ -240,7 +240,7 @@ lsm_target_port *value_to_target_port(Value &tp);
/**
* Converts a lsm_target_port to a value
- * @param cap lsm_target_port to convert to value
+ * @param tp lsm_target_port to convert to value
* @return Value
*/
Value target_port_to_value(lsm_target_port *tp);
diff --git a/c_binding/lsm_datatypes.cpp b/c_binding/lsm_datatypes.cpp
index ca74c12..b654557 100644
--- a/c_binding/lsm_datatypes.cpp
+++ b/c_binding/lsm_datatypes.cpp
@@ -482,6 +482,7 @@ rtype *name(uint32_t size) \
* @param name Name of function to create
* @param free_func Function to call to free one of the elements
* @param record_type Type to record
+ * @param error Value to return on error
* @return None
*/
#define CREATE_FREE_ARRAY_FUNC(name, free_func, record_type, error)\
diff --git a/doc/doxygen.conf.in b/doc/doxygen.conf.in
index 43a96e5..fbbd0c1 100644
--- a/doc/doxygen.conf.in
+++ b/doc/doxygen.conf.in
@@ -584,7 +584,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = . tools/lsmclipy/lsmcli
+INPUT = . tools/lsmcli
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
diff --git a/python_binding/lsm/_client.py b/python_binding/lsm/_client.py
index fbec4a8..d22bb24 100644
--- a/python_binding/lsm/_client.py
+++ b/python_binding/lsm/_client.py
@@ -283,11 +283,10 @@ class Client(INetworkAttachedStorage):
return self._tp.rpc('plugin_info', _del_self(locals()))
## Returns an array of pool objects.
- # @param self The this pointer
- # @param flags When equal to Pool.FLAG_RETRIEVE_FULL_INFO,
- # returned objects will contain optional data.
- # If not defined, only the mandatory properties will
- # returned.
+ # @param self The this pointer
+ # @param search_key Search key
+ # @param search_value Search value
+ # @param flags Reserved for future use, must be zero.
# @returns An array of pool objects.
@_return_requires([Pool])
def pools(self, search_key=None, search_value=None, flags=0):
@@ -343,7 +342,7 @@ class Client(INetworkAttachedStorage):
# @param system_id The id of system where new pool should reside.
# @param pool_name The name for new pool. Will not fail if created
# pool_name is not the same as requested.
- # @param Disks The disks (list) to create new pool from.
+ # @param disks The disks (list) to create new pool from.
# The new pool could contain more disks than
# requested due to internal needs, but if possible,
# new pool should only contain requested disks.
@@ -431,8 +430,10 @@ class Client(INetworkAttachedStorage):
return self._tp.rpc('iscsi_chap_auth', _del_self(locals()))
## Returns an array of volume objects
- # @param self The this pointer
- # @param flags Reserved for future use, must be zero.
+ # @param self The this pointer
+ # @param search_key Search key to use
+ # @param search_value Search value
+ # @param flags Reserved for future use, must be zero.
# @returns An array of volume objects.
@_return_requires([Volume])
def volumes(self, search_key=None, search_value=None, flags=0):
@@ -581,6 +582,8 @@ class Client(INetworkAttachedStorage):
## Returns an array of disk objects
# @param self The this pointer
+ # @param search_key Search Key
+ # @param search_value Search value
# @param flags When equal to DISK.FLAG_RETRIEVE_FULL_INFO
# returned objects will contain optional data.
# If not defined, only the mandatory properties will
@@ -595,10 +598,10 @@ class Client(INetworkAttachedStorage):
return self._tp.rpc('disks', _del_self(locals()))
## Access control for allowing an access group to access a volume
- # @param self The this pointer
- # @param group The access group
- # @param volume The volume to grant access to
- # @param flags Reserved for future use, must be zero.
+ # @param self The this pointer
+ # @param access_group The access group
+ # @param volume The volume to grant access to
+ # @param flags Reserved for future use, must be zero.
# @returns None on success, throws LsmError on errors.
@_return_requires(None)
def volume_mask(self, access_group, volume, flags=0):
@@ -608,10 +611,10 @@ class Client(INetworkAttachedStorage):
return self._tp.rpc('volume_mask', _del_self(locals()))
## Revokes access to a volume to initiators in an access group
- # @param self The this pointer
- # @param group The access group
- # @param volume The volume to grant access to
- # @param flags Reserved for future use, must be zero.
+ # @param self The this pointer
+ # @param access_group The access group
+ # @param volume The volume to grant access to
+ # @param flags Reserved for future use, must be zero.
# @returns None on success, throws LsmError on errors.
@_return_requires(None)
def volume_unmask(self, access_group, volume, flags=0):
@@ -622,6 +625,8 @@ class Client(INetworkAttachedStorage):
## Returns a list of access group objects
# @param self The this pointer
+ # @param search_key Search Key
+ # @param search_value Search value
# @param flags Reserved for future use, must be zero.
# @returns List of access groups
@_return_requires([AccessGroup])
@@ -650,9 +655,9 @@ class Client(INetworkAttachedStorage):
return self._tp.rpc('access_group_create', _del_self(locals()))
## Deletes an access group.
- # @param self The this pointer
- # @param group The access group to delete
- # @param flags Reserved for future use, must be zero.
+ # @param self The this pointer
+ # @param access_group The access group to delete
+ # @param flags Reserved for future use, must be zero.
# @returns None on success, throws LsmError on errors.
@_return_requires(None)
def access_group_delete(self, access_group, flags=0):
@@ -663,7 +668,7 @@ class Client(INetworkAttachedStorage):
## Adds an initiator to an access group
# @param self The this pointer
- # @param group Group to add initiator to
+ # @param access_group Group to add initiator to
# @param init_id Initiators id
# @param init_type Initiator id type (enumeration)
# @param flags Reserved for future use, must be zero.
@@ -678,8 +683,8 @@ class Client(INetworkAttachedStorage):
## Deletes an initiator from an access group
# @param self The this pointer
- # @param group The access group to remove initiator from
- # @param initiator_id The initiator to remove from the group
+ # @param access_group The access group to remove initiator from
+ # @param init_id The initiator to remove from the group
# @param flags Reserved for future use, must be zero.
# @returns None on success, throws LsmError on errors.
@_return_requires(None)
@@ -691,9 +696,9 @@ class Client(INetworkAttachedStorage):
_del_self(locals()))
## Returns the list of volumes that access group has access to.
- # @param self The this pointer
- # @param group The access group to list volumes for
- # @param flags Reserved for future use, must be zero.
+ # @param self The this pointer
+ # @param access_group The access group to list volumes for
+ # @param flags Reserved for future use, must be zero.
# @returns list of volumes
@_return_requires([Volume])
def volumes_accessible_by_access_group(self, access_group, flags=0):
@@ -753,8 +758,10 @@ class Client(INetworkAttachedStorage):
return self._tp.rpc('volume_child_dependency_rm', _del_self(locals()))
## Returns a list of file system objects.
- # @param self The this pointer
- # @param flags Reserved for future use, must be zero.
+ # @param self The this pointer
+ # @param search_key Search Key
+ # @param search_value Search value
+ # @param flags Reserved for future use, must be zero.
# @returns A list of FS objects.
@_return_requires([FileSystem])
def fs(self, search_key=None, search_value=None, flags=0):
@@ -990,6 +997,8 @@ class Client(INetworkAttachedStorage):
## Returns a list of all the exported file systems
# @param self The this pointer
+ # @param search_key Search Key
+ # @param search_value Search value
# @param flags Reserved for future use, must be zero.
# @returns An array of export objects
@_return_requires([NfsExport])
--
1.8.2.1