Drizzle

Merge lp:~hingo/drizzle/fix-make-html into lp:~drizzle-trunk/drizzle/development

  1. fix-make-html
  2. Merge into development
Proposed by Henrik Ingo
Status: Merged
Merged at revision: 2505
Proposed branch: lp:~hingo/drizzle/fix-make-html
Merge into: lp:~drizzle-trunk/drizzle/development
Diff against target: 86 lines (+18/-21)
3 files modified
docs/administration/plugins.rst (+3/-3)
docs/include.am (+14/-17)
tests/include.am (+1/-1)
To merge this branch: bzr merge lp:~hingo/drizzle/fix-make-html
Reviewer Review Type Date Requested Status
Drizzle Merge Team Pending
Review via email: mp+92578@code.launchpad.net

Description of the change

Somewhere along the way we have broken the docs:
 * administration/plugin.rst contains 2 broken links and make html fails.
 * tar ball is missing half of the docs so make html fails spectacularly.

This fixes both. (I'd like to also add make html or make doctest to the jenkins tests, or directly into make test, but will ask for advice on that on IRC.)

To post a comment you must log in.
Revision history for this message
Stewart Smith (stewart) wrote :

On Fri, 10 Feb 2012 21:09:24 -0000, Henrik Ingo <email address hidden> wrote:
> This fixes both. (I'd like to also add make html or make doctest to
> the jenkins tests, or directly into make test, but will ask for advice
> on that on IRC.)

I have a blog post on picking up warnings from sphinx and reporting them
through jenkins.

Unfortunately the external URL check that sphinx can automatically do
doesn't output in a standard format, so it's really hard to parse :(

--
Stewart Smith

Revision history for this message
Henrik Ingo (hingo) wrote :

Stewart: We have also sphinx set to fail on warnings, so catching warnings is not a problem. The problem is that make doctest and make html are never run - apparently even I've managed to slip in 2 lines that generate errors.

I think adding html and doctest to the test target is the way to go.

Revision history for this message
Stewart Smith (stewart) wrote :

On Sat, 11 Feb 2012 11:39:28 -0000, Henrik Ingo <email address hidden> wrote:
> Stewart: We have also sphinx set to fail on warnings, so catching
> warnings is not a problem. The problem is that make doctest and make
> html are never run - apparently even I've managed to slip in 2 lines
> that generate errors.

sounds good to me.

--
Stewart Smith

lp:~hingo/drizzle/fix-make-html updated
2506. By Henrik Ingo

Include generation of docs into make test, so it is actually routinely
tested. Hopefully we'll catch broken docs more often with this.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'docs/administration/plugins.rst'
2--- docs/administration/plugins.rst 2011-11-14 22:29:19 +0000
3+++ docs/administration/plugins.rst 2012-02-12 21:22:20 +0000
4@@ -22,7 +22,7 @@
5 * :ref:`collation_dictionary_plugin` - Data Dictionary for schema, table, column, indexes, etc (collation_dictionary)
6 * :ref:`compression_plugin` - UDFs for compression functions (compression)
7 * :ref:`connection_id_plugin` - Return the current connection_id (connection_id)
8- * :ref:`console_plugin` - Console Client (console)
9+ * console_plugin - Console Client (console) (TODO: documentation missing)
10 * :ref:`crc32_plugin` - CRC32 Function (crc32)
11 * :ref:`default_replicator_plugin` - Default Replicator (default_replicator)
12 * :ref:`drizzle_protocol_plugin` - Drizzle Protocol (drizzle_protocol)
13@@ -32,7 +32,7 @@
14 * :ref:`hex_functions_plugin` - Convert a string to HEX() or from UNHEX() (hex_functions)
15 * :ref:`information_schema_dictionary_plugin` - Data Dictionary for ANSI information schema, etc (information_schema_dictionary)
16 * :ref:`innobase_plugin` - Supports transactions, row-level locking, and foreign keys (innobase)
17- * :ref:`ipv6_function_plugin` - IPV6() function (ipv6_function)
18+ * ipv6_function_plugin - IPV6() function (ipv6_function) (TODO: documentation missing)
19 * :ref:`js_plugin` - Execute JavaScript code with supplied arguments (js)
20 * :ref:`length_plugin` - Return the byte length of a string (length)
21 * :ref:`logging_stats_plugin` - User Statistics as DATA_DICTIONARY tables (logging_stats)
22@@ -40,7 +40,7 @@
23 * :ref:`md5_plugin` - UDF for computing md5sum (md5)
24 * :ref:`memory_plugin` - Hash based, stored in memory, useful for temporary tables (memory)
25 * :ref:`multi_thread_plugin` - One Thread Per Session Scheduler (multi_thread)
26- * :ref:`myisam_plugin` - Default engine as of MySQL 3.23 with great performance (myisam)
27+ * :ref:`myisam_plugin` - Default engine as of MySQL 3.23, used for temporary tables (myisam)
28 * :ref:`mysql_protocol_plugin` - MySQL Protocol Module (mysql_protocol)
29 * :ref:`mysql_unix_socket_protocol_plugin` - MySQL Unix Socket Protocol (mysql_unix_socket_protocol)
30 * :ref:`protocol_dictionary_plugin` - Provides dictionary for protocol counters. (protocol_dictionary)
31
32=== modified file 'docs/include.am'
33--- docs/include.am 2011-06-07 21:19:19 +0000
34+++ docs/include.am 2012-02-12 21:22:20 +0000
35@@ -3,24 +3,21 @@
36 # All paths should be given relative to the root
37
38 EXTRA_DIST+= \
39- docs/_static \
40- docs/_templates \
41- docs/conf.py \
42- docs/Doxyfile \
43- docs/drizzled_header.html \
44- docs/logo.png \
45- docs/plugins/list.rst \
46- docs/pyext/__init__.py \
47- docs/pyext/options.py \
48- docs/pyext/confval.py \
49- docs/pyext/dbtable.py \
50- docs/_static/drizzle.ico \
51+ ${top_srcdir}/docs/_static \
52+ ${top_srcdir}/docs/_templates \
53+ ${top_srcdir}/docs/conf.py \
54+ ${top_srcdir}/docs/Doxyfile \
55+ ${top_srcdir}/docs/drizzled_header.html \
56+ ${top_srcdir}/docs/*.png \
57+ ${top_srcdir}/docs/pyext/__init__.py \
58+ ${top_srcdir}/docs/pyext/options.py \
59+ ${top_srcdir}/docs/pyext/confval.py \
60+ ${top_srcdir}/docs/pyext/dbtable.py \
61+ ${top_srcdir}/docs/python-inv.txt \
62+ ${top_srcdir}/docs/_static/drizzle.ico \
63 ${top_srcdir}/docs/*.rst \
64- ${top_srcdir}/docs/clients/*.rst \
65- ${top_srcdir}/docs/contributing/*.rst \
66- ${top_srcdir}/docs/libdrizzle/*.rst \
67- ${top_srcdir}/docs/installing/*.rst \
68- ${top_srcdir}/docs/testing/*.rst
69+ ${top_srcdir}/docs/*/*.rst \
70+ ${top_srcdir}/docs/*/*/*.rst
71
72 # Makefile for Sphinx documentation
73 #
74
75=== modified file 'tests/include.am'
76--- tests/include.am 2011-10-05 20:40:33 +0000
77+++ tests/include.am 2012-02-12 21:22:20 +0000
78@@ -142,7 +142,7 @@
79 # will then calculate the various port numbers it needs from this,
80 # making sure each user use different ports.
81
82-test: tests/var/drizzle check
83+test: html tests/var/drizzle check
84
85 # Please keep the list of tests in alphabetical order for ease of
86 # maintenance and verification