Fix documentation warnings.

 * P11_KIT_URI_NO_MEMORY is an unexpected state, that will probably
   never actually be returned. But kept for API compatibility.
 * make distcheck doc fix

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 530b75ac8b56cc9bd10c9c2f7e5c89beba243f66..33690d5b407b795cfbe0cbbe42a3d75c6b29cd05 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -50,7 +50,7 @@ HTML_IMAGES=
 
 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=p11-kit-config.xml p11-kit-sharing.xml
+content_files=p11-kit-config.xml p11-kit-sharing.xml p11-kit-notes.xml
 
 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
 # These files must be listed here *and* in content_files

diff --git a/doc/p11-kit-sections.txt b/doc/p11-kit-sections.txt
index bdd0434c0718b8d602ddcd2238a2424c164bb00c..f3f32a3ffab5f542831eef13b6ad9ba96d7145f9 100644 (file)
--- a/doc/p11-kit-sections.txt
+++ b/doc/p11-kit-sections.txt
@@ -27,6 +27,7 @@ p11_kit_uri_format
 p11_kit_uri_parse
 p11_kit_uri_free
 p11_kit_uri_message
+P11_KIT_URI_NO_MEMORY
 </SECTION>
 
 <SECTION>
@@ -84,4 +85,4 @@ p11_kit_uri_type_t
 p11_kit_set_progname
 p11_kit_be_quiet
 p11_kit_message
-</SECTION>
\ No newline at end of file
+</SECTION>

diff --git a/p11-kit/uri.c b/p11-kit/uri.c
index b9eef1febc866708d42287cc04f2b401b7c2c57b..752d677c05f676c6917a04f8485cc9e2f34aa4a2 100644 (file)
--- a/p11-kit/uri.c
+++ b/p11-kit/uri.c
@@ -116,6 +116,12 @@
  * which error codes they are capable of returning.
  */
 
+/**
+ * P11_KIT_URI_NO_MEMORY:
+ *
+ * Unexpected memory allocation failure result. Same as #P11_KIT_URI_UNEXPECTED.
+ */
+
 /**
  * P11_KIT_URI_SCHEME:
  *
@@ -468,7 +474,6 @@ uri_take_attribute (P11KitUri *uri, CK_ATTRIBUTE_PTR attr)
  *
  * Returns: %P11_KIT_URI_OK if the attribute was successfully set.
  *     %P11_KIT_URI_NOT_FOUND if the attribute was not valid for a URI.
- *     %P11_KIT_URI_NO_MEMORY if allocation failed.
  */
 int
 p11_kit_uri_set_attribute (P11KitUri *uri, CK_ATTRIBUTE_PTR attr)
@@ -933,7 +938,6 @@ format_struct_version (char **string, size_t *length, int *is_first,
  * The resulting string should be freed with free().
  *
  * Returns: %P11_KIT_URI_OK if the URI was formatted successfully.
- *     %P11_KIT_URI_NO_MEMORY if memory allocation failed.
  */
 int
 p11_kit_uri_format (P11KitUri *uri, P11KitUriType uri_type, char **string)
@@ -1276,7 +1280,6 @@ parse_extra_info (const char *name, const char *start, const char *end,
  * Returns: %P11_KIT_URI_OK if the URI was parsed successfully.
  *     %P11_KIT_URI_BAD_SCHEME if this was not a PKCS\#11 URI.
  *     %P11_KIT_URI_BAD_SYNTAX if the URI syntax was bad.
- *     %P11_KIT_URI_NO_MEMORY if memory allocation failed.
  *     %P11_KIT_URI_BAD_VERSION if a version number was bad.
  *     %P11_KIT_URI_BAD_ENCODING if the URI encoding was invalid.
  */