Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!

Bug 53500

Summary: Gentoo Ebuild/Developer HOWTO valign top Variables table -- printed
Product: [OLD] Docs-developer Reporter: Aaron Peterson <alpeterson>
Component: Guide XMLAssignee: Sven Vermeulen (RETIRED) <swift>
Status: RESOLVED FIXED    
Severity: normal CC: docs-team
Priority: High    
Version: unspecified   
Hardware: All   
OS: Linux   
URL: http://www.gentoo.org/doc/en/gentoo-howto.xml
Whiteboard:
Package list:
Runtime testing required: ---

Description Aaron Peterson 2004-06-10 03:19:49 UTC
The Variables section of the ebuild howto.. could really benefit from having the vertical alignment of the table, be "top"

It is very difficult to read the page when the caption is in the middle of the section. Perhaps the length of the variable description should be a bit shorter as well.

This is what happens:  I look at the caption, and my eyes move immediatly right... into the middle of the long, long, long paragraph on KEYWORDS  	MUST.







Reproducible: Always
Steps to Reproduce:
1.
2.
3.

Actual Results:  
 This variable now supports a couple of different functions. First of all, this
variable specifies what architecture the ebuild is meant for. These keywords
include: x86, ppc, sparc, mips, alpha, arm, hppa, amd64, ia64. Obviously, you
would set this to reflect the architecture of the target machine. Portage will
not allow an x86 machine to build anything but x86, as specified by the KEYWORDS
variable. Packages that do no support the native architecture are automatically
masked by Portage. If the KEYWORDS flag has a preceding ~, then that indicates
that the particular ebuild works, but needs to be tested in several environments
before being moved to the stable profile with the given keyword. If the KEYWORDS
flag has a preceding -, then the package does not work with the given keyword.
If there is nothing leading KEYWORDS, then the package is considered stable. You
can allow installation of these different types of packages through the
ACCEPT_KEYWORDS variable in make.conf.

Expected Results:  
Functions: supported architecture, and testing status.  architecture [ x86, ppc,
sparc, mips, alpha, arm, hppa, amd64, ia64.] portage will mask the package for
every architecture not specified. TESTING   a preceeding tilde (~arch) means
that the ebuild is in testing for that architecture. ** Relaited make.conf
setting: ACCEPT_KEYWORDS 

in general, the documentation is very wordy, and very hard to scan/skim,
especially on a computer monitor.  And it costs a lot to print.
Comment 1 Sven Vermeulen (RETIRED) gentoo-dev 2004-07-02 09:30:19 UTC
I've updated our CSS stylesheet to accomplish this.