Skip to contentSkip to conversation

libmpathpersist: correct function description in mpath_persist.h and man file

PATCH Applied Wang Sheng-Hui 2 participants 2 messages Jan 5, 2013 Device mapper

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 libmpathpersist: correct function description in mpath_persist.h and man file

* For mpath_persistent_reserve_out, we have "#define MPATH_PRTPE_EA_RO

    0x06".

Correct the description of the function prototype
mpath_persistent_reserve_out
in mpath_persist.h and man file.
* Correct typo in the description for the function prototype mpath_persistent_reserve_in in mpath_persist.h

---
 libmpathpersist/mpath_persist.h                |    8 ++++----
 libmpathpersist/mpath_persistent_reserve_out.3 |    2 +-
 2 files changed, 5 insertions(+), 5 deletions(-)
libmpathpersist/mpath_persist.h +1 -1
index 42294e9..d8ff6f2 100644
@@ -194,15 +194,15 @@ extern int mpath_lib_exit (void );
  *
  * @fd:    The file descriptor of a multipath device. Input argument.
  * @rq_servact: PRIN command service action. Input argument
- * @resp: The response from PRIN service action. The resp is a struct specified below. The caller should
+ * @resp: The response from PRIN service action. The resp is a struct specified above. The caller should
  *     manage the memory allocation of this struct
  * @noisy: Turn on debugging trace: Input argument. 0->Disable, 1->Enable
  * @verbose: Set verbosity level. Input argument. value:[0-3]. 

0->disabled, 3->Max verbose
*
* RESTRICTIONS:
*
- * RETURNS: MPATH_PR_SUCCESS if PR command successful else returns any of the PR status (specified
- * above).
+ * RETURNS: MPATH_PR_SUCCESS if PR command successful else returns any of the status specified
+ * above in RETURN_STATUS.
*
*/
extern int mpath_persistent_reserve_in (int fd, int rq_servact, struct
prin_resp *resp,
@@ -217,7 +217,7 @@ extern int mpath_persistent_reserve_in (int fd, int rq_servact, struct prin_resp
* @rq_scope: Persistent reservation scope. The value should be always
LU_SCOPE (0h).
* @rq_type: Persistent reservation type. The valid values of
persistent reservation types are

  *    5h (Write exclusive - registrants only)
- *    8h (Exclusive access - registrants only)
+ *    6h (Exclusive access - registrants only)
  *    7h (Write exclusive - All registrants)
  *    8h (Exclusive access - All registrants).

* @paramp: PROUT command parameter data. The paramp is a struct which
describes PROUT

libmpathpersist/mpath_persistent_reserve_out.3 +0 -0
index 44f950b..f7f84ff 100644
@@ -26,7 +26,7 @@ sends PR OUT command to the DM device and gets the response.
 .I rq_type
 .B Persistent reservation type. The valid values of persistent 

reservation types are
5h (Write exclusive - registrants only)
- 8h (Exclusive access - registrants only)
+ 6h (Exclusive access - registrants only)
7h (Write exclusive - All registrants)
8h (Exclusive access - All registrants).
.br

Signature · 1 line
1.7.10.4
#1 lore raw
Quoted 8 lines · Wang Sheng-Hui

* For mpath_persistent_reserve_out, we have "#define MPATH_PRTPE_EA_RO

     0x06".

Correct the description of the function prototype
mpath_persistent_reserve_out
in mpath_persist.h and man file.
* Correct typo in the description for the function prototype mpath_persistent_reserve_in in mpath_persist.h

Applied.
Thanks.

Quoted 65 lines
---
  libmpathpersist/mpath_persist.h                |    8 ++++----
  libmpathpersist/mpath_persistent_reserve_out.3 |    2 +-
  2 files changed, 5 insertions(+), 5 deletions(-)
libmpathpersist/mpath_persist.h +0 -1
index 42294e9..d8ff6f2 100644
@@ -194,15 +194,15 @@ extern int mpath_lib_exit (void );
   *
   * @fd:    The file descriptor of a multipath device. Input argument.
   * @rq_servact: PRIN command service action. Input argument
- * @resp: The response from PRIN service action. The resp is a struct 

specified below. The caller should
+ * @resp: The response from PRIN service action. The resp is a struct specified above. The caller should
* manage the memory allocation of this struct
* @noisy: Turn on debugging trace: Input argument. 0->Disable, 1->Enable
* @verbose: Set verbosity level. Input argument. value:[0-3].
0->disabled, 3->Max verbose
*
* RESTRICTIONS:

   *

- * RETURNS: MPATH_PR_SUCCESS if PR command successful else returns any of the PR status (specified
- * above).
+ * RETURNS: MPATH_PR_SUCCESS if PR command successful else returns any of the status specified
+ * above in RETURN_STATUS.
*
*/
extern int mpath_persistent_reserve_in (int fd, int rq_servact, struct
prin_resp *resp,

libmpathpersist/mpath_persist.h +0 -0
@@ -217,7 +217,7 @@ extern int mpath_persistent_reserve_in (int fd, int 

rq_servact, struct prin_resp
* @rq_scope: Persistent reservation scope. The value should be always
LU_SCOPE (0h).
* @rq_type: Persistent reservation type. The valid values of
persistent reservation types are
* 5h (Write exclusive - registrants only)
- * 8h (Exclusive access - registrants only)
+ * 6h (Exclusive access - registrants only)
* 7h (Write exclusive - All registrants)
* 8h (Exclusive access - All registrants).
* @paramp: PROUT command parameter data. The paramp is a struct which
describes PROUT

libmpathpersist/mpath_persistent_reserve_out.3 +0 -0
index 44f950b..f7f84ff 100644
@@ -26,7 +26,7 @@ sends PR OUT command to the DM device and gets the 

response.
.I rq_type
.B Persistent reservation type. The valid values of persistent
reservation types are
5h (Write exclusive - registrants only)

libmpathpersist/mpath_persistent_reserve_out.3 +1 -1
-      8h (Exclusive access - registrants only)
+      6h (Exclusive access - registrants only)
        7h (Write exclusive - All registrants)
        8h (Exclusive access - All registrants).
  .br