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

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


On 10/01/2019 09:21, Sebastian Huber wrote:
> On 10/01/2019 09:19, Sebastian Huber wrote:
>> 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 5.0.0.05d066a08fe840f6f926bf6d2f3f3c0ebd6cc603 (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). 
>
> We have to take also the hash-modified modifier into account if you 
> build with a non-clean Git checkout.
>

For the date we could also try to use the "today" variable in conf.py 
and use it for example in the PDF first page template separate from the 
version.

-- 
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