[gentoo-commits] gentoo commit in xml/htdocs/proj/en/devrel/handbook: hb-guide-ebuild.xml

["Petteri Raty (betelgeuse)" <betelgeuse@gentoo.org>]

betelgeuse    08/04/06 15:01:13

  Modified:             hb-guide-ebuild.xml
  Log:
  Remove the listing of different variables and point to devmanual instead. Fixes bug #216533.

Revision  Changes    Path
1.49                 xml/htdocs/proj/en/devrel/handbook/hb-guide-ebuild.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-ebuild.xml?rev=1.49&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-ebuild.xml?rev=1.49&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-ebuild.xml?r1=1.48&r2=1.49

Index: hb-guide-ebuild.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-ebuild.xml,v
retrieving revision 1.48
retrieving revision 1.49
diff -u -r1.48 -r1.49
--- hb-guide-ebuild.xml	19 Jan 2008 20:17:19 -0000	1.48
+++ hb-guide-ebuild.xml	6 Apr 2008 15:01:13 -0000	1.49
@@ -359,214 +359,11 @@
 <p><b>Variables</b></p>
 
 <p>
-The first part of every ebuild file is made up of a number of variables.  
-They fall under 3 categories (and are marked below):
+The first part of every ebuild file is made up of a number of variables.
+See the <uri link="http://devmanual.gentoo.org/ebuild-writing/variables/index.html">
+devmanual</uri> for information on the different variables.
 </p>
 
-<ul>
-<li>READ: variables you can utilize but <e>never set</e></li>
-<li>MUST: variables you <e>must always set</e></li>
-<li>OPT: variables that you should set</li>
-</ul>
-
-<table>
-<tr>
-  <th>Variable</th>
-  <th>Usage</th>
-  <th>Description</th>
-</tr>
-<tr>
-  <ti><c>P</c></ti>
-  <ti>READ</ti>
-  <ti>The name and version of the package.</ti>
-</tr>
-<tr>
-  <ti><c>PN</c></ti>
-  <ti>READ</ti>
-  <ti>The name of the package.</ti>
-</tr>
-<tr>
-  <ti><c>PV</c></ti>
-  <ti>READ</ti>
-  <ti>The version of the package.</ti>
-</tr>
-<tr>
-  <ti><c>PR</c></ti>
-  <ti>READ</ti>
-  <ti>Contains the revision number or <c>r0</c> if no revision number exists.</ti>
-</tr>
-<tr>
-  <ti><c>PVR</c></ti>
-  <ti>READ</ti>
-  <ti>Contains the version number with the revision.</ti>
-</tr>
-<tr>
-  <ti><c>PF</c></ti>
-  <ti>READ</ti>
-  <ti>Contains the full package name <c>${PN}-${PVR}</c>.</ti>
-</tr>
-<tr>
-  <ti><c>A</c></ti>
-  <ti>READ</ti>
-  <ti>
-    Space delimited list of the filenames in <c>SRC_URI</c>.  This does not 
-    contain the URL paths, just the filename.
-  </ti>
-</tr>
-<tr>
-  <ti><c>DISTDIR</c></ti>
-  <ti>READ</ti>
-  <ti>
-    Contains the path to the <path>distfiles</path> directory where all the
-    files fetched for a package are stored. Typically, this is
-    <path>/usr/portage/distfiles</path>.
-  </ti>
-</tr>
-<tr>
-  <ti><c>FILESDIR</c></ti>
-  <ti>READ</ti>
-  <ti>
-  Contains the path to the <path>files</path> sub folder in the package specific
-  location in the portage tree. Do not modify this variable.
-  </ti>
-</tr>
-<tr>
-  <ti><c>WORKDIR</c></ti>
-  <ti>READ</ti>
-  <ti>
-    Base of the build root for the ebuild.  Nothing should be built outside of 
-    this directory.
-  </ti>
-</tr>
-<tr>
-  <ti><c>S</c></ti>
-  <ti>OPT</ti>
-  <ti>
-    The source directory for your package; commonly <c>${WORKDIR}/${P}</c>.  
-    Portage will default to this value so you may not have to set it!
-  </ti>
-</tr>
-<tr>
-  <ti><c>T</c></ti>
-  <ti>READ</ti>
-  <ti>
-    The temporary directory for your package.  It is used as a virtual 
-    <path>/tmp</path> directory while processing the ebuild.
-  </ti>
-</tr>
-<tr>
-  <ti><c>D</c></ti>
-  <ti>READ</ti>
-  <ti>
-    The root directory that the package is installed to, treat it as the 
-    virtual <path>/</path>.
-  </ti>
-</tr>
-<tr>
-  <ti><c>SLOT</c></ti>
-  <ti>MUST</ti>
-  <ti>
-    Portage handles different versions of the same installed programs.  If you 
-    would want, say GCC 2.95 and GCC 3.2 installed at the same time, you would 
-    specify the <c>SLOT</c> in each ebuild.  Here we would set the <c>SLOT</c> 
-    of GCC 2.95 to <c>2</c> while we would set the <c>SLOT</c> of GCC 3.2 to 
-    <c>3</c>.
-    <br/>
-    <b>Note</b>: Using <c>0</c> as the <c>SLOT</c> value signifies that this
-    package only has 1 <c>SLOT</c> setting (in other words, this package is not
-    SLOTable).
-  </ti>
-</tr>
-<tr>
-  <ti><c>LICENSE</c></ti>
-  <ti>MUST</ti>
-  <ti>
-    This variable specifies what license the program is covered under, i.e. 
-    GPL-2, BSD, etc...  This field must be set to a valid license (which is 
-    any license found in <path>/usr/portage/license/</path>).  If the license 
-    does not already exist there, it must be added before the ebuild can be 
-    added to the portage tree. If the license does not allow redistribution,
-    make sure you place <c>RESTRICT</c>="nomirror" in the ebuild.
-  </ti>
-</tr>
-<tr>
-  <ti><c>KEYWORDS</c></ti>
-  <ti>MUST</ti>
-  <ti>
-    This variable now supports a couple of different functions.  First
-    of all, this variable specifies what architecture the ebuild is
-    meant for. Some example keywords include: <e>x86, ppc, sparc,
-    mips, alpha, arm, hppa, amd64 and ia64</e>. See the
-    profiles/arch.list file in the Portage tree for more
-    details. 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 <c>KEYWORDS</c>
-    variable. Packages that do not support the native architecture are
-    automatically masked by Portage. If the <c>KEYWORDS</c> flag has
-    a preceding <e>~</e>, 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 <c>KEYWORDS</c> flag has a preceding <e>-</e>, then the
-    package does not work with the given keyword.  If there is nothing
-    leading <c>KEYWORDS</c>, then the package is considered stable.
-    You can allow installation of these different types of packages
-    through the <c>ACCEPT_KEYWORDS</c> variable in
-    <path>make.conf</path>.
-  </ti>
-</tr>
-<tr>
-  <ti><c>DESCRIPTION</c></ti>
-  <ti>MUST</ti>
-  <ti>A <e>short</e>, one line description of your package.</ti>
-</tr>
-<tr>
-  <ti><c>SRC_URI</c></ti>
-  <ti>MUST</ti>
-  <ti>
-    The URLs for every source file in your package, separated by
-    whitespace. You should try not to include version numbers in the
-    SRC_URI and S. Always try to use ${PV} or ${P}, and if a version
-    number is not consistent with the name of the source package, make
-    a ${MY_P} variable and use that instead.
-  </ti>
-</tr>
-<tr>
-  <ti><c>HOMEPAGE</c></ti>
-  <ti>MUST</ti>
-  <ti>
-    The homepage of the package. If you are unable to locate an official one, 
-    try to provide a link from <uri link="http://freshmeat.net/">freshmeat.net</uri>
-    or a similar package tracking site. Never refer to a variable name in
-    the string; include only raw text.
-  </ti>
-</tr>
-<tr>
-  <ti><c>IUSE</c></ti>
-  <ti>MUST</ti>
-  <ti>
-    This is set to whatever <c>USE</c> variables your package utilizes.  
-    Remember that <c>KEYWORDS</c> should not be listed in here!
-  </ti>
-</tr>
-<tr>
-  <ti><c>DEPEND</c></ti>
-  <ti>OPT</ti>
-  <ti>
-    The package's build dependencies are listed here.  See the section 
-    <uri link="#doc_chap5">Package Dependencies</uri> for more details on 
-    proper syntax.
-  </ti>
-</tr>
-<tr>
-  <ti><c>RDEPEND</c></ti>
-  <ti>OPT</ti>
-  <ti>
-    The package's runtime dependencies are listed here.  Once again, see
-    <uri link="#doc_chap5">Package Dependencies</uri> for more details.
-  </ti>
-</tr>
-</table>
-
 <p><b>Functions</b></p>
 
 <p>
@@ -1556,8 +1353,8 @@
   <ti>N/A</ti>
 </tr>
 <tr>
-  <ti><c>digest</c>*</ti>
-  <ti>Creates a digest file for the package</ti>
+  <ti><c>manifest</c>*</ti>
+  <ti>Creates a Manifest file for the package</ti>
   <ti>N/A</ti>
 </tr>
 <tr>



-- 
gentoo-commits@lists.gentoo.org mailing list