[PATCH] Replace build date with Git hash and commit date

Sebastian Huber sebastian.huber at embedded-brains.de
Thu Jan 10 08:19:38 UTC 2019

On 10/01/2019 00:42, Chris Johns wrote:
> On 9/1/19 7:24 pm, Sebastian Huber wrote:
>> The usage of a build date prevents reproducible builds.
> Sorry to revisit this change. I have reviewed the generated the docs and they
> look good and the changes are welcome, thank you. I would like to ask a few
> questions.
> 1. Can the hash be the short version? I am seeing in the PDF in the page header:
>   Release (9th January 2019)
> which is correct but the page header is now 2 lines and a line on a page in the
> PDF is precious. In the Classic API manual at 716 pages this is 716 extra lines.
> Can we use a shortened hash?

I played a bit around view various variants. One problem I had is in 
case the version line is long but not enough for two lines, then it 
overlaps the chapter number in the header. If you want a one liner, then 
the chapter number, the document title and the version must fit into it. 
I think this is only possible if we drop the date, use a short hash and 
cut down some document titles (or use a smaller font size).

> 2. Should:
> be:
>   5.0.0-05d066a08fe840f6f926bf6d2f3f3c0ebd6cc603
> ? This separates the version number from the hash and helps avoid confusion. For
> example it took me a while to figure out if the version was and the hash
> 5d066a08fe840f6f926bf6d2f3f3c0ebd6cc603. It would also be consistent with the
> other places the hash is used, for example the rtems-tools programs.

I don't have a preference here. It is easy to change.

> 3. Can the git commit date (9th January 2019) please be added to the footer line
> in the HTML version? This makes the information available the PDF and HTML
> equivalent.

I didn't understand the difference between "release" and "version" in 
conf.py. It seems release is used for the PDF and version for the HTML? 
The comment says something else:

# The version info for the project you're documenting, acts as 
replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
# The short X.Y version.
#version = '@VERSION@'

# The full version, including alpha/beta/rc tags.
#release = '@RELEASE@'

Sebastian Huber, embedded brains GmbH

Address : Dornierstr. 4, D-82178 Puchheim, Germany
Phone   : +49 89 189 47 41-16
Fax     : +49 89 189 47 41-09
E-Mail  : sebastian.huber at embedded-brains.de
PGP     : Public key available on request.

Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.

More information about the devel mailing list