[SCM] GNU libtasn1 branch, master, updated. libtasn1_2_8-10-g8fa44eb

[Simon Josefsson]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GNU libtasn1".

http://git.savannah.gnu.org/cgit/libtasn1.git/commit/?id=8fa44eb88953ab3f1f81762a683d056c3b4a182f

The branch, master has been updated
       via  8fa44eb88953ab3f1f81762a683d056c3b4a182f (commit)
      from  344781710415052d8e907df1d312c0140405235e (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 8fa44eb88953ab3f1f81762a683d056c3b4a182f
Author: Simon Josefsson <address@hidden>
Date:   Mon Dec 6 14:33:52 2010 +0100

    Doc fix.
    
    Reported by Jeffrey Walton <address@hidden>.

-----------------------------------------------------------------------

Summary of changes:
 NEWS            |    1 +
 THANKS          |    4 ++--
 lib/ASN1.c      |   45 +++++++++++++++------------------------------
 lib/ASN1.y      |   45 +++++++++++++++------------------------------
 lib/coding.c    |   15 +++++----------
 lib/element.c   |   35 +++++++++++------------------------
 lib/structure.c |   47 ++++++++++++++---------------------------------
 7 files changed, 63 insertions(+), 129 deletions(-)

diff --git a/NEWS b/NEWS
index 6af3fa4..00bf1a3 100644
--- a/NEWS
+++ b/NEWS
@@ -4,6 +4,7 @@ GNU Libtasn1 NEWS                                     -*- 
outline -*-
 - tests: Link to gnulib to avoid build error related to 'rpl_ftello' on 
Solaris.
   Reported by Dagobert Michelsen.
 - doc: Fix bug reporting address to point at address@hidden
+- doc: Fix Returns: documentation in Texinfo.  Reported by Jeffrey Walton.
 - build: Update gnulib files.
 
 * Noteworthy changes in release 2.8 (2010-09-25) [stable]
diff --git a/THANKS b/THANKS
index 8e39626..02c8a55 100644
--- a/THANKS
+++ b/THANKS
@@ -17,10 +17,10 @@ David Reiser            <address@hidden>
 Didier Godefroy         <address@hidden>
 Andreas Metzler         <address@hidden>
 Ludovic Courtès         <address@hidden>
+Jeffrey Walton          <address@hidden>
 
 ----------------------------------------------------------------------
-Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008,
-              2009, 2010 Free Software Foundation, Inc.
+Copyright (C) 2002-2010 Free Software Foundation, Inc.
 Copying and distribution of this file, with or without modification,
 are permitted in any medium without royalty provided the copyright
 notice and this notice are preserved.
diff --git a/lib/ASN1.c b/lib/ASN1.c
index 01e84b5..c54b845 100644
--- a/lib/ASN1.c
+++ b/lib/ASN1.c
@@ -2752,22 +2752,14 @@ _asn1_create_errorDescription(int error,char 
*errorDescription)
  * Function used to start the parse algorithm.  Creates the structures
  * needed to manage the definitions included in @file_name file.
  *
- * Returns:
- *
- * %ASN1_SUCCESS: The file has a correct syntax and every identifier
- * is known.
- *
- * %ASN1_ELEMENT_NOT_EMPTY: @definitions not %ASN1_TYPE_EMPTY.
- *
- * %ASN1_FILE_NOT_FOUND: An error occured while opening @file_name.
- *
- * %ASN1_SYNTAX_ERROR: The syntax is not correct.
- *
- * %ASN1_IDENTIFIER_NOT_FOUND: In the file there is an identifier that
- * is not defined.
- *
- * %ASN1_NAME_TOO_LONG: In the file there is an identifier whith more
- * than %ASN1_MAX_NAME_SIZE characters.
+ * Returns: %ASN1_SUCCESS if the file has a correct syntax and every
+ *   identifier is known, %ASN1_ELEMENT_NOT_EMPTY if @definitions not
+ *   %ASN1_TYPE_EMPTY, %ASN1_FILE_NOT_FOUND if an error occured while
+ *   opening @file_name, %ASN1_SYNTAX_ERROR if the syntax is not
+ *   correct, %ASN1_IDENTIFIER_NOT_FOUND if in the file there is an
+ *   identifier that is not defined, %ASN1_NAME_TOO_LONG if in the
+ *   file there is an identifier whith more than %ASN1_MAX_NAME_SIZE
+ *   characters.
  **/
 asn1_retCode
 asn1_parser2tree(const char *file_name, ASN1_TYPE *definitions,
@@ -2845,20 +2837,13 @@ asn1_parser2tree(const char *file_name, ASN1_TYPE 
*definitions,
  * "/aa/bb/xx_asn1_tab.c".  If @vectorName is %NULL the vector name
  * will be "xx_asn1_tab".
  *
- * Returns:
- *
- * %ASN1_SUCCESS: The file has a correct syntax and every identifier
- *   is known.
- *
- * %ASN1_FILE_NOT_FOUND: An error occured while opening @inputFileName.
- *
- * %ASN1_SYNTAX_ERROR: The syntax is not correct.
- *
- * %ASN1_IDENTIFIER_NOT_FOUND: In the file there is an identifier that
- *   is not defined.
- *
- * %ASN1_NAME_TOO_LONG: In the file there is an identifier whith more
- *   than %ASN1_MAX_NAME_SIZE characters.
+ * Returns: %ASN1_SUCCESS if the file has a correct syntax and every
+ *   identifier is known, %ASN1_FILE_NOT_FOUND if an error occured
+ *   while opening @inputFileName, %ASN1_SYNTAX_ERROR if the syntax is
+ *   not correct, %ASN1_IDENTIFIER_NOT_FOUND if in the file there is
+ *   an identifier that is not defined, %ASN1_NAME_TOO_LONG if in the
+ *   file there is an identifier whith more than %ASN1_MAX_NAME_SIZE
+ *   characters.
  **/
 int asn1_parser2array(const char *inputFileName,const char *outputFileName,
                      const char *vectorName,char *errorDescription){
diff --git a/lib/ASN1.y b/lib/ASN1.y
index ff74927..be1f02f 100644
--- a/lib/ASN1.y
+++ b/lib/ASN1.y
@@ -567,22 +567,14 @@ _asn1_create_errorDescription(int error,char 
*errorDescription)
  * Function used to start the parse algorithm.  Creates the structures
  * needed to manage the definitions included in @file_name file.
  *
- * Returns:
- *
- * %ASN1_SUCCESS: The file has a correct syntax and every identifier
- * is known.
- *
- * %ASN1_ELEMENT_NOT_EMPTY: @definitions not %ASN1_TYPE_EMPTY.
- *
- * %ASN1_FILE_NOT_FOUND: An error occured while opening @file_name.
- *
- * %ASN1_SYNTAX_ERROR: The syntax is not correct.
- *
- * %ASN1_IDENTIFIER_NOT_FOUND: In the file there is an identifier that
- * is not defined.
- *
- * %ASN1_NAME_TOO_LONG: In the file there is an identifier whith more
- * than %ASN1_MAX_NAME_SIZE characters.
+ * Returns: %ASN1_SUCCESS if the file has a correct syntax and every
+ *   identifier is known, %ASN1_ELEMENT_NOT_EMPTY if @definitions not
+ *   %ASN1_TYPE_EMPTY, %ASN1_FILE_NOT_FOUND if an error occured while
+ *   opening @file_name, %ASN1_SYNTAX_ERROR if the syntax is not
+ *   correct, %ASN1_IDENTIFIER_NOT_FOUND if in the file there is an
+ *   identifier that is not defined, %ASN1_NAME_TOO_LONG if in the
+ *   file there is an identifier whith more than %ASN1_MAX_NAME_SIZE
+ *   characters.
  **/
 asn1_retCode
 asn1_parser2tree(const char *file_name, ASN1_TYPE *definitions,
@@ -660,20 +652,13 @@ asn1_parser2tree(const char *file_name, ASN1_TYPE 
*definitions,
  * "/aa/bb/xx_asn1_tab.c".  If @vectorName is %NULL the vector name
  * will be "xx_asn1_tab".
  *
- * Returns:
- *
- * %ASN1_SUCCESS: The file has a correct syntax and every identifier
- *   is known.
- *
- * %ASN1_FILE_NOT_FOUND: An error occured while opening @inputFileName.
- *
- * %ASN1_SYNTAX_ERROR: The syntax is not correct.
- *
- * %ASN1_IDENTIFIER_NOT_FOUND: In the file there is an identifier that
- *   is not defined.
- *
- * %ASN1_NAME_TOO_LONG: In the file there is an identifier whith more
- *   than %ASN1_MAX_NAME_SIZE characters.
+ * Returns: %ASN1_SUCCESS if the file has a correct syntax and every
+ *   identifier is known, %ASN1_FILE_NOT_FOUND if an error occured
+ *   while opening @inputFileName, %ASN1_SYNTAX_ERROR if the syntax is
+ *   not correct, %ASN1_IDENTIFIER_NOT_FOUND if in the file there is
+ *   an identifier that is not defined, %ASN1_NAME_TOO_LONG if in the
+ *   file there is an identifier whith more than %ASN1_MAX_NAME_SIZE
+ *   characters.
  **/
 int asn1_parser2array(const char *inputFileName,const char *outputFileName,
                      const char *vectorName,char *errorDescription){
diff --git a/lib/coding.c b/lib/coding.c
index 31b5ebb..0c357eb 100644
--- a/lib/coding.c
+++ b/lib/coding.c
@@ -857,16 +857,11 @@ _asn1_ordering_set_of (unsigned char *der, int der_len, 
ASN1_TYPE node)
  * Creates the DER encoding for the NAME structure (inside *POINTER
  * structure).
  *
- * Returns:
- *
- *   %ASN1_SUCCESS: DER encoding OK.
- *
- *   %ASN1_ELEMENT_NOT_FOUND: NAME is not a valid element.
- *
- *   %ASN1_VALUE_NOT_FOUND: There is an element without a value.
- *
- *   %ASN1_MEM_ERROR: @ider vector isn't big enough. Also in this case
- *     LEN will contain the length needed.
+ * Returns: %ASN1_SUCCESS if DER encoding OK, %ASN1_ELEMENT_NOT_FOUND
+ *   if @name is not a valid element, %ASN1_VALUE_NOT_FOUND if there
+ *   is an element without a value, %ASN1_MEM_ERROR if the @ider
+ *   vector isn't big enough and in this case @len will contain the
+ *   length needed.
  **/
 asn1_retCode
 asn1_der_coding (ASN1_TYPE element, const char *name, void *ider, int *len,
diff --git a/lib/element.c b/lib/element.c
index 51ade14..71b893e 100644
--- a/lib/element.c
+++ b/lib/element.c
@@ -264,13 +264,9 @@ _asn1_append_sequence_set (ASN1_TYPE node)
  *           result=asn1_write_value(cert,
  *           "tbsCertificate.subject.rdnSequence.?LAST", "NEW", 1);
  *
- * Returns:
- *
- *   %ASN1_SUCCESS: Set value OK.
- *
- *   %ASN1_ELEMENT_NOT_FOUND: NAME is not a valid element.
- *
- *   %ASN1_VALUE_NOT_VALID: VALUE has a wrong format.
+ * Returns: %ASN1_SUCCESS if the value was set,
+ *   %ASN1_ELEMENT_NOT_FOUND if @name is not a valid element, and
+ *   %ASN1_VALUE_NOT_VALID if @ivalue has a wrong format.
  **/
 asn1_retCode
 asn1_write_value (ASN1_TYPE node_root, const char *name,
@@ -697,16 +693,12 @@ asn1_write_value (ASN1_TYPE node_root, const char *name,
  * ANY: If NAME indicates an any type, VALUE will indicate the DER
  *   encoding of the structure actually used.
  *
- * Returns:
- *
- *   %ASN1_SUCCESS: Set value OK.
- *
- *   %ASN1_ELEMENT_NOT_FOUND: NAME is not a valid element.
- *
- *   %ASN1_VALUE_NOT_FOUND: There isn't any value for the element selected.
- *
- *   %ASN1_MEM_ERROR: The value vector isn't big enough to store the result.
- *   In this case LEN will contain the number of bytes needed.
+ * Returns: %ASN1_SUCCESS if value is returned,
+ *   %ASN1_ELEMENT_NOT_FOUND if @name is not a valid element,
+ *   %ASN1_VALUE_NOT_FOUND if there isn't any value for the element
+ *   selected, and %ASN1_MEM_ERROR if The value vector isn't big enough
+ *   to store the result, and in this case @len will contain the number of
+ *   bytes needed.
  **/
 asn1_retCode
 asn1_read_value (ASN1_TYPE root, const char *name, void *ivalue, int *len)
@@ -883,11 +875,8 @@ asn1_read_value (ASN1_TYPE root, const char *name, void 
*ivalue, int *len)
  * %ASN1_CLASS_UNIVERSAL, %ASN1_CLASS_PRIVATE or
  * %ASN1_CLASS_CONTEXT_SPECIFIC.
  *
- * Returns:
- *
- *   %ASN1_SUCCESS: Set value OK.
- *
- *   %ASN1_ELEMENT_NOT_FOUND: NAME is not a valid element.
+ * Returns: %ASN1_SUCCESS if successful, %ASN1_ELEMENT_NOT_FOUND if
+ *   @name is not a valid element.
  **/
 asn1_retCode
 asn1_read_tag (ASN1_TYPE root, const char *name, int *tagValue,
@@ -986,7 +975,5 @@ asn1_read_tag (ASN1_TYPE root, const char *name, int 
*tagValue,
        }
     }
 
-
   return ASN1_SUCCESS;
-
 }
diff --git a/lib/structure.c b/lib/structure.c
index b1c5b30..a272d62 100644
--- a/lib/structure.c
+++ b/lib/structure.c
@@ -168,16 +168,11 @@ _asn1_create_static_structure (ASN1_TYPE pointer, char 
*output_file_name,
  * Creates the structures needed to manage the ASN.1 definitions.
  * @array is a vector created by asn1_parser2array().
  *
- * Returns:
- *
- * %ASN1_SUCCESS: Structure created correctly.
- *
- * %ASN1_ELEMENT_NOT_EMPTY: address@hidden not ASN1_TYPE_EMPTY.
- *
- * %ASN1_IDENTIFIER_NOT_FOUND: In the file there is an identifier that
- *   is not defined (see @errorDescription for more information).
- *
- * %ASN1_ARRAY_ERROR: The array pointed by @array is wrong.
+ * Returns: %ASN1_SUCCESS if structure was created correctly,
+ *   %ASN1_ELEMENT_NOT_EMPTY if address@hidden not ASN1_TYPE_EMPTY,
+ *   %ASN1_IDENTIFIER_NOT_FOUND if in the file there is an identifier
+ *   that is not defined (see @errorDescription for more information),
+ *   %ASN1_ARRAY_ERROR if the array pointed by @array is wrong.
  **/
 asn1_retCode
 asn1_array2tree (const ASN1_ARRAY_TYPE * array, ASN1_TYPE * definitions,
@@ -284,11 +279,8 @@ asn1_array2tree (const ASN1_ARRAY_TYPE * array, ASN1_TYPE 
* definitions,
  * Deletes the structure address@hidden  At the end, address@hidden is set
  * to ASN1_TYPE_EMPTY.
  *
- * Returns:
- *
- * %ASN1_SUCCESS: Everything OK.
- *
- * %ASN1_ELEMENT_NOT_FOUND: address@hidden was ASN1_TYPE_EMPTY.
+ * Returns: %ASN1_SUCCESS if successful, %ASN1_ELEMENT_NOT_FOUND if
+ *   address@hidden was ASN1_TYPE_EMPTY.
  **/
 asn1_retCode
 asn1_delete_structure (ASN1_TYPE * structure)
@@ -351,11 +343,8 @@ asn1_delete_structure (ASN1_TYPE * structure)
  *
  * Deletes the element named address@hidden inside address@hidden
  *
- * Returns:
- *
- * %ASN1_SUCCESS: Everything OK.
- *
- * %ASN1_ELEMENT_NOT_FOUND: The name element was not found.
+ * Returns: %ASN1_SUCCESS if successful, %ASN1_ELEMENT_NOT_FOUND if
+ *   the @element_name was not found.
  **/
 asn1_retCode
 asn1_delete_element (ASN1_TYPE structure, const char *element_name)
@@ -670,11 +659,8 @@ _asn1_expand_identifier (ASN1_TYPE * node, ASN1_TYPE root)
  *
  * rc = asn1_create_element(cert_def, "PKIX1.Certificate", certptr);
  *
- * Returns:
- *
- * %ASN1_SUCCESS: Creation OK.
- *
- * %ASN1_ELEMENT_NOT_FOUND: SOURCE_NAME isn't known
+ * Returns: %ASN1_SUCCESS if creation OK, %ASN1_ELEMENT_NOT_FOUND if
+ *   @source_name is not known.
  **/
 asn1_retCode
 asn1_create_element (ASN1_TYPE definitions, const char *source_name,
@@ -1072,13 +1058,8 @@ asn1_print_structure (FILE * out, ASN1_TYPE structure, 
const char *name,
  * Counts the number of elements of a sub-structure called NAME with
  * names equal to "?1","?2", ...
  *
- * Returns:
- *
- *  %ASN1_SUCCESS: Creation OK.
- *
- *  %ASN1_ELEMENT_NOT_FOUND: NAME isn't known.
- *
- *  %ASN1_GENERIC_ERROR: Pointer num equal to NULL.
+ * Returns: %ASN1_SUCCESS if successful, %ASN1_ELEMENT_NOT_FOUND if
+ *   @name is not known, %ASN1_GENERIC_ERROR if pointer @num is %NULL.
  **/
 asn1_retCode
 asn1_number_of_elements (ASN1_TYPE element, const char *name, int *num)
@@ -1171,7 +1152,7 @@ asn1_find_structure_from_oid (ASN1_TYPE definitions, 
const char *oidValue)
  *
  * Create a deep copy of a ASN1_TYPE variable.
  *
- * Return value: Return %ASN1_SUCCESS on success.
+ * Returns: Return %ASN1_SUCCESS on success.
  **/
 asn1_retCode
 asn1_copy_node (ASN1_TYPE dst, const char *dst_name,


hooks/post-receive
-- 
GNU libtasn1