Commit Graph

133 Commits

Author SHA1 Message Date
Robert P. J. Day 4df50d3827 bitbake: bitbake-user-manual-intro.xml: Minor edits to start of intro chapter
(Bitbake rev: 4e5db4bc460c12194a233dd283c273009606bb64)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 11:00:57 +01:00
Robert Yang b62b682aef bitbake: bitbake-user-manual-metadata.xml: Replaced "populate_staging"
There is no "populate_staging" any longer, should be
"populate_sysroot".

(Bitbake rev: dbe5902e64259e2143f09ab1aa9afa03aa02f4c4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 11:00:57 +01:00
Scott Rifenbark 435e425976 bitbake: bitmake-user-manual-fetching.xml: Added transportuser parameter for SVN
Fixes [YOCTO #6475]

A new parameter has been added to make sure the user is not
passed as the username for the subversion commands with the
SVN fetcher.

(Bitbake rev: 366c70dbb0e9916f50ce1a4ff3ad4bd2757832a3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 11:00:56 +01:00
Scott Rifenbark 70439569c8 bitbake: bitbake-user-manual-ref-variables.xml: Edits to OVERRIDES variable.
More detail.

(Bitbake rev: 0ac8a504de1798dae02eb2dade2776e7e25d034d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:57 +01:00
Robert P. J. Day 0b96a4ba62 bitbake: bitbake-user-manual-execution.xml: Minor fixes.
Collection of typo and grammar fixes from "Execution"
chapter.

(Bitbake rev: ebca1b7847ff34213e6da71c79f00cb4b6b0757b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:57 +01:00
Robert P. J. Day 538cbf4932 bitbake: bitbake-user-manual-intro.xml: Minor fixes mostly grammar adjustments.
(Bitbake rev: fedc5470e9f4f5438d3de957f47985f76a484533)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:56 +01:00
Scott Rifenbark ac8ac1724d bitbake: bitbake-user-manual-fetching.xml: Small fix in Git Fetcher
Fixed how we refer to the "rev" paramater.

(Bitbake rev: 90b1aec42cd29716f1cbd058757941cbfda235b0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:56 +01:00
Robert P. J. Day 3a7258afd5 bitbake: bitbake-user-manual-execution.xml: Typo and grammar fixes.
(Bitbake rev: c469ceb86c1f76e9fa867ffb8a5c9b120ed7942b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:56 +01:00
Scott Rifenbark 00ade7ecd0 bitbake: bitbake-user-manual-execution.xml: Edits to "Providers and Preferences"
I split this section into two sections and tried to simplify what
was being said about PROVIDES.

(Bitbake rev: 394f64123d5ef1e9b4628d083488b9432eccbded)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:56 +01:00
Scott Rifenbark 0736649c57 bitbake: bitbake-user-manual-fetching.xml: Small wording change.
(Bitbake rev: 66529a17d50bbce211361d98ace012b9424459c9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:56 +01:00
Scott Rifenbark 157c80f488 bitbake: bitbake-user-manual-ref-variables.xml: Edits to PROVIDES variable.
Added some more detail to help describe the variable.

(Bitbake rev: 4b2019e67324f0f86e1a49d256eddb4f9ca597f4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:56 +01:00
Scott Rifenbark 41b46d7826 bitbake: bitbake-user-manual-style.css: Added permalink style for display
Fixes [YOCTO #5772]

Added a couple styles to the CSS style sheet so that the displayed
permalink symbol is barely visible unless you hover over it with
the mouse.

(Bitbake rev: ee8db0cda1c8716ab0151a4859bfff84b2f3bd58)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:56 +01:00
Scott Rifenbark d3e1ce60b1 bitbake: bitbake-user-manual-customization.xsl: Added support for variable permalinks.
Fixes [YOCTO #5772]

Including the gloss-permalink.xsl file in the customization layer
so that making the manual now generates permalinks for each variable
definition in the glossary.

(Bitbake rev: 04467594a599472c367365dffe205bf727c4d592)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:56 +01:00
Scott Rifenbark ca77f37bf8 bitbake: bitbake-user-manual-intro.xml: Edits to "Obtaining BitBake"
Updated the last bullet item that describes a final way to
obtain a copy of BitBake.  The example was too specific regarding
Poky and OE.  So, I made it quite generic and kept with the
convention of not having any specific links from the BitBake
manual into YP docs or such.

(Bitbake rev: a2a3b534871aa23a5d442b93dd9660d5f9e27536)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:55 +01:00
Robert P. J. Day 296bb748f6 bitbake: bitbake-user-manual-intro.xml: Basic proofreading, grammar fixes.
(Bitbake rev: 266a0b5ef41dcc4048e2a4d1c43567568d7449d7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:55 +01:00
Robert P. J. Day 5b1c329804 bitbake: bitbake-user-manual-fetching.xml: Grammar, typo, and tweaks.
Various grammatical and typo tweaks all in fetching chapter, including
moving CVS section after wget section for more logical content flow.

(Bitbake rev: 39bbc8f82894ca521d35645cd618dd131fde38ef)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 13:48:39 +01:00
Scott Rifenbark 8be77bb03f bitbake: bitbake-user-manual-style.css: Removed dead .PNG file
Fixes [YOCTO #6430]

I removed an old .PNG file that is not used.

(Bitbake rev: dc5adbb8ce140b6898f18bb99bac02aac16f2ac8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 13:48:38 +01:00
Scott Rifenbark 74551392b3 bitbake: bitbake-user-manual: Added permalink support.
Fixes [YOCTO #5772]

I added the five XSL templates to the template folder.  I updated
the bitbake-user-manual-customization.xsl layer file to include
the new templates.

(Bitbake rev: e1c24a79ededb2dd4ac5ce09fcfdf93218261907)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 13:48:38 +01:00
Scott Rifenbark c65de86d81 bitbake: bitbake-user-manual-customization.xsl: Removed stale TOC variable.
I deleted the commented out xsl:param line that attempts to
set labeling for Appendices.  It had been replaced by a working
line.

(Bitbake rev: bf79174e02cc113e0512bcadc3ab0fdffd138215)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 13:48:38 +01:00
Scott Rifenbark d87cb56aa8 bitbake: bitbake-user-manual-fetching.xml: Edits to the Git Submodule fetcher section.
Exchanged "SRC_URI" for "URI" for clarity.

(Bitbake rev: 90cc450671eaabf917c10a8d01b729b6bc0f544c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 13:48:38 +01:00
Scott Rifenbark 77166a2a88 bitbake: bitbake-user-manual-fetching.xml: Added new Git Submodule Fetcher section.
Added the "GIT Submodule Fetcher (gitsm://)" section to the
fetchers chapter.  This information was provided by Chris
Morgan.

Reported-by: Chris Morgan <chmorgan@gmail.com>
(Bitbake rev: a3a3331e7118fd3139fe5a80b157a5a5b38631de)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 13:48:38 +01:00
Chris Morgan 09edf20070 bitbake: fetch2/gitsm: Documentation improvements for gitsm:// fetcher
(Bitbake rev: ef2bf63e56b87e19d1a9059dd2d81a9a1a537254)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-19 12:04:34 +01:00
Scott Rifenbark 57e8d56a6b bitbake: bitbake-user-manual-hello.xml: Edits to the "Hello World" Appendix.
Fixes [YOCTO #1973]

These are review changes applied from Paul Eggleton.

(Bitbake rev: 431181705f1bc3fc51439faa04a193debc1d03fd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:19 +01:00
Scott Rifenbark 61a680fb5d bitbake: bitbake-user-manual-hello.xml: First draft of "Hello World" appendix
Fixes [YOCTO #1973]

Added the complete "Hello World" appendix first draft beyond
what Bill Traynor had supplied.

(Bitbake rev: 176baaf3d0f033091f5ab9d9cfb2cec3d25a5442)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:19 +01:00
Scott Rifenbark 4687351d16 bitbake: bitbake-user-manual-hello.xml: Edits to environment for hello world.
Some general edits to the sections that get you set up to run
the "Hello World" example.

(Bitbake rev: 43286d31c22e6e2fa96ba1b82445e85db0a0f18c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:19 +01:00
Scott Rifenbark f1b9c7ea32 bitbake: bitbake-user-manual-metadata.xml: Added section on pathname syntax
Added a brief subsection to the "Basic Syntax" section that
describes the issue using the tilde character (~) when providing
a pathname as part of a statement.  BitBake does not expand
this character like the shell does.  We recommend to not use
it in pathnames.

(Bitbake rev: 8e4c5cee932c3f38d4147c59612d76ca0b002727)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:19 +01:00
Scott Rifenbark ef7fac5bba bitbake: bitbake-user-manual-ref-variables.xml: Edits to the BBPATH variable.
I took the stuff about running bitbake outside the build
directory and removed the note syntax.

(Bitbake rev: 783f29a593ce16a37b275b02f71b3ec918ef8c91)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:19 +01:00
Scott Rifenbark 45880c7235 bitbake: bitbake-user-manual-ref-variables.xml: Fixed BBPATH example
The example used in the note in the BBPATH variable description
had incorrect syntax.  Spaces existed in the BBPATH = statement.
I have removed them.

(Bitbake rev: 896a1c102a4afda0e5d07d009bd7918044f88269)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:19 +01:00
Scott Rifenbark 8f4b4e6f31 bitbake: user-manual-hello.xml: General edits
I worked through the chapter and made some minor edits based
on my user experience.  Part of what I did was to update
the console output for the examples.

(Bitbake rev: 13bf6cf71ff49572c3413435a33d87e5b6a8df0d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:19 +01:00
Scott Rifenbark 1313bacfbe bitbake: bitbake-user-manual-hello.xml: Fixed two broken links.
(Bitbake rev: 7a0948beba2c882de31ec9b98c7740bba230aed9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:19 +01:00
Scott Rifenbark ea4e822b8d bitbake: bitbake-user-manual-metadata.xml: New section on anonymous Python functions
Per Paul Eggleton's suggestion, I added a new section on
anonymous Python functions into the "Functions" section.
I also updated the intro text to account for the added
type of functions.

(Bitbake rev: 983d03c1a082e2b83187f0788e61a7941670b242)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:19 +01:00
Scott Rifenbark 9889a91a5b bitbake: bitbake-user-manual-metadata.xml: Edits to flexible inheritance section.
Fixes [YOCTO #5472]

Applied review edits from Paul Eggleton to this section.
Minor edits and some re-writing.

(Bitbake rev: 7259d9d40aad8254751f7674653cd362a9023054)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:18 +01:00
Richard Purdie 392de9d568 bitbake: doc: Rename user-manual -> bitbake-user-manual
This manual gets combined with other manuals and in that context, it helps
a lot if its seen as the Bitbake User Manual. Renames are a pain but
this is worthwhile so that other docs can correctly be combined with this
one. This also clarifies things like google search results which is helpful.

(Bitbake rev: 452a62ae0c2793e281d6769fd3e45500a74898d6)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:18 +01:00