diff options
| author | Ben Kaduk <kaduk@mit.edu> | 2012-12-10 15:02:14 -0500 |
|---|---|---|
| committer | Ben Kaduk <kaduk@mit.edu> | 2012-12-11 16:34:57 -0500 |
| commit | 6e6364f7c7613a6b8002f0f64864e7d34acea8be (patch) | |
| tree | 868a10bc2b164c5c38c3a501f365b6ee388b14d5 /doc/tools | |
| parent | 3f7394c1440f7526bc6f008f841b438d84411f3d (diff) | |
| download | krb5-6e6364f7c7613a6b8002f0f64864e7d34acea8be.tar.gz krb5-6e6364f7c7613a6b8002f0f64864e7d34acea8be.tar.xz krb5-6e6364f7c7613a6b8002f0f64864e7d34acea8be.zip | |
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
Diffstat (limited to 'doc/tools')
| -rw-r--r-- | doc/tools/doxybuilder_funcs.py | 2 | ||||
| -rw-r--r-- | doc/tools/doxybuilder_types.py | 5 |
2 files changed, 4 insertions, 3 deletions
diff --git a/doc/tools/doxybuilder_funcs.py b/doc/tools/doxybuilder_funcs.py index b1ef8ac80..c9a128263 100644 --- 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 10eab1b56..0347a76ae 100644 --- 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): |