Format pass over RST documentation
authorGreg Hudson <ghudson@mit.edu>
Sun, 26 Feb 2012 16:45:09 +0000 (16:45 +0000)
committerGreg Hudson <ghudson@mit.edu>
Sun, 26 Feb 2012 16:45:09 +0000 (16:45 +0000)
commit1acc419ac66c4b6183d113351245b530f8219d00
tree8f53f9e47e3457fbde7bb726de1d07acb2ac30f8
parent2c990e6418cd7cee7ca178a3175b07ed6a01ffae
Format pass over RST documentation

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
129 files changed:
doc/rst_source/index.rst
doc/rst_source/krb_admins/admin_commands/index.rst
doc/rst_source/krb_admins/admin_commands/k5srvutil.rst
doc/rst_source/krb_admins/admin_commands/kadmin_local.rst
doc/rst_source/krb_admins/admin_commands/kadmind.rst
doc/rst_source/krb_admins/admin_commands/kdb5_ldap_util.rst
doc/rst_source/krb_admins/admin_commands/kdb5_util.rst
doc/rst_source/krb_admins/admin_commands/kprop.rst
doc/rst_source/krb_admins/admin_commands/kpropd.rst
doc/rst_source/krb_admins/admin_commands/kproplog.rst
doc/rst_source/krb_admins/admin_commands/krb5kdc.rst
doc/rst_source/krb_admins/admin_commands/ktutil.rst
doc/rst_source/krb_admins/admin_commands/sserver.rst
doc/rst_source/krb_admins/advanced/index.rst
doc/rst_source/krb_admins/advanced/ldapbackend.rst
doc/rst_source/krb_admins/advanced/plugins.rst
doc/rst_source/krb_admins/appl_servers/clock_skew.rst
doc/rst_source/krb_admins/appl_servers/conf_firewall.rst
doc/rst_source/krb_admins/appl_servers/dns_info.rst
doc/rst_source/krb_admins/appl_servers/index.rst
doc/rst_source/krb_admins/appl_servers/keytabs.rst
doc/rst_source/krb_admins/backup_host.rst
doc/rst_source/krb_admins/conf_files/enc_types.rst
doc/rst_source/krb_admins/conf_files/index.rst
doc/rst_source/krb_admins/conf_files/kdc_conf.rst
doc/rst_source/krb_admins/conf_files/krb5_conf.rst
doc/rst_source/krb_admins/conf_ldap.rst
doc/rst_source/krb_admins/database/change_tgtkey.rst
doc/rst_source/krb_admins/database/date_format.rst
doc/rst_source/krb_admins/database/db_operations/create_destroy_db.rst
doc/rst_source/krb_admins/database/db_operations/create_stash.rst
doc/rst_source/krb_admins/database/db_operations/db2file.rst
doc/rst_source/krb_admins/database/db_operations/file2db.rst
doc/rst_source/krb_admins/database/db_operations/index.rst
doc/rst_source/krb_admins/database/db_options.rst
doc/rst_source/krb_admins/database/db_policies/index.rst
doc/rst_source/krb_admins/database/db_policies/mod_pol.rst
doc/rst_source/krb_admins/database/db_policies/retr_pol.rst
doc/rst_source/krb_admins/database/db_policies/update_histkey.rst
doc/rst_source/krb_admins/database/db_princs/index.rst
doc/rst_source/krb_admins/database/db_princs/info_princ.rst
doc/rst_source/krb_admins/database/db_princs/modify_princ.rst
doc/rst_source/krb_admins/database/db_princs/pass_princ.rst
doc/rst_source/krb_admins/database/db_princs/priv_princ.rst
doc/rst_source/krb_admins/database/incr_db_prop.rst
doc/rst_source/krb_admins/database/index.rst
doc/rst_source/krb_admins/database/ldap_operations/edir_create_realm.rst
doc/rst_source/krb_admins/database/ldap_operations/edir_create_so.rst
doc/rst_source/krb_admins/database/ldap_operations/index.rst
doc/rst_source/krb_admins/database/ldap_operations/ldap_create_realm.rst
doc/rst_source/krb_admins/database/ldap_operations/ldap_del_realm.rst
doc/rst_source/krb_admins/database/ldap_operations/ldap_mod_realm.rst
doc/rst_source/krb_admins/database/ldap_operations/ldap_realm_info.rst
doc/rst_source/krb_admins/database/ldap_operations/ldap_realm_list.rst
doc/rst_source/krb_admins/database/ldap_operations/ldap_stash_pass.rst
doc/rst_source/krb_admins/database/ldap_operations/ldap_tkt_pol.rst
doc/rst_source/krb_admins/database/xrealm_authn.rst
doc/rst_source/krb_admins/dns.rst
doc/rst_source/krb_admins/env_variables.rst
doc/rst_source/krb_admins/index.rst
doc/rst_source/krb_admins/install.rst
doc/rst_source/krb_admins/install_appl_srv.rst
doc/rst_source/krb_admins/install_clients/cl_config.rst
doc/rst_source/krb_admins/install_clients/index.rst
doc/rst_source/krb_admins/install_clients/mac_osX_config.rst
doc/rst_source/krb_admins/install_kdc/admins_to_acl.rst
doc/rst_source/krb_admins/install_kdc/admins_to_db.rst
doc/rst_source/krb_admins/install_kdc/create_db.rst
doc/rst_source/krb_admins/install_kdc/index.rst
doc/rst_source/krb_admins/install_kdc/kadmind_kt.rst
doc/rst_source/krb_admins/install_kdc/kdc_prop_slave.rst
doc/rst_source/krb_admins/install_kdc/krb_daemon.rst
doc/rst_source/krb_admins/install_kdc/mod_conf.rst
doc/rst_source/krb_admins/install_kdc/slave_install.rst
doc/rst_source/krb_admins/install_kdc/switch_master_slave.rst
doc/rst_source/krb_admins/realm_config/db_prop.rst
doc/rst_source/krb_admins/realm_config/index.rst
doc/rst_source/krb_admins/realm_config/kdc_hn.rst
doc/rst_source/krb_admins/realm_config/kdc_ports.rst
doc/rst_source/krb_admins/realm_config/mapping_hn.rst
doc/rst_source/krb_admins/realm_config/realm_name.rst
doc/rst_source/krb_admins/realm_config/slave_kdc.rst
doc/rst_source/krb_admins/troubleshoot.rst
doc/rst_source/krb_admins/various_envs.rst
doc/rst_source/krb_appldev/h5l_mit_apidiff.rst
doc/rst_source/krb_appldev/index.rst
doc/rst_source/krb_appldev/princ_handle.rst
doc/rst_source/krb_build/directory_org.rst
doc/rst_source/krb_build/doing_build.rst
doc/rst_source/krb_build/index.rst
doc/rst_source/krb_build/options2configure.rst
doc/rst_source/krb_build/osconf.rst
doc/rst_source/krb_build/test_cov.rst
doc/rst_source/krb_users/index.rst
doc/rst_source/krb_users/pwd_mgmt/grant_access.rst
doc/rst_source/krb_users/pwd_mgmt/index.rst
doc/rst_source/krb_users/pwd_mgmt/pwd_management.rst
doc/rst_source/krb_users/pwd_mgmt/pwd_quality.rst
doc/rst_source/krb_users/tkt_mgmt/destroy_tkt.rst
doc/rst_source/krb_users/tkt_mgmt/index.rst
doc/rst_source/krb_users/tkt_mgmt/obtain_kinit.rst
doc/rst_source/krb_users/tkt_mgmt/tkt_management.rst
doc/rst_source/krb_users/tkt_mgmt/view_klist.rst
doc/rst_source/krb_users/user_appl/ftp.rst
doc/rst_source/krb_users/user_appl/index.rst
doc/rst_source/krb_users/user_appl/ksu.rst
doc/rst_source/krb_users/user_appl/rcp.rst
doc/rst_source/krb_users/user_appl/rlogin.rst
doc/rst_source/krb_users/user_appl/rsh.rst
doc/rst_source/krb_users/user_appl/ssh.rst
doc/rst_source/krb_users/user_appl/telnet.rst
doc/rst_source/krb_users/user_commands/index.rst
doc/rst_source/krb_users/user_commands/k5identity.rst
doc/rst_source/krb_users/user_commands/k5login.rst
doc/rst_source/krb_users/user_commands/kdestroy.rst
doc/rst_source/krb_users/user_commands/kinit.rst
doc/rst_source/krb_users/user_commands/klist.rst
doc/rst_source/krb_users/user_commands/kpasswd.rst
doc/rst_source/krb_users/user_commands/ksu.rst
doc/rst_source/krb_users/user_commands/kswitch.rst
doc/rst_source/krb_users/user_commands/kvno.rst
doc/rst_source/krb_users/user_commands/sclient.rst
doc/rst_source/krb_users/user_commands/send-pr.rst
doc/rst_source/mitK5defaults.rst
doc/rst_source/mitK5features.rst
doc/rst_source/mitK5license.rst
doc/rst_source/relay/build_this.rst
doc/rst_source/relay/index.rst
doc/rst_source/relay/philosophy.rst