summaryrefslogtreecommitdiffstats
path: root/documentation/adt-manual
Commit message (Collapse)AuthorAgeFilesLines
* docs: remove OE_INIT_FILE variableQuentin Schulz2020-10-201-1/+1
| | | | | | | | | | | | | | There's probably no need for such a variable (the name of the script is unlikely to change any time soon) and not all instances of oe-init-build-env were actually using this variable. For consistency sake, let's just remove the OE_INIT_FILE variable. Suggested-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (From yocto-docs rev: 6fd4421283005b0ecc980e9ef25770d383b93937) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UKRichard Purdie2020-10-086-6/+6
| | | | | | | | | | | When the license identifier tags were added, an incorrect string was used and the Share-Alike clause was lost. Fix this to match the license description in the files and add back the lost piece (its clear from the history it should be there) (From yocto-docs rev: 8d30c3d792755a7bfdb74b331dad98f51d3516af) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: remove DocBook filesNicolas Dechesne2020-10-069-2776/+0
| | | | | | | | | | The Yocto Project documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. (From yocto-docs rev: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: replace special quotes with single and double quotesQuentin Schulz2020-09-172-4/+4
| | | | | | | | (From yocto-docs rev: 0aeb7a94abcef3cb3850c753dd0a243f381e6675) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: insert blank below between title and tocNicolas Dechesne2020-09-171-0/+2
| | | | | | | | | | Whenever a TOC follows a title/heading, a blank line is missing. So let's add it explicitely. (From yocto-docs rev: 600b6fe7837dd817d32350e1a45431bdcfe8ebbd) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: fix links when the link text should be displayedNicolas Dechesne2020-09-173-10/+10
| | | | | | | | | | | | | | | | | When an hyperlink should be display in the output, there is no need to any specific syntax or marker, the parser finds links and mail addresses in ordinary text. Somehow the conversion from pandoc generated wrong output in the form: ` <link>`__. This patch is generated using the following Python regexp: line = re.sub("` <(https?://.*)>`__", "\\1", line) (From yocto-docs rev: a35d735a74425dff34c63c086947624467658c40) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: manual updates for some linksNicolas Dechesne2020-09-174-26/+23
| | | | | | | | | | | Some links were not found by the regexp, especially because of they are spanning across multiple lines. This patch is a manual fixup for these patterns. (From yocto-docs rev: 7a5cf8b372903d959d4a1f0882e6198f31f3cba5) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: fix internal linksNicolas Dechesne2020-09-173-39/+39
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Many of the internal links were not converted probably from DocBook using pandoc. After looking at the various patterns, the follow series of 'naive' Python regexp were used to perform some additional automatic conversion. Also, since we rely on built-in glossary, all links to terms need to use the sphinx :term: syntax. This commit is generated using the following Python series of regexp: line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_REF_URL;)?#var-\\1>`__", ":term:`\\1`", line) line = re.sub("`+do_([a-z_]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-tasks-\\1>`__", ":ref:`ref-tasks-\\1`", line) line = re.sub("`+([a-z_\-\*\.]+).bbclass`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__", ":ref:`\\1.bbclass <ref-classes-\\1>`", line) line = re.sub("`+([a-z_\-\*\.]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__", ":ref:`\\1 <ref-classes-\\1>`", line) line = re.sub("`Source Directory <(\&YOCTO_DOCS_REF_URL;)?#source-directory>`__", ":term:`Source Directory`", line) line = re.sub("`Build Directory <(\&YOCTO_DOCS_REF_URL;)?#build-directory>`__", ":term:`Build Directory`", line) line = re.sub("`Metadata <(\&YOCTO_DOCS_REF_URL;)?#metadata>`__", ":term:`Metadata`", line) line = re.sub("`BitBake <(\&YOCTO_DOCS_REF_URL;)?#bitbake-term>`__", ":term:`BitBake`", line) line = re.sub("`Images <(\&YOCTO_DOCS_REF_URL;)?#ref-images>`__", ":ref:`ref-manual/ref-images:Images`", line) line = re.sub("`Classes <(\&YOCTO_DOCS_REF_URL;)?#ref-classes>`__", ":ref:`ref-manual/ref-classes:Classes`", line) line = re.sub("`workspace <(\&YOCTO_DOCS_REF_URL;)?#devtool-the-workspace-layer-structure>`__", ":ref:`devtool-the-workspace-layer-structure`", line) line = re.sub("`Open-?Embedded b?B?uild s?S?ystem <(\&YOCTO_DOCS_REF_URL;)?#build-system-term>`__", ":term:`OpenEmbedded Build System`", line) line = re.sub("`(OpenEmbedded-Core )?(\(?OE-Core\)? )?<(\&YOCTO_DOCS_REF_URL;)?#oe-core>`__", ":term:`OpenEmbedded-Core (OE-Core)`", line) It won't catch multiline strings, but it catches a very large number of occurences! (From yocto-docs rev: 3f537d17de5b1fb76ba3bee196481984a4826378) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: Add SPDX license headersNicolas Dechesne2020-09-176-0/+12
| | | | | | | | | | SPDX headers have been added to each file, and match the headers used in the DocBook files. (From yocto-docs rev: 79dbb0007ae24da4a3689a23e921f2a2638757f7) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: initial sphinx supportNicolas Dechesne2020-09-176-0/+1170
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit is autogenerated pandoc to generate an inital set of reST files based on DocBook XML files. A .rst file is generated for each .xml files in all manuals with this command: cd <manual> for i in *.xml; do \ pandoc -f docbook -t rst --shift-heading-level-by=-1 \ $i -o $(basename $i .xml).rst \ done The conversion was done with: pandoc 2.9.2.1-91 (Arch Linux). Also created an initial top level index file for each document, and added all 'books' to the top leve index.rst file. The YP manuals layout is organized as: Book Chapter Section Section Section Sphinx uses section headers to create the document structure. ReStructuredText defines sections headers like that: To break longer text up into sections, you use section headers. These are a single line of text (one or more words) with adornment: an underline alone, or an underline and an overline together, in dashes "-----", equals "======", tildes "~~~~~~" or any of the non-alphanumeric characters = - ` : ' " ~ ^ _ * + # < > that you feel comfortable with. An underline-only adornment is distinct from an overline-and-underline adornment using the same character. The underline/overline must be at least as long as the title text. Be consistent, since all sections marked with the same adornment style are deemed to be at the same level: Let's define the following convention when converting from Docbook: Book => overline === (Title) Chapter => overline *** (1.) Section => ==== (1.1) Section => ---- (1.1.1) Section => ~~~~ (1.1.1.1) Section => ^^^^ (1.1.1.1.1) During the conversion with pandoc, we used --shift-heading-level=-1 to convert most of DocBook headings automatically. However with this setting, the Chapter header was removed, so I added it back manually. Without this setting all headings were off by one, which was more difficult to manually fix. At least with this change, we now have the same TOC with Sphinx and DocBook. (From yocto-docs rev: 3c73d64a476d4423ee4c6808c685fa94d88d7df8) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Add SPDX license headersakuster2020-06-179-0/+11
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: b2d60520431ef71ed2d1decf33605797995cb8f4) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepare for 2.1 buildsScott Rifenbark2016-01-071-0/+5
| | | | | | | | | | | The changes are for the poky.ent file and the mega-manual.sed file to take care of variables. Also, entries added for the manual revision table. (From yocto-docs rev: 60da39f85165e2d4aef55d456f8203183e089433) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Fixed PMS typoScott Rifenbark2015-10-211-1/+1
| | | | | | | | | | | | | Fixes [YOCTO #8419] There was a typo in the section that indicated the file extensions for various Package Management Systems. The one for RPM used a file extension of ".rms". I fixed it to ".rpm". (From yocto-docs rev: 7b303a789d4f11aed6ebc83d734a27442a531b52) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated files to support 2.0 release.Scott Rifenbark2015-10-211-2/+2
| | | | | | | | | | | | These updates included editing the poky.ent file so that DISTRO and related variables are now 2.0. Also updated all the title pages to have the manual revision table correct. Finally, used my email for the manuals. (From yocto-docs rev: deae61bfbb528ea0ced82399a78260a7f34a7a11) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Updated the build toolchain section with more detail.Scott Rifenbark2015-10-211-0/+15
| | | | | | | | | | | | | | | | Fixes [YOCTO #8368] Apparently there is confusion on how to build a cross-toolchain using Eclipse and the Yocto plug-in. Specifically on setting the MACHINE variable, the bblayers.conf stuff, and the preferences in Eclipse to find things. I added a couple key things to the section that describes using the OpenEmbedded build system to build out the toolchain. (From yocto-docs rev: 68c399e2560600cb3a5951c93d51e2cf1f610ff9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs and others: Rewrite of the QSScott Rifenbark2015-07-282-3/+261
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This was a complete re-write of the YP Quick Start in an attempt to streamline it, remove unecessary detail, and make it flow better with the examples. In doing so, many manuals were affected due to section headings being renamed, information being moved, etc. Here is a list of the changes by manual: Makefile - Removed two figures from TARFILE list for the yocto-project-qs. Added building-an-image.png to the ref-manual TARFILE list. Added using-a-pre-build-image.png to the adt-manual TARFILE list. Repositioned 'eclipse' in the adt-manual TARFILE list. adt-manual: Fixed a cross-reference so that it goes to the new 'Building Images' section that is within the YP QS. Added new section 'Example Using Pre-Build Binaries and QEMU' to hold the information that was formerly in YP QS. dev-manual: Removed a cross-reference into the YP QS that promised how to configure the most efficent build. Changed a cross-reference into the YP QS from 'The Packages' to 'The Build System Packages'. Changed a cross-reference into the YP QS from 'Building an Image' to 'Building Images'. Changed a text reference from the YP QS to the adt-manual. Moved the bit about getting YP files by using the YP website from the YP QS to the dev-manual. Changed a cross-reference into the YP QS from 'Using Pre-Built Binaries and QEMU' to 'Example Using Pre-built Binaries and QEMU', which was moved to the adt-manual. ref-manual: Changed a cross-reference into the YP QS from 'What You Need and How You Get It' to 'Setting Up to Use the Yocto Project'. Moved the note about if your system has oss4-dev in the packages area in the YP QS to the appropriate area in the ref-manual. Moved the introduction information regarding building an image along with the figure from YP QS to the ref-manual's section on building images. toaster-manual: Changed a cross-reference into the YP QS from 'What You Need and How You Get It' to 'Setting Up to Use the Yocto Project'. yocto-project-qs: Complete rewrite that changed many section headings and removed much detail, which was placed in other manuals. (From yocto-docs rev: da4ed8147b04963a700caa784bda709c57b4eb6e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated customization layers to point to XSL mirrorsScott Rifenbark2015-07-282-0/+16
| | | | | | | | | | | | | | The customization layers were pointing to Sourceforge site for the XSl files needed to build the manuals. Throuhgout time, this site has failed me enough to warrent trying to get these XSL files from some other source. Rather than ship the XSL files with the YP release, we decided to create some mirrors and point the customization files there. (From yocto-docs rev: 4fd1703870694dff1f593b421f90aad0803d9e65) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Updated the "Getting the Images" section for eclipse-debugScott Rifenbark2015-07-281-58/+24
| | | | | | | | | | | | | The way to include tcf-agent now in an image that you are going to remotely deploy and debug using the Eclipse IDE is to simply include the eclipse-debug image feature as part of the image. I updated the section around getting images to reflect this simple method. Reported-by: Adam Lee <adam@gumstix.com> (From yocto-docs rev: 9aec91d7f4fda558baa0e8a0290b42d76e735c63) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Emphasis on populate_sdk as bitbake method for building toolchainScott Rifenbark2015-07-281-44/+50
| | | | | | | | | | | | | I updated the "Optionally Building a Toolchain Installer" section to emphasize using 'bitbake <image> -c populate_sdk' as the method for building outa toolchain. Before the change, equal emphasis was put on for this preferred method and the 'bitbake meta-toolchain' method. (From yocto-docs rev: 447ad6167570bf1bd227771153de421d1154443d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: fixed formatting for user-supplied data in example.Scott Rifenbark2015-04-241-1/+1
| | | | | | | (From yocto-docs rev: 0a5b26ab90056b7107bb86329148e8c3a0173065) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Preparation for 1.9 buildsScott Rifenbark2015-04-151-0/+5
| | | | | | | | | | | | | | | | | This involves the following: * Inserting a new row for all manual revision history tables to have "October 2015" and 1.9 as the release information. * Updating the mega-manual.sed file to process links for 1.9 * Updating variables in poky.ent to deal with the 1.9 release variables. (From yocto-docs rev: 1ed55c08b96cf0fded38833635111a5c6da86781) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Updated the Makefile-based project section.Scott Rifenbark2015-04-151-21/+45
| | | | | | | | | | | Fixes [YOCTO #7133] Added more examples of how variables work in Makefile projects. (From yocto-docs rev: e8aa42f3609de3dfe94c022d957b855a4f7ef032) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updates to try to fix CentOS docs build errorsScott Rifenbark2015-04-011-1/+1
| | | | | | | | | | | | The docs are not building on CentOS and we think it is due to the XSL templates being called for the Eclipse parts. I located all the "current" templates and switched them out for "1.76.1" version as are used by the mainstream doc builds. (From yocto-docs rev: afbddde6524630433dfec973bbe886de32395bc8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated Manual revision tables with "April 2015"Scott Rifenbark2015-03-191-1/+1
| | | | | | | (From yocto-docs rev: a012e34956b8ac2fa7610e264f460bc27bdd66d8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual, ref-manual: Detail on using an external toolchain.Scott Rifenbark2015-02-171-0/+39
| | | | | | | | | | | | | | | | | | | Fixes [YOCTO #4907] I created a new section in the toolchain chapter of the adt-manual called "optionally Using an External Toolchain". This provides some fundamental information for the user that wants to use an external toolchain. Additionally, it references Mentor Graphics Sourcery toolchain as an example. In the ref-manual, I updated the TCMODE variable description to better integrate the MGC Sourcery toolchain as the overriding example. (From yocto-docs rev: 51e9c3b88f7e5a16da2aa101589b0f2612fff11d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Reverted back to the 1.76.1 XSL stylesheetScott Rifenbark2015-02-171-1/+1
| | | | | | | | | | Using the 1.76.1 version in all the customization layers so the manual revision tables will build with boxes. (From yocto-docs rev: 85a31ef53a59d17bed23ebf57a14db507eb21338) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual, ref-manual: Review edits for xcross-toolchain additions.Scott Rifenbark2015-02-172-8/+16
| | | | | | | | | | | | | | Mark Hatle reviewed the section and I updated some things based off his input. A rewrite to the "Makefile-Based Projects" section to get it technically correct. Also, removed all SDKROOT documentation from both the adt-manual and ref-manual. Fixes [YOCTO #7133] (From yocto-docs rev: dd785777834611d94868a3774f2eb21ffc081b1a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Remaining mods to clarify xtoolchain env useScott Rifenbark2015-02-173-18/+30
| | | | | | | | | | | | | Fixes [YOCTO #7133] Edits to add more clarification for use and role of the cross-toolchain environment variables established when a user runs the cross-toolchain environment setup script. (From yocto-docs rev: 2c3fa3a838a3a8970cd112935e903c96552ed06b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Added file name for reference to the config file.Scott Rifenbark2015-02-171-1/+2
| | | | | | | (From yocto-docs rev: 080af576473f886a9325cfb7514e0cc7740dec35) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual, ref-manual: Added missing variables and cross-linksScott Rifenbark2015-02-171-4/+4
| | | | | | | | | | | I added the ADKROOT, GDB, CROSS_COMPILE, and CONFIGURE_FLAGS variables to the glossary. Also added appropriate cross-reference links from the adt-manual to those new variables. (From yocto-docs rev: 812367e3b915b99d900b7934c4d5d409f393e814) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Added a list of variables defined for ADT setupScott Rifenbark2015-02-171-0/+27
| | | | | | | | | | | | | | Fixes [YOCTO #7133] partially At the end of the section that first mentions running the environment setup script for the cross-toolchain, I added a list of environment variables that are defined as a result of running the script. (From yocto-docs rev: f1b66a09676d1b5c055e7ae7e7cc9a7f45cb9b67) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Expanded note with a user configuration reference.Scott Rifenbark2015-02-171-0/+4
| | | | | | | | | | | | | The note in the "Getting the ADT Installer Tarball" section has a note that warns the user to be sure they have local.conf properly configured before baking out the adt-installer. I provided a linked cross-reference into the section of the ref-manual that takes a closer look at user configuration. (From yocto-docs rev: d13c044b65543a2f15fbda0266d2e30a14cfd19f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Added missing period.Scott Rifenbark2015-02-171-8/+16
| | | | | | | (From yocto-docs rev: 8a47c17cecf023c3eb021108a1830394cb8bf103) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Added some reasoning behind sourcing the xtoolchain env scriptScott Rifenbark2015-02-171-5/+7
| | | | | | | | | | | | | | The intro to the "installing the ADT and Toolchains" section notes that the user must source the cross-toolchain environment setup script. I added a clause stating that this establishes environment variables. Fixes [YOCTO #7133] partially. (From yocto-docs rev: e9777012d935ced8fd82209543569aaa70ab1832) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Reword for how user-space tools are provided.Scott Rifenbark2015-02-171-1/+1
| | | | | | | | | | | | The "User-Space Tools" section incorrectly stated that user-space tools are provided as part of the distribution. The Yocto Project is not a distribution. So I changed to say that they are provided as part of the Yocto Project. (From yocto-docs rev: 03dd97b68a1900959aa51ad6a17547822e8392fc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Added cross-reference to OE build system termScott Rifenbark2015-02-171-1/+2
| | | | | | | | | First occurrence cross-reference added. (From yocto-docs rev: 91db235e935e799c2d4cc301ef799cb581704020) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Fixed hyphenation issue.Scott Rifenbark2015-02-171-3/+3
| | | | | | | (From yocto-docs rev: a0b11ddf7ce4d12f330fcddd21ee127b11bf0ace) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual, adt-manual, yocto-project-qs: scrub eglibcScott Rifenbark2015-02-171-4/+4
| | | | | | | | | | | Scrubbed out the occurrences of eglibc and replaced them with glibc. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 868ceda79b1c738349e512e523c850b24f9232ca) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changed back to the "current" XSL style sheet.Scott Rifenbark2015-02-171-1/+1
| | | | | | | | | | | | I need to get back to how it was working and then fix the table box issue from there. Using the 1.76.1 stylesheets makes the build too long for the manuals and sometimes the XSL sheets do not load. (From yocto-docs rev: 7bc502fa069fdc4aebf5705513bb82127716859f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated all XSL style sheet imports to use 1.76.1 versionScott Rifenbark2015-01-061-1/+1
| | | | | | | | | | | | | This fixes the issue where the lines for the manual revision table are not appearing. For some reason they do not appear when building the docs using Ubuntu 14.10 and the "current" XSL transformation files. So, I backed up to the 1.76.1 version, which is the nearest version where the issue does not surface. (From yocto-docs rev: 82b15986b97b9ed082b652b562eaaf843572fdff) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated the manual revision history tables.Scott Rifenbark2014-11-041-0/+5
| | | | | | | | | | Added an entry for the 1.8 release stating that the release is slated for sometime in 2015. (From yocto-docs rev: 9799a7848f24024048eae0cbed470a2be4b4b879) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Scrubbed and fixed user-supplied input formatting.Scott Rifenbark2014-10-183-18/+18
| | | | | | | | | | | Throughout the manual I was using angled brackets to denote user-supplied input. This is confusing so I changed to using the <replaceable></replaceable> tag set. (From yocto-docs rev: 79ec3f1b1330539ab2b3bdfb1c94e58c2d0feead) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated release date for manual rev tables.Scott Rifenbark2014-10-031-1/+1
| | | | | | | | | | Added "October 2014" to table for all manuals that have the table. (From yocto-docs rev: 3f9ceb4dd2397fe907bf701c842277eb65d11a56) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added permalink display styles to CSS files.Scott Rifenbark2014-07-031-0/+7
| | | | | | | | | | | | | Fixes [YOCTO #5772] Updated each manual's CSS style sheet to contain a style for how the permalink symbol looks on its own and how it looks when a user hovers over it with the mouse. (From yocto-docs rev: c8d4afa0b83a40ac2de0c47c191a11b3e7d241e5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated style sheets to remove unused .PNG files.Scott Rifenbark2014-06-181-19/+17
| | | | | | | | | | | | | Fixes [YOCTO #6430] The style sheets were carrying over old .PNG files that are not part of the manuals. I have removed the statements that were using them. (From yocto-docs rev: 6e4fa419b9367ab5e34b9aa8010a24980416dc7d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Added XSL templates to support permalinks.Scott Rifenbark2014-06-181-2/+10
| | | | | | | | | Fixes [YOCTO #5722] (From yocto-docs rev: 316c484573a24ab3abdfa58110008677bb1e5320) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated the manual revision history tables for 1.7Scott Rifenbark2014-05-131-0/+5
| | | | | | | (From yocto-docs rev: 9014fe95b9607a15c0e72ef1b6df14f250a3d241) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated all the manual revision history tables.Scott Rifenbark2014-04-211-1/+1
| | | | | | | | | Set the release date to April 2014. (From yocto-docs rev: 2592bc968edeea941a92e6bdd321dd872745b78c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Fixed example bitbake command.Scott Rifenbark2014-03-251-1/+1
| | | | | | | | | | The command said 'bitbake image....' where it would be better to say 'bitbake <image>...' (From yocto-docs rev: be90d647a298c88f6a1a69c66a0795dcdb5cb56b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual, ref-manual: Cross-toolchain details added. New class also.Scott Rifenbark2014-03-251-4/+29
| | | | | | | | | | | | | | | | | | | In the adt-manual in the "Optionally Building a Toolchain Installer" setion, I added some basic advantage information for building a toolchain installer using bitbake image -c populate_sdk. In the ref-manual, I added cross-referencing to this basic information in several strategic areas: "SDK Generation", the populate_sdk class reference section, the populate_sdk_* class reference section, and the "Cross-Development Toolchain Generation" sections. Finally, I also put in documentation for a new class called autotools-brokensep. (From yocto-docs rev: cde7dd2fbd7bdc0d71dc678ee7a5422459654287) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-12 04:34:05 +0000