Changeset 3202e31 in rtems-docs

Timestamp:

01/04/19 10:02:45 (3 years ago)

Author:

Sebastian Huber <sebastian.huber@…>

Branches:

5, am, master

Children:

cd408b5

Parents:

c1d296a

git-author:

Sebastian Huber <sebastian.huber@…> (01/04/19 10:02:45)

git-committer:

Sebastian Huber <sebastian.huber@…> (01/09/19 08:23:58)

Message:

Replace build date with Git hash and commit date

The usage of a build date prevents reproducible builds.

Files:

• common/conf.py (modified) (2 diffs)
• common/waf.py (modified) (3 diffs)
• wscript (modified) (3 diffs)

common/conf.py

@@ -1 @@
-import datetime
-
-def build_date():
-    now = datetime.date.today()
-    m = now.strftime('%B')
-    y = now.strftime('%Y')
-    if now.day == 11:
-        s = 'th'
-    elif now.day % 10 == 1:
-        s = 'st'
-    elif now.day == 12:
-        s = 'th'
-    elif now.day % 10 == 2:
-        s = 'nd'
-    elif now.day == 13:
-        s = 'th'
-    elif now.day == 3:
-        s = 'rd'
-    else:
-        s = 'th'
-    d = '%2d%s' % (now.day, s)
-    return '%s %s %s' % (d, m, y)
-
 extensions = [
         "sphinx.ext.autodoc",
@@ -48 +25 @@
 # General information about the project.
 project = u'RTEMS Documentation Project'
-copyright = u'2018, RTEMS Project (built %s)' % (build_date())
+copyright = u'2018, RTEMS Project'
 
 # The version info for the project you're documenting, acts as replacement for

common/waf.py

@@ -18 +18 @@
 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 version_cmdline(ctx):
-    return '-Drelease="%s" -Dversion="%s"' % (ctx.env.VERSION, ctx.env.VERSION)
+    return '-Drelease="%s" -Dversion="%s"' % (ctx.env.RELEASE, ctx.env.VERSION)
 
 def sphinx_cmdline(ctx, build_type, conf_dir, doctrees,
@@ -208 +192 @@
     check_sphinx = not ctx.env.BIN_SPHINX_BUILD
     if check_sphinx:
-        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)
@@ -503 +485 @@
 
     root = cat.createElement('rtems-docs')
-    root.setAttribute('date', build_date())
+    root.setAttribute('date', ctx.env.DATE)
     cat.appendChild(root)
 

wscript

@@ -9 +9 @@
 import waflib
 import waf as docs_waf
-
-version = '5.0.0 (master)'
 
 build_all = ['user',
@@ -32 +30 @@
 
 def configure(conf):
-    conf.env.VERSION = version
     for b in building:
         conf.recurse(b)
@@ -54 +51 @@
         o.write(js.replace('@CATALOGUE', xml))
 
+def pretty_day(day):
+    if day == 3:
+        s = 'rd'
+    elif day == 11:
+        s = 'th'
+    elif day == 12:
+        s = 'th'
+    elif day == 13:
+        s = 'th'
+    elif day % 10 == 1:
+        s = 'st'
+    elif day % 10 == 2:
+        s = 'nd'
+    else:
+        s = 'th'
+    return str(day) + s
+
 def build(ctx):
+    #
+    # Get date and version from Git
+    #
+    version = '5.0.0'
+    if ctx.exec_command(['git', 'diff-index', '--quiet', 'HEAD']) == 0:
+        modified = ''
+    else:
+        modified = '-modified'
+    try:
+        out = ctx.cmd_and_log(['git', 'log', '-1', '--format=%H,%cd', '--date=format:%e,%B,%Y'])
+        f = out.strip('\n').split(',')
+        version = version + '.' + f[0] + modified
+        date = pretty_day(int(f[1])) + ' ' + f[2] + ' ' + f[3]
+    except waflib.Build.Errors.WafError:
+        date = 'unknown date'
+    ctx.env.DATE = date
+    ctx.env.RELEASE = version + ' (' + date + ')'
+    ctx.env.VERSION = version
+
     #
     # Generate any PlantUML images if enabled.