diff options
Diffstat (limited to 'bitbake/doc')
5 files changed, 66 insertions, 20 deletions
diff --git a/bitbake/doc/Makefile b/bitbake/doc/Makefile index 8e98c57eb1..3c28f4b222 100644 --- a/bitbake/doc/Makefile +++ b/bitbake/doc/Makefile @@ -11,7 +11,7 @@ # validate: validates # clean: removes files # -# The Makefile generates an HTML and PDF version of every document. The +# The Makefile generates an HTML version of every document. The # variable DOC indicates the folder name for a given manual. # # To build a manual, you must invoke 'make' with the DOC argument. @@ -21,8 +21,8 @@ # make DOC=bitbake-user-manual # make pdf DOC=bitbake-user-manual # -# The first example generates the HTML and PDF versions of the User Manual. -# The second example generates the HTML version only of the User Manual. +# The first example generates the HTML version of the User Manual. +# The second example generates the PDF version of the User Manual. # ifeq ($(DOC),bitbake-user-manual) @@ -31,9 +31,9 @@ XSLTOPTS = --stringparam html.stylesheet bitbake-user-manual-style.css \ --stringparam section.autolabel 1 \ --stringparam section.label.includes.component.label 1 \ --xinclude -ALLPREQ = html pdf tarball -TARFILES = bitbake-user-manual-style.css bitbake-user-manual.html bitbake-user-manual.pdf figures/bitbake-title.png -MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf +ALLPREQ = html tarball +TARFILES = bitbake-user-manual-style.css bitbake-user-manual.html figures/bitbake-title.png +MANUALS = $(DOC)/$(DOC).html FIGURES = figures STYLESHEET = $(DOC)/*.css diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml index 0dff736dea..21337208a1 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml @@ -345,7 +345,7 @@ A special value of "now" causes the checkout to be updated on every build. </para></listitem> - <listitem><para><emphasis><filename>CVSDIR</filename>:</emphasis> + <listitem><para><emphasis><link linkend='var-CVSDIR'><filename>CVSDIR</filename></link>:</emphasis> Specifies where a temporary checkout is saved. The location is often <filename>DL_DIR/cvs</filename>. </para></listitem> @@ -394,7 +394,8 @@ Effectively, you are renaming the output directory to which the module is unpacked. You are forcing the module into a special - directory relative to <filename>CVSDIR</filename>. + directory relative to + <link linkend='var-CVSDIR'><filename>CVSDIR</filename></link>. </para></listitem> <listitem><para><emphasis>"rsh"</emphasis> Used in conjunction with the "method" parameter. @@ -435,9 +436,9 @@ The executable used is specified by <filename>FETCHCMD_svn</filename>, which defaults to "svn". - The fetcher's temporary working directory is set - by <filename>SVNDIR</filename>, which is usually - <filename>DL_DIR/svn</filename>. + The fetcher's temporary working directory is set by + <link linkend='var-SVNDIR'><filename>SVNDIR</filename></link>, + which is usually <filename>DL_DIR/svn</filename>. </para> <para> @@ -491,8 +492,9 @@ This fetcher submodule fetches code from the Git source control system. The fetcher works by creating a bare clone of the - remote into <filename>GITDIR</filename>, which is - usually <filename>DL_DIR/git2</filename>. + remote into + <link linkend='var-GITDIR'><filename>GITDIR</filename></link>, + which is usually <filename>DL_DIR/git2</filename>. This bare clone is then cloned into the work directory during the unpack stage when a specific tree is checked out. This is done using alternates and by reference to diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml index 4ce7ed9f8c..fd5a92316c 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml @@ -471,7 +471,7 @@ ERROR: Unable to parse base: ParseError in configuration INHERITs: Could not inh Time: 00:00:00 Parsing of 1 .bb files complete (0 cached, 1 parsed). 1 targets, 0 skipped, 0 masked, 0 errors. NOTE: Resolving any missing task queue dependencies - NOTE: Preparing runqueue + NOTE: Preparing RunQueue NOTE: Executing RunQueue Tasks ******************** * * diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml index 0dd543bcc0..0dafb03250 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml @@ -1140,8 +1140,6 @@ <filename>DISPLAY</filename> variable. Here is an example: <literallayout class='monospaced'> - BB_ORIGENV - add example? - origenv = d.getVar("BB_ORIGENV", False) bar = origenv.getVar("BAR", False) </literallayout> diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml index 988719d038..f5e5e61b1e 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml @@ -43,8 +43,8 @@ <link linkend='var-DEFAULT_PREFERENCE'>D</link> <link linkend='var-EXCLUDE_FROM_WORLD'>E</link> <link linkend='var-FAKEROOT'>F</link> -<!-- <link linkend='var-GROUPADD_PARAM'>G</link> --> - <link linkend='var-HOMEPAGE'>H</link> + <link linkend='var-GITDIR'>G</link> + <link linkend='var-HGDIR'>H</link> <!-- <link linkend='var-ICECC_DISABLED'>I</link> --> <!-- <link linkend='var-glossary-j'>J</link> --> <!-- <link linkend='var-KARCH'>K</link> --> @@ -1154,6 +1154,15 @@ </glossdef> </glossentry> + <glossentry id='var-BZRDIR'><glossterm>BZRDIR</glossterm> + <glossdef> + <para> + The directory in which files checked out of a Bazaar + system are stored. + </para> + </glossdef> + </glossentry> + </glossdiv> <glossdiv id='var-glossary-c'><title>C</title> @@ -1168,6 +1177,15 @@ </glossdef> </glossentry> + <glossentry id='var-CVSDIR'><glossterm>CVSDIR</glossterm> + <glossdef> + <para> + The directory in which files checked out under the + CVS system are stored. + </para> + </glossdef> + </glossentry> + </glossdiv> <glossdiv id='var-glossary-d'><title>D</title> @@ -1412,13 +1430,32 @@ </glossdiv> -<!-- + <glossdiv id='var-glossary-g'><title>G</title> + + <glossentry id='var-GITDIR'><glossterm>GITDIR</glossterm> + <glossdef> + <para> + The directory in which a local copy of a Git repository + is stored when it is cloned. + </para> + </glossdef> + </glossentry> + </glossdiv> ---> + <glossdiv id='var-glossary-h'><title>H</title> + <glossentry id='var-HGDIR'><glossterm>HGDIR</glossterm> + <glossdef> + <para> + The directory in which files checked out of a Mercurial + system are stored. + </para> + </glossdef> + </glossentry> + <glossentry id='var-HOMEPAGE'><glossterm>HOMEPAGE</glossterm> <glossdef> <para>Website where more information about the software the recipe is building @@ -2100,6 +2137,15 @@ </glossdef> </glossentry> + <glossentry id='var-SVNDIR'><glossterm>SVNDIR</glossterm> + <glossdef> + <para> + The directory in which files checked out of a Subversion + system are stored. + </para> + </glossdef> + </glossentry> + </glossdiv> <glossdiv id='var-glossary-t'><title>T</title> |