Re: [PATCH] Misc documentation fixes and improvements

From: Petr Baudis <pasky@suse.cz>
Date: Jul 20, 2005, 17:12 UTC
Message-ID: <20050720171221.GD17217@pasky.ji.cz>
In-Reply-To: <20050720120501.GA14074@diku.dk>

Dear diary, on Wed, Jul 20, 2005 at 02:05:01PM CEST, I got a letter where Jonas Fonseca <fonseca@diku.dk> told me that...

Show 19 quoted lines

> Fix displaying of an error message when cg-help is called with unknown
> command and use $USAGE so the correct cg-help usage string is printed.
> Drop useless use of cat in print_help(). Improve the asciidoc markup.
> 
> Signed-off-by: Jonas Fonseca <fonseca@diku.dk>
> ---
> 
> diff --git a/cg-diff b/cg-diff
> --- a/cg-diff
> +++ b/cg-diff
> @@ -3,7 +3,7 @@
>  # Make a diff between two GIT trees.
>  # Copyright (c) Petr Baudis, 2005
>  #
> -# Outputs a diff for converting the first tree to the second one.
> +# Outputs a diff for converting between two trees.
>  # By default compares the current working tree to the state at the
>  # last commit. The output will automatically be displayed in a pager
>  # unless it is piped to a program.

I dropped this hunk (seems to only lose clarity).

Show 12 quoted lines

> diff --git a/cg-help b/cg-help
> --- a/cg-help
> +++ b/cg-help
> @@ -90,7 +91,7 @@ ADVANCED_COMMANDS="$(ls $bin_path/cg-adm
>  colorize <<__END__
>  The Cogito version control system  $(cg-version)
>  
> -Usage: cg-COMMAND [ARG]...
> +Usage: $USAGE
>  
>  Available commands:
>  $(print_command_listing $REGULAR_COMMANDS)

And I dropped the Usage string here altogether.

Thanks,

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