cvs commit: ALFS/docs/syntax_doc/alfs_dtd elem_else.xml elem_environment.xml elem_execute.xml

jwrober at linuxfromscratch.org jwrober at linuxfromscratch.org
Sun Feb 22 19:09:50 PST 2004


jwrober     04/02/22 20:09:50

  Modified:    docs/syntax_doc/alfs_dtd elem_else.xml elem_environment.xml
                        elem_execute.xml
  Log:
  finished first pass across all elements
  
  Revision  Changes    Path
  1.6       +21 -21    ALFS/docs/syntax_doc/alfs_dtd/elem_else.xml
  
  Index: elem_else.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/elem_else.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- elem_else.xml	4 Nov 2003 03:07:50 -0000	1.5
  +++ elem_else.xml	23 Feb 2004 03:09:50 -0000	1.6
  @@ -7,34 +7,34 @@
   
   <synopsis>
   <!ELEMENT else        (stageinfo?,(configure|copy|download|execute|
  -                                       if|link|make|mkdir|move|ownership|package|
  +                                       if|xref|make|mkdir|move|ownership|package|
                                          patch|permissions|remove|search_replace|
                                          stage|textdump|unpack)*)>
   </synopsis>
   
   <para>This element occurs in the element
  -<link linkend="elem_if">if</link>.
  +<xref xrefend="elem_if">if</xref>.
   </para>
   
   <para>See also :
  -<link linkend="elem_configure">configure</link>,
  -<link linkend="elem_copy">copy</link>,
  -<link linkend="elem_download">download</link>,
  -<link linkend="elem_execute">execute</link>,
  -<link linkend="elem_if">if</link>,
  -<link linkend="elem_link">link</link>,
  -<link linkend="elem_make">make</link>,
  -<link linkend="elem_mkdir">mkdir</link>,
  -<link linkend="elem_move">move</link>,
  -<link linkend="elem_ownership">ownership</link>,
  -<link linkend="elem_package">package</link>,
  -<link linkend="elem_patch">patch</link>,
  -<link linkend="elem_permissions">permissions</link>,
  -<link linkend="elem_remove">remove</link>,
  -<link linkend="elem_search_replace">search_replace</link>,
  -<link linkend="elem_stageinfo">stageinfo</link>,
  -<link linkend="elem_textdump">textdump</link>,
  -<link linkend="elem_unpack">unpack</link>.
  +<xref xrefend="elem_configure">configure</xref>,
  +<xref xrefend="elem_copy">copy</xref>,
  +<xref xrefend="elem_download">download</xref>,
  +<xref xrefend="elem_execute">execute</xref>,
  +<xref xrefend="elem_if">if</xref>,
  +<xref xrefend="elem_xref">xref</xref>,
  +<xref xrefend="elem_make">make</xref>,
  +<xref xrefend="elem_mkdir">mkdir</xref>,
  +<xref xrefend="elem_move">move</xref>,
  +<xref xrefend="elem_ownership">ownership</xref>,
  +<xref xrefend="elem_package">package</xref>,
  +<xref xrefend="elem_patch">patch</xref>,
  +<xref xrefend="elem_permissions">permissions</xref>,
  +<xref xrefend="elem_remove">remove</xref>,
  +<xref xrefend="elem_search_replace">search_replace</xref>,
  +<xref xrefend="elem_stageinfo">stageinfo</xref>,
  +<xref xrefend="elem_textdump">textdump</xref>,
  +<xref xrefend="elem_unpack">unpack</xref>.
   </para>
   
   </sect2>
  @@ -44,7 +44,7 @@
   <title>Description</title>
   
   <para>This element groups the elements that should be executed if
  -the test performed when evaluating an <token>if</token> element isn't satisfied.
  +the test performed when evaluating an <filename>if</filename> element isn't satisfied.
   </para>
   
   </sect2>
  
  
  
  1.8       +32 -36    ALFS/docs/syntax_doc/alfs_dtd/elem_environment.xml
  
  Index: elem_environment.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/elem_environment.xml,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- elem_environment.xml	4 Nov 2003 03:07:50 -0000	1.7
  +++ elem_environment.xml	23 Feb 2004 03:09:50 -0000	1.8
  @@ -8,15 +8,16 @@
   <synopsis>
   <!ELEMENT environment    (variable+)>
   <!ATTLIST environment
  -    mode    CDATA #IMPLIED>
  +          mode           ((append | prepend)?)>
  +
   </synopsis>
   
  -<para>This element occurs in the element
  -<link linkend="elem_stageinfo">stageinfo</link>.
  +<para>This element occurs in the element :  
  +<xref linkend="elem_stageinfo"/>
   </para>
   
  -<para>See also :
  -<link linkend="elem_variable">variable</link>,
  +<para>See also :  
  +<xref linkend="elem_variable"/>
   </para>
   
   </sect2>
  @@ -24,12 +25,12 @@
   <sect2>
   <title>Description</title>
   
  -<para>The element <token>environment</token> allows you to define
  +<para>The element <filename>environment</filename> allows you to define
   one or more environment variables to be added to the system environment
   used when calling the commands of the stage to which it applies.</para>
   
   <para>By default, the supplied value replaces any existing value for the
  -specified variable. The attribute <token>mode</token> allows you to specify
  +specified variable. The attribute <filename>mode</filename> allows you to specify
   whether the supplied value should be prepended or appended to the existing
   value.</para>
   
  @@ -38,31 +39,28 @@
   <sect2>
   <title>Examples</title>
   
  -<programlisting>
  -<stage>
  -    <stageinfo>
  -        <base>/usr/src/gzip.1.2.4a</base>
  -        <environment>
  -            <variable name="GCCFLAGS">-O2</variable>
  -            <variable name="PATH" mode="prepend">/usr/src/gzip.1.2.4a:</variable>
  -            <variable name="LDFLAGS" mode="append"> -s</variable>
  -	    </environment>
  -    </stageinfo>
  -
  -    <configure />
  -
  -    <make />
  -
  -    <make>
  -        <param>install</param>
  -    </make>
  -</stage>
  -</programlisting>
  +<userinput><screen><stage>
  +	<stageinfo>
  +		<base>/usr/src/gzip.1.2.4a</base>
  +	<environment>
  +		<variable name="GCCFLAGS">-O2</variable>
  +		<variable name="PATH" mode="prepend">/usr/src/gzip.1.2.4a:</variable>
  +		<variable name="LDFLAGS" mode="append"> -s</variable>
  +		</environment>
  +	</stageinfo>
  +
  +	<configure />
  +
  +	<make />
  +
  +	<make>
  +		<param>install</param>
  +	</make>
  +</stage></screen></userinput>
   
  -<para>The equivalent bash script is :</para>
  +<para>The equivalent bash script is :</para>
   
  -<programlisting>
  -echo Stage
  +<userinput><screen>echo Stage
   
   export GCCFLAGS=-O2
   export PATH=/usr/src/gzip.1.2.4a:$PATH
  @@ -70,19 +68,17 @@
   
   echo Executing configure
   cd /usr/src/gzip.1.2.4a
  -./configure
  +<command>./configure</command>
   
   echo Executing make
   cd /usr/src/gzip.1.2.4a
  -make
  +<command>make</command>
   
   echo Executing make
   cd /usr/src/gzip.1.2.4a
  -make install
  -
  -echo Exiting stage
  +<command>make install</command>
   
  -</programlisting>
  +echo Exiting stage</screen></userinput>
   
   </sect2>
   
  
  
  
  1.6       +35 -34    ALFS/docs/syntax_doc/alfs_dtd/elem_execute.xml
  
  Index: elem_execute.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/elem_execute.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- elem_execute.xml	4 Nov 2003 03:07:50 -0000	1.5
  +++ elem_execute.xml	23 Feb 2004 03:09:50 -0000	1.6
  @@ -6,21 +6,20 @@
   <title>Syntax</title>
   
   <synopsis>
  -<!ELEMENT execute        (param*)>
  +<!ELEMENT execute        ((param | prefix)*)>
   <!ATTLIST execute
             base           CDATA #IMPLIED
  -          command        CDATA #REQUIRED>
  +          command        CDATA #REQUIRED>
   </synopsis>
   
  -<para>This element occurs in the elements
  -<link linkend="elem_alfs">alfs</link>,
  -<link linkend="elem_alfs">else</link>,
  -<link linkend="elem_stage">stage</link>.
  -and <link linkend="elem_then">then</link>
  +<para>This element occurs in the elements :  
  +<xref linkend="elem_alfs"/>  |  
  +<xref linkend="elem_stage"/>
   </para>
   
  -<para>See also :
  -<link linkend="elem_param">param</link>.
  +<para>See also :  
  +<xref linkend="elem_param"/>  |  
  +<xref linkend="elem_prefix"/>
   </para>
   
   </sect2>
  @@ -28,47 +27,49 @@
   <sect2>
   <title>Description</title>
   
  -<para>The element <token>execute</token> is used to execute an arbitrary command.</para>
  +<para>The element <filename>execute</filename> is one of the many main
  +operation elements. It is used to execute an arbitrary command.</para>
   
  -<para>The attribute <token>base</token> allows to specify the directory
  -in which the command will be executed;</para>
  +<para>The sub-element <filename>param</filename> contains one or many
  +optional parameters of the command.</para>
   
  -<para>The attribute <token>command</token> contains the text of the command itself.</para>
  +<para>The sub-element <filename>prefix</filename> contains any prefix data
  +for the command to execute.</para>
   
  -<para>The subelements <token>param</token> contain parameters of the command.</para>
  +<para>Both sub-elements are optional, but if used can be used more than
  +once.</para>
  +
  +<para>The attribute <filename>base</filename> allows you to specify the
  +directory in which the command will be executed. See 
  +<xref linkend="elem_base"/>.</para>
  +
  +<para>The attribute <filename>command</filename> contains the text of the
  +command itself. See <xref linkend="elem_command"/>.</para>
   
   </sect2>
   
   <sect2>
   <title>Examples</title>
   
  -<para>The first example is an execute command without parameter.</para>
  -
  -<programlisting>
  -<execute command="umount" />
  -</programlisting>
  +<para>The first example is an execute command without a parameter.</para>
   
  -<para>The equivalent bash script is :</para>
  +<userinput><screen><execute command="umount" /></screen></userinput>
   
  -<programlisting>
  -echo Executing 'umount'
  -umount
  -</programlisting>
  +<para>The equivalent bash script is :</para>
   
  +<userinput><screen>echo Executing 'umount'
  +<command>umount</command></screen></userinput>
   
  -<para>The second example is an execute command without one parameter.</para>
  +<para>The second example is an execute command with one parameter.</para>
   
  -<programlisting>
  -<execute command="mount">
  -    <param>/mnfs/lfs</param>
  -</execute>
  -</programlisting>
  +<userinput><screen><execute command="mount">
  +	<param>/mnfs/lfs</param>
  +</execute></screen></userinput>
   
  -<para>The equivalent bash script is :</para>
  +<para>The equivalent bash script is :</para>
   
  -<programlisting>echo Executing 'mount'
  -mount /mnfs/lfs
  -</programlisting>
  +<userinput><screen>echo Executing 'mount'
  +<command>mount /mnfs/lfs</command></screen></userinput>
   
   </sect2>
   
  
  
  



More information about the alfs-log mailing list