diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml index 49148abead..020f9373e6 100644 --- a/documentation/dev-manual/dev-manual-intro.xml +++ b/documentation/dev-manual/dev-manual-intro.xml @@ -109,144 +109,13 @@ Other Information - Because this manual presents overview information for many different + Because this manual presents information for many different topics, supplemental information is recommended for full comprehension. - The following list presents other sources of information you might find helpful: - - Yocto Project Website: - The home page for the Yocto Project provides lots of information on the project - as well as links to software and documentation. - - - Yocto Project Quick Start: - This short document lets you get started - with the Yocto Project and quickly begin building an image. - - - Yocto Project Reference Manual: - This manual is a reference - guide to the OpenEmbedded build system, which is based on BitBake. - The build system is sometimes referred to as "Poky". - - - Yocto Project Software Development Kit (SDK) Developer's Guide: - This guide provides information that lets you get going - with the standard or extensible SDK. - An SDK, with its cross-development toolchains, allows you - to develop projects inside or outside of the Yocto Project - environment. - - - Yocto Project Board Support Package (BSP) Developer's Guide: - This guide defines the structure for BSP components. - Having a commonly understood structure encourages standardization. - - - Yocto Project Linux Kernel Development Manual: - This manual describes how to work with Linux Yocto kernels as well as provides a bit - of conceptual information on the construction of the Yocto Linux kernel tree. - - - Yocto Project Profiling and Tracing Manual: - This manual presents a set of common and generally useful tracing and - profiling schemes along with their applications (as appropriate) to each tool. - - - Toaster User Manual: - This manual introduces and describes how to set up and use - Toaster, which is a web interface to the Yocto Project's - OpenEmbedded Build System. - - - - Eclipse IDE Yocto Plug-in: - Instructions that demonstrate how an application developer - uses the Eclipse Yocto Project Plug-in feature within - the Eclipse IDE. - - - FAQ: - A list of commonly asked questions and their answers. - - - Release Notes: - Features, updates and known issues for the current - release of the Yocto Project. - - - Toaster: - An Application Programming Interface (API) and web-based - interface to the OpenEmbedded build system, which uses - BitBake, that reports build information. - - - Build Appliance: - A virtual machine that - enables you to build and boot a custom embedded Linux image - with the Yocto Project using a non-Linux development system. - - - Bugzilla: - The bug tracking application the Yocto Project uses. - If you find problems with the Yocto Project, you should report them using this - application. - - Yocto Project Mailing Lists: - To subscribe to the Yocto Project mailing - lists, click on the following URLs and follow the instructions: - - - for a Yocto Project Discussions mailing list. - - - for a Yocto Project Discussions mailing list about the - OpenEmbedded build system (Poky). - - - for a mailing list to receive official Yocto Project announcements - as well as Yocto Project milestones. - - - for a listing of all public mailing lists on - lists.yoctoproject.org. - - - Internet Relay Chat (IRC): - Two IRC channels on freenode are available - for Yocto Project and Poky discussions: #yocto and - #poky, respectively. - - - OpenEmbedded: - The build system used by the Yocto Project. - This project is the upstream, generic, embedded distribution - from which the Yocto Project derives its build system (Poky) - and to which it contributes. - - - BitBake: - The tool used by the OpenEmbedded build system - to process project metadata. - - - BitBake User Manual: - A comprehensive guide to the BitBake tool. - If you want information on BitBake, see this manual. - - - Quick EMUlator (QEMU): - An open-source machine emulator and virtualizer. - - + See the + "Links and Related Documentation" + section in the Yocto Project Reference Manual for helpful + sources. diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index cec23b6039..7423467150 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml @@ -44,75 +44,114 @@ This reference manual consists of the following: - - Using the Yocto Project: - Provides an overview of the components that make up the Yocto Project - followed by information about debugging images created in the Yocto Project. + + + Using the Yocto Project: + + Provides an overview of the components that make up the Yocto + Project followed by information about debugging images created + in the Yocto Project. - - A Closer Look at the Yocto Project Development Environment: + + + A Closer Look at the Yocto Project Development Environment: + Provides a more detailed look at the Yocto Project development environment within the context of development. - - Technical Details: - Describes fundamental Yocto Project components as well as an explanation - behind how the Yocto Project uses shared state (sstate) cache to speed build time. + + + Technical Details: + + Describes fundamental Yocto Project components as well as an + explanation behind how the Yocto Project uses shared state + (sstate) cache to speed build time. - - Migrating to a Newer Yocto Project Release: + + + Migrating to a Newer Yocto Project Release: + Describes release-specific information that helps you move from one Yocto Project Release to another. - - Directory Structure: - Describes the - Source Directory created - either by unpacking a released Yocto Project tarball on your host development system, - or by cloning the upstream - Poky Git repository. + + + Directory Structure: + Describes the + Source Directory + created either by unpacking a released Yocto Project tarball on + your host development system, or by cloning the upstream + Poky + Git repository. - - Classes: - Describes the classes used in the Yocto Project. - - Tasks: + + + Classes: + + Describes the classes used in the Yocto Project. + + + + Tasks: + Describes the tasks defined by the OpenEmbedded build system. - - devtool Quick Reference: + + + devtool Quick Reference: + Provides a quick reference for the devtool command. - - QA Error and Warning Messages: + + + QA Error and Warning Messages: + Lists and describes QA warning and error messages. - - Images: + + + Images: + Describes the standard images that the Yocto Project supports. - - Features: - Describes mechanisms for creating distribution, machine, and image - features during the build process using the OpenEmbedded build system. - - Variables Glossary: - Presents most variables used by the OpenEmbedded build system, which - uses BitBake. - Entries describe the function of the variable and how to apply them. + + + Features: + + Describes mechanisms for creating distribution, machine, and + image features during the build process using the OpenEmbedded + build system. + + + + Variables Glossary: + + Presents most variables used by the OpenEmbedded build system, + which uses BitBake. + Entries describe the function of the variable and how to + apply them. + + + + Variable Context: + + Provides variable locality or context. + + + + FAQ: + + Provides answers for commonly asked questions in the Yocto + Project development environment. + + + + Contributions and Additional Information: + + Provides an overview of methods by which you can + contribute to and participate in the Yocto Project. - - Variable Context: - Provides variable locality or context. - - FAQ: - Provides answers for commonly asked questions in the Yocto Project - development environment. - - Contributing to the Yocto Project: - Provides guidance on how you can contribute back to the Yocto - Project. diff --git a/documentation/ref-manual/resources.xml b/documentation/ref-manual/resources.xml index 0cd0e5a254..c713ffcf11 100644 --- a/documentation/ref-manual/resources.xml +++ b/documentation/ref-manual/resources.xml @@ -3,15 +3,31 @@ [ %poky; ] > -Contributing to the Yocto Project +Contributions and Additional Information
Introduction - The Yocto Project team is happy for people to experiment with the Yocto Project. - A number of places exist to find help if you run into difficulties or find bugs. - To find out how to download source code, - see the "Yocto Project Release" + The Yocto Project team is happy for people to experiment with the + Yocto Project. + A number of places exist to find help if you run into difficulties + or find bugs. + This presents information about contributing and participating in + the Yocto Project. + +
+ +
+ Contributions + + + The Yocto Project gladly accepts contributions. + You can submit changes to the project either by creating and sending + pull requests, + or by submitting patches through email. + For information on how to do both as well as information on how + to identify the maintainer for each area of code, see the + "How to Submit a Change" section in the Yocto Project Development Manual.
@@ -100,53 +116,173 @@ -