[PATCH][COGITO] Broken Documentation
From: Martin Atukunda <hidden>
Date: 2016-06-15 22:42:06
Subsystem:
the rest · Maintainer:
Linus Torvalds
As noted by Horst von Brand [off-list ref], cg-parent-id.txt and cg-tree-id.txt don't validate as xml, and this breaks the Documentation build. I traced this to the fact that cg-parent-id and cg-tree-id do not have USAGE=... lines. btw, this also affects cg-commit-id. Patch below adds USAGE lines to cg-parent-id, cg-tree-id, and cg-commit-id. Signed-Off-By: Martin Atukunda <redacted> ---
diff --git a/cg-commit-id b/cg-commit-id
--- a/cg-commit-id
+++ b/cg-commit-id@@ -5,6 +5,8 @@ # # Takes the appropriate ID, defaults to HEAD. +USAGE="cg-commit-id [COMMIT_ID]" + id="$1" normid=$(. ${COGITO_LIB}cg-Xnormid "$id") || exit 1 type=${normid#* }
diff --git a/cg-parent-id b/cg-parent-id
--- a/cg-parent-id
+++ b/cg-parent-id@@ -7,5 +7,7 @@ # # NOTE: Will return multiple SHA1s if ID is a commit with multiple parents. +USAGE="cg-parent-id [COMMIT_ID]" + normid=$(. ${COGITO_LIB}cg-Xnormid "$1"^) echo ${normid%% *}
diff --git a/cg-tree-id b/cg-tree-id
--- a/cg-tree-id
+++ b/cg-tree-id@@ -5,6 +5,8 @@ # # Takes ID of the appropriate commit, defaults to HEAD. +USAGE="cg-tree-id [COMMIT_ID]" + id="$1" normid=$(. ${COGITO_LIB}cg-Xnormid "$id") || exit 1 type=${normid#* }