Gentoo Archives: gentoo-dev

From: Mike Frysinger <vapier@g.o>
To: gentoo-dev@l.g.o
Subject: [gentoo-dev] merging man page documentation into eclasses
Date: Mon, 11 Jun 2007 06:07:55
Message-Id: 200706110205.01904.vapier@gentoo.org
1 keeping documentation of functions in a separate file (man pages in this case)
2 has obvious bit rot problems written all over it, so i'd like to merge the
3 documentation into the respective eclasses so that the man pages can be
4 automatically generated
5
6 off the cuff, i'd propose a style like:
7 # FUNCTION: edos2unix
8 # USAGE: <files>
9 # DESCRIPTION:
10 # A handy replacement for dos2unix, recode, fixdos, etc... This allows you
11 # to remove all of these text utilities from DEPEND variables because this
12 # is a script based solution. Just give it a list of files to convert and
13 # they will all be changed from the DOS CRLF format to the UNIX LF format.
14 -mike

Attachments

File name MIME type
signature.asc application/pgp-signature

Replies