krb5.git/src/doc, branch keyring MIT Kerberos patches Clean up python bytecode from doc build 2013-04-02T17:06:16+00:00 Ben Kaduk kaduk@mit.edu 2013-04-02T16:03:40+00:00 424bed7b2943e0bc32a3feab4c55a4ea056bfa21 Otherwise they escape into the release tarball. 
Otherwise they escape into the release tarball.
Add copyright footer to HTML docs 2012-12-17T22:47:20+00:00 Tom Yu tlyu@mit.edu 2012-12-17T20:44:27+00:00 49d31402d77744a58dcd03808a94361ef011a594 The technique we use for inserting the feedback link in the footer overrides the Sphinx basic/layout.html and agogo/layout.html footers in a way that prevents us from getting the copyright link footer. Copy the relevant part of the Sphinx basic/layout.html for now. Add a copyright.rst that links to mitK5license.rst. ticket: 7510 (new) target_version: 1.11 tags: pullup 
The technique we use for inserting the feedback link in the footer
overrides the Sphinx basic/layout.html and agogo/layout.html footers
in a way that prevents us from getting the copyright link footer.
Copy the relevant part of the Sphinx basic/layout.html for now.

Add a copyright.rst that links to mitK5license.rst.

ticket: 7510 (new)
target_version: 1.11
tags: pullup
Make the doc build quieter 2012-12-14T16:02:36+00:00 Ben Kaduk kaduk@mit.edu 2012-12-12T15:36:18+00:00 311347e5e9d9208e2d341b8f8aed37791a4de090 Don't print out every node processed (or not processed) in the doxygen-Sphinx bridge, nor print out a summary of how many types or functions were processed. While here, tell doxygen to be quiet in its output as well, and not print out each file that is generated. It still outputs warnings, though. ticket: 7495 (new) tags: pullup target_version: 1.11 
Don't print out every node processed (or not processed) in the
doxygen-Sphinx bridge, nor print out a summary of how many types
or functions were processed.

While here, tell doxygen to be quiet in its output as well, and
not print out each file that is generated.  It still outputs
warnings, though.

ticket: 7495 (new)
tags: pullup
target_version: 1.11
Make sphinx warnings fatal for doc build 2012-12-11T21:34:58+00:00 Ben Kaduk kaduk@mit.edu 2012-11-27T23:45:59+00:00 7b6758a09f92ccc386022bcc86e3a5fea472fdce We currently do not have any warnings. Let us keep it that way by making warnings fatal in maintainer-mode (and configurable on the buildslaves). Using sphinx-build -W also causes errors to be reported in the exit status and picked up by make, which is quite useful. In order to allow the build bot to use -W but end-users to not use it, SPHINX_ARGS must be passed on the command line; it cannot be set by the convenience target 'htmlsrc'. Document this. ticket: 7468 (new) tags: pullup target_version: 1.11 
We currently do not have any warnings.  Let us keep it that way by
making warnings fatal in maintainer-mode (and configurable on the
buildslaves).  Using sphinx-build -W also causes errors to be reported
in the exit status and picked up by make, which is quite useful.

In order to allow the build bot to use -W but end-users to not use it,
SPHINX_ARGS must be passed on the command line; it cannot be set by
the convenience target 'htmlsrc'.  Document this.

ticket: 7468 (new)
tags: pullup
target_version: 1.11
Make building docs easier in an unconfigured tree 2012-12-11T21:34:58+00:00 Ben Kaduk kaduk@mit.edu 2012-12-11T05:13:30+00:00 f6ef297fe537de3712fce751bad8a597ef32e0ed Instead of requiring the user to specify srcdir, top_srcdir, PYTHON, and possibly more in the future, make an 'htmlsrc' target that does so for them. This also lets us do the clean in the same step, so that only one command is required of the user. ticket: 7491 (new) tags: pullup target_version: 1.11 
Instead of requiring the user to specify srcdir, top_srcdir, PYTHON,
and possibly more in the future, make an 'htmlsrc' target that does so
for them.

This also lets us do the clean in the same step, so that only one
command is required of the user.

ticket: 7491 (new)
tags: pullup
target_version: 1.11
Don't use $(RM) in src/doc/Makefile.in 2012-12-11T21:34:57+00:00 Ben Kaduk kaduk@mit.edu 2012-12-10T23:13:52+00:00 3f7394c1440f7526bc6f008f841b438d84411f3d We allow these rules to be used in an unconfigured tree, and some makes do not supply a value for RM by default. ticket: 7492 (new) subject: Doc build in unconfigured tree broken on some platforms tags: pullup target_version: 1.11 
We allow these rules to be used in an unconfigured tree, and some
makes do not supply a value for RM by default.

ticket: 7492 (new)
subject: Doc build in unconfigured tree broken on some platforms
tags: pullup
target_version: 1.11
Note notice.txt's dependency on version.py 2012-12-10T18:01:26+00:00 Ben Kaduk kaduk@mit.edu 2012-11-29T00:06:44+00:00 9031b739fc4f9e4215e537855a853d2134a69ba9 This dependency has been in effect since the notice build was changed to use the main conf.py, due to its unconditional execfile('version.py'). Adding another conditional in conf.py seems to add needless complication, it is easier to just note the dependency in the Makefile and carry on. ticket: 7470 (new) title: NOTICE build has unnoted dependency on version.py tags: pullup target_version: 1.11 
This dependency has been in effect since the notice build was changed
to use the main conf.py, due to its unconditional execfile('version.py').
Adding another conditional in conf.py seems to add needless complication,
it is easier to just note the dependency in the Makefile and carry on.

ticket: 7470 (new)
title: NOTICE build has unnoted dependency on version.py
tags: pullup
target_version: 1.11
Remove .doctrees when cleaning src/doc 2012-11-26T21:01:23+00:00 Tom Yu tlyu@mit.edu 2012-11-26T21:01:23+00:00 49931235536b1b5888532a4732d03f1d390042e2 Sphinx produces .doctree pickles that can be over 17MB with the current documentation. Remove them when running "make clean" in src/doc so that they don't pollute distribution tar files. ticket: 7461 (new) target_version: 1.11 tags: pullup 
Sphinx produces .doctree pickles that can be over 17MB with the
current documentation.  Remove them when running "make clean" in
src/doc so that they don't pollute distribution tar files.

ticket: 7461 (new)
target_version: 1.11
tags: pullup
Rename doc subdirectories 2012-11-14T20:31:13+00:00 Ben Kaduk kaduk@mit.edu 2012-11-07T03:15:50+00:00 ccaf2682c79974cee368d2f3b0611dabc1361df5 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 
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
Make glue for building PDFs 2012-11-14T19:15:24+00:00 Ben Kaduk kaduk@mit.edu 2012-10-17T00:11:14+00:00 f06725b7a98c16630f80d8cc1dd6386a7d21a058 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. ticket: 7433 tags: pullup 
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.

ticket: 7433
tags: pullup