Split trailers out of the commit message

1 file changed, 38 insertions, 0 deletions

diff --git a/MANUAL.txt b/MANUAL.txt
index f59a64c..fc91125 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -256,6 +256,16 @@ enable-subject-links::
 	parent commit as link text when generating links to parent commits in
 	commit view. Default value: "0". See also: "repo.enable-subject-links".
 
+enable-trailers::
+	Flag which, when set to "1", makes the commit page split the trailer
+	block, the Signed-off-by lines and their kin, off the end of the commit
+	message and show it as a table under the message. The block is found
+	the way git finds it for "git interpret-trailers": the last paragraph
+	is taken when every line in it is a trailer, or when it holds a
+	Signed-off-by and at least a quarter of its lines are trailers.
+	Default value: "0". See also: "trailer-filter",
+	"repo.enable-trailers".
+
 enable-tree-group-dirs::
 	Flag which, when set to "1", makes the tree view list all directories
 	first, sorted, followed by the files. When set to "0", entries appear in
@@ -512,6 +522,18 @@ summary-tags::
 	Specifies the number of tags to display in the repository "summary"
 	view. Default value: "10".
 
+trailer-filter::
+	Specifies a command which will be invoked to format the value of a
+	commit trailer when "enable-trailers" is set. The command will get the
+	trailer key and an origin page string as its command line arguments and
+	the value on its STDIN, and the STDOUT from the command will be
+	included verbatim as the value. Trailers whose value is a name and
+	email address, such as Signed-off-by, go through the email-filter
+	instead, and when no trailer-filter is configured the remaining values
+	go through the commit-filter. A ready filter linking Fixes, Closes and
+	URL values ships as custom/extensions/link-trailers.lua. Default value:
+	none. See also: "Filter API".
+
 virtual-root::
 	Url which, if specified, will be used as root for all cgit links. It
 	will also cause cgit to generate 'virtual urls', i.e. urls like
@@ -600,6 +622,10 @@ repo.enable-subject-links::
 	A flag which can be used to override the global setting
 	"enable-subject-links". Default value: <enable-subject-links>.
 
+repo.enable-trailers::
+	A flag which can be used to override the global setting
+	"enable-trailers". Default value: <enable-trailers>.
+
 repo.head-content::
 	This value will be added verbatim to the html HEAD section of each page
 	displayed for this repo. Default value: none. See also: "head-include".
@@ -687,6 +713,11 @@ repo.source-filter::
 	"enable-filter-overrides" is set. Default value: <source-filter>. See
 	also: "Filter API".
 
+repo.trailer-filter::
+	Override the default trailer-filter. Only honoured when
+	"enable-filter-overrides" is set. Default value: <trailer-filter>. See
+	also: "Filter API".
+
 repo.url::
 	The relative url used to access the repository. This must be the first
 	setting specified for each repo. Default value: none.
@@ -805,6 +836,13 @@ source filter::
 	be filtered is available on standard input and the filtered contents is
 	expected on standard output.
 
+trailer filter::
+	This filter is given two parameters: the key of the trailer being
+	formatted, such as "Fixes", and a string indicating the originating
+	page. The filter will then receive the trailer value, already HTML
+	escaped, on standard input and is expected to write to standard output
+	the formatted value to be included in the page.
+
 
 All filters are handed the following environment variables: