Skip to content

Commit bf08fa0

Browse files
committed
docs: auto update revname and revdate
Related: #764 Signed-off-by: Jaroslav Škarvada <jskarvad@redhat.com>
1 parent 71854de commit bf08fa0

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

doc/manual/Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
.PHONY: clean
22

3+
DOCVER=$(shell cd ../..; $$PYTHON -c 'import tuned.version as v; print(v.TUNED_VERSION_STR)')
4+
DOCDATE=$(shell date '+%Y-%m-%d')
5+
36
index.html: master.adoc assemblies/*.adoc meta/*.adoc modules/performance/*.adoc ../../tuned/plugins/plugin_*.py ../../tuned/profiles/functions/function_*.py
47
$(PYTHON) ./compile_plugin_docs.py ../../tuned/plugins plugin_ Plugin modules/performance/ref_available-tuned-plug-ins_intro.adoc modules/performance/ref_available-tuned-plug-ins.adoc
58
$(PYTHON) ./compile_plugin_docs.py ../../tuned/profiles/functions function_ Function modules/performance/ref_built-in-functions-available-in-tuned-profiles_intro.adoc modules/performance/ref_built-in-functions-available-in-tuned-profiles.adoc
6-
asciidoctor -o index.html master.adoc || asciidoc -d book -o index.html master.adoc
9+
asciidoctor -a revnumber=$(DOCVER) -a revdate=$(DOCDATE) -o index.html master.adoc || asciidoc -a revnumber=$(DOCVER) -a revdate=$(DOCDATE) -d book -o index.html master.adoc
710

811
install: index.html
912
install -Dpm 0644 index.html $(DESTDIR)$(DOCDIR)/manual/index.html

doc/manual/master.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
:revnumber: 2.27.0
2-
:revdate: 2026-03-03
1+
:revnumber: 0.0.0
2+
:revdate: 2000-01-01
33
:keywords: documentation, tuned, performance, power, linux
44
:toc:
55

6-
// The revnumber attribute is intended to show the TuneD version for which the document has been updated
6+
// The revnumber and revdate attributes are automatically updated during build
77

88
[id="{tuned-documentation}"]
99
= TuneD documentation: Optimizing system throughput, latency, and power consumption

0 commit comments

Comments
 (0)