git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH][COGITO] Broken Documentation

From
MAMartin Atukunda <matlads@dsmagic.com>
Date
Sep 19, 2005, 20:23 UTC
Message-ID
<20050919202310.GB17503@igloo.ds.co.ug>

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#* }
Message 1 of 1 in “[COGITO] Broken Documentation”
  1. [COGITO] Broken DocumentationMartin Atukunda, Sep 19, 2005

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.