summaryrefslogtreecommitdiffstats
path: root/doc/rst_source/krb_build
Commit message (Collapse)AuthorAgeFilesLines
* Massive reST content renameBen Kaduk2012-10-156-773/+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
* Document DejaGnu dependency and manual testsBen Kaduk2012-10-081-0/+11
| | | | | | | | | The Texinfo install guide had a separate subsection about the DejaGnu tests which did not get converted to the RST source. In the testing section, also link to the wiki page on manual testing. ticket: 7407
* Fix HTML rendering of long-form optionsBenjamin Kaduk2012-08-062-69/+69
| | | | | | | | | | | | | | | | | | | We at present only have long-form options for configure, the scope of the change is somewhat limited. Our SmartyPants config for Sphinx causes these options to appear as prefixed with an en dash, instead of the two hyphens that demarcate the (GNU-style) long-form options. Using a different type of markup for command options could work around this, but that would be a much larger patch. Instead, apply a workaround in the markup for display purposes, which makes the source a bit more ugly but the output correct. Man page output is unaffected. This patch was automatically generated with: git grep -- -- doc/rst_source | grep -v -- --- | cut -d ':' -f 1 | uniq | xargs sed -i '' -e 's/\*\*--\([a-zA-Z]\)/**-**\\ **-\1/g' and manually reviewed for correctness. ticket: 7187
* Remove eDirectory support code in LDAP KDB moduleGreg Hudson2012-07-291-3/+0
|
* Support changing the built-in ccache/keytab namesGreg Hudson2012-07-241-0/+16
| | | | | | | | | | | | | | * Add DEFCCNAME, DEFKTNAME, and DEFCKTNAME configure variables to change the built-in ccache and keytab names. * Add krb5-config options to display the built-in ccache and keytab names. * In the default build, use krb5-config to discover the system's built-in ccache and keytab names and use them (if not overridden). This can be controlled with the --with-krb5-config=PATH or --without-krb5-config configure options. * Make the built-in ccache name subject to parameter expansion. ticket: 7221 (new)
* Tidy up configure options documentationBen Kaduk2012-07-121-45/+2
| | | | | | | | | | | | | Our only C++ code is under src/tests/misc/. Infodir is only referenced in send-pr's makefile but not used in any rules therein. Docdir and its descendants ({html,dvi,pdf,ps}dir) are not used in any install rules. We do not have anything to install into libexecdir or sharedstatedir, and oldincludedir simply has no effect.
* Standardize on commas after "e.g.", "i.e."Ben Kaduk2012-07-122-9/+9
| | | | It seems to be "more correct".
* Sync configure options with configureBen Kaduk2012-07-121-3/+41
| | | | | | | We should try to stay coupled with the actual configure options, as documented by 'configure --help'. Remove an option which is no longer present and add several that were missing.
* Only list --enable-dns-for-realm onceBen Kaduk2012-07-121-3/+0
| | | | | | | | If we list something as "commonly used", we seem to not also list it with the rest of the options. This has the advantage of not requiring us to remember to update two things for future changes, but the disadvantage of requiring users to look in two places for options. Stick with the prevailing form for now.
* Sort configure optionsBen Kaduk2012-07-121-11/+11
| | | | | | | | | Stick to the order of 'configure --help' for most sections, but sort environment variables alphabetically (since, e.g., configure --help does not list CPPFLAGS and there is not a good way to add that). Note that this does not add or remove any content, even though some options are missing/extra.
* Cleanup docs for DNS lookup configure optionsBen Kaduk2012-07-121-6/+5
| | | | | | | DNS lookups for KDCs have been unconditionally enabled in configure since 2003; configure options only affect whether DNS lookups are used for realm names. Change the RST documentation of configure options to catch up.
* Remove orphaned KfM codeGreg Hudson2012-06-211-1/+0
|
* Minor reformating for better Sphinx HTML outputZhanna Tsitkov2012-06-191-1/+3
| | | | No content was changed.
* Remove CRs from options2configure.rstGreg Hudson2012-06-181-402/+402
| | | | | options2configure.rst had CRLF newlines, and should have LF newlines like everything else.
* Update Build Kerberos V5 doc sectionZhanna Tsitkov2012-06-082-25/+32
| | | | ticket: 7126
* Remove mention of util/autoconfTom Yu2012-05-171-14/+8
| | | | | | | | | We no longer use our own customized version of autoconf, so remove mentions of the src/util/autoconf directory where that used to be. Reported by W. Trevor King. ticket: 7139 (new)
* Remove references to the "feedback" and the original source of the document ↵Zhanna Tsitkov2012-03-231-6/+0
| | | | | | (such as Kerberos V5 Installation Guide etc) in the rst files git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25787 dc483132-0cff-0310-8789-dd5450dbe970
* Miscellaneous small edits to RST docsGreg Hudson2012-03-221-3/+0
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25785 dc483132-0cff-0310-8789-dd5450dbe970
* Use substitutions in RST docsGreg Hudson2012-03-221-5/+5
| | | | | | | Create an rst_epilog variable defining substitutions for pathnames and default enctypes, and use them in the RST source files. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25784 dc483132-0cff-0310-8789-dd5450dbe970
* Remove "Feedback" paragraphs from the rst files.Zhanna Tsitkov2012-03-081-7/+0
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25750 dc483132-0cff-0310-8789-dd5450dbe970
* Remove eDirectory references in RST docsGreg Hudson2012-03-051-3/+0
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25731 dc483132-0cff-0310-8789-dd5450dbe970
* Clean up labels in RST docsGreg Hudson2012-02-271-2/+2
| | | | | | | In various labels, correct typos, remove the redundant "_label" suffix, and avoid overabbreviating. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25715 dc483132-0cff-0310-8789-dd5450dbe970
* Improve man page references in RST documentationGreg Hudson2012-02-271-4/+4
| | | | | | | Give each command and config file a reference label, and change many uses of command names and config file names to be references. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25714 dc483132-0cff-0310-8789-dd5450dbe970
* Format pass over RST documentationGreg Hudson2012-02-266-563/+586
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Without substantially changing the content, reformat RST documentation sources, normalizing: * Whitespace: four-space indentation where indentation is arbitrary; no trailing whitespace or tabs. Two spaces after sentence periods. * 70-column fill where lines can be wrapped (outside tables, mostly) * Section header underlines: = for page titles, - for sections, ~ and then # for subsections. Underlines exactly as long as titles. No trailing punctuation in titles. * Bullet lists: * for top-level bullets, - for sub-bullets. No indentation of the list bullets relative to the surrounding content. * Inline markup: italics for words representing variable text, boldface for config keywords and command option names, monospaced text for examples, pathnames. No adornment for command names and filenames. * Man page subcommands: subsection header for the subcommand, indented command synposis, then non-indented description and option list. * Man page command synopses: newline in source before each option. All parts of synopsis at same indentation level. (Ideally we'd want a hanging indent to the length of the command name, but RST doesn't seem to support that.) * Feedback links: in a separate section at the end. (This will need to be revisited as it affects some multi-level tables of contents.) git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25712 dc483132-0cff-0310-8789-dd5450dbe970
* Correct typos and formatingZhanna Tsitkov2011-12-192-43/+46
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25594 dc483132-0cff-0310-8789-dd5450dbe970
* Added Test Coverage topicZhanna Tsitkov2011-11-302-0/+34
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25495 dc483132-0cff-0310-8789-dd5450dbe970
* Formating fixes and update per rev#25480Zhanna Tsitkov2011-11-211-75/+69
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25481 dc483132-0cff-0310-8789-dd5450dbe970
* Document --with-system-verto in rst docsGreg Hudson2011-11-181-0/+18
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25478 dc483132-0cff-0310-8789-dd5450dbe970
* Adjust "make check" constraints in rst docsGreg Hudson2011-11-151-3/+8
| | | | | | | | Recopy the text from the texinfo build docs into the rst version, describing --disable-rpath and avoiding an erroneous reference to make fake-install. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25476 dc483132-0cff-0310-8789-dd5450dbe970
* Expanded documentation on configure/build optionsZhanna Tsitkov2011-10-281-111/+416
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25421 dc483132-0cff-0310-8789-dd5450dbe970
* Updated some of the topics related to "how to build Kerberos"Zhanna Tsitkov2011-10-213-86/+116
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25403 dc483132-0cff-0310-8789-dd5450dbe970
* Added documentation on how to build Kerberos. Mainly from the Installation ↵Zhanna Tsitkov2011-10-205-0/+363
Guide with some corrections git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25393 dc483132-0cff-0310-8789-dd5450dbe970