MacPorts Docs Strategy - Proposal

Anders F Björklund afb at
Sat Sep 8 06:05:02 PDT 2007

markd wrote:

> 5) After ensuring that the guide and the wiki have within them all the
> notes from various text files within trunk, delete these legacy 
> documents.
>  base/doc/INTERNALS, trunk, base/HACKING, etc.

I think it would be good to have the traditional README and LICENSE 
Maybe even an INSTALL file, even if all it does is say "look at the 
The other ones can be docbookized, but it would be nice if there was an
offline copy of the internal documentation included with the source 
code ?

Including code:
I do think embedded code documentation is better than external, though.
(too easy to forget to change the documentation after making changes
to the code itself, so it's better if functions are documented inline)


More information about the macports-users mailing list