Difference between revisions of "Projects/Kerberos Documentation"
From K5Wiki
< Projects
m (→How to contribute) |
m |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{project- |
+ | {{project-rel|1.11}} |
== Purpose == |
== Purpose == |
||
The goal of the project is to create an infrastructure and process for the future development of the extensive Kerberos documentation. |
The goal of the project is to create an infrastructure and process for the future development of the extensive Kerberos documentation. |
||
| + | The documentation should be useful and correct; it must be detailed, but optimized -- do not be too verbose. |
||
'''The documentation will be built incrementally. We will analyze what works and what doesn't and correct the course of action as needed.''' |
'''The documentation will be built incrementally. We will analyze what works and what doesn't and correct the course of action as needed.''' |
||
| + | Part of the criteria for "what works" is that the documentation should be easy to maintain. |
||
The actualized documentation will be useful for developers and administrators, both for experienced ones and newcomers. It will address the following topics: |
The actualized documentation will be useful for developers and administrators, both for experienced ones and newcomers. It will address the following topics: |
||
| Line 11: | Line 13: | ||
* Complete reference - API, internal functions, data types, macros |
* Complete reference - API, internal functions, data types, macros |
||
* Tutorial for application developers - description on various tasks such as working with credentials, topics on how to write plugins, etc |
* Tutorial for application developers - description on various tasks such as working with credentials, topics on how to write plugins, etc |
||
| − | * Cookbook for administrators - Installation, configuration, troubleshooting |
+ | * Cookbook for administrators - Installation, configuration, troubleshooting. |
| − | == Example == |
||
| + | == Documentation for application developers == |
||
| + | |||
| + | Generally any topic in the Kerberos documentation can cross-reference with function documentation and each other. |
||
| − | Please, follow this link for Kerberos documentation example [http://web.mit.edu/tsitkova/www/build/index.html]. |
||
| Line 22: | Line 25: | ||
| − | + | === Documenting functions === |
|
| − | |||
| − | |||
| − | '''Part_1''' |
||
| − | |||
The following fields ''must'' be included in the function documentation and should reside in the source code : |
The following fields ''must'' be included in the function documentation and should reside in the source code : |
||
| Line 32: | Line 35: | ||
# Detailed description (optional) |
# Detailed description (optional) |
||
| − | |||
| + | <pre> |
||
| − | One can see that Part_1 contains the information that is the most useful for those who update the code and fix the bugs. To avoid the code overcrowding and make any additions to the function documentation as simple as possible, we suggest to save additional documentation ( see below Part_2) in the separate location - one file per function.. |
||
| + | /** Some brief description |
||
| − | |||
| + | * |
||
| − | |||
| + | * Optional detailed description |
||
| − | '''Part_2''' |
||
| + | * |
||
| − | |||
| + | * @param[in] arg1 Description of arg1 |
||
| + | * |
||
| + | * @return Something useful |
||
| + | */ |
||
| + | char * KRB5_CALLCONV |
||
| + | krb5_X(type arg1) |
||
| + | </pre> |
||
The ''optional'' fields may include: |
The ''optional'' fields may include: |
||
| Line 48: | Line 57: | ||
# Version of Kerberos when fuction was introduced or became obsolete |
# Version of Kerberos when fuction was introduced or became obsolete |
||
| − | |||
| − | Effectively this means that we expect the Doxygen style comments in the headers in the following format: |
||
| − | |||
| − | /** |
||
| − | * @brief Some brief description |
||
| − | * |
||
| − | * Optional detailed description |
||
| − | * |
||
| − | * @param[in] arg1 Description of arg1 |
||
| − | * |
||
| − | * @return Something useful |
||
| − | */ |
||
| − | char * KRB5_CALLCONV |
||
| − | krb5_X ( type arg1) |
||
| − | |||
| − | Also, when available, we suggest to have Part_2 information associated with the particular function in ReST format. For example: |
||
| − | |||
| − | * Warnings and suggestions |
||
| − | Warn about any potential mistakes and misuse. |
||
| − | Point to other useful routines. |
||
| − | |||
| − | * Links to RFC, wiki Projects, krbdev discussions |
||
| − | :rfc:4120 |
||
| − | Or if you want to reffer to the specific section of the RFC use the following notation: :rfc:4120#section-5.2 |
||
| − | Or link to Kerberos Project page, for example, Disable_DES project <http://k5wiki.kerberos.org/wiki/Projects/Disable_DES> |
||
| − | |||
| − | * Example |
||
| − | The place for the function usage examples |
||
| − | |||
| − | |||
| − | '''Workflow: Putting Part_1 and Part_2 together''' |
||
| + | ==== Workflow ==== |
||
# Configure Doxygen to generate output both in xml and html formats. Run Doxygen. |
# Configure Doxygen to generate output both in xml and html formats. Run Doxygen. |
||
| − | # For each function and data type generate document in ReST format |
+ | # For each function and data type generate document in ReST format. For the function ''krb5_X()'' lets call it ''krb5_X_p1''. |
| − | # If the Part_2 documentation for ''krb5_X()'' has been already written, there is a file called ''krb5_X_p2.rst'' in the designated directory. If not - nothing happens. |
||
| − | # Concatenate ''krb5_X_p1'' and ''krb5_X_p2.rst'' (if it exists), add the link to Doxygen generated documentation for this function in html format (generated automatically) and save as a file ''krb5_X.rst''. |
||
# File ''krb5_X.rst'' can be used as input for Sphinx |
# File ''krb5_X.rst'' can be used as input for Sphinx |
||
| − | NOTE: Initially we provide Python script to automate steps 2-4. The whole process will be automated later. |
||
| + | === Documenting data types and macros=== |
||
| − | ==== Documenting data types ==== |
||
| + | Similar to documenting functions. |
||
| − | |||
| − | TODO |
||
| − | |||
| − | == Documentation for application developers == |
||
| − | |||
| − | TODO |
||
| − | |||
| − | Generally any topic in the Kerberos documentation can cross-reference with function documentation and each other. |
||
| Line 111: | Line 82: | ||
* Sphinx 1.0.4 <http://sphinx.pocoo.org> |
* Sphinx 1.0.4 <http://sphinx.pocoo.org> |
||
* Python 2.5+ (with lxml extension) |
* Python 2.5+ (with lxml extension) |
||
| + | * Cheetah 2.4.4 <http://www.cheetahtemplate.org> |
||
* Restructured Text markup <http://docutils.sourceforge.net/docs/user/rst/quickstart.html> |
* Restructured Text markup <http://docutils.sourceforge.net/docs/user/rst/quickstart.html> |
||
Latest revision as of 10:21, 29 October 2013
This project was completed in release 1.11.
Contents
Purpose
The goal of the project is to create an infrastructure and process for the future development of the extensive Kerberos documentation. The documentation should be useful and correct; it must be detailed, but optimized -- do not be too verbose.
The documentation will be built incrementally. We will analyze what works and what doesn't and correct the course of action as needed. Part of the criteria for "what works" is that the documentation should be easy to maintain.
The actualized documentation will be useful for developers and administrators, both for experienced ones and newcomers. It will address the following topics:
- Complete reference - API, internal functions, data types, macros
- Tutorial for application developers - description on various tasks such as working with credentials, topics on how to write plugins, etc
- Cookbook for administrators - Installation, configuration, troubleshooting.
Documentation for application developers
Generally any topic in the Kerberos documentation can cross-reference with function documentation and each other.
Details of source documentation
Documenting functions
The following fields must be included in the function documentation and should reside in the source code :
- Function signature
- Brief function description
- Arguments - [in/out] with description
- Return value description
- Detailed description (optional)
/** Some brief description * * Optional detailed description * * @param[in] arg1 Description of arg1 * * @return Something useful */ char * KRB5_CALLCONV krb5_X(type arg1)
The optional fields may include:
- See also section to refer to the related functions,
- Note section to highlight the specifics of the behaivor
- Examples of the usage
- Snap-shot of the real code involving this function
- Links to KRB5 Wiki Project page, krbdev discussion, RFC document or its section etc
- Version of Kerberos when fuction was introduced or became obsolete
Workflow
- Configure Doxygen to generate output both in xml and html formats. Run Doxygen.
- For each function and data type generate document in ReST format. For the function krb5_X() lets call it krb5_X_p1.
- File krb5_X.rst can be used as input for Sphinx
Documenting data types and macros
Similar to documenting functions.
How to contribute
- The core team - the administrator - posts the initial list of the tasks (such as API, admin tasks, "How to"-s etc) and further supports it. See Projects/Documentation Tasks for more detailed information.
- Community can suggest new tasks
- The core team provides templates that, if helpful, may be used by the documentation writers. The most desirable format for the contributed documents is ReST as the easiest to integrate with the mainstream documentation.
- Community can provide the feedback on the documented tasks.
Tools
- Doxygen 1.7.2 <http://www.stack.nl/~dimitri/doxygen/index.html>
- Sphinx 1.0.4 <http://sphinx.pocoo.org>
- Python 2.5+ (with lxml extension)
- Cheetah 2.4.4 <http://www.cheetahtemplate.org>
- Restructured Text markup <http://docutils.sourceforge.net/docs/user/rst/quickstart.html>
