git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* [PATCH][COGITO] Broken Documentation
@ 2005-09-19 20:23 Martin Atukunda
  0 siblings, 0 replies; only message in thread
From: Martin Atukunda @ 2005-09-19 20:23 UTC (permalink / raw
  To: git

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>

---

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

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2005-09-19 20:25 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2005-09-19 20:23 [PATCH][COGITO] Broken Documentation Martin Atukunda

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).