From 81276042d235328168d75c6a736a9882244e8286 Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Mon, 20 Mar 2017 11:42:56 +1100 Subject: Use a single top level version number. Fix the path in the catalogue links to allow prefix testing on a local disk. Close #2940. --- bsp-howto/conf.py | 10 ++--- c-user/conf.py | 11 +++--- common/conf.py | 6 +-- common/html-coverpage/static/rtems/js/catalogue.js | 4 +- common/waf.py | 43 ++++++++++++++++------ cpu-supplement/conf.py | 11 +++--- develenv/conf.py | 11 +++--- eclipse/conf.py | 11 +++--- filesystem/conf.py | 11 +++--- networking/conf.py | 11 +++--- porting/conf.py | 12 +++--- posix-users/conf.py | 11 +++--- posix1003-1/conf.py | 11 +++--- rsb/conf.py | 11 +++--- rtemsconfig/conf.py | 12 +++--- shell/conf.py | 11 +++--- user/conf.py | 11 +++--- wscript | 5 ++- 18 files changed, 109 insertions(+), 104 deletions(-) diff --git a/bsp-howto/conf.py b/bsp-howto/conf.py index 2fa48ba..64499bd 100644 --- a/bsp-howto/conf.py +++ b/bsp-howto/conf.py @@ -3,11 +3,9 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '4.11.0' -release = '4.11.0' - project = "RTEMS BSP and Device Driver Development Guide" -latex_documents = [ - ('index', 'bsp-howto.tex', u'RTEMS BSP and Device Driver Development Guide', u'RTEMS Documentation Project', 'manual'), -] +latex_documents = [('index', + 'bsp-howto.tex', + u'RTEMS BSP and Device Driver Development Guide', + u'RTEMS Documentation Project', 'manual')] diff --git a/c-user/conf.py b/c-user/conf.py index eaf8e92..27c95e2 100644 --- a/c-user/conf.py +++ b/c-user/conf.py @@ -3,11 +3,10 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '4.11.0' -release = '4.11.0' - project = "RTEMS C User Manual" -latex_documents = [ - ('index', 'c-user.tex', u'RTEMS C User Documentation', u'RTEMS Documentation Project', 'manual'), -] +latex_documents = [('index', + 'c-user.tex', + u'RTEMS C User Documentation', + u'RTEMS Documentation Project', + 'manual')] diff --git a/common/conf.py b/common/conf.py index c4531b9..ca67cb3 100644 --- a/common/conf.py +++ b/common/conf.py @@ -6,7 +6,7 @@ import datetime def build_date(): now = datetime.date.today() - m = now.strftime('%b') + m = now.strftime('%B') y = now.strftime('%Y') if now.day % 10 == 1: s = 'st' @@ -51,10 +51,10 @@ copyright = u'2016, RTEMS Project (built %s)' % (build_date()) # built documents. # # The short X.Y version. -version = '@VERSION@' +#version = '@VERSION@' # The full version, including alpha/beta/rc tags. -release = '@RELEASE@' +#release = '@RELEASE@' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/common/html-coverpage/static/rtems/js/catalogue.js b/common/html-coverpage/static/rtems/js/catalogue.js index ae32aed..42d8d5d 100644 --- a/common/html-coverpage/static/rtems/js/catalogue.js +++ b/common/html-coverpage/static/rtems/js/catalogue.js @@ -56,12 +56,12 @@ function paintCatalogue(xml) { else table += empty; if (pdf) - table += '' + + table += '' + '\n'; else table += empty; if (singlehtml) - table += '' + + table += '' + '\n'; else table += empty; diff --git a/common/waf.py b/common/waf.py index 8aeac5d..56fff79 100644 --- a/common/waf.py +++ b/common/waf.py @@ -5,6 +5,22 @@ import latex sphinx_min_version = (1, 3) +def build_date(): + import datetime + now = datetime.date.today() + m = now.strftime('%B') + y = now.strftime('%Y') + if now.day % 10 == 1: + s = 'st' + elif now.day % 10 == 2: + s = 'nd' + elif now.day == 3: + s = 'rd' + else: + s = 'th' + d = '%2d%s' % (now.day, s) + return '%s %s %s' % (d, m, y) + def cmd_spell(ctx): from waflib import Options from sys import argv @@ -88,6 +104,9 @@ def build_dir_setup(ctx, buildtype): doctrees = os.path.join(os.path.dirname(output_dir), 'doctrees', buildtype) return build_dir, output_node, output_dir, doctrees +def version_cmdline(ctx): + return "-Drelease='%s' -Dversion='%s'" % (ctx.env.VERSION, ctx.env.VERSION) + def pdf_resources(ctx, buildtype): packages_base = ctx.path.parent.find_dir('common/latex') if packages_base is None: @@ -135,6 +154,8 @@ def html_resources(ctx, buildtype): def cmd_configure(ctx): + ctx.msg('Checking version', ctx.env.VERSION) + ctx.find_program("sphinx-build", var="BIN_SPHINX_BUILD", mandatory = True) ctx.find_program("aspell", var = "BIN_ASPELL", mandatory = False) @@ -180,8 +201,8 @@ def doc_pdf(ctx, source_dir, conf_dir): buildtype = 'latex' build_dir, output_node, output_dir, doctrees = build_dir_setup(ctx, buildtype) pdf_resources(ctx, buildtype) - rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s -d %s %s %s" % \ - (sphinx_verbose(ctx), buildtype, conf_dir, + rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s %s -d %s %s %s" % \ + (sphinx_verbose(ctx), buildtype, conf_dir, version_cmdline(ctx), doctrees, source_dir, output_dir) ctx( rule = rule, @@ -232,8 +253,8 @@ def doc_singlehtml(ctx, source_dir, conf_dir): buildtype = 'singlehtml' build_dir, output_node, output_dir, doctrees = build_dir_setup(ctx, buildtype) html_resources(ctx, buildtype) - rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s -d %s %s %s" % \ - (sphinx_verbose(ctx), buildtype, conf_dir, + rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s %s -d %s %s %s" % \ + (sphinx_verbose(ctx), buildtype, conf_dir, version_cmdline(ctx), doctrees, source_dir, output_dir) ctx( rule = rule, @@ -254,8 +275,8 @@ def doc_html(ctx, conf_dir, source_dir): buildtype = 'html' build_dir, output_node, output_dir, doctrees = build_dir_setup(ctx, buildtype) html_resources(ctx, buildtype) - rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s -d %s %s %s" % \ - (sphinx_verbose(ctx), buildtype, conf_dir, + rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s %s -d %s %s %s" % \ + (sphinx_verbose(ctx), buildtype, conf_dir, version_cmdline(ctx), doctrees, source_dir, output_dir) ctx( rule = rule, @@ -313,7 +334,7 @@ def cmd_configure_path(ctx): cmd_configure(ctx) -def xml_catalogue(ctx, building, title): +def xml_catalogue(ctx, building): # # The following is a hack to find the top_dir because the task does # provided a reference to top_dir like a build context. @@ -338,8 +359,8 @@ def xml_catalogue(ctx, building, title): sys.path = sp[:] catalogue[doc] = { 'title': bconf.project, - 'version': bconf.version, - 'release': bconf.release, + 'version': str(ctx.env.VERSION), + 'release': str(ctx.env.VERSION), 'pdf': bconf.latex_documents[0][1].replace('.tex', '.pdf'), 'html': '%s/index.html' % (doc), 'singlehtml': '%s.html' % (doc) @@ -350,11 +371,11 @@ def xml_catalogue(ctx, building, title): cat = xml.Document() root = cat.createElement('rtems-docs') - root.setAttribute('date', 'today') + root.setAttribute('date', build_date()) cat.appendChild(root) heading = cat.createElement('catalogue') - text = cat.createTextNode(title) + text = cat.createTextNode(str(ctx.env.VERSION)) heading.appendChild(text) root.appendChild(heading) diff --git a/cpu-supplement/conf.py b/cpu-supplement/conf.py index 735e42b..716ff71 100644 --- a/cpu-supplement/conf.py +++ b/cpu-supplement/conf.py @@ -3,11 +3,10 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '1.0' -release = '4.11.0' - project = "RTEMS CPU Supplement Documentation" -latex_documents = [ - ('index', 'cpu-supplement.tex', u'RTEMS CPU Supplement Documentation', u'RTEMS Documentation Project', 'manual'), -] +latex_documents = [('index', + 'cpu-supplement.tex', + u'RTEMS CPU Supplement Documentation', + u'RTEMS Documentation Project', + 'manual')] diff --git a/develenv/conf.py b/develenv/conf.py index 6358d33..b889e23 100644 --- a/develenv/conf.py +++ b/develenv/conf.py @@ -3,9 +3,8 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '4.11.0' -release = '4.11.0' - -latex_documents = [ - ('index', 'develenv.tex', u'RTEMS Development Environment Documentation', u'RTEMS Documentation Project', 'manual'), -] +latex_documents = [('index', + 'develenv.tex', + u'RTEMS Development Environment Documentation', + u'RTEMS Documentation Project', + 'manual')] diff --git a/eclipse/conf.py b/eclipse/conf.py index 0af2bde..a66eeab 100644 --- a/eclipse/conf.py +++ b/eclipse/conf.py @@ -3,11 +3,10 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '4.11.0' -release = '4.11.0' - project = "RTEMS Eclipse Manual" -latex_documents = [ - ('index', 'eclipse.tex', u'RTEMS Eclipse Manual', u'RTEMS Documentation Project', 'manual'), -] +latex_documents = [('index', + 'eclipse.tex', + u'RTEMS Eclipse Manual', + u'RTEMS Documentation Project', + 'manual')] diff --git a/filesystem/conf.py b/filesystem/conf.py index 4c15bad..35d2d66 100644 --- a/filesystem/conf.py +++ b/filesystem/conf.py @@ -3,11 +3,10 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '4.11.0' -release = '4.11.0' - project = "RTEMS Filesystem Design Guide" -latex_documents = [ - ('index', 'filesystem.tex', u'RTEMS Filesystem Design Guide', u'RTEMS Filesystem Design Guide', 'manual'), -] +latex_documents = [('index', + 'filesystem.tex', + u'RTEMS Filesystem Design Guide', + u'RTEMS Filesystem Design Guide', + 'manual')] diff --git a/networking/conf.py b/networking/conf.py index 426ea45..5a93f05 100644 --- a/networking/conf.py +++ b/networking/conf.py @@ -3,11 +3,10 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '4.11.0' -release = '4.11.0' - project = "RTEMS Networking User Manual" -latex_documents = [ - ('index', 'networking.tex', u'RTEMS Networking User Documentation', u'RTEMS Documentation Project', 'manual'), -] +latex_documents = [('index', + 'networking.tex', + u'RTEMS Networking User Documentation', + u'RTEMS Documentation Project', + 'manual')] diff --git a/porting/conf.py b/porting/conf.py index 8ccb18f..9e26b43 100644 --- a/porting/conf.py +++ b/porting/conf.py @@ -3,10 +3,8 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '1.0' -release = '5.0' - -latex_documents = [ - ('index', 'porting.tex', u'RTEMS Porting Documentation', u'RTEMS Documentation Project', 'manual'), -] - +latex_documents = [('index', + 'porting.tex', + u'RTEMS Porting Documentation', + u'RTEMS Documentation Project', + 'manual')] diff --git a/posix-users/conf.py b/posix-users/conf.py index 81b6443..4aa859c 100644 --- a/posix-users/conf.py +++ b/posix-users/conf.py @@ -3,11 +3,10 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '4.11.0' -release = '4.11.0' - project = "RTEMS POSIX User Manual" -latex_documents = [ - ('index', 'posix-users.tex', u'RTEMS POSIX API User\'s Guide', u'RTEMS Documentation Project', 'manual'), -] +latex_documents = [('index', + 'posix-users.tex', + u'RTEMS POSIX API User\'s Guide', + u'RTEMS Documentation Project', + 'manual')] diff --git a/posix1003-1/conf.py b/posix1003-1/conf.py index 1d7b4ef..98dfd99 100644 --- a/posix1003-1/conf.py +++ b/posix1003-1/conf.py @@ -3,9 +3,8 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '1.0' -release = '5.0' - -latex_documents = [ - ('index', 'posix1003-1.tex', u'RTEMS POSIX 1003_1 Documentation', u'RTEMS Documentation Project', 'manual'), -] +latex_documents = [('index', + 'posix1003-1.tex', + u'RTEMS POSIX 1003_1 Documentation', + u'RTEMS Documentation Project', + 'manual')] diff --git a/rsb/conf.py b/rsb/conf.py index aa400b0..2dd1df7 100644 --- a/rsb/conf.py +++ b/rsb/conf.py @@ -3,11 +3,10 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '4.11.0' -release = '4.11.0' - project = "RTEMS Source Builder Manual" -latex_documents = [ - ('index', 'rsb.tex', u'RTEMS Source Builder', u'RTEMS Documentation Project', 'manual'), -] +latex_documents = [('index', + 'rsb.tex', + u'RTEMS Source Builder', + u'RTEMS Documentation Project', + 'manual')] diff --git a/rtemsconfig/conf.py b/rtemsconfig/conf.py index d9e87bb..2260ac2 100644 --- a/rtemsconfig/conf.py +++ b/rtemsconfig/conf.py @@ -3,10 +3,8 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '1.0' -release = '5.0' - -latex_documents = [ - ('index', 'rtemsconfig.tex', u'RTEMS RTEMS Config Documentation', u'RTEMS Documentation Project', 'manual'), -] - +latex_documents = [('index', + 'rtemsconfig.tex', + u'RTEMS RTEMS Config Documentation', + u'RTEMS Documentation Project', + 'manual')] diff --git a/shell/conf.py b/shell/conf.py index 3b1b1ee..a593dbd 100644 --- a/shell/conf.py +++ b/shell/conf.py @@ -3,11 +3,10 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '4.11.0' -release = '4.11.0' - project = "RTEMS Shell Manual" -latex_documents = [ - ('index', 'shell.tex', u'RTEMS Shell Documentation', u'RTEMS Documentation Project', 'manual'), -] +latex_documents = [('index', + 'shell.tex', + u'RTEMS Shell Documentation', + u'RTEMS Documentation Project', + 'manual')] diff --git a/user/conf.py b/user/conf.py index 17a4a20..ce5f807 100644 --- a/user/conf.py +++ b/user/conf.py @@ -3,9 +3,6 @@ sys.path.append(os.path.abspath('../common/')) from conf import * -version = '4.11.0' -release = '4.11.0' - project = "RTEMS User Manual" exclude_patterns = ['config/build.rst', @@ -39,6 +36,8 @@ exclude_patterns = ['config/build.rst', 'waf/index.rst'] -latex_documents = [ - ('index', 'user.tex', u'RTEMS User Manual', u'RTEMS Documentation Project', 'manual'), -] +latex_documents = [('index', + 'user.tex', + u'RTEMS User Manual', + u'RTEMS Documentation Project', + 'manual')] diff --git a/wscript b/wscript index 16b3efc..585e23f 100644 --- a/wscript +++ b/wscript @@ -9,7 +9,7 @@ path.append(abspath('common')) import waflib import waf as docs_waf -version = '4.11 (4.11.2)' +version = '4.11 (branch)' build_all = ['user', 'rsb', @@ -29,12 +29,13 @@ def options(opt): docs_waf.cmd_options(opt) def configure(conf): + conf.env.VERSION = version for b in building: conf.recurse(b) conf.env['BUILD_FROM_TOP'] = 'yes' def catalogue(ctx): - docs_waf.xml_catalogue(ctx, building, version) + docs_waf.xml_catalogue(ctx, building) def coverpage_js(ctx): js = None -- cgit v1.2.3