Do not document unused symbols

The macro KRB5_KEYUSAGE_PA_REFERRAL was defined in an early revision
of draft-ietf-krb-wg-kerberos-referrals but did not make it into
RFC 6806.  We retain the definition so as to not break code implementing
the early draft, but need not document it.

Likewise, the krb5_octet_data structure and krb5_free_octet_data routine
are marked as having been originally introduced for PKINIT and "Do not
use this."  They are in fact unused, and should not be documented, but
the actual definitions must remain for compatibility.

ticket: 7489 (new)
tags: pullup
target_version: 1.11

diff --git a/doc/appdev/refs/api/index.rst b/doc/appdev/refs/api/index.rst
index b119165d1e52115bf40a28718b39be2d03b6956d..a280d39c7700fd41050f30fe93b3786388a5a5b5 100644 (file)
--- a/doc/appdev/refs/api/index.rst
+++ b/doc/appdev/refs/api/index.rst
@@ -202,7 +202,6 @@ Rarely used public interfaces
    krb5_free_keyblock.rst
    krb5_free_keyblock_contents.rst
    krb5_free_keytab_entry_contents.rst
-   krb5_free_octet_data.rst
    krb5_free_string.rst
    krb5_free_ticket.rst
    krb5_free_unparsed_name.rst

diff --git a/doc/appdev/refs/macros/index.rst b/doc/appdev/refs/macros/index.rst
index 33dca06a6ee1e892c65d7e454ab6365246b615f0..4426be64e8bd2b84ce468214d83beba5143aaa76 100644 (file)
--- a/doc/appdev/refs/macros/index.rst
+++ b/doc/appdev/refs/macros/index.rst
@@ -176,7 +176,6 @@ Public
    KRB5_KEYUSAGE_KRB_SAFE_CKSUM.rst
    KRB5_KEYUSAGE_PA_OTP_REQUEST.rst
    KRB5_KEYUSAGE_PA_PKINIT_KX.rst
-   KRB5_KEYUSAGE_PA_REFERRAL.rst
    KRB5_KEYUSAGE_PA_S4U_X509_USER_REPLY.rst
    KRB5_KEYUSAGE_PA_S4U_X509_USER_REQUEST.rst
    KRB5_KEYUSAGE_PA_SAM_CHALLENGE_CKSUM.rst

diff --git a/doc/appdev/refs/types/index.rst b/doc/appdev/refs/types/index.rst
index 23d9d125fceb2232a9f12988905c88c365e2a87f..5efdd6c82b2d5f9d166e5b039bfa95662cfc78c4 100644 (file)
--- a/doc/appdev/refs/types/index.rst
+++ b/doc/appdev/refs/types/index.rst
@@ -51,7 +51,6 @@ Public
    krb5_mk_req_checksum_func.rst
    krb5_msgtype.rst
    krb5_octet.rst
-   krb5_octet_data.rst
    krb5_pa_pac_req.rst
    krb5_pa_server_referral_data.rst
    krb5_pa_svr_referral_data.rst

diff --git a/doc/tools/doxybuilder_funcs.py b/doc/tools/doxybuilder_funcs.py
index b1ef8ac80576fb299d9570fd679be907a61477ac..c9a128263fe270b72c38ac1248dc93d657d6c128 100644 (file)
--- a/doc/tools/doxybuilder_funcs.py
+++ b/doc/tools/doxybuilder_funcs.py
@@ -29,7 +29,7 @@ from xml.sax import make_parser
 from xml.sax.handler import ContentHandler
 from docmodel import *
 
-exclude_funcs = []
+exclude_funcs = ['krb5_free_octet_data']
 
 class DocNode(object):
     """

diff --git a/doc/tools/doxybuilder_types.py b/doc/tools/doxybuilder_types.py
index 10eab1b5658c278d45f61f17aa9c1f34c688cbde..0347a76aeafb83a8df9898292896fff5af3301bb 100644 (file)
--- a/doc/tools/doxybuilder_types.py
+++ b/doc/tools/doxybuilder_types.py
@@ -32,9 +32,10 @@ from docmodel import *
 
 exclude_types = [ 'TRUE', 'FALSE', 'KRB5_ATTR_DEPRECATED',
                   'KRB5_CALLCONV', 'KRB5_CALLCONV_C', 'KRB5_CALLCONV_WRONG',
-                  'KRB5_GENERAL__', 'KRB5_OLD_CRYPTO',
+                  'KRB5_GENERAL__', 'KRB5_KEYUSAGE_PA_REFERRAL',
+                  'KRB5_OLD_CRYPTO',
                   'KRB5INT_BEGIN_DECLS', 'KRB5INT_END_DECLS',
-                  'krb5_cc_ops', 'krb5_responder_context' ]
+                  'krb5_cc_ops', 'krb5_octet_data', 'krb5_responder_context' ]
 
 class DoxyTypes(object):
     def __init__(self, xmlpath):