summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* Cross-reference account lockout documentationGreg Hudson2012-12-053-26/+33
| | | | | | | | | | | | Link to the database.rst description of policy objects when talking about them. Briefly mention the "default" policy. Link to the kadmin_local.rst description of policy fields when referencing them. Describe policy fields more briefly, and expand the kadmin_local.rst descriptions where appropriate. ticket: 7480 (new) target_version: 1.11 tags: pullup
* Document account lockout configurationGreg Hudson2012-12-032-0/+141
| | | | | | ticket: 7477 (new) target_version: 1.11 tags: pullup
* Document param expansion for keytab/ccache namesZhanna Tsitkov2012-11-292-4/+9
| | | | | | | | | | The DEFCCNAME, DEFCKTNAME and DEFKTNAME configuration options are subjects to parameter expansion. Also note that this feature was first introduced in release 1.11. ticket: 7472 tags: pullup target_version: 1.11
* Update documentation Feature list with 1.11 itemsZhanna Tsitkov2012-11-291-11/+15
| | | | | | | | | Also, change the reference for Camellia enc type to rfc6803 and do minor table re-formatting. ticket: 7456 tags: pullup target_version: 1.11
* Remove last "document not in toctree" warningsBen Kaduk2012-11-272-0/+6
| | | | | | | | | | | | | | | | | | | | There were two of them, for notice.rst and mitK5license.rst. The former is included in the latter, which is linked to from the mitK5features document but not listed in a table of contents otherwise. Includes are processed unconditionally, so we can add notice.rst to the exclude_patterns array (formerly unused_docs) and its content will still be included. If we attempt to do the same for mitK5license.rst, it is not processed at all, and the attempt to link to it will fail. Instead, put a dummy table of contents in the mitK5features document (which links to the license document), with the "hidden" attribute. This satisfies the Sphinx need to know where all the input documents are without changing the displayed table of contents. ticket: 7447 tags: pullup target_version: 1.11
* Render macros as literalsBen Kaduk2012-11-272-7/+7
| | | | | | | | | | | | | | | | | | | | | | | | | Some convenience macros are referring to and dereferencing pointers, and Sphinx will get a bit confused trying to interpret this as markup. There should never be any markup intended to be interpreted in the value of a macro definition, so we can silence this class of warnings by treating them as literals. (In some sense, they actually are literals, too.) This will cause a warning for macros that only cause a symbol to be defined, that is, a literal "#define MACRO" with no initializer, due to the lack of body in the inline-literal markup. Such macros should probably be added to the exclude list for conversion to reStructuredText in the Doxygen-Sphinx bridge, as was already done for KRB5_OLD_CRYPTO. Support code to programmatically omit macros of this sort is deliberately *not* included, so that explicit action must be taken when a new macro is to be undocumented. Also, strip leading and trailing whitespace from the macro name, since this causes problems with the markup. ticket: 7447 tags: pullup target_version: 1.11
* Handle multiline macro definitionsBen Kaduk2012-11-271-0/+2
| | | | | | | | Compress them onto one line for printing in the generated table. ticket: 7447 tags: pullup target_version: 1.11
* Exclude lists for doxygen API docsBen Kaduk2012-11-273-1/+11
| | | | | | | | | | | | | | | | | | | | | | | | Doxygen will pick up every function, macro, and typedef defined in krb5.h; some of these may not actually be part of the public API for one reason or another. Provide hardcoded exclude lists for macro/function/type names for which we do not want to emit reStructuredText documentation, and check these lists when processing the Doxygen XML output. Seed these lists with the macros TRUE, FALSE, KRB5_OLD_CRYPTO, KRB5_GENERAL__, KRB5_CALLCONV, KRB5_CALLCONV_C, KRB5_CALLCONV_WRONG, KRB5INT_BEGIN_DECLS, KRB5INT_END_DECLS, and KRB5_ATTR_DEPRECATED, and typedefs krb5_cc_ops and krb5_responder_context. The booleans are compatibility cruft that we do not want to advertise, and the other macros are for internal use for signalling and platform compatibility. The typedefs are functioning just as forward declarations. For consistency, remove KRB5_OLD_CRYPTO.rst from the macros index; it had no content even when we did generate it. ticket: 7447 tags: pullup target_version: 1.11
* Handle adjacent notes from doxygen more correctlyBen Kaduk2012-11-271-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | The Doxygen documentation seems to claim that adjacent @note entries will be collapsed into a single "note" element, as separate paragraphs. This seems to be reflected in the XML output: multiple <para> entries in a single <simplesec kind="note"> with a <simplesecsep/> element between them. Our XML-to-RST converter gets the entire contents of the simplesec element, parsed into a unicode string with a single newline between paragraphs. Paragraphs seem to always start with two spaces, though I have not tracked down the origin of this behavior. Prior to this commit, we would just output this entire unicode string directly. Since our template puts a tab character before the note string, this means that the first paragraph is indented by a tab and two spaces, and the second paragraph by just two spaces. Sphinx warns about this, as "block did not end with blank line; unexpected whitespace", and the paragraphs are indented differently within the note. Fix the warning by checking for newlines in the interior of the parsed unicode string, and introducing the appropriate whitespace for the Sphinx parser. ticket: 7447 tags: pullup target_version: 1.11
* Fix overflowing cell in HTML tableBen Kaduk2012-11-271-0/+3
| | | | | | | | | | | | | | | | | sphinx-build defaults to the 'tabulary' environment for tables, but uses regular 'tabular' for those involving literal blocks, since tabulary does not handle them properly. It seems that this deficiency of tabulary also applies to inline literals, which are rendered as \code{} sections by the latex builder. Fortunately, sphinx provides a workaround to force a particular column specification for the table. The requirement for a table:: statement after the tabularcolumns:: statement is very poorly documented. ticket: 7447 tags: pullup target_version: 1.11
* Use en dash instead of hyphenBen Kaduk2012-11-271-1/+1
| | | | | | | | It should not be bracketed in whitespace. ticket: 7447 tags: pullup target_version: 1.11
* Remove Test Coverage topic from documentationZhanna Tsitkov2012-11-262-32/+0
| | | | ticket: 7464
* Move Release tag into footer for Sphinx HTMLZhanna Tsitkov2012-11-262-6/+2
| | | | | | | | The current position of the Release tag is in the body of the main page of the Sphinx html. Move it to the footer. This way the release number can be viewed from every page. ticket: 7462
* Update feature list in the documentationZhanna Tsitkov2012-11-261-77/+83
| | | | | | | | | | | | | | | In Quick facts section: - restructure the Supported platforms section; - do not tie KfW to 1.11 release; - move references to GSS-API extensions to Feature list table. In Feature list section: - reformat the table; - move PRNG and Pre-auth mechanisms into their own tables; - clarify GS2 feature description; - reference rfc6680 for GSS-API naming extensions. Lowercase the words in the title of the document. ticket: 7455
* Add "Kerberos" to PDF titlesTom Yu2012-11-191-4/+4
| | | | | | ticket: 7451 (new) tags: pullup target_version: 1.11
* Add Camellia enctypes to default enctype listsGreg Hudson2012-11-141-1/+1
| | | | | | | | | | | | Add camellia256-cts-cmas and camellia128-cts-cmac to the default permitted_enctypes, default_tkt_enctypes, and default_tgs_enctypes lists, to simplify deployment of Camellia. The new enctypes still aren't on supported_enctypes, so won't be in the set of long-term keys for principals without administrator intervention. ticket: 7446 (new) target_version: 1.11 tags: pullup
* Replace UTF-8 with ASCIIBen Kaduk2012-11-141-6/+6
| | | | | | | | | | | | | We try to restrict non-ASCII to names. Python does not accept U+2013 EN DASH as indicating a command-line argument; U+2D HYPHEN-MINUS is required. Replace U+201C LEFT DOUBLE QUOTATION MARK and U+201D RIGHT DOUBLE QUOTATION MARK with ordinary ASCII quotes. ticket: 7433 tags: pullup
* Rename doc subdirectoriesBen Kaduk2012-11-1467-77/+74
| | | | | | | | | | | | | | | | | | | | We like these names better, and they match the PDF document filenames. admins -> admin appldev -> appdev users -> user and catch up where the names are used elsewhere. The relay/ directory has been removed, with its contents moved to the top level in build_this.rst and a new about.rst. The section headers for kadmind, krb5kdc, sserver, kpasswd, kswitch, and sclient are misdetected as conflict markers. bigredbutton: whitespace ticket: 7433 tags: pullup
* Remove trailing whitespaceBen Kaduk2012-11-144-5/+0
| | | | | ticket: 7433 tags: pullup
* Use release, not version, for HTML indexBen Kaduk2012-11-141-1/+1
| | | | | | | | The full release string includes RELTAIL from patchlevel.h; it is useful to know whether we are on a pre- or post-release branch. ticket: 7433 tags: pullup
* Update conf.py for latex outputBen Kaduk2012-11-141-1/+8
| | | | | | | | | | | We do not want one giant PDF document; we want separate PDFs for our various components. The features document cannot be included in the list because the generated LaTeX for tables with empty cells does not compile. ticket: 7433 tags: pullup
* Use main conf.py for NOTICETom Yu2012-11-143-100/+21
| | | | | | | | | | Generate the NOTICE file using the main conf.py, by using a special tag when invoking sphinx-build. While here, add notice.txt to the list of files removed by make clean. ticket: 7433 tags: pullup
* Generate and use version.py for SphinxTom Yu2012-11-141-3/+8
| | | | | | | | | | | | Sphinx's idea of the version number appears in the man pages and compiled PDF documents, and shows up as metadata in the generated HTML sources. Extract the version information from the master source (patchlevel.h) into a form usable by Sphinx. ticket: 7433 tags: pullup
* Add Camellia to enctype table in documentationGreg Hudson2012-11-021-0/+3
| | | | | | ticket: 7439 (new) target_version: 1.11 tags: pullup
* Fix a typo in pkinit.rstGreg Hudson2012-11-021-1/+1
|
* Update Camellia feature descriptionTom Yu2012-11-011-1/+1
| | | | | | | | | | Remove the potentially misleading "experimental" annotation on the description of the Camellia encryption feature. Also update the I-D version to match the IESG-approved version. ticket: 7437 (new) target_version: 1.11 tags: pullup
* Document PKINIT and anonymos PKINIT configurationGreg Hudson2012-11-012-0/+220
| | | | | | ticket: 7436 (new) target_version: 1.11 tags: pullup
* Document GSSAPI loadable module interfaceGreg Hudson2012-10-253-5/+112
| | | | | | ticket: 7429 (new) target_version: 1.11 tags: pullup
* Add missing macro and type index.rst entriesGreg Hudson2012-10-232-0/+17
| | | | | | ticket: 7424 (new) target_version: 1.11 tags: pullup
* Document prompter and responder callbacksGreg Hudson2012-10-221-0/+85
|
* Fix kswitch section heading markupBen Kaduk2012-10-171-1/+1
| | | | | SYNOPSIS is a first-level section, and should use '-' like the other sections.
* Add docs for kinit's -I optionNalin Dahyabhai2012-10-171-0/+9
|
* Use bulleted instead of ordinal lists as neededBen Kaduk2012-10-171-26/+26
| | | | | The texinfo-generated NOTICE used bullets for some of the lists; make the RST source consistent with that.
* Add an input ccache get_init_creds optionNalin Dahyabhai2012-10-161-0/+1
| | | | | | | | Add a krb5_get_init_creds_opt_set_in_ccache() function. An input ccache may hold configuration data which the client libraries can use to influence their decisions. ticket: 7413 (new)
* Remove nroff man pagesBen Kaduk2012-10-161-1/+0
| | | | | | | We generate man pages from RST sources now; they are checked into the tree in src/man/. The gen-manpages directory is no longer needed.
* More RST rename follow-upBen Kaduk2012-10-163-28/+28
| | | | | | Update conf.py for paths to man page sources and update make rules for building the man pages. Correct README files for the location of the sources.
* Better doc the accepted values for kdc_timesyncZhanna Tsitkov2012-10-161-1/+1
|
* Modify MIT Kerberos Features documentZhanna Tsitkov2012-10-161-3/+4
|
* Catch up to RST move/renameBen Kaduk2012-10-152-10/+10
| | | | | | | | Change the make rules for the directory structure. Update the RST sources which include other RST sources for the loss of the krb_ prefix. ticket: 7409
* Massive reST content renameBen Kaduk2012-10-15102-0/+0
| | | | | | | | | | | All of rst_source/ is now just in doc/. The krb_ prefix is stripped from the document sub-directories. rst_tools are now just tools. The section headers of kadmind, krb5kdc, and sserver match as conflict markers. bigredbutton: whitespace ticket: 7409
* Whitespace cleanupBen Kaduk2012-10-1510-146/+146
| | | | Prior to a mass rename of the RST sources and utilities.
* Remove stale implement documentBen Kaduk2012-10-1513-1544/+0
| | | | | | | | As with the texinfo implementor's guide, it is sufficiently stale so as to be untrustworthy without verification. Content of this nature should live on k5wiki.kerberos.org. ticket: 7408
* Remove the last vestiges of the texinfo docsBen Kaduk2012-10-1511-12490/+0
| | | | | | | | | | | | | | We needed these last stragglers to build the NOTICE file at the root of the tree, but we now generate a notice.txt from reST. Man pages have been generated from reST for some time now, we no longer need scripts to turn them into HTML and ps, as those can be generated directly from the reST source. The Makefile only existed to serve the texinfo builds, so it goes away, too. (The tgz target appears to have been broken since 1996.) ticket: 7408
* Make rules for building NOTICE from RSTBen Kaduk2012-10-151-0/+88
| | | | | | | | | | | | | | | | | | | | Sphinx-build wants to scan over all the sources in the source dir, and its text output engine does not handle the spanning row cells used in some of our fancy tables, so it will crash if we attempt to generate text output from our full suite of documents. We could work around this by attempting to just compile the one source file as an additional argument to sphinx-build, but this seems to insist on producing an index.txt as well as a notice.txt. Furthermore, we cannot use the same conf.py as in rst_composite because the paths substitutions are not available with just the minimal contents of rst_notice. Make a copy and remove the irrelevant parts, for now, changing only the master_doc field as appropriate. For the HTML build, we use the standard |copy| macro from isonum.txt to get the unicode copyright symbol glyph, but for ASCII output we prefer to just use the literal "(C)". ticket: 7407
* Add notice.rstBen Kaduk2012-10-152-2/+1125
| | | | | | | | | | To replace the texinfo sources previously used to generate NOTICE. When compiled to HTML, compares well against the original NOTICE; use notice.rst in mitK5license.rst instead of using a literal include of the old NOTICE file. ticket: 7407
* Remove texinfo implementors guideBen Kaduk2012-10-152-1256/+0
| | | | | | | | | It is sufficiently old and unloved that nothing in it should be taken as truth without independent verification. Content of this nature should live on k5wiki.kerberos.org in the future. ticket: 7408
* Remove unused texinfo sourcesBen Kaduk2012-10-152-1775/+0
| | | | | | | Now that the users guide make rules are removed, some of the texinfo sources are not referenced from anywhere and can be safely removed. ticket: 7408
* Remove make glue for texinfo users guideBen Kaduk2012-10-151-35/+1
| | | | | | Towards removing the texinfo docs entirely. ticket: 7408
* Disconnect the texinfo users guide from the buildBen Kaduk2012-10-151-1/+1
| | | | | | | | | | | | | | | | | | Its content has been migrated to or superseded by the krb_users reST documentation. The texinfo document attempted to have a general introduction to Kerberos, but it is not quite suitable for the target audience of the user's guide and will be rewritten. A few portions of the texinfo document are simply no longer relevant and do not need to be migrated. In particular: The krb5-appl utilities are out of scope for this document, as they have been moved to a separate repository. Coverage of ksu may be brought back at a later time, though. The Kerberos Glossary will be expanded and handled separately. ticket: 7408
* Add a -C flag to klist to also show config entriesNalin Dahyabhai2012-10-151-0/+6
|
generated by cgit (git 2.34.1) at 2025-09-25 19:40:07 +0000