* [gentoo-dev] updated elass documentation syntax
@ 2010-08-21 19:27 99% Mike Frysinger
0 siblings, 0 replies; 1+ results
From: Mike Frysinger @ 2010-08-21 19:27 UTC (permalink / raw
To: gentoo-dev
[-- 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 --]
^ permalink raw reply [relevance 99%]
Results 1-1 of 1 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2010-08-21 19:27 99% [gentoo-dev] updated elass documentation syntax Mike Frysinger
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox