Gentoo Logo
Gentoo Spaceship




Note: Due to technical difficulties, the Archives are currently not up to date. GMANE provides an alternative service for most mailing lists.
c.f. bug 424647
List Archive: gentoo-dev
Navigation:
Lists: gentoo-dev: < Prev By Thread Next > < Prev By Date Next >
Headers:
To: gentoo-dev@g.o
From: Mike Frysinger <vapier@g.o>
Subject: updated elass documentation syntax
Date: Sat, 21 Aug 2010 15:27:04 -0400
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:
signature.asc (This is a digitally signed message part.)
Replies:
Re: updated elass documentation syntax
-- Tomáš Chvátal
Navigation:
Lists: gentoo-dev: < Prev By Thread Next > < Prev By Date Next >
Previous by thread:
Lastrite: ferrisloki, stldb4, fampp2, libferrisstreams
Next by thread:
Re: updated elass documentation syntax
Previous by date:
Re: Lastrite: ferrisloki, stldb4, fampp2, libferrisstreams
Next by date:
Re: updated elass documentation syntax


Updated Jun 29, 2012

Summary: Archive of the gentoo-dev mailing list.

Donate to support our development efforts.

Copyright 2001-2013 Gentoo Foundation, Inc. Questions, Comments? Contact us.