threads / patch / 1864

patch[COGITO] Broken Documentation

Subject: [PATCH][COGITO] Broken Documentation

## tl;dr

One message between Sep 19, 2005 and Sep 19, 2005. Diffs are folded; open one to read it.

replies: 0people: 1as markdown or json

Martin Atukunda· Sep 19, 2005, 20:23 UTC · lore

As noted by Horst von Brand <vonbrand@inf.utfsm.cl>, 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 <matlads@dsmagic.com>
---
Show changes to 3 files +6 −0

cg-commit-id, cg-parent-id, cg-tree-id

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#* }

← back to recent threads