Gentoo Archives: gentoo-dev

From: Mike Frysinger <vapier@g.o>
To: gentoo-dev@l.g.o
Subject: [gentoo-dev] updated elass documentation syntax
Date: Sat, 21 Aug 2010 19:24:49
Message-Id: 201008211527.05435.vapier@gentoo.org
1 ive extended the eclass documentation format a little for variables. you can
2 now use the markers:
3
4 @DEFAULT_UNSET
5 avoid overhead of adding useless constructs like:
6 : ${FOO:=}
7 this way the awk script wont warn when it was unable to find a default value
8 for the variable in question
9
10 @REQUIRED
11 similar to the previous construct; this allows people to mark a variable so
12 that ebuild writers know they must provide for this. in the man page output,
13 the variable will be marked with "(REQUIRED)".
14
15 @INTERNAL
16 some people like to document all variables, even ones that ebuilds/users
17 shouldnt be setting (i.e. internal state variables). now you can do just that
18 and the variable wont be included in the output.
19 -mike

Attachments

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

Replies

Subject Author
Re: [gentoo-dev] updated elass documentation syntax "Tomáš Chvátal" <scarabeus@g.o>