From: Mike Frysinger <vapier@gentoo.org>
To: gentoo-dev@lists.gentoo.org
Subject: [gentoo-dev] updated elass documentation syntax
Date: Sat, 21 Aug 2010 15:27:04 -0400 [thread overview]
Message-ID: <201008211527.05435.vapier@gentoo.org> (raw)
[-- Attachment #1: Type: text/plain, Size: 741 bytes --]
ive extended the eclass documentation format a little for variables. you can
now use the markers:
@DEFAULT_UNSET
avoid overhead of adding useless constructs like:
: ${FOO:=}
this way the awk script wont warn when it was unable to find a default value
for the variable in question
@REQUIRED
similar to the previous construct; this allows people to mark a variable so
that ebuild writers know they must provide for this. in the man page output,
the variable will be marked with "(REQUIRED)".
@INTERNAL
some people like to document all variables, even ones that ebuilds/users
shouldnt be setting (i.e. internal state variables). now you can do just that
and the variable wont be included in the output.
-mike
[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 836 bytes --]
next reply other threads:[~2010-08-21 19:24 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-08-21 19:27 Mike Frysinger [this message]
2010-08-21 19:29 ` [gentoo-dev] updated elass documentation syntax Tomáš Chvátal
2010-08-21 19:38 ` Mike Frysinger
2010-08-21 19:43 ` Tomáš Chvátal
2010-08-21 20:32 ` Mike Frysinger
2010-08-22 8:03 ` Tomáš Chvátal
2010-08-22 18:08 ` 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=201008211527.05435.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