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

Re: implement a stable 'Last updated' in Documentation

From
Jeff King <peff@peff.net>
Date
Jan 30, 2015, 15:07 UTC
Message-ID
<20150130150758.GA3683@peff.net>
In-Reply-To
<54CB5770.8030503@drmicha.warpmail.net>
On Fri, Jan 30, 2015 at 11:05:36AM +0100, Michael J Gruber wrote:
Show 12 quoted lines
> 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).

I have 8.6.9-3 installed (it is part of Debian testing/unstable now), and confirmed that:

diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf
index 2c16c53..10c777e 100644
--- a/Documentation/asciidoc.conf
+++ b/Documentation/asciidoc.conf
@@ -21,6 +21,7 @@ tilde=&#126;
 apostrophe=&#39;
 backtick=&#96;
 litdd=&#45;&#45;
+footer-style=none
 
 ifdef::backend-docbook[]
 [linkgit-inlinemacro]

drops the "last-updated" footer.

But note that this only affects the generated HTML. The manpages still
get the date in their footer. But this isn't an asciidoc-ism at all;
it's added by docbook when converting the xml to roff. I'm sure there is
a way to tweak that, too, but looking at docbook gives me nightmares.

-Peff
Previous: Michael J GruberNext: Olaf Hering
Message 7 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.