summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-03-20 12:07:06 +1100
committerChris Johns <chrisj@rtems.org>2017-03-20 12:07:06 +1100
commit036752382cb95960d4c47f456bc1ec752eeaf2d5 (patch)
treef96672aefb571d6e04d8b12e902decd3b95ae42b
parent755db78b9e5543abbcfb89bc760b2cd32f558c1a (diff)
Add 4.11.1 as the latest release. Fix current vs legacy support.
Remove any releases that are not formal releases but some sort of release candidate. Add release dates to all the releases as best as I can find.
-rw-r--r--docs.rtems.org/configuration.ini84
-rw-r--r--docs.rtems.org/configuration.py60
-rw-r--r--docs.rtems.org/static/rtems/js/catalogue.js5
-rw-r--r--docs.rtems.org/wscript2
4 files changed, 110 insertions, 41 deletions
diff --git a/docs.rtems.org/configuration.ini b/docs.rtems.org/configuration.ini
index fe761df..e9aa4d3 100644
--- a/docs.rtems.org/configuration.ini
+++ b/docs.rtems.org/configuration.ini
@@ -3,13 +3,14 @@
;
[latest]
-release = 4.10.2
+release = 4.11.1
[branches]
master = master
4.11 = 4.11
[releases]
+4.11.1 = rtems-docs-4.11.1
4.10.2 = rtemsdocs-4.10.2
4.10.1 = rtemsdocs-4.10.1
4.10.0 = rtemsdocs-4.10.0
@@ -23,19 +24,15 @@ master = master
4.8.1 = rtemsdocs-4.8.1
4.8.0 = rtemsdocs-4.8.0
4.7.3 = rtemsdoc-4.7.3
-4.7.99.2 = rtemsdocs-4.7.99.2
4.7.2 = rtemsdocs-4.7.2
4.7.1 = rtemsdocs-4.7.1
4.7.0 = rtemsdocs-4.7.0
-4.6.99.3 = rtemsdocs-4.6.99.3
4.6.6 = rtemsdocs-4.6.6
4.6.5 = rtemsdocs-4.6.5
4.6.4 = rtemsdocs-4.6.4
4.6.2 = rtemsdocs-4.6.2
4.6.1 = rtemsdocs-4.6.1
-4.6.0pre5 = rtemsdocs-4.6.0pre5
4.6.0 = rtemsdocs-4.6.0
-4.5.1-pre3 = 4.5.1-pre3
4.5.0 = 4.5.0
4.0.0 = 4.0.0
@@ -72,6 +69,15 @@ started_ada = "Getting Started with GNAT/RTEMS"
;
; RTEMS 4.10
;
+[no-legacy-template]
+legacy = no
+
+[rtems-docs-4.11.1]
+template = no-legacy-template
+
+;
+; RTEMS 4.10
+;
[4.10-4.9-template]
legacy = yes
index_per_doc = Yes
@@ -95,16 +101,19 @@ manuals = started,
template = 4.10-4.9-template
html = rtemsdocs-4.10.0/share/rtems/html
pdf = rtemsdocs-4.10.0/share/rtems/pdf
+date = 8th Feburary 2011
[rtemsdocs-4.10.1]
template = 4.10-4.9-template
html = rtemsdocs-4.10.1/share/rtems/html
pdf = rtemsdocs-4.10.1/share/rtems/pdf
+date = 21st July 2011
[rtemsdocs-4.10.2]
template = 4.10-4.9-template
html = rtemsdocs-4.10.2/share/rtems/html
pdf = rtemsdocs-4.10.2/share/rtems/pdf
+date = 14th December 2011
;
; RTEMS 4.9
@@ -113,36 +122,43 @@ pdf = rtemsdocs-4.10.2/share/rtems/pdf
template = 4.10-4.9-template
html = rtemsdocs-4.9.0/share/rtems/html
pdf = rtemsdocs-4.9.0/share/rtems/pdf
+date = 24th September 2009
[rtemsdocs-4.9.1]
template = 4.10-4.9-template
html = rtemsdocs-4.9.1/share/rtems/html
pdf = rtemsdocs-4.9.1/share/rtems/pdf
+date = 12th December 2008
[rtemsdocs-4.9.2]
template = 4.10-4.9-template
html = rtemsdocs-4.9.2/share/rtems/html
pdf = rtemsdocs-4.9.2/share/rtems/pdf
+date = 12th March 2009
[rtemsdocs-4.9.3]
template = 4.10-4.9-template
html = rtemsdocs-4.9.3/share/rtems/html
pdf = rtemsdocs-4.9.3/share/rtems/pdf
+date = 13th November 2009
[rtemsdocs-4.9.4]
template = 4.10-4.9-template
html = rtemsdocs-4.9.4/share/rtems/html
pdf = rtemsdocs-4.9.4/share/rtems/pdf
+date = 18th March 2010
[rtemsdocs-4.9.5]
template = 4.10-4.9-template
html = rtemsdocs-4.9.5/share/rtems/html
pdf = rtemsdocs-4.9.5/share/rtems/pdf
+date = 9th Feburary 2011
[rtemsdocs-4.9.6]
template = 4.10-4.9-template
html = rtemsdocs-4.9.6/share/rtems/html
pdf = rtemsdocs-4.9.6/share/rtems/pdf
+date = 24th July 2011
;
; RTEMS 4.8
@@ -169,11 +185,19 @@ manuals = started,
template = 4.8-template
html = rtemsdocs-4.8.0/share/rtems/html
pdf = rtemsdocs-4.8.0/share/rtems/pdf
+date = 14th Feburary 2008
[rtemsdocs-4.8.1]
template = 4.8-template
html = rtemsdocs-4.8.1/share/rtems/html
pdf = rtemsdocs-4.8.1/share/rtems/pdf
+date = 13th August 2008
+
+[rtemsdocs-4.8.2]
+template = 4.8-template
+html = rtemsdocs-4.8.1/share/rtems/html
+pdf = rtemsdocs-4.8.1/share/rtems/pdf
+date = 19th March 2010
;
; RTEMS 4.7
@@ -202,26 +226,31 @@ manuals = started,
template = 4.7-template
html = rtemsdocs-4.7.0/share/rtems/html
pdf = rtemsdocs-4.7.0/share/rtems/pdf
+date = 5th March 2007
[rtemsdocs-4.7.1]
template = 4.7-template
html = rtemsdocs-4.7.1/share/rtems/html
pdf = rtemsdocs-4.7.1/share/rtems/pdf
+date = 13th April 2007
[rtemsdocs-4.7.2]
template = 4.7-template
html = rtemsdocs-4.7.2/share/rtems/html
pdf = rtemsdocs-4.7.2/share/rtems/pdf
+date = 15th Feburary 2008
-[rtemsdocs-4.7.99.2]
-template = 4.7-template
-html = rtemsdocs-4.7.99.2/share/rtems/html
-pdf = rtemsdocs-4.7.99.2/share/rtems/pdf
+;[rtemsdocs-4.7.99.2]
+;template = 4.7-template
+;html = rtemsdocs-4.7.99.2/share/rtems/html
+;pdf = rtemsdocs-4.7.99.2/share/rtems/pdf
+;date =
[rtemsdoc-4.7.3]
template = 4.7-template
html = rtemsdoc-4.7.3/share/rtems/html
pdf = rtemsdoc-4.7.3/share/rtems/pdf
+date = 8th August 2008
;
; RTEMS 4.6
@@ -258,41 +287,52 @@ supplements = i386,
template = 4.6-template
html = rtemsdocs-4.6.0/share/rtems/html
pdf = rtemsdocs-4.6.0/share/rtems/pdf
+date = 31st Janurary 2004
-[rtemsdocs-4.6.0pre5]
-template = 4.6-template
-html = rtemsdocs-4.6.0pre5/share/rtems/html
-pdf = rtemsdocs-4.6.0pre5/share/rtems/pdf
+;[rtemsdocs-4.6.0pre5]
+;template = 4.6-template
+;html = rtemsdocs-4.6.0pre5/share/rtems/html
+;pdf = rtemsdocs-4.6.0pre5/share/rtems/pdf
+;date =
[rtemsdocs-4.6.1]
template = 4.6-template
html = rtemsdocs-4.6.1/share/rtems/html
pdf = rtemsdocs-4.6.1/share/rtems/pdf
+date = 9th April 2004
[rtemsdocs-4.6.2]
template = 4.6-template
html = rtemsdocs-4.6.2/share/rtems/html
pdf = rtemsdocs-4.6.2/share/rtems/pdf
+date = 19th October 2004
-[rtemsdocs-4.6.99.3]
-template = 4.6-template
-html = rtemsdocs-4.6.99.3/share/rtems/html
-pdf = rtemsdocs-4.6.99,3/share/rtems/pdf
+;
+; I cannot find this release and so will remove it.
+;
+;[rtemsdocs-4.6.99.3]
+;template = 4.6-template
+;html = rtemsdocs-4.6.99.3/share/rtems/html
+;pdf = rtemsdocs-4.6.99,3/share/rtems/pdf
+;date =
[rtemsdocs-4.6.4]
template = 4.6-template
html = rtemsdocs-4.6.4/share/rtems/html
pdf = rtemsdocs-4.6.4/share/rtems/pdf
+date = 2nd September 2005
[rtemsdocs-4.6.5]
template = 4.6-template
html = rtemsdocs-4.6.5/share/rtems/html
pdf = rtemsdocs-4.6.5/share/rtems/pdf
+date = 7th October 2005
[rtemsdocs-4.6.6]
template = 4.6-template
html = rtemsdocs-4.6.6/share/rtems/html
pdf = rtemsdocs-4.6.6/share/rtems/pdf
+date = 25th April 2006
;
; RTEMS 4.5
@@ -328,11 +368,12 @@ supplements = i386,
template = 4.5-template
html = 4.5.0/rtemsdoc-4.5.0/share/rtemsdoc/html
pdf = 4.5.0/rtemsdoc-4.5.0/share/rtemsdoc/pdf
+date = 30th October 2000
-[4.5.1-pre3]
-template = 4.5-template
-html = 4.5.1-pre3/rtemsdoc/html
-pdf = 4.5.1-pre3/rtemsdoc/pdf
+;[4.5.1-pre3]
+;template = 4.5-template
+;html = 4.5.1-pre3/rtemsdoc/html
+;pdf = 4.5.1-pre3/rtemsdoc/pdf
;
; RTEMS 4.0
@@ -347,3 +388,4 @@ manuals = c_user,
networking
html = 4.0.0/doc
pdf = 4.0.0/docs
+date = 27th May 1998
diff --git a/docs.rtems.org/configuration.py b/docs.rtems.org/configuration.py
index 66bb6c0..99e2342 100644
--- a/docs.rtems.org/configuration.py
+++ b/docs.rtems.org/configuration.py
@@ -51,6 +51,8 @@ class configuration:
pprint.pformat(self.branches, indent = 1, width = 80) + os.linesep
s += 'Releases:' + os.linesep + \
pprint.pformat(self.releases, indent = 1, width = 80) + os.linesep
+ s += 'Legacy:' + os.linesep + \
+ pprint.pformat(self.get_legacy_releases(), indent = 1, width = 80) + os.linesep
return s
def _get_item(self, section, label, err = True):
@@ -151,19 +153,40 @@ class configuration:
template = self._get_item(label, 'template', False)
if template is None:
template = label
- rel['manuals'] = self._comma_list(template, 'manuals')
- rel['supplements'] = self._comma_list(template, 'supplements', False)
rel['legacy'] = self._get_item(template, 'legacy', False)
if rel['legacy'] is None:
rel['legacy'] = self._get_item(label, 'legacy', False)
- rel['index_per_doc'] = self._get_item(template, 'index_per_doc', False)
- if rel['index_per_doc'] is None:
- rel['index_per_doc'] = self._get_item(label, 'index_per_doc', False)
- rel['html'] = self._get_item(label, 'html')
- rel['pdf'] = self._get_item(label, 'pdf')
- for d in rel['manuals'] + rel['supplements']:
- if d.lower() not in self.titles:
- self.ctx.fatal('title not found in %s: %s' % (label, d))
+ if rel['legacy'] == 'yes':
+ rel['manuals'] = self._comma_list(template, 'manuals')
+ rel['supplements'] = self._comma_list(template, 'supplements', False)
+ rel['index_per_doc'] = self._get_item(template, 'index_per_doc', False)
+ if rel['index_per_doc'] is None:
+ rel['index_per_doc'] = self._get_item(label, 'index_per_doc', False)
+ rel['html'] = self._get_item(label, 'html')
+ rel['pdf'] = self._get_item(label, 'pdf')
+ rel['date'] = self._get_item(label, 'date')
+ for d in rel['manuals'] + rel['supplements']:
+ if d.lower() not in self.titles:
+ self.ctx.fatal('title not found in %s: %s' % (label, d))
+
+ def get_release(self, release):
+ if self.releases is None:
+ self.ctx.fatal('no configuration loaded')
+ for r in self.releases['releases']:
+ if r[0] == release:
+ return r[0], r[1], self.releases[r[1]]
+ self.ctx.fatal('cannot find release: %s' % (release))
+
+ def is_legacy_releases(self, release):
+ if self.releases is None:
+ self.ctx.fatal('no configuration loaded')
+ name, label, rel = self.get_release(release)
+ return rel['legacy'] == 'yes'
+
+ def get_legacy_releases(self):
+ if self.releases is None:
+ self.ctx.fatal('no configuration loaded')
+ return sorted([r[0] for r in self.releases['releases'] if self.releases[r[1]]['legacy'] == 'yes'])
def get_releases(self):
if self.releases is None:
@@ -173,15 +196,13 @@ class configuration:
def generate_xml(self):
if self.releases is None:
self.ctx.fatal('no configuration loaded')
- for r in self.releases['releases']:
- name = r[0]
- label = r[1]
- rel = self.releases[label]
+ for r in self.get_legacy_releases():
+ name, label, rel = self.get_release(r)
cat = xml.Document()
root = cat.createElement('rtems-docs')
- root.setAttribute('date', today())
+ root.setAttribute('date', rel['date'])
cat.appendChild(root)
heading = cat.createElement('catalogue')
@@ -221,10 +242,15 @@ class configuration:
return _tag(release[0])
def _release_script(release):
name = release[0]
+ label = release[1]
tag = _release_tag(release)
+ if self.is_legacy_releases(name):
+ catalogue = "releases/%s.xml" % (name)
+ else:
+ catalogue = "releases/%s/catalogue.xml" % (label)
return \
- '<script> loadCatalogue("releases/%s.xml", "releases", "%s", false); </script>\n' \
- % (name, tag)
+ '<script> loadCatalogue("%s", "releases", "%s", false); </script>\n' \
+ % (catalogue, tag)
def _match_all(tag):
return True
diff --git a/docs.rtems.org/static/rtems/js/catalogue.js b/docs.rtems.org/static/rtems/js/catalogue.js
index f73fe76..d341db1 100644
--- a/docs.rtems.org/static/rtems/js/catalogue.js
+++ b/docs.rtems.org/static/rtems/js/catalogue.js
@@ -12,8 +12,9 @@ function catalogueHeader(id, title, date) {
' <thead>' +
' <tr id="' + id + '" class="accordion-toggle" data-toggle="collapse"' +
' data-parent="#rtems-catalogue" data-target=".' + id + 'Details">' +
- ' <th><span class="label label-default">' + date + '</span> ' + title + '</th>\n' +
- ' <th><i class="indicator glyphicon glyphicon-chevron-up pull-right"></i></th>' +
+ ' <th class="col-sm-2"><span class="label label-default pull-right">' + date + '</span></th>\n' +
+ ' <th class="col-sm-2"><span>' + title + '</span></th>\n' +
+ ' <th width="30px"><i class="indicator glyphicon glyphicon-chevron-up pull-right"></i></th>' +
' </tr>' +
' </thead>' +
' <tr>' +
diff --git a/docs.rtems.org/wscript b/docs.rtems.org/wscript
index bc93fd8..7c3994d 100644
--- a/docs.rtems.org/wscript
+++ b/docs.rtems.org/wscript
@@ -53,7 +53,7 @@ def build(ctx):
# Generate the Release XML cataogues
#
config = configuration.configuration(ctx, 'configuration.ini')
- release_xml = ['%s.xml' % r for r in config.get_releases()]
+ release_xml = ['%s.xml' % r for r in config.get_legacy_releases()]
ctx(rule = generate_xml,
target = release_xml,
source = 'configuration.ini')