changeset 40011:e66a3ae8211a

help: document about "annotate" template keywords
author Yuya Nishihara <yuya@tcha.org>
date Wed, 03 Oct 2018 22:27:45 +0900
parents f5d819d84461
children d44efe0e6f40
files mercurial/commands.py
diffstat 1 files changed, 19 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/commands.py	Fri Sep 28 16:34:53 2018 -0700
+++ b/mercurial/commands.py	Wed Oct 03 22:27:45 2018 +0900
@@ -288,6 +288,25 @@
     anyway, although the results will probably be neither useful
     nor desirable.
 
+    .. container:: verbose
+
+      Template:
+
+      The following keywords are supported in addition to the common template
+      keywords and functions. See also :hg:`help templates`.
+
+      :lines:   List of lines with annotation data.
+      :path:    String. Repository-absolute path of the specified file.
+
+      And each entry of ``{lines}`` provides the following sub-keywords in
+      addition to ``{date}``, ``{node}``, ``{rev}``, ``{user}``, etc.
+
+      :line:    String. Line content.
+      :lineno:  Integer. Line number at that revision.
+      :path:    String. Repository-absolute path of the file at that revision.
+
+      See :hg:`help templates.operators` for the list expansion syntax.
+
     Returns 0 on success.
     """
     opts = pycompat.byteskwargs(opts)