threads / patch / 1865

patchFixing --help, usage for *-id

Subject: [PATCH] Fixing --help, usage for *-id

## tl;dr

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

replies: 1people: 2as markdown or json

Pavel Roskin· Sep 19, 2005, 21:29 UTC · lore

Hello!

Removal of cg-Xlib inclusion in *-id scripts broke "--help" switch. When cg-Xlib is sourced indirectly through cg-Xnormid, the help text is treated like an ID, and its last word is dropped.

Lack of USAGE string in the *-id scripts breaks the documentation generation because empty synopsis causes invalid XML. Thus the USAGE strings should be provided.

Signed-off-by: Pavel Roskin <proski@gnu.org>

Show changes to 3 files +12 −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,10 @@
 #
 # Takes the appropriate ID, defaults to HEAD.
 
+USAGE="cg-commit-id"
+
+. ${COGITO_LIB}cg-Xlib
+
 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,9 @@
 #
 # NOTE: Will return multiple SHA1s if ID is a commit with multiple parents.
 
+USAGE="cg-parent-id"
+
+. ${COGITO_LIB}cg-Xlib
+
 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,10 @@
 #
 # Takes ID of the appropriate commit, defaults to HEAD.
 
+USAGE="cg-tree-id"
+
+. ${COGITO_LIB}cg-Xlib
+
 id="$1"
 normid=$(. ${COGITO_LIB}cg-Xnormid "$id") || exit 1
 type=${normid#* }

-- 
Regards,
Pavel Roskin

Petr Baudis· Sep 19, 2005, 21:40 UTC · re: Pavel Roskin · lore

Re: [PATCH] Fixing --help, usage for *-id

Dear diary, on Mon, Sep 19, 2005 at 11:29:41PM CEST, I got a letter where Pavel Roskin <proski@gnu.org> told me that...

> Hello!

Hello,

> Removal of cg-Xlib inclusion in *-id scripts broke "--help" switch.
> When cg-Xlib is sourced indirectly through cg-Xnormid, the help text is
> treated like an ID, and its last word is dropped.

do we really need --help in *-id? They are some kind of scripts half-internal and half for the user - their _primary_ use is from the other scripts, but they are standalone since they can be useful for the end user as well in various situations. I can roughly remember cg-Xlib inclusion in those scripts being significantly visible on the running times of the users.

> Lack of USAGE string in the *-id scripts breaks the documentation
> generation because empty synopsis causes invalid XML.  Thus the USAGE
> strings should be provided.

Thanks, this was already taken care of by Martin Atukunda.

-- 
				Petr "Pasky" Baudis
Stuff: http://pasky.or.cz/
If you want the holes in your knowledge showing up try teaching
someone.  -- Alan Cox