[libknet] fix comments and update man pages

Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>

diff --git a/libknet/libknet.h b/libknet/libknet.h
index 49804db3f635ee880c3ebb4b5c186ceb8e161cfe..77f2fa1fe910964456c3954e56db47923be10062 100644 (file)
--- a/libknet/libknet.h
+++ b/libknet/libknet.h
@@ -805,13 +805,13 @@ struct knet_crypto_info {
  * @brief Get a list of supported crypto libraries
  *
  * crypto_list  - array of struct knet_crypto_info *
- *                If NULL then only the number of names is returned in crypto_list_entries
+ *                If NULL then only the number of structs is returned in crypto_list_entries
  *                to allow the caller to allocate sufficient space.
  *               libknet does not allow more than 256 crypto methods at the moment.
  *               it is safe to allocate 256 structs to avoid calling
  *               knet_get_crypto_list twice.
  *
- * crypto_list_entries - returns the number of strings in crypto_names
+ * crypto_list_entries - returns the number of structs in crypto_list
  *
  * @return
  * knet_get_crypto_list returns
@@ -836,13 +836,13 @@ struct knet_compress_info {
  * @brief Get a list of support compression types
  *
  * compress_list - array of struct knet_compress_info *
- *                If NULL then only the number of names is returned in num_names to
+ *                If NULL then only the number of structs is returned in compress_list_entries
  *                to allow the caller to allocate sufficient space.
  *                libknet does not allow more than 256 compress methods at the moment.
  *                it is safe to allocate 256 structs to avoid calling
  *                knet_get_compress_list twice.
  *
- * compress_list_entries - returns the number of strings in compres_names
+ * compress_list_entries - returns the number of structs in compress_list
  *
  * @return
  * knet_get_compress_list returns

diff --git a/libknet/man/knet_get_compress_list.3 b/libknet/man/knet_get_compress_list.3
index c849bf1febd3674dc003111a0aa918834d50ce4f..2c87d23169cd947584335141fc5ea9042d07480d 100644 (file)
--- a/libknet/man/knet_get_compress_list.3
+++ b/libknet/man/knet_get_compress_list.3
@@ -16,9 +16,9 @@ knet_get_compress_list \- Get a list of support compression types.
 .PP 
 knet_get_compress_list
 .PP 
-compress_list - array of struct knet_compress_info * If NULL then only the number of names is returned in num_names to to allow the caller to allocate sufficient space. libknet does not allow more than 256 compress methods at the moment. it is safe to allocate 256 structs to avoid calling knet_get_compress_list twice.
+compress_list - array of struct knet_compress_info * If NULL then only the number of structs is returned in compress_list_entries to allow the caller to allocate sufficient space. libknet does not allow more than 256 compress methods at the moment. it is safe to allocate 256 structs to avoid calling knet_get_compress_list twice.
 .PP 
-compress_list_entries - returns the number of strings in compres_names
+compress_list_entries - returns the number of structs in compress_list
 .SH STRUCTURES
 .SS ""
 .PP

diff --git a/libknet/man/knet_get_crypto_list.3 b/libknet/man/knet_get_crypto_list.3
index 492a80d73c9250d0a3e7e546e47663c046839035..ae20ce2b2acb7599af739c824bcdf5885b102a93 100644 (file)
--- a/libknet/man/knet_get_crypto_list.3
+++ b/libknet/man/knet_get_crypto_list.3
@@ -16,9 +16,9 @@ knet_get_crypto_list \- Get a list of supported crypto libraries.
 .PP 
 knet_get_crypto_list
 .PP 
-crypto_list - array of struct knet_crypto_info * If NULL then only the number of names is returned in crypto_list_entries to allow the caller to allocate sufficient space. libknet does not allow more than 256 crypto methods at the moment. it is safe to allocate 256 structs to avoid calling knet_get_crypto_list twice.
+crypto_list - array of struct knet_crypto_info * If NULL then only the number of structs is returned in crypto_list_entries to allow the caller to allocate sufficient space. libknet does not allow more than 256 crypto methods at the moment. it is safe to allocate 256 structs to avoid calling knet_get_crypto_list twice.
 .PP 
-crypto_list_entries - returns the number of strings in crypto_names
+crypto_list_entries - returns the number of structs in crypto_list
 .SH STRUCTURES
 .SS ""
 .PP

diff --git a/libknet/man/libknet.h.3 b/libknet/man/libknet.h.3
index 3bd060386eaf3599af862ea4ae92a4f82473b692..6b5c0d21c36fe7b2cdb3375318fa44dd8433ee23 100644 (file)
--- a/libknet/man/libknet.h.3
+++ b/libknet/man/libknet.h.3
@@ -83,6 +83,54 @@ int           knet_strtoaddr(const char *, const char *, struct sockaddr_storage
 .RS
 .nf
 \fB
+struct knet_handle_crypto_cfg {
+  char          \fIcrypto_model\fP;
+  char          \fIcrypto_cipher_type\fP;
+  char          \fIcrypto_hash_type\fP;
+  unsigned char \fIprivate_key\fP;
+  unsigned int  \fIprivate_key_len\fP;
+};
+\fP
+.fi
+.RE
+.SS ""
+.PP
+.sp
+.sp
+.RS
+.nf
+\fB
+struct knet_transport_info {
+  const char  *\fIname\fP;
+  uint8_t      \fIid\fP;
+  uint8_t      \fIproperties\fP;
+  char         \fIpad\fP;
+};
+\fP
+.fi
+.RE
+.SS ""
+.PP
+.sp
+.sp
+.RS
+.nf
+\fB
+struct knet_host_status {
+  uint8_t  \fIreachable\fP;
+  uint8_t  \fIremote\fP;
+  uint8_t  \fIexternal\fP;
+};
+\fP
+.fi
+.RE
+.SS ""
+.PP
+.sp
+.sp
+.RS
+.nf
+\fB
 struct knet_handle_stats {
   size_t   \fIsize\fP;
   uint64_t \fItx_uncompressed_packets\fP;
@@ -143,37 +191,6 @@ struct knet_link_status {
 .RS
 .nf
 \fB
-struct knet_crypto_info {
-  const char  *\fIname\fP;
-  uint8_t      \fIproperties\fP;
-  char         \fIpad\fP;
-};
-\fP
-.fi
-.RE
-.SS ""
-.PP
-.sp
-.sp
-.RS
-.nf
-\fB
-struct knet_transport_info {
-  const char  *\fIname\fP;
-  uint8_t      \fIid\fP;
-  uint8_t      \fIproperties\fP;
-  char         \fIpad\fP;
-};
-\fP
-.fi
-.RE
-.SS ""
-.PP
-.sp
-.sp
-.RS
-.nf
-\fB
 struct knet_handle_compress_cfg {
   char     \fIcompress_model\fP;
   uint32_t \fIcompress_threshold\fP;
@@ -189,7 +206,7 @@ struct knet_handle_compress_cfg {
 .RS
 .nf
 \fB
-struct knet_compress_info {
+struct knet_crypto_info {
   const char  *\fIname\fP;
   uint8_t      \fIproperties\fP;
   char         \fIpad\fP;
@@ -204,27 +221,10 @@ struct knet_compress_info {
 .RS
 .nf
 \fB
-struct knet_host_status {
-  uint8_t  \fIreachable\fP;
-  uint8_t  \fIremote\fP;
-  uint8_t  \fIexternal\fP;
-};
-\fP
-.fi
-.RE
-.SS ""
-.PP
-.sp
-.sp
-.RS
-.nf
-\fB
-struct knet_handle_crypto_cfg {
-  char          \fIcrypto_model\fP;
-  char          \fIcrypto_cipher_type\fP;
-  char          \fIcrypto_hash_type\fP;
-  unsigned char \fIprivate_key\fP;
-  unsigned int  \fIprivate_key_len\fP;
+struct knet_compress_info {
+  const char  *\fIname\fP;
+  uint8_t      \fIproperties\fP;
+  char         \fIpad\fP;
 };
 \fP
 .fi