Commit Graph

22 Commits

Author SHA1 Message Date
Scott Rifenbark 9abc72cc98 adt-manual: Fixed PMS typo
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>
2015-10-21 23:06:33 +01:00
Scott Rifenbark 93052c9900 adt-manual: Remaining mods to clarify xtoolchain env use
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>
2015-02-17 15:16:55 +00:00
Scott Rifenbark 05feb9679e adt-manual: Added file name for reference to the config file.
(From yocto-docs rev: 080af576473f886a9325cfb7514e0cc7740dec35)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:55 +00:00
Scott Rifenbark 5f613896ee adt-manual: Scrubbed and fixed user-supplied input formatting.
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>
2014-10-18 16:15:30 +02:00
Scott Rifenbark 79ac80d840 adt-manual: Fixed Cross-ref target title and applied minor formatting.
(From yocto-docs rev: 14ebfc28d92b5fe9018ad2046a6ac070a2349e92)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:40 +00:00
Scott Rifenbark 3015438126 adt-manual: Added quotes around cross-link section title.
(From yocto-docs rev: e467b272498ad9400fe9c025a193d4d58851ffe5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:22 +01:00
Scott Rifenbark 3bcdba62b1 documentation: adt-manual - Removed all trailing whitespace.
(From yocto-docs rev: c1c271c0404dff9ed49597a4582a56def8237dd7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 16:15:24 +00:00
Scott Rifenbark c26d20e7be documentation: adt-manual - final edits before 1.3 lockdown.
Made some minor edits to the book before locking down the
files for 1.3.

(From yocto-docs rev: 2b941103585a31b5dbcb65b784cc3381467ed697)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-23 00:03:13 +01:00
Scott Rifenbark 14554f8d2e documentation/adt-manual/adt-package.xml: Edits to packaging chapter
Some minor edits to create some links to some terms used.

(From yocto-docs rev: 1559b8caca07cce8630de9ddf8c84f0b24fa35e7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18 12:43:51 +01:00
Scott Rifenbark 347424e558 documentation/adt-manual: Adjustments to Yocto Project term
Changes throughout the manual that either eliminate or change
many of the "Yocto Project" strings.  The file structure for
the meta data is now called "source directory."  The build
directory is referred as just that - "build directory."  Any
where the build system is referred to it is called the
"OpenEmbedded build system."

(From yocto-docs rev: 1210c19f90d4a52042fec12657212ae3e58e13d6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-29 13:31:02 +01:00
Scott Rifenbark 2ede6c8c44 documentation/adt-manual: Converted manual to use the poky.ent file
Conversion of hard links to use the variables set up in the file
documentation/poky.ent.

(From yocto-docs rev: edbacc1b57f02c31ff6eaee666245be83fb17543)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:09 -08:00
Scott Rifenbark b95e5493ca documentation/adt-manual/adt-package.xml: Fixed reference to manual.
Removed redundant link for referencing a section of a different
manual.

(From yocto-docs rev: 5a78f2c4453944e750a0250f585bcb0614dbcbf6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:41 -08:00
Scott Rifenbark 684c35b7aa documentation: Changed all manual links to point to "latest"
There are many references to YP documentation throughout the
YP manual set.  They used to have hard-coded links to the
current release (e.g. yoctoproject.org/docs/1.1 for Edison).
This created a situation where if you went to a document on
the website and clicked on a external reference to another
manual, you would redirect to the current manual on the website.
Really, you would want to go to the latest manual, which is
one that is under development.  Changing the links to
"yoctoproject.org/docs/latest" makes the tip of master, which
is used for devloping the next release, always have references
to the manuals being developed and not back to the stable
released set of manuals.

This "latest" and "current" scheme for the links is not perfect.
What has to happen when the latest set of the manuals freezes
and becomes the next stable release, all the links in the docs
will need to be changed from "latest" in the URL to the new
release number.  So for example, all the "latest" occurences
would need to be changed to "1.2".  Then for the next cycle
as development begins again, the links need to be infused with
"latest" again.

(From yocto-docs rev: a234aef34303b07671da956de0e94b352797143e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-25 15:24:17 +00:00
Scott Rifenbark 99cb233e0c YOCTO #1088: documentation - Added text to partially address package bug
This bug was filed by Gary Thomas and was requesting more information
on the "hows" and "whys" of setting up your own package repositories.
At this point, I have added information to help the user understand
build performance issues when choosing between the RPM and IPKG packaging
systems.  Likely, there is more that needs to be added to fully address
this bug.

For now, I added explanations in the packaging class and glossary areas
of the YP reference manual, a new paragraph in the YP QS just prior to
firing off a build, and a new bit of information in the configuring
PMS in the ADT Manual.

(From yocto-docs rev: d0025f862cb85ca741787b4737dca286e3ebfb45)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-02 23:38:52 +01:00
Scott Rifenbark 77d1ba446c documentation/adt-manual: General edits.
I made a pass through the manual and made some general formatting changes,
updated some links in anticipation for the 1.1 release.

(From yocto-docs rev: f2d3a012fbe4e8db3cf07e5497acfdf732e55d97)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-02 23:38:51 +01: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
Scott Rifenbark 7946934811 documentation/adt-manual/adt-package.xml: Minor edits
(From yocto-docs rev: f035bf540c07b98d88dbf134b4a4706887754e32)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-20 17:52:00 -07:00
Scott Rifenbark c655092dea documentation/adt-manual/adt-package.xml: Updates to configuring PMS
Changed the command examples so the variables contained underscore
characters.

(From yocto-docs rev: 34bfceb14a04c5fa026486f33d32df7c21f8c742)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:27:43 +01:00
Scott Rifenbark 5534892228 documentation/adt-manual/adt-package.xml: Updated PMS section
Small correction to refer to sysroot instead of root filesystem
in opening paragraph.

(From yocto-docs rev: e9af5bbd69ab9421a97ce87d5210d31838e93151)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:27:43 +01:00
Scott Rifenbark ff51a3445b documentation/adt-manual/adt-package.xml: Initial file
This file is the initial XML file for the chapter on optionally
customizing the development packages installation.

(From OE-Core rev: 2e3d29d493d6a3be006e80e75e41a0ff9ad29564)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 13:54:26 +00:00
Scott Rifenbark 4a8b398d4c documentation/adt-manual: cleaned up labels in chapter files
The initial chapters were failing to make due to duplicate section
identifiers that were created when I copied in the original files.
I gave each of the five chapter files (adt-command.xml, adt-eclipse.xml,
adt-intro.xml, adt-package.xml, and adt-prepare.xml) unique identifier
tags.

(From OE-Core rev: d30460c835c51dcc9301bcd848ceda29ba9ceeb6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 13:54:24 +00:00
Scott Rifenbark 3258234181 documentation/adt-manual: New file structure for ADT Manual
I have added a new directory to documentation named adt-manual.
This directory holds a Figures folder, and the 9 files needed
for the ADT manual.  The book consists of five chapters:
adt-intro, adt-prepare, adt-package, adt-eclipse, and adt-command.
There is also a adt-manual.xml file called by the Makefile.
There is also a style.css file.  And finally, a adt-manual-customization.xsl
file to control numbering.

(From OE-Core rev: ac2c8848bbefcf7d24192573904baaef87c67382)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 13:54:22 +00:00