Skip to contentSkip to conversation

perf docs: Allow man page date to be specified

PATCH Applied Ian Rogers 2 participants 2 messages Sep 21, 2019 – Oct 7, 2019 perf events

lore
Share & tools
lore

Ian Rogers

author reviewer
#0 lore raw

PATCH 1/1 perf docs: Allow man page date to be specified

With this change if a perf_date parameter is provided to asciidoc then it will override the default date written to the man page metadata. Without this change, or if the perf_date isn't specified, then the current date is written to the metadata. Having this parameter allows the metadata to be constant if builds happen on different dates. The name of the parameter is intended to be consistent with the existing perf_version parameter.

---
 tools/perf/Documentation/asciidoc.conf | 3 +++
 1 file changed, 3 insertions(+)
tools/perf/Documentation/asciidoc.conf +3 -0
index 356b23a40339..2b62ba1e72b7 100644
@@ -71,6 +71,9 @@ ifdef::backend-docbook[]
 [header]
 template::[header-declarations]
 <refentry>
+ifdef::perf_date[]
+<refentryinfo><date>{perf_date}</date></refentryinfo>
+endif::perf_date[]
 <refmeta>
 <refentrytitle>{mantitle}</refentrytitle>
 <manvolnum>{manvolnum}</manvolnum>
Signature · 1 line
2.23.0.351.gc4317032e6-goog
merge bot Applied
#1 lore raw
The following commit has been merged into the perf/urgent branch of tip:

The following commit has been merged into the perf/urgent branch of tip:

Commit-ID:     d586ac10ce56b2381b8e1d8ed74660c1b2b8ab0d
Gitweb:        https://git.kernel.org/tip/d586ac10ce56b2381b8e1d8ed74660c1b2b8ab0d
Author:        Ian Rogers <[email protected]>
AuthorDate:    Fri, 20 Sep 2019 21:13:27 -07:00
Committer:     Arnaldo Carvalho de Melo <[email protected]>
CommitterDate: Fri, 27 Sep 2019 09:26:14 -03:00

perf docs: Allow man page date to be specified

With this change if a perf_date parameter is provided to asciidoc then it will override the default date written to the man page metadata.

Without this change, or if the perf_date isn't specified, then the current date is written to the metadata.

Having this parameter allows the metadata to be constant if builds happen on different dates.

The name of the parameter is intended to be consistent with the existing perf_version parameter.

---
 tools/perf/Documentation/asciidoc.conf | 3 +++
 1 file changed, 3 insertions(+)
tools/perf/Documentation/asciidoc.conf +3 -0
index 356b23a..2b62ba1 100644
@@ -71,6 +71,9 @@ ifdef::backend-docbook[]
 [header]
 template::[header-declarations]
 <refentry>
+ifdef::perf_date[]
+<refentryinfo><date>{perf_date}</date></refentryinfo>
+endif::perf_date[]
 <refmeta>
 <refentrytitle>{mantitle}</refentrytitle>
 <manvolnum>{manvolnum}</manvolnum>