public inbox for gentoo-dev@lists.gentoo.org
 help / color / mirror / Atom feed
From: Mike Frysinger <vapier@gentoo.org>
To: gentoo-dev@lists.gentoo.org
Subject: [gentoo-dev] merging man page documentation into eclasses
Date: Mon, 11 Jun 2007 02:05:01 -0400	[thread overview]
Message-ID: <200706110205.01904.vapier@gentoo.org> (raw)

[-- Attachment #1: Type: text/plain, Size: 669 bytes --]

keeping documentation of functions in a separate file (man pages in this case) 
has obvious bit rot problems written all over it, so i'd like to merge the 
documentation into the respective eclasses so that the man pages can be 
automatically generated

off the cuff, i'd propose a style like:
# FUNCTION: edos2unix
# USAGE: <files>
# DESCRIPTION:
# A handy replacement for dos2unix, recode, fixdos, etc...  This allows you
# to remove all of these text utilities from DEPEND variables because this
# is a script based solution.  Just give it a list of files to convert and
# they will all be changed from the DOS CRLF format to the UNIX LF format.
-mike

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 827 bytes --]

             reply	other threads:[~2007-06-11  6:07 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-06-11  6:05 Mike Frysinger [this message]
2007-06-11  6:40 ` [gentoo-dev] merging man page documentation into eclasses Andrew Ross
2007-06-11 12:41 ` Joshua Nichols
2007-06-18  0:19 ` Mike Frysinger

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=200706110205.01904.vapier@gentoo.org \
    --to=vapier@gentoo.org \
    --cc=gentoo-dev@lists.gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox