Commit Graph

577 Commits

Author SHA1 Message Date
Paul Eggleton 954444f1d3 documentation: update documentation for SRCREV variable
* Add note about specifying a full revision ID to prevent querying the
  remote server on every parse
* Mercurial also supports this variable

(From yocto-docs rev: 47ce273dd751b0ae32b5c53310b6aedc4dade2ef)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:37 -07:00
Paul Eggleton 1e18d85170 documentation: set titles for all documents
These documents do not have titles when showing up on the website; set
the title tag value so that they do.

(From yocto-docs rev: baf958e3f49317689275b14dd31c6141f36c8c65)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:37 -07:00
Paul Eggleton cf65497076 documentation: update BBFILE_* variable documentation
* Add documentation of LAYERVERSION, LAYERDEPENDS and new layer priority
  behaviour
* Improve some wording

(From yocto-docs rev: be7c10f3b8b35ff231e5974a48936e66fd49fcbc)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:37 -07:00
Paul Eggleton 75fc3840aa documentation: update for directdisk/live image changes
-live and -directdisk image have been removed; add a tip about using the
live option in IMAGE_FSTYPES to build any image as a live image.

(From yocto-docs rev: ef7c508a4073c4f04c2368420e64a5d6620c8fbc)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:37 -07:00
Paul Eggleton 23a7eec172 documentation: update TERMCMD/TERMCMDRUN documentation
* xterm is now the default
* Konsole from KDE 4.x will no longer work due to changes in behaviour

(From yocto-docs rev: 031a619ca19dbc2011a4df7bba1c332f2770e15d)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:36 -07:00
Paul Eggleton 547ba60f85 documentation: ensure all examples have LIC_FILES_CHKSUM
We really need to have LIC_FILES_CHKSUM in all of our example recipes,
because it is now mandatory.

(From yocto-docs rev: 76998b7c54246e0505cf01b21d65d04ab285f1f0)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:36 -07:00
Paul Eggleton 3906b60791 documentation: improve LIC_FILES_CHKSUM documentation
Document that LIC_FILES_CHKSUM is mandatory, when gets validated, and
improve some wording.

(From yocto-docs rev: ca878d7b0c84812ef29bbaf5894c96dd89500ec9)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:36 -07:00
Paul Eggleton 88c16945fa documentation: SITEINFO_ENDIANESS -> SITEINFO_ENDIANNESS
This variable was renamed (to match OE) in the Yocto 1.1 development
cycle.

(From yocto-docs rev: 5cda8fe3b5dd18b629ccd13427da3b5743ae66ce)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:36 -07:00
Paul Eggleton e4e0d026c1 documentation: typo, spelling & minor grammar fixes
(From yocto-docs rev: a5b069b04979a566b08415cf27af2ad6abf90f2f)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:35 -07:00
Paul Eggleton 82fd0556c2 documentation: manpage -> help output
Replace the reference to this being the manpage.

(From yocto-docs rev: ebb689a8ccc2aaf5d21341c69899588e77d5172c)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:35 -07:00
Paul Eggleton 6ca8903629 documentation: correct QT to Qt
(From yocto-docs rev: 37ac4cbd61bc8c891aa6dc05baf632a0a4bfd906)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:35 -07:00
Scott Rifenbark 51351e3f93 documentation/yocto-project-qs/yocto-project-qs.xml: Fixed manual references
I changed the references to the Poky Reference Manual to the Yocto Project
Reference Manual.  I also changed 'poky-qemu' command to 'runqemu'.

(From yocto-docs rev: f46003eab91d1f682113b9e0672efd486a509ec6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:08 -07:00
Scott Rifenbark d02f6b0c23 documentation/poky-ref-manual/ref-variables.xml: Fixed links
The links to the lettered divisions of the glossary do not work.
I changed them to the first entry for each lettered area.

(From yocto-docs rev: b7692bcfa19fb940a050c0cf72dc2f7e427b8ba7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:08 -07:00
Scott Rifenbark 94638de796 documentation/poky-ref-manual/ref-varlocality.xml: Reformatted
This appendix had poor organization.  I re-organized it according
to configuration and recipe context.  The sub-sections break out much
more nicely now.

(From yocto-docs rev: 7a3a7b3a7b4861122194ea0a78c16af531f0078b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:07 -07:00
Scott Rifenbark 61d65d11df documentation/poky-ref-manual/introduction.xml: Title changed.
(From yocto-docs rev: 244c632812f10a3dc79eb814caf1449c50655e36)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:07 -07:00
Scott Rifenbark 638ffa90db documentation/poky-ref-manual/ref-variables.xml: Fixed default format
In the document, several variables state their default values. I set the
formatting to surround a default value with double quotes in all cases.

I also fixed a typo for "RECOMMEDNS"

(From yocto-docs rev: 3da85f54df6fd4ad64d5be2cc9ae0e6dd50a68f5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:07 -07:00
Scott Rifenbark 70bd76e658 documentation/poky-ref-manual/ref-variables.xml: Scrubbed for Poky
I also fixed formatting and some minor wordings.

(From yocto-docs rev: b1bbfe89cb250ef5267fb16635dc41338aab0c59)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:06 -07:00
Scott Rifenbark 7a59fbde96 documentation/poky-ref-manual/ref-variables.xml: partial edits.
(From yocto-docs rev: e8300735591f0b47aff64200a2dff477b5bfd9b2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:06 -07:00
Scott Rifenbark 87f4bfd0a3 documentation/poky-ref-manual/ref-features.xml: Cleaned up list formatting.
(From yocto-docs rev: 1813848d673dedae6b918676eec1f3926ee630f2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:06 -07:00
Scott Rifenbark 5b171729f2 documentation/poky-ref-manual/ref-images.xml: Reformats of the Docbook code.
(From yocto-docs rev: 8b334782415a428724023af0e6ee8a0ee5aa79f6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:06 -07:00
Scott Rifenbark 95ef8d7a2e documentation/poky-ref-manual/ref-classes.xml: Scrubbed for Poky
I changed the "Poky" references to "the Yocto Project" and performed
general edits where necessary.

(From yocto-docs rev: a7ef3e7d5c792bde5231b9302e614cb7b5db81b7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:05 -07:00
Scott Rifenbark 32a860851c documentation/poky-ref-manual/ref-bitbake.xml: scrubbed for Poky
I swapped the Yocto Project for Poky throughout.  Some other general
edits were done.  I put in a reference to a spot to learn how to best
set the BB_NUMBER_THREADS variable.

(From yocto-docs rev: 2543a915957014a59e6c49a1cdde270725d47af3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:05 -07:00
Scott Rifenbark 39de08c105 documentation/poky-ref-manual/ref-structure.xml: Scrubbed for Poky and edits
I converted "Poky" to "the Yocto Project."  I also updated several examples.
In particular the build/tmp/work example.

(From yocto-docs rev: eb82bc36904f502fb4f314ff05eb86cff27ce0b6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:05 -07:00
Scott Rifenbark cde376cc04 documentation/poky-ref-manual: Removed figures from file structure.
The poky-beaver.png, poky-log.svg, and white-on-black-yp.png
figures are not used and do not need to be in the file structure
for this manual.

(From yocto-docs rev: c2217102813fc0a72922bf2baf24e07184cf24e3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:04 -07:00
Scott Rifenbark 31d594802f documentation/bsp-guide/bsp.xml: General updates
I added a parallel textual construct at the beginning of each section
that details a directory in the Yocto Project file's structure.
I did not like starting these sections with a literallayout string.

(From yocto-docs rev: 5dde476f0c02d655217f3fa863522e8b7df57cda)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:04 -07:00
Scott Rifenbark 8fd890a8ec documentation/Makefile: Removed sato image from tarfile list in poky-ref-manual.
(From yocto-docs rev: 350ba4e6c799ec0c98bd50f097815306e0911f37)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:04 -07:00
Scott Rifenbark ec6b3071eb documentation/poky-ref-manual/figures/ss-sato.png: deleted figure.
(From yocto-docs rev: 29a5c1da4695fc8a5979c3d095f87879c0b267ce)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:04 -07:00
Scott Rifenbark 10ddfd6f51 documentation/poky-ref-manual/extendpoky.xml: scrubbed for Poky
Converted to Yocto Project from Poky.

(From yocto-docs rev: 0263e8b29efeff051184ce1700da9559ea511faf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:03 -07:00
Scott Rifenbark 776834d63b documentation/poky-ref-manual/development.xml: Garman's partial review comments
(From yocto-docs rev: 329401ac13e60381ca74a617ae398586cbd5dfed)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:03 -07:00
Scott Rifenbark ed4caadd13 documentation/poky-ref-manual/development.xml: updates for YP terms
I updated the profiling sections to reflect Yocto Project rather than
Poky.

(From yocto-docs rev: 4f2c3bc93d97a6a8676fdd14ff9061bb92bdf5c9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:03 -07:00
Scott Rifenbark 90d5834ad2 documentation/poky-ref-manual/usingpoky.xml: small edits to list and title
I added emphasis to a bulleted list and I also updated a section title
to reflect Yocto Project instead of Poky.

(From yocto-docs rev: f967aff5c0a0047ef44145c6a95da84e57c255b1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:02 -07:00
Scott Rifenbark e384051ded documentation/poky-ref-manual/introduction.xml: re-write for YP
I re-wrote and reorganzied this chapter to reflect the book as
a Yocto Project Reference Guide.

(From yocto-docs rev: ef3c3955ab0cedb57d9ae48041ed94806fe34001)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:02 -07:00
Scott Rifenbark 7f9b16defb documentation/poky-ref-manual/resources.xml: Changed title
Changed the title to refelect the Yocto Project and not Poky.

(From yocto-docs rev: 151c1925659e986b27866fed5abfcba96744b204)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:02 -07:00
Scott Rifenbark 8aa163ba69 documentation/poky-ref-manual: Changed top-level titles
Each of these chapters needed the title changes to reflect Yocto
Project and not Poky.

(From yocto-docs rev: a6d8d01b20af334ca9950c4287d61a728532f652)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:02 -07:00
Scott Rifenbark 295b855fc9 documentation/poky-ref-manual/usingpoky.xml: re-write for Yocto
General re-write to make the chapter Yocto Project friendly.
Weeded out the references to "Poky."

(From yocto-docs rev: ac4fc6082f458e5ee60962693ee332bbf1e3c1a9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:01 -07:00
Scott Rifenbark 00d483d65a documentation/poky-ref-manual/usingpoky.xml: YOCTO #1001 - new section added
YOCTO #1001 - created a new section to address this issue.  This is the
first draft.  Darren to provide review comments.

(From yocto-docs rev: fc2aee572cc3e620684533a12a2d8436dc0abe32)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:01 -07:00
Scott Rifenbark 8165eefb1f documentation/dev-manual/figures: Figure updates
Not sure if I need to commit these again.  They are showing up in the
git status command so I might have updated them and forgot to commit
them.  Doing so to be sure.

(From yocto-docs rev: 75c87592c10647ec09f42a1363a8ae123cd6e33d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:38 -07:00
Scott Rifenbark 96f0c57a0a documentation/poky-ref-manual/development.xml: re-write of software dev section
This is a comprehensive pass through this entire section that incorporates
understanding given to me by Scott Garman.  I have added more detail and
text that helps the non-developer understand what is fundamentally going
on.

(From yocto-docs rev: 124c722ccf0316f6e62790ca77c88d0444559378)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:37 -07:00
Scott Rifenbark 34de499685 documentation/dev-manual/dev-manual-newbie.xml: Updated term list.
I added a reference to the Image appendix for the description of
images.  Also, added a new term "meta-toolchain."

(From yocto-docs rev: a9c1110ec7499afa669416c00bc81573fcbf920d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:37 -07:00
Scott Rifenbark 266b83c8e1 documentation/poky-ref-manual/development.xml: Updated software dev intro
Added more general description of what this section's purpose it.
I felt it was missing some basic information and making too many
assumptions.

(From yocto-docs rev: 4a5faeecc616313147283e50fe947c68555f55a2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:37 -07:00
Scott Rifenbark 45aa3ff3b8 documentation/poky-ref-manual/figures/poky-title.png: Changed Title
It seems that this manual should be named the yocto project reference
manual as we slowly try to rid ourselves of the "Poky" term.

(From yocto-docs rev: c9d30285adf83bbcfc06233be54aec4203cbfd13)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:36 -07:00
Scott Rifenbark 1e789e60b5 documentation/dev-manual: Incorporated Joshua Lock's review comments.
(From yocto-docs rev: d4bf6343d7575ff96030242e2025570db52b515b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:36 -07:00
Scott Rifenbark 0a2e82c007 documentation/poky-ref-manual/usingpoky.xml: Fixed double dash display.
In the PDF version of the manual the "&dash;&dash;" docbook statement
does not display correctly.  I changed this to "--".

(From yocto-docs rev: b0596e0ce370d6c6e1680e89d9c5a5b9da26dd93)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:36 -07:00
Scott Rifenbark 73be798329 documentation/yocto-project-qs/yocto-project-qs.xml: fixed double dash
In the PDF version of the manual the "&dash;&dash;" statement does not
display correctly.  I changed this to "--".

(From yocto-docs rev: ae3a5bc15d30668b6f9048245f70dcd82f89da32)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:35 -07:00
Scott Rifenbark 9346231745 documentation/adt-manual/adt-prepare.xml: changed 1.0 to 1.1
In anticipation of 1.1 I have changes several filenames that
had "1.0" to include "1.1" instead.  I am unsure if the names are
correct at this time.  I will need to check them when the release is
created.

(From yocto-docs rev: ae50f920c5cf18f6c0494280a453feb41ef56d83)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:35 -07:00
Scott Rifenbark 5b5ace9e1f documentation/adt-manual/adt-eclipse.xml: Fixed double dash display.
In the PDF version of the manual the "&dash;&dash;" docbook statement
does not disply correctly.  I changed them to "--".

(From yocto-docs rev: 8aea27a6de1ca2d5dffc84cfb7a26d29c3eb0e8d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:35 -07:00
Scott Rifenbark cc340cdfbb documentation/adt-manual/adt-command.xml: fixed double dash display.
In the PDF version of the manual the "&dash;&dash;" docbook command
does not display.  I changed this to "--".

(From yocto-docs rev: b5f42fad0c7447a480e0557988f868ef4833abbf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:34 -07:00
Scott Rifenbark cc4a9d7e8d documentation/yocto-project-qs/yocto-project-qs.xml: changed to 1.1.
There are examples that use "1.0".  i have changed these to "1.1"
in anticipation of the 1.1 release.  At the time of the change I don't
know if the actual file names i put in are correct.  I need to check them
when Beth sends me the real stuff.

(From yocto-docs rev: 3d5bd0bd38fd2d99e7d5cbb6bedf0fde0fdd5fa9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:34 -07:00
Scott Rifenbark 7d465d6040 documentation/kernel-manual/kernel-how-to.xml: command indentation fixed.
(From yocto-docs rev: d3116dbda4af7f469e10449ed27b2885474317b5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:34 -07:00
Scott Rifenbark 53dcd99b31 documentation/adt-manual/adt-package.xml: Fixed typo and long commands
Errors caught by Robert P. J. Day:

1. An extra ">" character removed.
2. Overly long commands changed to use the continuation symbol.

(From yocto-docs rev: e84b7d5a46817fdc9c0f55242840989cbe8494c7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:34 -07:00