Commit Graph

39 Commits

Author SHA1 Message Date
Scott Rifenbark b1dc0ee121 ref-manual, dev-manual: Completed first draft of 2.3 migration section.
(From yocto-docs rev: 42ab9e34da640b46d39741c9c83648dc65518ec1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10 12:13:32 +01:00
Scott Rifenbark 62f7812b93 ref-manual: New VOLATILE_LOG_DIR variable description
Fixes [YOCTO #6132]

No mention of how to make the target directory /var/log
persistent.  I added a note to the "post-install-logging"
image feature that points to the new VOLATILE_LOG_DIR
variable description, which I added to the glossary.

(From yocto-docs rev: 5d2bdf49e569e44d02602501d72418f04dbe6e4a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11 17:23:17 +00:00
Scott Rifenbark d2523d535f documentation: Added new appendix for customizing standard SDK
Fixes [YOCTO #8584]

This fix essentially had to document how to add the API
documentation to the standard SDK.  The fix required adding a
new appendix to the SDK manual on how to customize that
standard SDK.  I could not put just one topic in a new appendix
so I also added a sub-section on how to add indidual packages
to the standard SDK.

Other changes here were the introduction of a new file for the new
appendix, updated the mega-manual.xml file so that it would include
the new chapter when the MM was built.  Finally, I added some
cross-referencing to the new appendix from the TOOLCHAIN_HOST_TASK
and TOOLCHAIN_TARGET_TASK variables.  And a cross reference from the
distro features section on the api-documentation bullet.

(From yocto-docs rev: 1fb4321ae42253d1fc9602496b5e9e8b495197dd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16 10:38:42 +00:00
Scott Rifenbark 78aa906c2e ref-manual: Added api-documentation to distro features
Fixes [YOCTO #8584]

Updated the "Distro Features" section to include the
"api-documentation" feature.

(From yocto-docs rev: 5b4e8fc58b84aea9a940f67f8d7585912fadc676)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16 10:38:42 +00:00
Scott Rifenbark fc518b5a48 ref-manual: Updated the DISTRO_FEATURES description of Bluez5
Edits to explain that by default, DISTRO_FEATURES backfills
bluetooth support with Bluez5.  If the user wants to use the
Bluez4 feature, they need to backfill consider Bluez5.

(From yocto-docs rev: 4e8b34c8c5841cdc1cae564decae4689ae4f2b11)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:48 +01:00
Scott Rifenbark 8fc310c90f ref-manual: Added BlueZ version 5 feature to distro feature section.
(From yocto-docs rev: c7055f313a127bc8ed65a93ed7bea21775518567)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-06 22:53:35 +01:00
Scott Rifenbark 9f970b6bc1 dev-manual, profile-manual, ref-manual: Purging Oprofile stuff
Fixes [YOCTO #9264]

Several occurrences of tools-profile and the like had to be dealt
with.

(From yocto-docs rev: 62f45579970f47d22dabe921a51c663059a04576)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:25 +01:00
Scott Rifenbark 4c5157f7dc ref-manual: Resolving a conflict
(From yocto-docs rev: b364516928d04da38ef3188f07f190ffac64762b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:08 +00:00
Scott Rifenbark 7814b33b56 ref-manual: Updates to cull out qt4 stuff.
Several areas changed throughout the ref-manual to remove qt4
referencing.

(From yocto-docs rev: 9ee721034ceb2bb7b7a9e64f6a6a7a2b3bfd1c82)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-15 16:31:17 +00:00
Scott Rifenbark fb82bcb989 ref-manual: Added 'ptest' to the list of Distro Features
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: a6ae91468a67779c796712794656a72f701aea25)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:28 +01:00
Scott Rifenbark b72cb0dbbe ref-manual: Updated the "Image Features" section
Removed the requirement that debug-tweaks is needed in order to
individually use the allow-empty-passowrk, empty-root-password,
and post-install-logging features.  These three features can be
individually turned on an off regardless of debug-tweaks.

(From yocto-docs rev: ea33b98c0a7ceb80adb15bf63eee8d6872099235)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-03 11:49:35 +01:00
Scott Rifenbark 6d17aa00f9 ref-manual: Added 'debug-tweaks' fragmentation.
The image feature 'debug-tweaks' has been fragmented into three
separate areas of functionality that deals with handling empty
passwords and post-installation logging.  I updated the list of
image features appropriately and the description of 'debug-tweaks'
in the EXTRA_IMAGE_FEATURES variable.

Fixes [YOCTO #5344]

(From yocto-docs rev: ce0ab20472a75049298287cd05109f6e091b80bd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:17:03 +00:00
Scott Rifenbark 2eaf7e6e75 ref-manual: Scrubbed for variable (user) input.
Throughout the manual I had been using angled bracket sets to
denote user-supplied input.  This is confusing and better shown
by using the <replaceable></replaceable> tags.  I scrubbed all
the chapters and replaced as needed.

Some other minor formatting changes were caught and fixed during
the scrub as well.

(From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:30 +02:00
Scott Rifenbark 6f32f3c757 ref-manual: Fixed grammar use in "Image Features" list.
(From yocto-docs rev: eb4ff8e1345987391e735f088d685ec70e641ed1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-10 16:44:33 +01:00
Scott Rifenbark e90f4a1360 ref-manual: Minor edits to "Image Features" section.
Reversed order of the list presentation and re-worded the static
library sentence.

(From yocto-docs rev: 5c32730550629527f6ceb2140df31a097f7a6081)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-03 14:41:29 +01:00
Scott Rifenbark 6d843e6336 ref-manual: Edits to the "Image Features" section layout
I updated the section to have two lists of features.  One list
is for features that work only when you inherit the core-image
class.  The other list is for features that are available for
all images regargless of inheriting this class.

(From yocto-docs rev: 9d1bcab2a9264e64db2dec66247aaf55493ae362)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-30 21:37:43 +01:00
Scott Rifenbark 380ec32a4d ref-manual: Fixed "debug-tweaks" typo.
(From yocto-docs rev: d8b8005cc8e24b08db74961aa28e33b746d3acd1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-30 21:37:42 +01:00
Scott Rifenbark 328cb8ced6 ref-manual: Updated the "Image Features" section.
The list of features in the section was out of sync with the list
of features shown in the comments of the core-image class.
Additionally, four of the features are available to all images
regardless of whether or not the core-image class is inherited.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: e4821fd0a63e906da8b1ff015fb4970e5e62d667)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-30 21:37:42 +01:00
Scott Rifenbark 4a908714ef ref-manual: Updated list of Machine Features shipped with YP.
Added the following:

 efi
 pcbios
 phone
 qvga
 rtc
 vfat

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b3fe96df8552921cb6494a72d721fa6b41a70a3b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-30 21:37:42 +01:00
Robert P. J. Day 8732dab099 ref-manual: Minor edits for clarity.
(From yocto-docs rev: 79025b3cb5e3af25d960f0fc9f2266a8dcb3fd12)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:31 +01:00
Scott Rifenbark e867967d60 ref-manual: Added links to new do_* sections.
With the creation of the new chapter that documents the 51
tasks defined by the OpenEmbedded build system, the remainder
of the ref-manual had many first-instance occurrences of do_*
task names that could be cross-referenced to the new sections.

I have added these links.

(From yocto-docs rev: 2ff39bd226a1d8f11924283bbaa3542a9d936ba3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13 07:50:58 +01:00
Scott Rifenbark 2c9202770f ref-manual: Added directfb to DISTRO_FEATURES list chapter.
Reported-by: Ross Burton <ross.burton@intel.com>
(From yocto-docs rev: 488302a491db45709ef89ac03bf5abac4b5abe3a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:35 +00:00
Jonas Eriksson beb54ff6f7 ref-manual: Adds x11 to Distro Feature list.
Before this change, x11 was only documented as an IMAGE_FEATURE.
However, it is heavily relied upon as a DISTRO_FEATURE by
pacages that have an optional X dependency determined during
build time.  Examples include libsdl, dbus, alsa, and
pulseaudio.

(From yocto-docs rev: dd243b453b6d69bc439dda816fa5c9c83c5c3cd4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:01:31 +00:00
David Nystrom 797a91947a ref-manual: Reverted a patch that had added sdk-pms
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-13 16:30:02 +00:00
Scott Rifenbark 031f1880a4 ref-manual: Slight grammar edits.
(From yocto-docs rev: 4092f38d873c86cb2a3cf931c52cf9aa5920d3cf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:18 +00:00
Scott Rifenbark 9a8d0ea021 ref-manual: Updated the intro text to "Distro Features" section.
(From yocto-docs rev: 38a35921be904bfa1e20160f6548aacefbc5f144)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:18 +00:00
Scott Rifenbark cf0424185c ref-manual: re-ordered distro features and machine features sub-sections.
(From yocto-docs rev: 14d910f53c347a580e80747a947a70a79c9692e2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:16 +00:00
Scott Rifenbark d85638820b dev-manual, ref-manual: Updated some section titles.
I noticed that chapter 10 of the ref-manual still had
"Reference: Features" as the title.  This is left over from way
back.  I changed that chapter title to "Features."  Next, I
noticed an inconsistency with some sub-section titles.
I changed the "Images" title into "Image Features."  This affected
several links across the doc set so I had to update those
cross-references as well so they have the latest section title
as part of the reference.

(From yocto-docs rev: b68f009a92e0e24802e367d98cf66e15ba1cd364)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:16 +00:00
Scott Rifenbark 89fc8b84b7 ref-manual: Updated to *_FEATURES variables.
I updated the MACHINE_FEATURES, DISTRO_FEATURES, and
COMBINED_FEATURES variable descriptions to better reflect what
they actually do.  Also, fixed two occurences of IrDA in the
features lists section.

(From yocto-docs rev: af79b0b3bc88ca0811d488c7c5d6b5407de808a7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:15 +00:00
Scott Rifenbark dd6b2ef9e7 documentation: Scrubbed use of directory names
There was inconsistent use of the way directory names were
handled throughout the YP documentation.  I have scrubbed the
set and replaced many instances such as the following:

meta/<something> replaces /meta/<something>
poky replaces ~/poky (except in some very specific examples)

I basically got rid of leading slash characters.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ae2e451ed8f61484d04b30017021912c4493a441)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:06 +00:00
David Nyström a2aeade07c ref-manual: Added sdk-pms to Distro Feature list.
Added description of DISTRO_FEATURE sdk-pms in the Yocto
Reference Manual.

The changes I made are not exactly identical to the patch
submitted by David.  I dit a bit of re-writing for the
text but the concepts are the same.

(From yocto-docs rev: f8076f1916cc52647b129922c1b1646ad6df8ff9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01 17:09:50 +00:00
Scott Rifenbark caa29e693c ref-manual: Fixed "fsroot" typo to "rootfs".
(From yocto-docs rev: deaf9eec735a860c5b0e57799d2d269722bf179d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:43 +01:00
Scott Rifenbark 8007feff87 ref-manual: added opengl to distro feature list.
Fixes [YOCTO #4907]

Open Graphics Library was not included in the list of supported
distro features that could be included using the
DISTRO_FEATURES variable.  It is now.

(From yocto-docs rev: 2e06fe0f8135c13d3a86857f9b0e450239cedbf4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:43 +01:00
Scott Rifenbark 6f6d0a59e3 ref-manual, dev-manual: Applied review edits (read-only rootfs and package repo)
A couple sets of review comments from Paul applied here.

1. Added the "read-only-rootfs" item to the EXTRA_IMAGE_FEATURES
   variable description and a link to the appropriate section
   in the dev-manual.

2. Pulled the how-to-create a package repository section out
   of the section on how to customize an image with the
   IMAGE_FEATURES and EXTRA_IMAGE_FEATURES section and made
   it a stand-alone section in the "Tasks" chapter of the
   dev-manual.

3. Integrated the SSH server example into the main topic
   because we don't want an isolated sub-section within a
   main topic.

4. In the image features section of the ref-manual, I fixed
   the link with the "read-only-rootfs" feature to go to
   the now-isolated section on how to do that instead of
   going to the customizing an image using the IMAGE_FEATURES
   and EXTRA_IMAGE_FEATURES variables section.

(From yocto-docs rev: 9c79b5f40d8dc6b37fbe636a2459f89b70bd8ea8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:45 +01:00
Scott Rifenbark 95c36b7cc2 ref-manual: Added read-only-fsroot feature to list.
(From yocto-docs rev: 612f8841b6b61d0cc155034c8e8685b28bfd10c7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:45 +01:00
Scott Rifenbark d72c0e688d ref-manual: Edits to the "Images" section.
Added some cross-references to some other parts of the YP
documentation.  Also, re-orderd the list to be alphabetical.

(From yocto-docs rev: c2faf4ab4b9fd0ef2670f5c31deaa933b3119779)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:36 +01:00
Scott Rifenbark e73fc8e047 ref-manual: Edits to "Distro" section.
Added the "systemd" and "wayland" features.  Also re-ordered the
list to be by alphabetical order.

(From yocto-docs rev: a68247e2f3da2563ca851898eea21bd83aa6853c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:36 +01:00
Scott Rifenbark 534be33e71 ref-manual: Edits to the introduction section.
(From yocto-docs rev: c01105ad507deaa1cdc21588ab8c6f4ec8455a51)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:36 +01:00
Scott Rifenbark ed0a240e16 documentation: Rename of poky-ref-manual folder to ref-manual.
Changing the folder that holds the YP Reference Manual to be
"ref-manual".  This will help with confustion over the manual's
intended purpose.

(From yocto-docs rev: 1106442964b5080cb0b6b3bd3af32e9407c0f7c1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:25 +00:00