Gentoo Archives: gentoo-dev

From: "Tomáš Chvátal" <scarabeus@g.o>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] updated elass documentation syntax
Date: Sat, 21 Aug 2010 19:29:24
Message-Id: 4C702909.8060204@gentoo.org
In Reply to: [gentoo-dev] updated elass documentation syntax by Mike Frysinger
1 -----BEGIN PGP SIGNED MESSAGE-----
2 Hash: SHA1
3
4 Dne 21.8.2010 21:27, Mike Frysinger napsal(a):
5 > ive extended the eclass documentation format a little for variables. you can
6 > now use the markers:
7 >
8 > @DEFAULT_UNSET
9 > avoid overhead of adding useless constructs like:
10 > : ${FOO:=}
11 > this way the awk script wont warn when it was unable to find a default value
12 > for the variable in question
13 >
14 > @REQUIRED
15 > similar to the previous construct; this allows people to mark a variable so
16 > that ebuild writers know they must provide for this. in the man page output,
17 > the variable will be marked with "(REQUIRED)".
18 >
19 > @INTERNAL
20 > some people like to document all variables, even ones that ebuilds/users
21 > shouldnt be setting (i.e. internal state variables). now you can do just that
22 > and the variable wont be included in the output.
23 > -mike
24 Mike,
25 if i define variable in some function it gets into functions section for
26 manpage. Not sure if that is your area to fix too :)
27
28 Cheers
29
30 Tom
31 -----BEGIN PGP SIGNATURE-----
32 Version: GnuPG v2.0.16 (GNU/Linux)
33 Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
34
35 iEYEARECAAYFAkxwKQkACgkQHB6c3gNBRYfIzQCgvDG7fM+LBA0wjtkubzmS8K54
36 vPwAoL49i9HPst2uTLqBTsHPcWYEFpql
37 =5jB0
38 -----END PGP SIGNATURE-----

Replies

Subject Author
Re: [gentoo-dev] updated elass documentation syntax Mike Frysinger <vapier@g.o>