Skip Menu |
 

Subject: Documentation build system improvements
Placeholder ticket for multiple commits to come that improve the documentation build system.
From: kaduk@MIT.EDU
Subject: SVN Commit

Generate and use version.py for Sphinx

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.

https://github.com/krb5/krb5/commit/07c77b51d33c23d3ea28d588adc43b6c5ec5c20f
Author: Tom Yu <tlyu@mit.edu>
Committer: Ben Kaduk <kaduk@mit.edu>
Commit: 07c77b51d33c23d3ea28d588adc43b6c5ec5c20f
Branch: master
.gitignore | 2 ++
doc/conf.py | 11 ++++++++---
src/doc/Makefile.in | 15 ++++++++++++---
src/doc/version.py.in | 21 +++++++++++++++++++++
src/man/Makefile.in | 5 ++++-
5 files changed, 47 insertions(+), 7 deletions(-)
From: kaduk@MIT.EDU
Subject: SVN Commit

Use main conf.py for NOTICE

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.

https://github.com/krb5/krb5/commit/3f7aebe3f77fc99200f863f66c064614509d7882
Author: Tom Yu <tlyu@mit.edu>
Committer: Ben Kaduk <kaduk@mit.edu>
Commit: 3f7aebe3f77fc99200f863f66c064614509d7882
Branch: master
doc/conf.py | 31 ++++++++++++------
doc/notice.rst | 2 -
doc/txt_conf.py | 88 ---------------------------------------------------
src/doc/Makefile.in | 19 ++---------
4 files changed, 25 insertions(+), 115 deletions(-)
From: kaduk@MIT.EDU
Subject: SVN Commit

Update conf.py for latex output

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.

https://github.com/krb5/krb5/commit/d6d0455c13bdd137dca527219e4cd6ecce161fc3
Author: Ben Kaduk <kaduk@mit.edu>
Commit: d6d0455c13bdd137dca527219e4cd6ecce161fc3
Branch: master
doc/conf.py | 9 ++++++++-
1 files changed, 8 insertions(+), 1 deletions(-)
From: kaduk@MIT.EDU
Subject: SVN Commit

Make glue for building PDFs

sphinx-build's latex output engine creates a subdirectory with
various latex files, and a Makefile. The generated Makefile assumes
gmake, which we do not. The logic needed in this makefile is rather
simple, so we just include it in src/doc/Makefile.in, even if we
do need a rather complicated shell expression to work in the subdirectory.

https://github.com/krb5/krb5/commit/f06725b7a98c16630f80d8cc1dd6386a7d21a058
Author: Ben Kaduk <kaduk@mit.edu>
Commit: f06725b7a98c16630f80d8cc1dd6386a7d21a058
Branch: master
.gitignore | 1 +
src/doc/Makefile.in | 26 ++++++++++++++++++++++++++
2 files changed, 27 insertions(+), 0 deletions(-)
From: kaduk@MIT.EDU
Subject: SVN Commit

Use release, not version, for HTML index

The full release string includes RELTAIL from patchlevel.h; it
is useful to know whether we are on a pre- or post-release branch.

https://github.com/krb5/krb5/commit/6353783765cd51c8588490765098861ba36c7f08
Author: Ben Kaduk <kaduk@mit.edu>
Commit: 6353783765cd51c8588490765098861ba36c7f08
Branch: master
doc/index.rst | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
From: kaduk@MIT.EDU
Subject: SVN Commit

Remove trailing whitespace

https://github.com/krb5/krb5/commit/07b66c2220ad1b38c5465cacc2537096afe332d2
Author: Ben Kaduk <kaduk@mit.edu>
Commit: 07b66c2220ad1b38c5465cacc2537096afe332d2
Branch: master
doc/admins/advanced/index.rst | 1 -
doc/appldev/refs/api/index.rst | 1 -
doc/appldev/refs/index.rst | 1 -
doc/appldev/refs/types/index.rst | 2 --
4 files changed, 0 insertions(+), 5 deletions(-)
From: kaduk@MIT.EDU
Subject: SVN Commit
Download (untitled) / with headers
text/plain 4.6KiB

Rename doc subdirectories

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

https://github.com/krb5/krb5/commit/ccaf2682c79974cee368d2f3b0611dabc1361df5
Author: Ben Kaduk <kaduk@mit.edu>
Commit: ccaf2682c79974cee368d2f3b0611dabc1361df5
Branch: master
doc/about.rst | 32 ++++++++++
doc/{admins => admin}/admin_commands/index.rst | 0
doc/{admins => admin}/admin_commands/k5srvutil.rst | 0
.../admin_commands/kadmin_local.rst | 0
doc/{admins => admin}/admin_commands/kadmind.rst | 0
.../admin_commands/kdb5_ldap_util.rst | 0
doc/{admins => admin}/admin_commands/kdb5_util.rst | 0
doc/{admins => admin}/admin_commands/kprop.rst | 0
doc/{admins => admin}/admin_commands/kpropd.rst | 0
doc/{admins => admin}/admin_commands/kproplog.rst | 0
doc/{admins => admin}/admin_commands/krb5kdc.rst | 0
doc/{admins => admin}/admin_commands/ktutil.rst | 0
doc/{admins => admin}/admin_commands/sserver.rst | 0
doc/{admins => admin}/advanced/index.rst | 0
doc/{admins => admin}/advanced/ldapbackend.rst | 0
doc/{admins => admin}/advanced/retiring-des.rst | 0
doc/{admins => admin}/appl_servers.rst | 0
doc/{admins => admin}/backup_host.rst | 0
doc/{admins => admin}/conf_files/index.rst | 0
doc/{admins => admin}/conf_files/kadm5_acl.rst | 0
doc/{admins => admin}/conf_files/kdc_conf.rst | 0
doc/{admins => admin}/conf_files/krb5_conf.rst | 0
doc/{admins => admin}/conf_ldap.rst | 0
doc/{admins => admin}/database.rst | 0
doc/{admins => admin}/env_variables.rst | 0
doc/{admins => admin}/host_config.rst | 0
doc/{admins => admin}/index.rst | 0
doc/{admins => admin}/install.rst | 0
doc/{admins => admin}/install_appl_srv.rst | 0
doc/{admins => admin}/install_clients.rst | 0
doc/{admins => admin}/install_kdc.rst | 0
doc/{admins => admin}/pkinit.rst | 0
doc/{admins => admin}/realm_config.rst | 0
doc/{admins => admin}/troubleshoot.rst | 0
doc/{admins => admin}/various_envs.rst | 0
doc/{appldev => appdev}/gssapi.rst | 0
doc/{appldev => appdev}/h5l_mit_apidiff.rst | 0
doc/{appldev => appdev}/index.rst | 0
doc/{appldev => appdev}/init_creds.rst | 0
doc/{appldev => appdev}/princ_handle.rst | 0
doc/{appldev => appdev}/refs/api/index.rst | 0
doc/{appldev => appdev}/refs/index.rst | 0
doc/{appldev => appdev}/refs/macros/index.rst | 0
doc/{appldev => appdev}/refs/types/index.rst | 0
doc/{appldev => appdev}/refs/types/krb5_int32.rst | 0
doc/{appldev => appdev}/refs/types/krb5_ui_4.rst | 0
doc/{relay => }/build_this.rst | 8 +-
doc/conf.py | 61 ++++++++++----------
doc/index.rst | 9 ++-
doc/relay/index.rst | 9 ---
doc/relay/philosophy.rst | 28 ---------
doc/tools/README | 4 +-
doc/{users => user}/index.rst | 0
doc/{users => user}/pwd_mgmt.rst | 0
doc/{users => user}/tkt_mgmt.rst | 0
doc/{users => user}/user_commands/index.rst | 0
doc/{users => user}/user_commands/kdestroy.rst | 0
doc/{users => user}/user_commands/kinit.rst | 0
doc/{users => user}/user_commands/klist.rst | 0
doc/{users => user}/user_commands/kpasswd.rst | 0
doc/{users => user}/user_commands/ksu.rst | 0
doc/{users => user}/user_commands/kswitch.rst | 0
doc/{users => user}/user_commands/kvno.rst | 0
doc/{users => user}/user_commands/sclient.rst | 0
doc/{users => user}/user_config/index.rst | 0
doc/{users => user}/user_config/k5identity.rst | 0
doc/{users => user}/user_config/k5login.rst | 0
src/doc/Makefile.in | 15 +++--
68 files changed, 82 insertions(+), 84 deletions(-)
From: kaduk@MIT.EDU
Subject: SVN Commit

Replace UTF-8 with ASCII

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.

https://github.com/krb5/krb5/commit/b1ba4ac45345d93ecbba22626843b06f32b2262d
Author: Ben Kaduk <kaduk@mit.edu>
Commit: b1ba4ac45345d93ecbba22626843b06f32b2262d
Branch: master
doc/tools/README | 12 ++++++------
1 files changed, 6 insertions(+), 6 deletions(-)
From: tlyu@mit.edu
Subject: SVN Commit

Generate and use version.py for Sphinx

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.

(cherry picked from commit 07c77b51d33c23d3ea28d588adc43b6c5ec5c20f)

https://github.com/krb5/krb5/commit/8d290c2e310999a241ab6a56ee2b33871cce0eb0
Author: Tom Yu <tlyu@mit.edu>
Commit: 8d290c2e310999a241ab6a56ee2b33871cce0eb0
Branch: krb5-1.11
.gitignore | 2 ++
doc/conf.py | 11 ++++++++---
src/doc/Makefile.in | 15 ++++++++++++---
src/doc/version.py.in | 21 +++++++++++++++++++++
src/man/Makefile.in | 5 ++++-
5 files changed, 47 insertions(+), 7 deletions(-)
From: tlyu@mit.edu
Subject: SVN Commit

Use main conf.py for NOTICE

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.

(cherry picked from commit 3f7aebe3f77fc99200f863f66c064614509d7882)

https://github.com/krb5/krb5/commit/f8ba9944931e4a38ca137256ee251387c3c6a1b0
Author: Tom Yu <tlyu@mit.edu>
Commit: f8ba9944931e4a38ca137256ee251387c3c6a1b0
Branch: krb5-1.11
doc/conf.py | 31 ++++++++++++------
doc/notice.rst | 2 -
doc/txt_conf.py | 88 ---------------------------------------------------
src/doc/Makefile.in | 19 ++---------
4 files changed, 25 insertions(+), 115 deletions(-)
From: tlyu@mit.edu
Subject: SVN Commit

Update conf.py for latex output

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.

(cherry picked from commit d6d0455c13bdd137dca527219e4cd6ecce161fc3)

https://github.com/krb5/krb5/commit/af0521ac9737e9de73fc6f4c89da63f06fd73b4f
Author: Ben Kaduk <kaduk@mit.edu>
Committer: Tom Yu <tlyu@mit.edu>
Commit: af0521ac9737e9de73fc6f4c89da63f06fd73b4f
Branch: krb5-1.11
doc/conf.py | 9 ++++++++-
1 files changed, 8 insertions(+), 1 deletions(-)
From: tlyu@mit.edu
Subject: SVN Commit

Make glue for building PDFs

sphinx-build's latex output engine creates a subdirectory with
various latex files, and a Makefile. The generated Makefile assumes
gmake, which we do not. The logic needed in this makefile is rather
simple, so we just include it in src/doc/Makefile.in, even if we
do need a rather complicated shell expression to work in the subdirectory.

(cherry picked from commit f06725b7a98c16630f80d8cc1dd6386a7d21a058)

https://github.com/krb5/krb5/commit/12e7827ee9b89d67164cef7aa64416722c0016ad
Author: Ben Kaduk <kaduk@mit.edu>
Committer: Tom Yu <tlyu@mit.edu>
Commit: 12e7827ee9b89d67164cef7aa64416722c0016ad
Branch: krb5-1.11
.gitignore | 1 +
src/doc/Makefile.in | 26 ++++++++++++++++++++++++++
2 files changed, 27 insertions(+), 0 deletions(-)
From: tlyu@mit.edu
Subject: SVN Commit

Use release, not version, for HTML index

The full release string includes RELTAIL from patchlevel.h; it
is useful to know whether we are on a pre- or post-release branch.

(cherry picked from commit 6353783765cd51c8588490765098861ba36c7f08)

https://github.com/krb5/krb5/commit/15939bc5b5ccef96293edb3c2a0cfa156d03bad5
Author: Ben Kaduk <kaduk@mit.edu>
Committer: Tom Yu <tlyu@mit.edu>
Commit: 15939bc5b5ccef96293edb3c2a0cfa156d03bad5
Branch: krb5-1.11
doc/index.rst | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
From: tlyu@mit.edu
Subject: SVN Commit

Remove trailing whitespace

(cherry picked from commit 07b66c2220ad1b38c5465cacc2537096afe332d2)

https://github.com/krb5/krb5/commit/c221a88746c2cdeaf0fbb851de0f26bebdef4bdc
Author: Ben Kaduk <kaduk@mit.edu>
Committer: Tom Yu <tlyu@mit.edu>
Commit: c221a88746c2cdeaf0fbb851de0f26bebdef4bdc
Branch: krb5-1.11
doc/admins/advanced/index.rst | 1 -
doc/appldev/refs/api/index.rst | 1 -
doc/appldev/refs/index.rst | 1 -
doc/appldev/refs/types/index.rst | 2 --
4 files changed, 0 insertions(+), 5 deletions(-)
From: tlyu@mit.edu
Subject: SVN Commit
Download (untitled) / with headers
text/plain 4.7KiB

Rename doc subdirectories

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

(cherry picked from commit ccaf2682c79974cee368d2f3b0611dabc1361df5)

https://github.com/krb5/krb5/commit/b88e89bbf5ee1be9cf4bdd0e86d3df1531062b77
Author: Ben Kaduk <kaduk@mit.edu>
Committer: Tom Yu <tlyu@mit.edu>
Commit: b88e89bbf5ee1be9cf4bdd0e86d3df1531062b77
Branch: krb5-1.11
doc/about.rst | 32 ++++++++++
doc/{admins => admin}/admin_commands/index.rst | 0
doc/{admins => admin}/admin_commands/k5srvutil.rst | 0
.../admin_commands/kadmin_local.rst | 0
doc/{admins => admin}/admin_commands/kadmind.rst | 0
.../admin_commands/kdb5_ldap_util.rst | 0
doc/{admins => admin}/admin_commands/kdb5_util.rst | 0
doc/{admins => admin}/admin_commands/kprop.rst | 0
doc/{admins => admin}/admin_commands/kpropd.rst | 0
doc/{admins => admin}/admin_commands/kproplog.rst | 0
doc/{admins => admin}/admin_commands/krb5kdc.rst | 0
doc/{admins => admin}/admin_commands/ktutil.rst | 0
doc/{admins => admin}/admin_commands/sserver.rst | 0
doc/{admins => admin}/advanced/index.rst | 0
doc/{admins => admin}/advanced/ldapbackend.rst | 0
doc/{admins => admin}/advanced/retiring-des.rst | 0
doc/{admins => admin}/appl_servers.rst | 0
doc/{admins => admin}/backup_host.rst | 0
doc/{admins => admin}/conf_files/index.rst | 0
doc/{admins => admin}/conf_files/kadm5_acl.rst | 0
doc/{admins => admin}/conf_files/kdc_conf.rst | 0
doc/{admins => admin}/conf_files/krb5_conf.rst | 0
doc/{admins => admin}/conf_ldap.rst | 0
doc/{admins => admin}/database.rst | 0
doc/{admins => admin}/env_variables.rst | 0
doc/{admins => admin}/host_config.rst | 0
doc/{admins => admin}/index.rst | 0
doc/{admins => admin}/install.rst | 0
doc/{admins => admin}/install_appl_srv.rst | 0
doc/{admins => admin}/install_clients.rst | 0
doc/{admins => admin}/install_kdc.rst | 0
doc/{admins => admin}/pkinit.rst | 0
doc/{admins => admin}/realm_config.rst | 0
doc/{admins => admin}/troubleshoot.rst | 0
doc/{admins => admin}/various_envs.rst | 0
doc/{appldev => appdev}/gssapi.rst | 0
doc/{appldev => appdev}/h5l_mit_apidiff.rst | 0
doc/{appldev => appdev}/index.rst | 0
doc/{appldev => appdev}/init_creds.rst | 0
doc/{appldev => appdev}/princ_handle.rst | 0
doc/{appldev => appdev}/refs/api/index.rst | 0
doc/{appldev => appdev}/refs/index.rst | 0
doc/{appldev => appdev}/refs/macros/index.rst | 0
doc/{appldev => appdev}/refs/types/index.rst | 0
doc/{appldev => appdev}/refs/types/krb5_int32.rst | 0
doc/{appldev => appdev}/refs/types/krb5_ui_4.rst | 0
doc/{relay => }/build_this.rst | 8 +-
doc/conf.py | 61 ++++++++++----------
doc/index.rst | 9 ++-
doc/relay/index.rst | 9 ---
doc/relay/philosophy.rst | 28 ---------
doc/tools/README | 4 +-
doc/{users => user}/index.rst | 0
doc/{users => user}/pwd_mgmt.rst | 0
doc/{users => user}/tkt_mgmt.rst | 0
doc/{users => user}/user_commands/index.rst | 0
doc/{users => user}/user_commands/kdestroy.rst | 0
doc/{users => user}/user_commands/kinit.rst | 0
doc/{users => user}/user_commands/klist.rst | 0
doc/{users => user}/user_commands/kpasswd.rst | 0
doc/{users => user}/user_commands/ksu.rst | 0
doc/{users => user}/user_commands/kswitch.rst | 0
doc/{users => user}/user_commands/kvno.rst | 0
doc/{users => user}/user_commands/sclient.rst | 0
doc/{users => user}/user_config/index.rst | 0
doc/{users => user}/user_config/k5identity.rst | 0
doc/{users => user}/user_config/k5login.rst | 0
src/doc/Makefile.in | 15 +++--
68 files changed, 82 insertions(+), 84 deletions(-)
From: tlyu@mit.edu
Subject: SVN Commit

Replace UTF-8 with ASCII

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.

(cherry picked from commit b1ba4ac45345d93ecbba22626843b06f32b2262d)

https://github.com/krb5/krb5/commit/cb85a51e6092b0d3bade289e45f7edce14b1bfee
Author: Ben Kaduk <kaduk@mit.edu>
Committer: Tom Yu <tlyu@mit.edu>
Commit: cb85a51e6092b0d3bade289e45f7edce14b1bfee
Branch: krb5-1.11
doc/tools/README | 12 ++++++------
1 files changed, 6 insertions(+), 6 deletions(-)