Changeset f97be09 in rtems-docs


Ignore:
Timestamp:
Mar 20, 2017, 1:18:53 AM (4 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
5, am, master
Children:
228560f
Parents:
1accbe3
Message:

Use a single top level version number.

Files:
17 edited

Legend:

Unmodified
Added
Removed
  • bsp-howto/conf.py

    r1accbe3 rf97be09  
    44from conf import *
    55
    6 version = '4.11.99'
    7 release = '4.11.99'
    8 
    96project = "RTEMS BSP and Device Driver Development Guide"
    107
    118latex_documents = [
    12         ('index', 'bsp-howto.tex', u'RTEMS BSP and Device Driver Development Guide', u'RTEMS Documentation Project', 'manual'),
     9    ('index',
     10     'bsp-howto.tex',
     11     u'RTEMS BSP and Device Driver Development Guide',
     12     u'RTEMS Documentation Project',
     13     'manual'),
    1314]
  • c-user/conf.py

    r1accbe3 rf97be09  
    44from conf import *
    55
    6 version = '4.11.99'
    7 release = '4.11.99'
    8 
    96project = "RTEMS Classic API Guide"
    107
    118latex_documents = [
    12         ('index', 'c-user.tex', u'RTEMS Classic API Guide', u'RTEMS Documentation Project', 'manual'),
     9    ('index',
     10     'c-user.tex',
     11     u'RTEMS Classic API Guide',
     12     u'RTEMS Documentation Project',
     13     'manual'),
    1314]
  • common/conf.py

    r1accbe3 rf97be09  
    77def build_date():
    88    now = datetime.date.today()
    9     m = now.strftime('%b')
     9    m = now.strftime('%B')
    1010    y = now.strftime('%Y')
    1111    if now.day == 11:
     
    5959#
    6060# The short X.Y version.
    61 version = '@VERSION@'
     61#version = '@VERSION@'
    6262
    6363# The full version, including alpha/beta/rc tags.
    64 release = '@RELEASE@'
     64#release = '@RELEASE@'
    6565
    6666# The language for content autogenerated by Sphinx. Refer to documentation
  • common/waf.py

    r1accbe3 rf97be09  
    55
    66sphinx_min_version = (1, 3)
     7
     8def build_date():
     9    import datetime
     10    now = datetime.date.today()
     11    m = now.strftime('%B')
     12    y = now.strftime('%Y')
     13    if now.day % 10 == 1:
     14        s = 'st'
     15    elif now.day % 10 == 2:
     16        s = 'nd'
     17    elif now.day == 3:
     18        s = 'rd'
     19    else:
     20        s = 'th'
     21    d = '%2d%s' % (now.day, s)
     22    return '%s %s %s' % (d, m, y)
    723
    824def cmd_spell(ctx):
     
    88104    doctrees = os.path.join(os.path.dirname(output_dir), 'doctrees', buildtype)
    89105    return build_dir, output_node, output_dir, doctrees
     106
     107def version_cmdline(ctx):
     108    return "-Drelease='%s' -Dversion='%s'" % (ctx.env.VERSION, ctx.env.VERSION)
    90109
    91110def pdf_resources(ctx, buildtype):
     
    157176    check_sphinx = not ctx.env.BIN_SPHINX_BUILD
    158177    if check_sphinx:
     178        ctx.msg('Checking version', ctx.env.VERSION)
     179
    159180        ctx.find_program("sphinx-build", var="BIN_SPHINX_BUILD", mandatory = True)
    160181        ctx.find_program("aspell", var = "BIN_ASPELL", mandatory = False)
     
    212233    build_dir, output_node, output_dir, doctrees = build_dir_setup(ctx, buildtype)
    213234    pdf_resources(ctx, buildtype)
    214     rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s -d %s %s %s" % \
    215            (sphinx_verbose(ctx), buildtype, conf_dir,
     235    rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s %s -d %s %s %s" % \
     236           (sphinx_verbose(ctx), buildtype, conf_dir, version_cmdline(ctx),
    216237            doctrees, source_dir, output_dir)
    217238    ctx(
     
    264285    build_dir, output_node, output_dir, doctrees = build_dir_setup(ctx, buildtype)
    265286    html_resources(ctx, buildtype)
    266     rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s -d %s %s %s" % \
    267            (sphinx_verbose(ctx), buildtype, conf_dir,
     287    rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s %s -d %s %s %s" % \
     288           (sphinx_verbose(ctx), buildtype, conf_dir, version_cmdline(ctx),
    268289            doctrees, source_dir, output_dir)
    269290    ctx(
     
    286307    build_dir, output_node, output_dir, doctrees = build_dir_setup(ctx, buildtype)
    287308    html_resources(ctx, buildtype)
    288     rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s -d %s %s %s" % \
    289            (sphinx_verbose(ctx), buildtype, conf_dir,
     309    rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s %s -d %s %s %s" % \
     310           (sphinx_verbose(ctx), buildtype, conf_dir, version_cmdline(ctx),
    290311            doctrees, source_dir, output_dir)
    291312    ctx(
     
    345366    cmd_configure(ctx)
    346367
    347 def xml_catalogue(ctx, building, title):
     368def xml_catalogue(ctx, building):
    348369    #
    349370    # The following is a hack to find the top_dir because the task does
     
    370391        catalogue[doc] = {
    371392            'title': bconf.project,
    372             'version':  bconf.version,
    373             'release': bconf.release,
     393            'version': str(ctx.env.VERSION),
     394            'release': str(ctx.env.VERSION),
    374395            'pdf': bconf.latex_documents[0][1].replace('.tex', '.pdf'),
    375396            'html': '%s/index.html' % (doc),
     
    382403
    383404    root = cat.createElement('rtems-docs')
    384     root.setAttribute('date', 'today')
     405    root.setAttribute('date', build_date())
    385406    cat.appendChild(root)
    386407
    387408    heading = cat.createElement('catalogue')
    388     text = cat.createTextNode(title)
     409    text = cat.createTextNode(str(ctx.env.VERSION))
    389410    heading.appendChild(text)
    390411    root.appendChild(heading)
  • cpu-supplement/conf.py

    r1accbe3 rf97be09  
    44from conf import *
    55
    6 extensions = ['sphinxcontrib.bibtex']
    7 
    8 version = '1.0'
    9 release = '4.11.99'
    10 
    116project = "RTEMS CPU Architecture Supplement"
    127
    138latex_documents = [
    14         ('index', 'cpu-supplement.tex', u'RTEMS CPU Architecture Supplement', u'RTEMS Documentation Project', 'manual'),
     9    ('index',
     10     'cpu-supplement.tex',
     11     u'RTEMS CPU Architecture Supplement',
     12     u'RTEMS Documentation Project',
     13     'manual'),
    1514]
  • develenv/conf.py

    r1accbe3 rf97be09  
    44from conf import *
    55
    6 version = '4.11.99'
    7 release = '4.11.99'
    8 
    96latex_documents = [
    10         ('index', 'develenv.tex', u'RTEMS Development Environment Guide', u'RTEMS Documentation Project', 'manual'),
     7    ('index',
     8     'develenv.tex',
     9     u'RTEMS Development Environment Guide',
     10     u'RTEMS Documentation Project',
     11     'manual'),
    1112]
  • eclipse/conf.py

    r1accbe3 rf97be09  
    44from conf import *
    55
    6 version = '4.11.99'
    7 release = '4.11.99'
    8 
    96project = "RTEMS Eclipse Manual"
    107
    118latex_documents = [
    12         ('index', 'eclipse.tex', u'RTEMS Eclipse Manual', u'RTEMS Documentation Project', 'manual'),
     9    ('index',
     10     'eclipse.tex',
     11     u'RTEMS Eclipse Manual',
     12     u'RTEMS Documentation Project',
     13     'manual'),
    1314]
  • filesystem/conf.py

    r1accbe3 rf97be09  
    44from conf import *
    55
    6 version = '4.11.99'
    7 release = '4.11.99'
    8 
    96project = "RTEMS Filesystem Design Guide"
    107
    118latex_documents = [
    12         ('index', 'filesystem.tex', u'RTEMS Filesystem Design Guide', u'RTEMS Filesystem Design Guide', 'manual'),
     9    ('index',
     10     'filesystem.tex',
     11     u'RTEMS Filesystem Design Guide',
     12     u'RTEMS Filesystem Design Guide',
     13     'manual'),
    1314]
  • networking/conf.py

    r1accbe3 rf97be09  
    44from conf import *
    55
    6 version = '4.11.99'
    7 release = '4.11.99'
    8 
    96project = "RTEMS Networking User Manual"
    107
    118latex_documents = [
    12         ('index', 'networking.tex', u'RTEMS Networking User Manual', u'RTEMS Documentation Project', 'manual'),
     9    ('index',
     10     'networking.tex',
     11     u'RTEMS Networking User Manual',
     12     u'RTEMS Documentation Project',
     13     'manual'),
    1314]
  • porting/conf.py

    r1accbe3 rf97be09  
    44from conf import *
    55
    6 version = '1.0'
    7 release = '5.0'
    8 
    96latex_documents = [
    10         ('index', 'porting.tex', u'RTEMS Porting Guide', u'RTEMS Documentation Project', 'manual'),
     7    ('index',
     8     'porting.tex',
     9     u'RTEMS Porting Guide',
     10     u'RTEMS Documentation Project',
     11     'manual'),
    1112]
    12 
  • posix-users/conf.py

    r1accbe3 rf97be09  
    44from conf import *
    55
    6 version = '4.11.99'
    7 release = '4.11.99'
    8 
    96project = "RTEMS POSIX API Guide"
    107
    118latex_documents = [
    12         ('index', 'posix-users.tex', u'RTEMS POSIX API Guide', u'RTEMS Documentation Project', 'manual'),
     9    ('index',
     10     'posix-users.tex',
     11     u'RTEMS POSIX API Guide',
     12     u'RTEMS Documentation Project',
     13     'manual'),
    1314]
  • posix1003-1/conf.py

    r1accbe3 rf97be09  
    44from conf import *
    55
    6 version = '1.0'
    7 release = '5.0'
    8 
    96latex_documents = [
    10         ('index', 'posix1003-1.tex', u'RTEMS POSIX 1003.1 Compliance Guide', u'RTEMS Documentation Project', 'manual'),
     7    ('index',
     8     'posix1003-1.tex',
     9     u'RTEMS POSIX 1003.1 Compliance Guide',
     10     u'RTEMS Documentation Project',
     11     'manual'),
    1112]
  • rsb/conf.py

    r1accbe3 rf97be09  
    44from conf import *
    55
    6 version = '4.11.99'
    7 release = '4.11.99'
    8 
    96project = "RTEMS Source Builder"
    107
    118latex_documents = [
    12         ('index', 'rsb.tex', u'RTEMS Source Builder', u'RTEMS Documentation Project', 'manual'),
     9    ('index',
     10     'rsb.tex',
     11     u'RTEMS Source Builder',
     12     u'RTEMS Documentation Project',
     13     'manual'),
    1314]
  • rtemsconfig/conf.py

    r1accbe3 rf97be09  
    44from conf import *
    55
    6 version = '1.0'
    7 release = '5.0'
    8 
    96latex_documents = [
    10         ('index', 'rtemsconfig.tex', u'RTEMS RTEMS Config Documentation', u'RTEMS Documentation Project', 'manual'),
     7    ('index',
     8     'rtemsconfig.tex',
     9     u'RTEMS RTEMS Config Documentation',
     10     u'RTEMS Documentation Project',
     11     'manual'),
    1112]
    12 
  • shell/conf.py

    r1accbe3 rf97be09  
    44from conf import *
    55
    6 version = '4.11.99'
    7 release = '4.11.99'
    8 
    96project = "RTEMS Shell Guide"
    107
    118latex_documents = [
    12         ('index', 'shell.tex', u'RTEMS Shell Guide', u'RTEMS Documentation Project', 'manual'),
     9    ('index',
     10     'shell.tex',
     11     u'RTEMS Shell Guide',
     12     u'RTEMS Documentation Project',
     13     'manual'),
    1314]
  • user/conf.py

    r1accbe3 rf97be09  
    33
    44from conf import *
    5 
    6 version = '4.11.99'
    7 release = '4.11.99'
    85
    96project = "RTEMS User Manual"
     
    4138
    4239latex_documents = [
    43         ('index', 'user.tex', u'RTEMS User Manual', u'RTEMS Documentation Project', 'manual'),
     40    ('index',
     41     'user.tex',
     42     u'RTEMS User Manual',
     43     u'RTEMS Documentation Project',
     44     'manual'),
    4445]
  • wscript

    r1accbe3 rf97be09  
    1010import waf as docs_waf
    1111
    12 version = 'Master (4.11.99.1)'
     12version = '4.11.99 (master)'
    1313
    1414build_all = ['user',
     
    3030
    3131def configure(conf):
     32    conf.env.VERSION = version
    3233    for b in building:
    3334        conf.recurse(b)
     
    3536
    3637def catalogue(ctx):
    37     docs_waf.xml_catalogue(ctx, building, version)
     38    docs_waf.xml_catalogue(ctx, building)
    3839
    3940def coverpage_js(ctx):
Note: See TracChangeset for help on using the changeset viewer.