git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: implement a stable 'Last updated' in Documentation

From
Michael J Gruber <git@drmicha.warpmail.net>
Date
Jan 30, 2015, 10:05 UTC
Message-ID
<54CB5770.8030503@drmicha.warpmail.net>
In-Reply-To
<xmqqbnlif6t9.fsf@gitster.dls.corp.google.com>
Junio C Hamano schrieb am 29.01.2015 um 07:18:
Show 16 quoted lines
> Olaf Hering <olaf@aepfle.de> writes:
> 
>> On Tue, Jan 27, Junio C Hamano wrote:
>>
>>>> What file timestamp should be used for them? Likely "../version"?
>>>
>>> I tend to think the "Last updated" timestamp taken from the
>>> filesystem timestamp is a bad practice inherited by these tools from
>>> the days back when nobody used any revision control systems.
>>
>> I'm not sure. The bug is that such 'Last updated' line exists at all in
>> the default output. Noone asked for it, noone really needs it. And it
>> makes it impossible to get reproducible builds.
> 
> Amen to that ;-)
> 

It's a shame one can't simply replace the [footer-text] template which asciidoc insists on.

It turns out asciidoc 8.6.9-3 and later will habe a knob to turn:
https://github.com/asciidoc/asciidoc/pull/9

I'll try and get my hands on it to see whether we can simply use that. I'm wondering though which is more useful - the version of the tree the doc is processed from, or the version of the last commit changing the corresponding doc source file. The first one changes even when the doc source is unchanged (but is stable between reruns, of course).

Michael
Previous: Junio C HamanoNext: Jeff King
Message 6 of 11 in “implement a stable 'Last updated' in Documentation”
  1. Olaf HeringJan 26, 2015
  2. Olaf HeringJan 27, 2015
  3. Junio C HamanoJan 27, 2015
  4. Olaf HeringJan 28, 2015
  5. Junio C HamanoJan 29, 2015
  6. Michael J GruberJan 30, 2015
  7. Jeff KingJan 30, 2015
  8. Olaf HeringFeb 10, 2015
  9. Jeff KingFeb 10, 2015
  10. Olaf HeringSep 1, 2016
  11. Jeff KingSep 1, 2016

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.