bug-gnulib
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Documentation for the regexp module


From: Karl Berry
Subject: Re: Documentation for the regexp module
Date: Mon, 24 Jan 2011 00:27:24 GMT

    I think it would be nice to make the regex module to import a texinfo
    file documenting the supported regular expressions syntax 

I agree in principle, but ...

    We could get the "Regular Expression Syntax"
    chapter in its own file regex-syntax.texi, 

.. this isn't ideal as-is.  There's a bunch of stuff in there referring
to syntax bits.  That's needed as documentation of the library, but
isn't relevant to users.

I fear the ideal would be to actually write new text with users in mind.
But as we all know, the ideal is hard to put into practice.

As an available-now alternative, James (Youngman) developed some
automatically-generated Texinfo for each syntax for findutils.  I'd
suggest going that way for recutils.  I don't remember why we never
generated/imported/exported those docs in gnulibs, but see the findutils
sources for what he did.

    POSIX BREs and EREs

And the GNU extensions that we should all be supporting by default :).
Everything except the "Overview" and "Programming with Regex" chapters
looks more or less relevant, modulo the caveats above ...

Best,
k



reply via email to

[Prev in Thread] Current Thread [Next in Thread]