[darcs-users] Unused documentation in Darcs.Patch.*

Trent W. Buck trentbuck at gmail.com
Sun Nov 2 01:05:09 UTC 2008


The file src/Darcs/Patch.lhs is currently included in the appendices of
the end user manual.  This file itself includes

    \input{Darcs/Patch/Apply.lhs}
    \input{Darcs/Patch/Core.lhs}
    \input{Darcs/Patch/Commute.lhs}
    \input{Darcs/Patch/Show.lhs}

and src/Darcs/Arguments.lhs \inputs Darcs/Patch/Match.lhs.

However, there are a several other files in Darcs/Patch/*.lhs that
AFAICT are never rendered to PDF or HTML, but contain non-trivial
literate documentation:

    Prim       -- should be \inputted by Darcs/Patch.lhs?

    Choices    -- literate comments should be haddockized?
    Test       -- literate comments should be haddockized?

    Properties -- a stand-alone single-page document that's rendered as
                  patch-theory.pdf.  Should this be folded into the
                  end user manual's patch appendix?



More information about the darcs-users mailing list