Re: [gentoo-dev] updated elass documentation syntax

["Tomáš Chvátal" <scarabeus@gentoo.org>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Dne 21.8.2010 21:27, Mike Frysinger napsal(a):
> 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
Mike,
if i define variable in some function it gets into functions section for
manpage. Not sure if that is your area to fix too :)

Cheers

Tom
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.16 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkxwKQkACgkQHB6c3gNBRYfIzQCgvDG7fM+LBA0wjtkubzmS8K54
vPwAoL49i9HPst2uTLqBTsHPcWYEFpql
=5jB0
-----END PGP SIGNATURE-----