Commit Graph

73 Commits

Author SHA1 Message Date
Darren Hart
e12c57e877 handbook: corrent RRECOOMENDS spelling in ref-variables
Correct MACHINE_EXTRA_ESSENTIAL_RRECOOMENDS to
MACHINE_EXTRA_ESSENTIAL_RRECOMMENDS.

Signed-off-by: Darren Hart <dvhart@linux.intel.com>
2010-10-07 10:17:56 +01:00
Richard Purdie
a598c15636 handbook/bsp-guide: Fix typo
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-09-29 15:29:32 +01:00
Richard Purdie
2624b61814 poky-doc-tools: Remove unnecessary autotools usage and simplfy structure
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-09-29 15:27:04 +01:00
Tom Zanussi
73049a3431 handbook: add BSP click-through licensing section
Add a section to the BSB Developer's Guide outlining the motivation
and procedures for click-through BSP licensing support.

The corresponding build system support hasn't been implemented yet;
this is being added now mainly as a guideline wrt future intentions.

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
2010-09-21 23:36:05 +01:00
Tom Zanussi
c0317494aa Fix some typos and grammatical errors in Poky handbook
While going through the BSP section, I noticed some minor problems -
these are my cleanup fixes.

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
2010-09-21 23:35:36 +01:00
Richard Purdie
75bffcd47a handbook: Drop USB Networking section, its no longer appropriate
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-09-10 12:44:56 +01:00
Richard Purdie
ad30f2cc4e handbook: Various minor fixes
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-09-10 12:32:48 +01:00
Yu Ke
0a217cd18f handbook: review and update CH1(introduction) and CH2(using Poky)
Signed-off-by: Yu Ke <ke.yu@intel.com>
Signed-off-by: Kevin Tian <kevin.tian@intel.com>
2010-09-10 12:32:13 +01:00
Dexuan Cui
8627258ac3 handbook: review and modify Appendix A, D and E
Major change are about the structure of Poky source tree, which has been
changed a lot recently

Signed-off-by: Dexuan Cui <dexuan.cui@intel.com>
Signed-off-by: Edwin Zhai <edwin.zhai@intel.com>
Signed-off-by: Kevin Tian <kevin.tian@intel.com>
2010-09-10 12:23:21 +01:00
Zhai Edwin
8c7e1aced8 handbook: review and modify CH4 (BSP) and Appendix B
Besides basic corrections, also add .bbappend to bsp introduction
and update bitbake help to match latest output

Signed-off-by: Zhai Edwin <edwin.zhai@intel.com>
Signed-off-by: Dexuan Cui <dexuan.cui@intel.com>
Signed-off-by: Kevin Tian <kevin.tian@intel.com>
2010-09-10 12:20:44 +01:00
Dongxiao Xu
2beaecb351 handbook: Fix some errors in Appendix F/G
CVS_TARBALL_STASH and SHELLRCCMD is not found in current poky.
Fix some grammar issues.

Signed-off-by: Dongxiao Xu <dongxiao.xu@intel.com>
Signed-off-by: Qing He <qing.he@intel.com>
2010-09-10 12:18:00 +01:00
Lianhao Lu
276abb19ce handbook: review and correct CH5(development)
Signed-off-by: Lianhao Lu <lianhao.lu@intel.com>
Signed-off-by: Liping Ke <liping.ke@intel.com>
2010-09-10 12:17:48 +01:00
Qing He
a6e7652944 handbook: update appendix C/H/I
The following is suggested but not changed:
 - adding documentation of cmake.bbclass
 - remove src_distribute_local.bbclass

Signed-off-by: Qing He <qing.he@intel.com>
Signed-off-by: Dongxiao Xu <dongxiao.xu@intel.com>
2010-09-10 12:14:02 +01:00
Kevin Tian
3c6e1d7c62 handbook: review and correct CH3(extend poky) in handbook
Fix inaccurate descriptions.
Update recipe examples to make sure they do build
Add some examples for better guidance

Signed-off-by: Kevin Tian <kevin.tian@intel.com>
Signed-off-by: Ke Yu <ke.yu@intel.com>
2010-09-10 11:57:31 +01:00
Kevin Tian
a4141e1c11 xset: move DISTRO_PN_ALIAS to distro .inc file
also use space as the delimiter instead of semicolon. fix handbook accordingly

Signed-off-by: Kevin Tian <kevin.tian@intel.com>
2010-09-02 09:38:35 +01:00
Richard Purdie
caab7fc509 Drop chroot usage as its not well used, tested and is broken
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-09-01 15:08:45 +01:00
Saul Wold
e8ac5a76d9 Add glossary entry for SUMMARY for binary packaging
Signed-off-by: Saul Wold <Saul.Wold@intel.com>
2010-08-13 23:37:30 +01:00
Joshua Lock
408f124c86 handbook: update SDK paths
Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-07-22 15:47:41 +01:00
Joshua Lock
971907567c Enable build dir outside of the poky directory
You need to first set up the build directory by sourcing the poky build script,
after that builds can be run in that directory so long as bitbake is in $PATH
removing the need to source the init script for each build.

i.e:
$ . poky-init-build-env ~/my-build
$ bitbake some-image
<<later, in a different shell>>
$ cd ~/my-build
$ export PATH=/path/to/bitbake/bin:$PATH
$ bitbake an-image

This patch also removes use of OEROOT in recipes, etc.

Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-07-21 15:39:53 +01:00
Joshua Lock
c27b951109 handbook: PR should always be set, even if to 0
Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-06-25 14:54:30 +01:00
Joshua Lock
0d62b8d9b7 handbook: update the required dependencies list
The dependencies list in the introduction was missing chrpath and mercurial.
Also adds a note about the packages required to build qemu-native.

Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-06-25 14:54:11 +01:00
Joshua Lock
5101076eab handbook: Fix stylesheet
Some sizes where defined without units (in our case px) causing display of the
header of the handbook to be broken.

Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-06-14 14:33:07 +01:00
Joshua Lock
5735f03d18 handbook: Fix typo in last commit
Managed to mangle the command...

Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-06-14 12:12:55 +01:00
Joshua Lock
45a26b92e3 handbook: fix extraction command
We ship bzipped tarballs now so we need to pass j to tar, not z

Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-06-14 12:07:03 +01:00
Joshua Lock
85982ab6cd handbook: fix version reference
Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-06-14 12:05:50 +01:00
Joshua Lock
c3e09804e5 handbook: Fix references to the stable release
The handbook was still talking about the purple release, we're green now

Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-06-14 12:05:17 +01:00
Joshua Lock
d9062199b4 handbook: Fix generation of HTML handbook
Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-06-11 15:27:23 +01:00
Nitin A Kamble
fd4924087c Add an entry for ${BPN} in the handbook
Signed-off-by: Nitin A Kamble <nitin.a.kamble@intel.com>
2010-06-10 17:34:57 -07:00
Joshua Lock
fcd220b4fd handbook: document the LAYERDIR variable
LAYERDIR is one of the few variables which requires immediate expansion and is
worth documenting explicitly.

Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-06-08 17:53:25 +01:00
Joshua Lock
79f330c6c9 handbook: point out required Python version
Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-06-08 17:29:56 +01:00
Joshua Lock
3a6948a2af handbook: add documentation for layers
Collections and overlays are deprecated in favour of layers, a much cleaner and
non-intrusive way of extending Poky with custom recipes, classes and
configuration.

This patch updates the Extending Poky section of the handbook to show how to
use layers to tailor Poky while dropping  the existing section on using
collections.

Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-06-08 17:29:56 +01:00
Joshua Lock
8f34dcfdbc handbook: Use new style patch application syntax
Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-06-08 17:07:03 +01:00
Joshua Lock
1ccbc1549e handbook: use XML catalogues to make building work on all(?) distros
Thanks to Damien's pointers we should now be able to generate the handbook
regardless of host distro

Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-06-04 20:02:06 +01:00
Nitin A Kamble
6b82b70c93 Handbook: Documentation for DISTRO_PN_ALIAS
Signed-Off-By: Nitin A Kamble <nitin.a.kamble@intel.com
2010-06-02 14:06:03 +01:00
Nitin A Kamble
2ccd2e67c5 Handbook: Documentation for LIC_FILES_CHKSUM
Signed-off-by: Nitin A Kamble <nitin.a.kamble@intel.com>
2010-06-02 14:06:02 +01:00
Richard Purdie
d630317b6b handbook: Add alpha verison of a BSP specification
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-05-26 15:26:09 +01:00
Richard Purdie
f71a4b9be8 handbook: Add section to Poky manual about contributions and certificate of origin
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-05-14 11:17:54 +08:00
Richard Purdie
37858f5fac handbook: Add new FAQs
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-05-06 10:29:14 +01:00
Joshua Lock
6458da896f Fix references to CROSS_DIR now that it has been removed
CROSS_DIR is no longer removed so fix up classes, packages and documentation
which refer to it.

Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-04-28 16:47:14 +01:00
Joshua Lock
9b3a51fbd8 handbook: Update links to Anjuta plugin
Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-03-26 10:29:18 +00:00
Joshua Lock
62cd0ea1a5 handbook: remove OpenedHand contact information
Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-03-19 10:23:23 +00:00
Richard Purdie
5b5f1ba099 handbook: Add a section on extending images using packages
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-03-18 23:47:48 +00:00
Richard Purdie
b3f5e554d0 handbook: Publishing tweaks
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-03-18 23:31:35 +00:00
Richard Purdie
d2805818aa handbook: Add missing tag
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-03-18 23:23:25 +00:00
Richard Purdie
de9c12bea2 handbook/faq: Add entry about building on NTFS
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-03-18 21:40:11 +00:00
Joshua Lock
1eb093938b handbook: Correction, we're building QEMU x86 not QEMU Arm image
Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-03-18 16:10:42 +00:00
Joshua Lock
208f6a9ec0 handbook: update references of stable version number
Signed-off-by: Joshua Lock <josh@linux.intel.com>
2010-03-18 16:10:42 +00:00
Richard Purdie
ffb5db2c57 handbook: Clean up OpenedHand references
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-03-18 15:50:08 +00:00
Richard Purdie
05324ae0cd handbook: Various tweaks for recent fop/pdf generation
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-03-18 15:37:59 +00:00
Richard Purdie
4c07b33f14 poky-doc-tools: Update to work with fop >= 0.95
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-03-18 15:36:58 +00:00