svn rev #25065: trunk/ doc/rst_source/ doc/rst_source/krb_admins/advanced/ doc/rst_source/krb_appldev/ ...
tsitkova@MIT.EDU
tsitkova at MIT.EDU
Mon Aug 1 11:18:21 EDT 2011
http://src.mit.edu/fisheye/changelog/krb5/?cs=25065
Commit By: tsitkova
Log Message:
Option to add API documentation to the Sphinx doc tree.
Changed Files:
U trunk/doc/rst_source/conf.py
U trunk/doc/rst_source/krb_admins/advanced/index.rst
A trunk/doc/rst_source/krb_appldev/refs/
A trunk/doc/rst_source/krb_appldev/refs/api/
A trunk/doc/rst_source/krb_appldev/refs/api/index.rst
A trunk/doc/rst_source/krb_appldev/refs/index.rst
A trunk/doc/rst_source/krb_appldev/refs/macros/
A trunk/doc/rst_source/krb_appldev/refs/macros/index.rst
A trunk/doc/rst_source/krb_appldev/refs/types/
A trunk/doc/rst_source/krb_appldev/refs/types/index.rst
U trunk/doc/rst_tools/README
U trunk/src/Doxyfile
Modified: trunk/doc/rst_source/conf.py
===================================================================
--- trunk/doc/rst_source/conf.py 2011-08-01 15:14:30 UTC (rev 25064)
+++ trunk/doc/rst_source/conf.py 2011-08-01 15:18:21 UTC (rev 25065)
@@ -27,8 +27,11 @@
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
#extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.doxylink']
extensions = ['sphinx.ext.autodoc']
+#extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.doxylink']
+#doxylink = {
+# 'krb5doxy' : ('path-to-doxygen-tag-file/krb5doxy.tag', 'location-of-doxygen-html-output/'),
+#}
-
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Modified: trunk/doc/rst_source/krb_admins/advanced/index.rst
===================================================================
--- trunk/doc/rst_source/krb_admins/advanced/index.rst 2011-08-01 15:14:30 UTC (rev 25064)
+++ trunk/doc/rst_source/krb_admins/advanced/index.rst 2011-08-01 15:18:21 UTC (rev 25065)
@@ -16,12 +16,12 @@
Topics in TODO list:
---------------------
- Choosing backend: LDAP vs DB2
- Validating Kerberos tickets
- Cross-realm interaction with AD
- Replication
- Performance tuning tips
- Error log messages
+#. Choosing backend: LDAP vs DB2
+#. Validating Kerberos tickets
+#. Cross-realm interaction with AD
+#. Replication
+#. Performance tuning tips
+#. Logging error messages
------------------
Added: trunk/doc/rst_source/krb_appldev/refs/api/index.rst
===================================================================
--- trunk/doc/rst_source/krb_appldev/refs/api/index.rst (rev 0)
+++ trunk/doc/rst_source/krb_appldev/refs/api/index.rst 2011-08-01 15:18:21 UTC (rev 25065)
@@ -0,0 +1,376 @@
+krb5 API
+========
+
+
+Frequently used public interfaces
+----------------------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ krb5_build_principal.rst
+ krb5_build_principal_alloc_va.rst
+ krb5_build_principal_ext.rst
+ krb5_cc_close.rst
+ krb5_cc_default.rst
+ krb5_cc_default_name.rst
+ krb5_cc_destroy.rst
+ krb5_cc_dup.rst
+ krb5_cc_get_name.rst
+ krb5_cc_get_principal.rst
+ krb5_cc_get_type.rst
+ krb5_cc_initialize.rst
+ krb5_cc_new_unique.rst
+ krb5_cc_resolve.rst
+ krb5_change_password.rst
+ krb5_free_context.rst
+ krb5_free_error_message.rst
+ krb5_free_principal.rst
+ krb5_fwd_tgt_creds.rst
+ krb5_get_default_realm.rst
+ krb5_get_error_message.rst
+ krb5_get_host_realm.rst
+ krb5_get_credentials.rst
+ krb5_get_fallback_host_realm.rst
+ krb5_get_init_creds_keytab.rst
+ krb5_get_init_creds_opt_alloc.rst
+ krb5_get_init_creds_opt_free.rst
+ krb5_get_init_creds_opt_get_fast_flags.rst
+ krb5_get_init_creds_opt_set_address_list.rst
+ krb5_get_init_creds_opt_set_anonymous.rst
+ krb5_get_init_creds_opt_set_canonicalize.rst
+ krb5_get_init_creds_opt_set_change_password_prompt.rst
+ krb5_get_init_creds_opt_set_etype_list.rst
+ krb5_get_init_creds_opt_set_expire_callback.rst
+ krb5_get_init_creds_opt_set_fast_ccache.rst
+ krb5_get_init_creds_opt_set_fast_ccache_name.rst
+ krb5_get_init_creds_opt_set_fast_flags.rst
+ krb5_get_init_creds_opt_set_forwardable.rst
+ krb5_get_init_creds_opt_set_out_ccache.rst
+ krb5_get_init_creds_opt_set_pa.rst
+ krb5_get_init_creds_opt_set_preauth_list.rst
+ krb5_get_init_creds_opt_set_proxiable.rst
+ krb5_get_init_creds_opt_set_renew_life.rst
+ krb5_get_init_creds_opt_set_salt.rst
+ krb5_get_init_creds_opt_set_tkt_life.rst
+ krb5_get_init_creds_password.rst
+ krb5_get_profile.rst
+ krb5_get_prompt_types.rst
+ krb5_get_renewed_creds.rst
+ krb5_get_validated_creds.rst
+ krb5_init_context.rst
+ krb5_init_secure_context.rst
+ krb5_is_config_principal.rst
+ krb5_is_thread_safe.rst
+ krb5_kt_close.rst
+ krb5_kt_default.rst
+ krb5_kt_default_name.rst
+ krb5_kt_get_name.rst
+ krb5_kt_get_type.rst
+ krb5_kt_resolve.rst
+ krb5_kuserok.rst
+ krb5_parse_name.rst
+ krb5_parse_name_flags.rst
+ krb5_principal_compare.rst
+ krb5_principal_compare_any_realm.rst
+ krb5_principal_compare_flags.rst
+ krb5_prompter_posix.rst
+ krb5_realm_compare.rst
+ krb5_set_default_realm.rst
+ krb5_set_password.rst
+ krb5_set_password_using_ccache.rst
+ krb5_set_principal_realm.rst
+ krb5_set_trace_callback.rst
+ krb5_set_trace_filename.rst
+ krb5_sname_match.rst
+ krb5_sname_to_principal.rst
+ krb5_unparse_name.rst
+ krb5_unparse_name_ext.rst
+ krb5_unparse_name_flags.rst
+ krb5_unparse_name_flags_ext.rst
+ krb5_us_timeofday.rst
+ krb5_verify_authdata_kdc_issued.rst
+
+Rarely used public interfaces
+--------------------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ krb5_425_conv_principal.rst
+ krb5_524_conv_principal.rst
+ krb5_address_compare.rst
+ krb5_address_order.rst
+ krb5_address_search.rst
+ krb5_allow_weak_crypto.rst
+ krb5_aname_to_localname.rst
+ krb5_anonymous_principal.rst
+ krb5_anonymous_realm.rst
+ krb5_appdefault_boolean.rst
+ krb5_appdefault_string.rst
+ krb5_auth_con_free.rst
+ krb5_auth_con_genaddrs.rst
+ krb5_auth_con_get_checksum_func.rst
+ krb5_auth_con_getaddrs.rst
+ krb5_auth_con_getauthenticator.rst
+ krb5_auth_con_getflags.rst
+ krb5_auth_con_getkey.rst
+ krb5_auth_con_getkey_k.rst
+ krb5_auth_con_getlocalseqnumber.rst
+ krb5_auth_con_getrcache.rst
+ krb5_auth_con_getrecvsubkey.rst
+ krb5_auth_con_getrecvsubkey_k.rst
+ krb5_auth_con_getremoteseqnumber.rst
+ krb5_auth_con_getsendsubkey.rst
+ krb5_auth_con_getsendsubkey_k.rst
+ krb5_auth_con_init.rst
+ krb5_auth_con_set_checksum_func.rst
+ krb5_auth_con_set_req_cksumtype.rst
+ krb5_auth_con_setaddrs.rst
+ krb5_auth_con_setflags.rst
+ krb5_auth_con_setports.rst
+ krb5_auth_con_setrcache.rst
+ krb5_auth_con_setrecvsubkey.rst
+ krb5_auth_con_setrecvsubkey_k.rst
+ krb5_auth_con_setsendsubkey.rst
+ krb5_auth_con_setsendsubkey_k.rst
+ krb5_auth_con_setuseruserkey.rst
+ krb5_cc_copy_creds.rst
+ krb5_cc_end_seq_get.rst
+ krb5_cc_get_config.rst
+ krb5_cc_get_flags.rst
+ krb5_cc_last_change_time.rst
+ krb5_cc_lock.rst
+ krb5_cc_move.rst
+ krb5_cc_next_cred.rst
+ krb5_cc_remove_cred.rst
+ krb5_cc_retrieve_cred.rst
+ krb5_cc_set_config.rst
+ krb5_cc_set_default_name.rst
+ krb5_cc_set_flags.rst
+ krb5_cc_start_seq_get.rst
+ krb5_cc_store_cred.rst
+ krb5_cc_unlock.rst
+ krb5_cccol_cursor_free.rst
+ krb5_cccol_cursor_new.rst
+ krb5_cccol_cursor_next.rst
+ krb5_cccol_last_change_time.rst
+ krb5_cccol_lock.rst
+ krb5_cccol_unlock.rst
+ krb5_clear_error_message.rst
+ krb5_copy_addresses.rst
+ krb5_copy_authdata.rst
+ krb5_copy_authenticator.rst
+ krb5_copy_checksum.rst
+ krb5_copy_context.rst
+ krb5_copy_creds.rst
+ krb5_copy_data.rst
+ krb5_copy_error_message.rst
+ krb5_copy_keyblock.rst
+ krb5_copy_keyblock_contents.rst
+ krb5_copy_principal.rst
+ krb5_copy_ticket.rst
+ krb5_free_addresses.rst
+ krb5_free_ap_rep_enc_part.rst
+ krb5_free_authdata.rst
+ krb5_free_authenticator.rst
+ krb5_free_cred_contents.rst
+ krb5_free_creds.rst
+ krb5_free_data.rst
+ krb5_free_data_contents.rst
+ krb5_free_default_realm.rst
+ krb5_free_error.rst
+ krb5_free_host_realm.rst
+ krb5_free_keyblock.rst
+ krb5_free_keyblock_contents.rst
+ krb5_free_keytab_entry_contents.rst
+ krb5_free_ticket.rst
+ krb5_free_unparsed_name.rst
+ krb5_get_permitted_enctypes.rst
+ krb5_get_server_rcache.rst
+ krb5_get_time_offsets.rst
+ krb5_init_context_profile.rst
+ krb5_init_creds_free.rst
+ krb5_init_creds_get.rst
+ krb5_init_creds_get_creds.rst
+ krb5_init_creds_get_error.rst
+ krb5_init_creds_get_times.rst
+ krb5_init_creds_init.rst
+ krb5_init_creds_set_keytab.rst
+ krb5_init_creds_set_password.rst
+ krb5_init_creds_set_service.rst
+ krb5_init_creds_step.rst
+ krb5_init_keyblock.rst
+ krb5_is_referral_realm.rst
+ krb5_kt_add_entry.rst
+ krb5_kt_end_seq_get.rst
+ krb5_kt_get_entry.rst
+ krb5_kt_next_entry.rst
+ krb5_kt_read_service_key.rst
+ krb5_kt_remove_entry.rst
+ krb5_kt_start_seq_get.rst
+ krb5_make_authdata_kdc_issued.rst
+ krb5_merge_authdata.rst
+ krb5_mk_1cred.rst
+ krb5_mk_error.rst
+ krb5_mk_ncred.rst
+ krb5_mk_priv.rst
+ krb5_mk_rep.rst
+ krb5_mk_rep_dce.rst
+ krb5_mk_req.rst
+ krb5_mk_req_extended.rst
+ krb5_mk_safe.rst
+ krb5_os_localaddr.rst
+ krb5_pac_add_buffer.rst
+ krb5_pac_free.rst
+ krb5_pac_get_buffer.rst
+ krb5_pac_get_types.rst
+ krb5_pac_init.rst
+ krb5_pac_parse.rst
+ krb5_pac_verify.rst
+ krb5_principal2salt.rst
+ krb5_rd_cred.rst
+ krb5_rd_error.rst
+ krb5_rd_priv.rst
+ krb5_rd_rep.rst
+ krb5_rd_rep_dce.rst
+ krb5_rd_req.rst
+ krb5_rd_safe.rst
+ krb5_read_password.rst
+ krb5_salttype_to_string.rst
+ krb5_server_decrypt_ticket_keytab.rst
+ krb5_set_default_tgs_enctypes.rst
+ krb5_set_error_message.rst
+ krb5_set_real_time.rst
+ krb5_string_to_cksumtype.rst
+ krb5_string_to_deltat.rst
+ krb5_string_to_enctype.rst
+ krb5_string_to_salttype.rst
+ krb5_string_to_timestamp.rst
+ krb5_timeofday.rst
+ krb5_timestamp_to_sfstring.rst
+ krb5_timestamp_to_string.rst
+ krb5_tkt_creds_free.rst
+ krb5_tkt_creds_get.rst
+ krb5_tkt_creds_get_creds.rst
+ krb5_tkt_creds_get_times.rst
+ krb5_tkt_creds_init.rst
+ krb5_tkt_creds_step.rst
+ krb5_verify_init_creds.rst
+ krb5_verify_init_creds_opt_init.rst
+ krb5_verify_init_creds_opt_set_ap_req_nofail.rst
+ krb5_vset_error_message.rst
+
+
+Public interfaces that should not be called directly
+-------------------------------------------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ krb5_c_block_size.rst
+ krb5_c_checksum_length.rst
+ krb5_c_crypto_length.rst
+ krb5_c_crypto_length_iov.rst
+ krb5_c_decrypt.rst
+ krb5_c_decrypt_iov.rst
+ krb5_c_encrypt.rst
+ krb5_c_encrypt_iov.rst
+ krb5_c_encrypt_length.rst
+ krb5_c_enctype_compare.rst
+ krb5_c_free_state.rst
+ krb5_c_fx_cf2_simple.rst
+ krb5_c_init_state.rst
+ krb5_c_is_coll_proof_cksum.rst
+ krb5_c_is_keyed_cksum.rst
+ krb5_c_keyed_checksum_types.rst
+ krb5_c_keylengths.rst
+ krb5_c_make_checksum.rst
+ krb5_c_make_checksum_iov.rst
+ krb5_c_make_random_key.rst
+ krb5_c_padding_length.rst
+ krb5_c_prf.rst
+ krb5_c_prf_length.rst
+ krb5_c_random_add_entropy.rst
+ krb5_c_random_make_octets.rst
+ krb5_c_random_os_entropy.rst
+ krb5_c_random_to_key.rst
+ krb5_c_string_to_key.rst
+ krb5_c_string_to_key_with_params.rst
+ krb5_c_valid_cksumtype.rst
+ krb5_c_valid_enctype.rst
+ krb5_c_verify_checksum.rst
+ krb5_c_verify_checksum_iov.rst
+ krb5_cksumtype_to_string.rst
+ krb5_decode_authdata_container.rst
+ krb5_decode_ticket.rst
+ krb5_deltat_to_string.rst
+ krb5_encode_authdata_container.rst
+ krb5_enctype_to_name.rst
+ krb5_enctype_to_string.rst
+ krb5_free_checksum.rst
+ krb5_free_checksum_contents.rst
+ krb5_free_cksumtypes.rst
+ krb5_free_tgt_creds.rst
+ krb5_k_create_key.rst
+ krb5_k_decrypt.rst
+ krb5_k_decrypt_iov.rst
+ krb5_k_encrypt.rst
+ krb5_k_encrypt_iov.rst
+ krb5_k_free_key.rst
+ krb5_k_key_enctype.rst
+ krb5_k_key_keyblock.rst
+ krb5_k_make_checksum.rst
+ krb5_k_make_checksum_iov.rst
+ krb5_k_prf.rst
+ krb5_k_reference_key.rst
+ krb5_k_verify_checksum.rst
+ krb5_k_verify_checksum_iov.rst
+
+
+Legacy convenience interfaces
+------------------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ krb5_recvauth.rst
+ krb5_recvauth_version.rst
+ krb5_sendauth.rst
+
+
+Deprecated public interfaces
+------------------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ krb5_524_convert_creds.rst
+ krb5_auth_con_getlocalsubkey.rst
+ krb5_auth_con_getremotesubkey.rst
+ krb5_auth_con_initivector.rst
+ krb5_build_principal_va.rst
+ krb5_c_random_seed.rst
+ krb5_calculate_checksum.rst
+ krb5_checksum_size.rst
+ krb5_encrypt.rst
+ krb5_decrypt.rst
+ krb5_eblock_enctype.rst
+ krb5_encrypt_size.rst
+ krb5_finish_key.rst
+ krb5_finish_random_key.rst
+ krb5_cc_gen_new.rst
+ krb5_get_credentials_renew.rst
+ krb5_get_credentials_validate.rst
+ krb5_get_in_tkt_with_password.rst
+ krb5_get_in_tkt_with_skey.rst
+ krb5_get_in_tkt_with_keytab.rst
+ krb5_get_init_creds_opt_init.rst
+ krb5_init_random_key.rst
+ krb5_kt_free_entry.rst
+ krb5_random_key.rst
+ krb5_process_key.rst
+ krb5_string_to_key.rst
+ krb5_use_enctype.rst
+ krb5_verify_checksum.rst
+
Added: trunk/doc/rst_source/krb_appldev/refs/index.rst
===================================================================
--- trunk/doc/rst_source/krb_appldev/refs/index.rst (rev 0)
+++ trunk/doc/rst_source/krb_appldev/refs/index.rst 2011-08-01 15:18:21 UTC (rev 25065)
@@ -0,0 +1,10 @@
+Complete reference - API and datatypes
+==========================================================
+
+.. toctree::
+ :maxdepth: 1
+
+ api/index.rst
+ types/index.rst
+ macros/index.rst
+
Added: trunk/doc/rst_source/krb_appldev/refs/macros/index.rst
===================================================================
--- trunk/doc/rst_source/krb_appldev/refs/macros/index.rst (rev 0)
+++ trunk/doc/rst_source/krb_appldev/refs/macros/index.rst 2011-08-01 15:18:21 UTC (rev 25065)
@@ -0,0 +1,351 @@
+krb5 simple macros
+=========================
+
+Public
+-------
+
+.. toctree::
+ :maxdepth: 1
+
+ ADDRTYPE_ADDRPORT.rst
+ ADDRTYPE_CHAOS.rst
+ ADDRTYPE_DDP.rst
+ ADDRTYPE_INET.rst
+ ADDRTYPE_INET6.rst
+ ADDRTYPE_IPPORT.rst
+ ADDRTYPE_ISO.rst
+ ADDRTYPE_IS_LOCAL.rst
+ ADDRTYPE_NETBIOS.rst
+ ADDRTYPE_XNS.rst
+ AD_TYPE_EXTERNAL.rst
+ AD_TYPE_FIELD_TYPE_MASK.rst
+ AD_TYPE_REGISTERED.rst
+ AD_TYPE_RESERVED.rst
+ AP_OPTS_ETYPE_NEGOTIATION.rst
+ AP_OPTS_MUTUAL_REQUIRED.rst
+ AP_OPTS_RESERVED.rst
+ AP_OPTS_USE_SESSION_KEY.rst
+ AP_OPTS_USE_SUBKEY.rst
+ AP_OPTS_WIRE_MASK.rst
+ CKSUMTYPE_CRC32.rst
+ CKSUMTYPE_DESCBC.rst
+ CKSUMTYPE_HMAC_MD5_ARCFOUR.rst
+ CKSUMTYPE_HMAC_SHA1_96_AES128.rst
+ CKSUMTYPE_HMAC_SHA1_96_AES256.rst
+ CKSUMTYPE_HMAC_SHA1_DES3.rst
+ CKSUMTYPE_MD5_HMAC_ARCFOUR.rst
+ CKSUMTYPE_NIST_SHA.rst
+ CKSUMTYPE_RSA_MD4.rst
+ CKSUMTYPE_RSA_MD4_DES.rst
+ CKSUMTYPE_RSA_MD5.rst
+ CKSUMTYPE_RSA_MD5_DES.rst
+ ENCTYPE_AES128_CTS_HMAC_SHA1_96.rst
+ ENCTYPE_AES256_CTS_HMAC_SHA1_96.rst
+ ENCTYPE_ARCFOUR_HMAC.rst
+ ENCTYPE_ARCFOUR_HMAC_EXP.rst
+ ENCTYPE_DES3_CBC_ENV.rst
+ ENCTYPE_DES3_CBC_RAW.rst
+ ENCTYPE_DES3_CBC_SHA.rst
+ ENCTYPE_DES3_CBC_SHA1.rst
+ ENCTYPE_DES_CBC_CRC.rst
+ ENCTYPE_DES_CBC_MD4.rst
+ ENCTYPE_DES_CBC_MD5.rst
+ ENCTYPE_DES_CBC_RAW.rst
+ ENCTYPE_DES_HMAC_SHA1.rst
+ ENCTYPE_DSA_SHA1_CMS.rst
+ ENCTYPE_MD5_RSA_CMS.rst
+ ENCTYPE_NULL.rst
+ ENCTYPE_RC2_CBC_ENV.rst
+ ENCTYPE_RSA_ENV.rst
+ ENCTYPE_RSA_ES_OAEP_ENV.rst
+ ENCTYPE_SHA1_RSA_CMS.rst
+ ENCTYPE_UNKNOWN.rst
+ KDC_OPT_ALLOW_POSTDATE.rst
+ KDC_OPT_CANONICALIZE.rst
+ KDC_OPT_CNAME_IN_ADDL_TKT.rst
+ KDC_OPT_DISABLE_TRANSITED_CHECK.rst
+ KDC_OPT_ENC_TKT_IN_SKEY.rst
+ KDC_OPT_FORWARDABLE.rst
+ KDC_OPT_FORWARDED.rst
+ KDC_OPT_POSTDATED.rst
+ KDC_OPT_PROXIABLE.rst
+ KDC_OPT_PROXY.rst
+ KDC_OPT_RENEW.rst
+ KDC_OPT_RENEWABLE.rst
+ KDC_OPT_RENEWABLE_OK.rst
+ KDC_OPT_REQUEST_ANONYMOUS.rst
+ KDC_OPT_VALIDATE.rst
+ KDC_TKT_COMMON_MASK.rst
+ KRB5_ALTAUTH_ATT_CHALLENGE_RESPONSE.rst
+ KRB5_ANONYMOUS_PRINCSTR.rst
+ KRB5_ANONYMOUS_REALMSTR.rst
+ KRB5_AP_REP.rst
+ KRB5_AP_REQ.rst
+ KRB5_AS_REP.rst
+ KRB5_AS_REQ.rst
+ KRB5_AUTHDATA_AND_OR.rst
+ KRB5_AUTHDATA_ETYPE_NEGOTIATION.rst
+ KRB5_AUTHDATA_FX_ARMOR.rst
+ KRB5_AUTHDATA_IF_RELEVANT.rst
+ KRB5_AUTHDATA_INITIAL_VERIFIED_CAS.rst
+ KRB5_AUTHDATA_KDC_ISSUED.rst
+ KRB5_AUTHDATA_MANDATORY_FOR_KDC.rst
+ KRB5_AUTHDATA_OSF_DCE.rst
+ KRB5_AUTHDATA_SESAME.rst
+ KRB5_AUTHDATA_SIGNTICKET.rst
+ KRB5_AUTHDATA_WIN2K_PAC.rst
+ KRB5_AUTH_CONTEXT_DO_SEQUENCE.rst
+ KRB5_AUTH_CONTEXT_DO_TIME.rst
+ KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR.rst
+ KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR.rst
+ KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR.rst
+ KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR.rst
+ KRB5_AUTH_CONTEXT_PERMIT_ALL.rst
+ KRB5_AUTH_CONTEXT_RET_SEQUENCE.rst
+ KRB5_AUTH_CONTEXT_RET_TIME.rst
+ KRB5_AUTH_CONTEXT_USE_SUBKEY.rst
+ KRB5_CRED.rst
+ KRB5_CRYPTO_TYPE_CHECKSUM.rst
+ KRB5_CRYPTO_TYPE_DATA.rst
+ KRB5_CRYPTO_TYPE_EMPTY.rst
+ KRB5_CRYPTO_TYPE_HEADER.rst
+ KRB5_CRYPTO_TYPE_PADDING.rst
+ KRB5_CRYPTO_TYPE_SIGN_ONLY.rst
+ KRB5_CRYPTO_TYPE_STREAM.rst
+ KRB5_CRYPTO_TYPE_TRAILER.rst
+ KRB5_CYBERSAFE_SECUREID.rst
+ KRB5_DOMAIN_X500_COMPRESS.rst
+ KRB5_ENCPADATA_REQ_ENC_PA_REP.rst
+ KRB5_ERROR.rst
+ KRB5_FAST_REQUIRED.rst
+ KRB5_GC_CACHED.rst
+ KRB5_GC_CANONICALIZE.rst
+ KRB5_GC_CONSTRAINED_DELEGATION.rst
+ KRB5_GC_FORWARDABLE.rst
+ KRB5_GC_NO_STORE.rst
+ KRB5_GC_NO_TRANSIT_CHECK.rst
+ KRB5_GC_USER_USER.rst
+ KRB5_GET_INIT_CREDS_OPT_ADDRESS_LIST.rst
+ KRB5_GET_INIT_CREDS_OPT_ANONYMOUS.rst
+ KRB5_GET_INIT_CREDS_OPT_CANONICALIZE.rst
+ KRB5_GET_INIT_CREDS_OPT_CHG_PWD_PRMPT.rst
+ KRB5_GET_INIT_CREDS_OPT_ETYPE_LIST.rst
+ KRB5_GET_INIT_CREDS_OPT_FORWARDABLE.rst
+ KRB5_GET_INIT_CREDS_OPT_PREAUTH_LIST.rst
+ KRB5_GET_INIT_CREDS_OPT_PROXIABLE.rst
+ KRB5_GET_INIT_CREDS_OPT_RENEW_LIFE.rst
+ KRB5_GET_INIT_CREDS_OPT_SALT.rst
+ KRB5_GET_INIT_CREDS_OPT_TKT_LIFE.rst
+ KRB5_INIT_CONTEXT_SECURE.rst
+ KRB5_INIT_CONTEXT_KDC.rst
+ KRB5_INIT_CREDS_STEP_FLAG_CONTINUE.rst
+ KRB5_INT16_MAX.rst
+ KRB5_INT16_MIN.rst
+ KRB5_INT32_MAX.rst
+ KRB5_INT32_MIN.rst
+ KRB5_KEYUSAGE_AD_ITE.rst
+ KRB5_KEYUSAGE_AD_KDCISSUED_CKSUM.rst
+ KRB5_KEYUSAGE_AD_MTE.rst
+ KRB5_KEYUSAGE_AD_SIGNEDPATH.rst
+ KRB5_KEYUSAGE_APP_DATA_CKSUM.rst
+ KRB5_KEYUSAGE_APP_DATA_ENCRYPT.rst
+ KRB5_KEYUSAGE_AP_REP_ENCPART.rst
+ KRB5_KEYUSAGE_AP_REQ_AUTH.rst
+ KRB5_KEYUSAGE_AP_REQ_AUTH_CKSUM.rst
+ KRB5_KEYUSAGE_AS_REP_ENCPART.rst
+ KRB5_KEYUSAGE_AS_REQ.rst
+ KRB5_KEYUSAGE_AS_REQ_PA_ENC_TS.rst
+ KRB5_KEYUSAGE_ENC_CHALLENGE_CLIENT.rst
+ KRB5_KEYUSAGE_ENC_CHALLENGE_KDC.rst
+ KRB5_KEYUSAGE_FAST_ENC.rst
+ KRB5_KEYUSAGE_FAST_FINISHED.rst
+ KRB5_KEYUSAGE_FAST_REP.rst
+ KRB5_KEYUSAGE_FAST_REQ_CHKSUM.rst
+ KRB5_KEYUSAGE_GSS_TOK_MIC.rst
+ KRB5_KEYUSAGE_GSS_TOK_WRAP_INTEG.rst
+ KRB5_KEYUSAGE_GSS_TOK_WRAP_PRIV.rst
+ KRB5_KEYUSAGE_IAKERB_FINISHED.rst
+ KRB5_KEYUSAGE_KDC_REP_TICKET.rst
+ KRB5_KEYUSAGE_KRB_CRED_ENCPART.rst
+ KRB5_KEYUSAGE_KRB_ERROR_CKSUM.rst
+ KRB5_KEYUSAGE_KRB_PRIV_ENCPART.rst
+ KRB5_KEYUSAGE_KRB_SAFE_CKSUM.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
+ KRB5_KEYUSAGE_PA_SAM_CHALLENGE_TRACKID.rst
+ KRB5_KEYUSAGE_PA_SAM_RESPONSE.rst
+ KRB5_KEYUSAGE_TGS_REP_ENCPART_SESSKEY.rst
+ KRB5_KEYUSAGE_TGS_REP_ENCPART_SUBKEY.rst
+ KRB5_KEYUSAGE_TGS_REQ_AD_SESSKEY.rst
+ KRB5_KEYUSAGE_TGS_REQ_AD_SUBKEY.rst
+ KRB5_KEYUSAGE_TGS_REQ_AUTH.rst
+ KRB5_KEYUSAGE_TGS_REQ_AUTH_CKSUM.rst
+ KRB5_KPASSWD_ACCESSDENIED.rst
+ KRB5_KPASSWD_AUTHERROR.rst
+ KRB5_KPASSWD_BAD_VERSION.rst
+ KRB5_KPASSWD_HARDERROR.rst
+ KRB5_KPASSWD_INITIAL_FLAG_NEEDED.rst
+ KRB5_KPASSWD_MALFORMED.rst
+ KRB5_KPASSWD_SOFTERROR.rst
+ KRB5_KPASSWD_SUCCESS.rst
+ KRB5_LRQ_ALL_ACCT_EXPTIME.rst
+ KRB5_LRQ_ALL_LAST_INITIAL.rst
+ KRB5_LRQ_ALL_LAST_RENEWAL.rst
+ KRB5_LRQ_ALL_LAST_REQ.rst
+ KRB5_LRQ_ALL_LAST_TGT.rst
+ KRB5_LRQ_ALL_LAST_TGT_ISSUED.rst
+ KRB5_LRQ_ALL_PW_EXPTIME.rst
+ KRB5_LRQ_NONE.rst
+ KRB5_LRQ_ONE_ACCT_EXPTIME.rst
+ KRB5_LRQ_ONE_LAST_INITIAL.rst
+ KRB5_LRQ_ONE_LAST_RENEWAL.rst
+ KRB5_LRQ_ONE_LAST_REQ.rst
+ KRB5_LRQ_ONE_LAST_TGT.rst
+ KRB5_LRQ_ONE_LAST_TGT_ISSUED.rst
+ KRB5_LRQ_ONE_PW_EXPTIME.rst
+ KRB5_NT_ENTERPRISE_PRINCIPAL.rst
+ KRB5_NT_ENT_PRINCIPAL_AND_ID.rst
+ KRB5_NT_MS_PRINCIPAL.rst
+ KRB5_NT_MS_PRINCIPAL_AND_ID.rst
+ KRB5_NT_PRINCIPAL.rst
+ KRB5_NT_SMTP_NAME.rst
+ KRB5_NT_SRV_HST.rst
+ KRB5_NT_SRV_INST.rst
+ KRB5_NT_SRV_XHST.rst
+ KRB5_NT_UID.rst
+ KRB5_NT_UNKNOWN.rst
+ KRB5_NT_WELLKNOWN.rst
+ KRB5_NT_X500_PRINCIPAL.rst
+ KRB5_OLD_CRYPTO.rst
+ KRB5_PADATA_AFS3_SALT.rst
+ KRB5_PADATA_AP_REQ.rst
+ KRB5_PADATA_ENCRYPTED_CHALLENGE.rst
+ KRB5_PADATA_ENC_SANDIA_SECURID.rst
+ KRB5_PADATA_ENC_TIMESTAMP.rst
+ KRB5_PADATA_ENC_UNIX_TIME.rst
+ KRB5_PADATA_ETYPE_INFO.rst
+ KRB5_PADATA_ETYPE_INFO2.rst
+ KRB5_PADATA_FOR_USER.rst
+ KRB5_PADATA_FX_COOKIE.rst
+ KRB5_PADATA_FX_ERROR.rst
+ KRB5_PADATA_FX_FAST.rst
+ KRB5_PADATA_GET_FROM_TYPED_DATA.rst
+ KRB5_PADATA_NONE.rst
+ KRB5_PADATA_OSF_DCE.rst
+ KRB5_PADATA_PAC_REQUEST.rst
+ KRB5_PADATA_PKINIT_KX.rst
+ KRB5_PADATA_PK_AS_REP.rst
+ KRB5_PADATA_PK_AS_REP_OLD.rst
+ KRB5_PADATA_PK_AS_REQ.rst
+ KRB5_PADATA_PK_AS_REQ_OLD.rst
+ KRB5_PADATA_PW_SALT.rst
+ KRB5_PADATA_REFERRAL.rst
+ KRB5_PADATA_S4U_X509_USER.rst
+ KRB5_PADATA_SAM_CHALLENGE.rst
+ KRB5_PADATA_SAM_CHALLENGE_2.rst
+ KRB5_PADATA_SAM_REDIRECT.rst
+ KRB5_PADATA_SAM_RESPONSE.rst
+ KRB5_PADATA_SAM_RESPONSE_2.rst
+ KRB5_PADATA_SESAME.rst
+ KRB5_PADATA_SVR_REFERRAL_INFO.rst
+ KRB5_PADATA_TGS_REQ.rst
+ KRB5_PADATA_USE_SPECIFIED_KVNO.rst
+ KRB5_PRINCIPAL_COMPARE_CASEFOLD.rst
+ KRB5_PRINCIPAL_COMPARE_ENTERPRISE.rst
+ KRB5_PRINCIPAL_COMPARE_IGNORE_REALM.rst
+ KRB5_PRINCIPAL_COMPARE_UTF8.rst
+ KRB5_PRINCIPAL_PARSE_ENTERPRISE.rst
+ KRB5_PRINCIPAL_PARSE_NO_REALM.rst
+ KRB5_PRINCIPAL_PARSE_REQUIRE_REALM.rst
+ KRB5_PRINCIPAL_UNPARSE_DISPLAY.rst
+ KRB5_PRINCIPAL_UNPARSE_NO_REALM.rst
+ KRB5_PRINCIPAL_UNPARSE_SHORT.rst
+ KRB5_PRIV.rst
+ KRB5_PROMPT_TYPE_NEW_PASSWORD.rst
+ KRB5_PROMPT_TYPE_NEW_PASSWORD_AGAIN.rst
+ KRB5_PROMPT_TYPE_PASSWORD.rst
+ KRB5_PROMPT_TYPE_PREAUTH.rst
+ KRB5_PVNO.rst
+ KRB5_REALM_BRANCH_CHAR.rst
+ KRB5_RECVAUTH_BADAUTHVERS.rst
+ KRB5_RECVAUTH_SKIP_VERSION.rst
+ KRB5_REFERRAL_REALM.rst
+ KRB5_SAFE.rst
+ KRB5_SAM_MUST_PK_ENCRYPT_SAD.rst
+ KRB5_SAM_SEND_ENCRYPTED_SAD.rst
+ KRB5_SAM_USE_SAD_AS_KEY.rst
+ KRB5_TC_MATCH_2ND_TKT.rst
+ KRB5_TC_MATCH_AUTHDATA.rst
+ KRB5_TC_MATCH_FLAGS.rst
+ KRB5_TC_MATCH_FLAGS_EXACT.rst
+ KRB5_TC_MATCH_IS_SKEY.rst
+ KRB5_TC_MATCH_KTYPE.rst
+ KRB5_TC_MATCH_SRV_NAMEONLY.rst
+ KRB5_TC_MATCH_TIMES.rst
+ KRB5_TC_MATCH_TIMES_EXACT.rst
+ KRB5_TC_NOTICKET.rst
+ KRB5_TC_OPENCLOSE.rst
+ KRB5_TC_SUPPORTED_KTYPES.rst
+ KRB5_TGS_NAME.rst
+ KRB5_TGS_NAME_SIZE.rst
+ KRB5_TGS_REP.rst
+ KRB5_TGS_REQ.rst
+ KRB5_TKT_CREDS_STEP_FLAG_CONTINUE.rst
+ KRB5_VERIFY_INIT_CREDS_OPT_AP_REQ_NOFAIL.rst
+ KRB5_WELLKNOWN_NAMESTR.rst
+ LR_TYPE_INTERPRETATION_MASK.rst
+ LR_TYPE_THIS_SERVER_ONLY.rst
+ MAX_KEYTAB_NAME_LEN.rst
+ MSEC_DIRBIT.rst
+ MSEC_VAL_MASK.rst
+ PAC_CLIENT_INFO.rst
+ PAC_CREDENTIALS_INFO.rst
+ PAC_DELEGATION_INFO.rst
+ PAC_LOGON_INFO.rst
+ PAC_PRIVSVR_CHECKSUM.rst
+ PAC_SERVER_CHECKSUM.rst
+ PAC_UPN_DNS_INFO.rst
+ SALT_TYPE_AFS_LENGTH.rst
+ SALT_TYPE_NO_LENGTH.rst
+ THREEPARAMOPEN.rst
+ TKT_FLG_ANONYMOUS.rst
+ TKT_FLG_ENC_PA_REP.rst
+ TKT_FLG_FORWARDABLE.rst
+ TKT_FLG_FORWARDED.rst
+ TKT_FLG_HW_AUTH.rst
+ TKT_FLG_INITIAL.rst
+ TKT_FLG_INVALID.rst
+ TKT_FLG_MAY_POSTDATE.rst
+ TKT_FLG_OK_AS_DELEGATE.rst
+ TKT_FLG_POSTDATED.rst
+ TKT_FLG_PRE_AUTH.rst
+ TKT_FLG_PROXIABLE.rst
+ TKT_FLG_PROXY.rst
+ TKT_FLG_RENEWABLE.rst
+ TKT_FLG_TRANSIT_POLICY_CHECKED.rst
+ VALID_INT_BITS.rst
+ VALID_UINT_BITS.rst
+ krb5_const.rst
+ krb5_princ_component.rst
+ krb5_princ_name.rst
+ krb5_princ_realm.rst
+ krb5_princ_set_realm.rst
+ krb5_princ_set_realm_data.rst
+ krb5_princ_set_realm_length.rst
+ krb5_princ_size.rst
+ krb5_princ_type.rst
+ krb5_roundup.rst
+ krb5_x.rst
+ krb5_xc.rst
+
+Deprecated macros
+------------------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ krb524_convert_creds_kdc.rst
+ krb524_init_ets.rst
Added: trunk/doc/rst_source/krb_appldev/refs/types/index.rst
===================================================================
--- trunk/doc/rst_source/krb_appldev/refs/types/index.rst (rev 0)
+++ trunk/doc/rst_source/krb_appldev/refs/types/index.rst 2011-08-01 15:18:21 UTC (rev 25065)
@@ -0,0 +1,103 @@
+krb5 types and structures
+=========================
+
+Public
+-------
+
+.. toctree::
+ :maxdepth: 1
+
+ krb5_address.rst
+ krb5_addrtype.rst
+ krb5_ap_req.rst
+ krb5_ap_rep.rst
+ krb5_ap_rep_enc_part.rst
+ krb5_authdata.rst
+ krb5_authdatatype.rst
+ krb5_authenticator.rst
+ krb5_boolean.rst
+ krb5_checksum.rst
+ krb5_const_pointer.rst
+ krb5_const_principal.rst
+ krb5_cred.rst
+ krb5_cred_enc_part.rst
+ krb5_cred_info.rst
+ krb5_creds.rst
+ krb5_crypto_iov.rst
+ krb5_cryptotype.rst
+ krb5_data.rst
+ krb5_deltat.rst
+ krb5_enc_data.rst
+ krb5_enc_kdc_rep_part.rst
+ krb5_enc_tkt_part.rst
+ krb5_encrypt_block.rst
+ krb5_enctype.rst
+ krb5_error.rst
+ krb5_error_code.rst
+ krb5_expire_callback_func.rst
+ krb5_flags.rst
+ krb5_get_init_creds_opt.rst
+ krb5_gic_opt_pa_data.rst
+ krb5_int32.rst
+ krb5_kdc_rep.rst
+ krb5_kdc_req.rst
+ krb5_keyblock.rst
+ krb5_keytab_entry.rst
+ krb5_keyusage.rst
+ krb5_kt_cursor.rst
+ krb5_kvno.rst
+ krb5_last_req_entry.rst
+ krb5_magic.rst
+ 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
+ krb5_pa_data.rst
+ krb5_pointer.rst
+ krb5_preauthtype.rst
+ krb5_principal.rst
+ krb5_principal_data.rst
+ krb5_const_principal.rst
+ krb5_prompt.rst
+ krb5_prompt_type.rst
+ krb5_prompter_fct.rst
+ krb5_pwd_data.rst
+ krb5_response.rst
+ krb5_replay_data.rst
+ krb5_ticket.rst
+ krb5_ticket_times.rst
+ krb5_timestamp.rst
+ krb5_tkt_authent.rst
+ krb5_trace_callback.rst
+ krb5_trace_info.rst
+ krb5_transited.rst
+ krb5_typed_data.rst
+ krb5_ui_4.rst
+ krb5_verify_init_creds_opt.rst
+ passwd_phrase_element.rst
+
+
+Internal
+---------
+
+.. toctree::
+ :maxdepth: 1
+
+ krb5_auth_context.rst
+ krb5_cksumtype
+ krb5_context.rst
+ krb5_cc_cursor.rst
+ krb5_cc_ops.rst
+ krb5_ccache.rst
+ krb5_cccol_cursor.rst
+ krb5_init_creds_context.rst
+ krb5_key.rst
+ krb5_keytab.rst
+ krb5_pac.rst
+ krb5_rcache.rst
+ krb5_tkt_creds_context.rst
+
+
Modified: trunk/doc/rst_tools/README
===================================================================
--- trunk/doc/rst_tools/README 2011-08-01 15:14:30 UTC (rev 25064)
+++ trunk/doc/rst_tools/README 2011-08-01 15:18:21 UTC (rev 25065)
@@ -46,16 +46,20 @@
-Part B: Transforming Doxygen XML output into reStructuredText with the bridge to Doxygen HTML output.
+Part B: Bridge to Doxygen HTML output.
-1. In the Doxygen configuration file set option GENERATE_XML to YES. Also, set option GENERATE_TAGFILE to create a Doxygen tag file. For example, GENERATE_TAGFILE = /tmp/krb5doxy.tag. Generate Doxygen XML output;
+1. Transform Doxygen XML output into reStructuredText.
+ In src/Doxygen configuration file request genetation of the tag file and XML output:
+ GENERATE_TAGFILE = krb5doxy.tag
+ GENERATE_XML = YES
-2. Modify Sphinx conf.py file to point to the “doxylink†extension and Doxygen tag file:
+2. Modify Sphinx conf.py file to point to the “doxylink†extension and Doxygen tag file:
+ extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.doxylink']
+ doxylink = { ' krb5doxy' : ('/tmp/krb5doxy.tag, ' doxy_html_dir ') }
-extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.doxylink']
-doxylink = { ' krb5doxy' : ('/tmp/krb5doxy.tag, ' doxy_html_dir ') }
+ where doxy_html_dir is the location of the Doxygen HTML output
-where doxy_html_dir is the location of the Doxygen HTML output
-
3. Continue with steps 3 - 6 of Part A.
+
+
Modified: trunk/src/Doxyfile
===================================================================
--- trunk/src/Doxyfile 2011-08-01 15:14:30 UTC (rev 25064)
+++ trunk/src/Doxyfile 2011-08-01 15:18:21 UTC (rev 25065)
@@ -1273,7 +1273,7 @@
# generate an XML file that captures the structure of
# the code including all documentation.
-GENERATE_XML = YES
+GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
@@ -1435,7 +1435,7 @@
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
-GENERATE_TAGFILE = ../PolyVox.tag
+# GENERATE_TAGFILE = krb5doxy.tag
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
More information about the cvs-krb5
mailing list