Re: [RFC] Embedding asciidoc manpages in the cg scripts

From: Petr Baudis <pasky@ucw.cz>
Date: May 11, 2005, 21:32 UTC
Message-ID: <20050511213217.GG22686@pasky.ji.cz>
In-Reply-To: <20050511014445.GA14377@diku.dk>

Dear diary, on Wed, May 11, 2005 at 03:44:45AM CEST, I got a letter where Jonas Fonseca <fonseca@diku.dk> told me that...

Show 11 quoted lines

> Index: cg-add
> ===================================================================
> --- 1cfa9d5a4f751f8ddd8b9a40758b8d6d0141264e/cg-add  (mode:100755)
> +++ uncommitted/cg-add  (mode:100755)
> @@ -1,14 +1,36 @@
>  #!/usr/bin/env bash
>  #
> -# Add new file to a GIT repository.
> -# Copyright (c) Petr Baudis, 2005
> +# CG-ADD(1)
> +# =========

This is really awful - it carries no interesting information whatsoever since that is pretty obvious from the fact that it is in file called cg-add.

>  #
> +# NAME
> +# ----
> +# cg-add - add files to a GIT repository

Half of this is useless, too.

I think you should just keep the first paragraph of the files as it is now. Don't touch it, just parse it.

> +#
> +# SYNOPSIS
> +# --------

No need for this heading either.

Show 10 quoted lines

> +USAGE="cg-add FILE..."
> +#
> +# DESCRIPTION
> +# -----------
>  # Takes a list of file names at the command line, and schedules them
>  # for addition to the GIT repository at the next commit.
> +#
> +# The command will fail if one of the given files does not exist.
> +#
> +# cg-add is part of Cogito, an SCM-like toolkit for managing GIT trees.

Useless.

> +#
> +# OPTIONS
> +# -------
> +# No options.

The rest of DESCRIPTION and OPTIONS looks fine.

I'd just expect you to be much less intrusive in the in-file comments and do more work when processing the stuff. I'm commenting on how it looks inside of the sources - do whatever is necessary when processing it to generate a proper-looking manpage from it.

-- 
				Petr "Pasky" Baudis
Stuff: http://pasky.or.cz/
C++: an octopus made by nailing extra legs onto a dog. -- Steve Taylor