Updates to allow the reference manual to be built as
ref-manual.htm and ref-manual.pdf.
(From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Clean operation should also remove the *.tgz file. I added
code so that if the user makes the file and specifies the
'clean' target, the generated tarfile is removed.
(From yocto-docs rev: 565c147eaa169e287278b87e9bba2979a44be9d5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added variable descriptions for BB_DISKMON_DIRS and
BB_DISKMON_WARNINTERVAL. These went in the reference
manual in the glossary section. First draft for both
descriptions.
Also, updated the Makefile to include two new figures used
in the Build History section. The figures needed to be added
to the TARFILE variable so that the .PNG files are included
when publishing both the poky-ref-manual and the mega-manual.
Added two figures to the figures directories of the poky-ref-manual
and the mega-manual. These figures are part of the new Build
History section. Anytime you add a figure to any manual you
also have to store it in the figures directory of the mega-manual.
(From yocto-docs rev: bbf68ed28ba8660af34d4cae146fb172ca4e681e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
this figure used to be at the end of the development manual.
I have removed it from both figures directories and taken
it out of the TARFILE list in the Makefile.
(From yocto-docs rev: ad8fcfc4bddb6bcee0e1a4ece78cd87ab0d51b6c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made some general edits to the new "Patching the Kernel" section.
Also had to remove a couple of images no longer used in the section
from the Makefile "TARFILES" variable.
(From yocto-docs rev: ac61e22e2f89926fbbda56fbaa4384c3c5156360)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Each time the kernel revision is bumped (e.g. 3.2 to 3.4)
Some of the figures would be out of date. The reason is they
had pathnames that included the release of the kernel.
For previous YP releases I was adding logic to the Makefile
to be sure to catch the right files dependent on the branch
from which the documents were being built. This scheme is
not scalable so I decided to make the figures generic by
adding a note within the figures explaining the place-holder
"<x.x>" as part of a pathname. Thus, three new figures were
added to the folders directories of the dev-manual and the
mega-manual. Correspondingly, the 'denzil' version of the
figures were deleted.
I modified the Makefile so that if the BRANCH is not edison
or denzil then the generic figure set is used. I have to retain
the logic for both edison and denzil to cover the case where
a user clones or sets up an edison or denzil repo and then
builds out the manuals. Basically, it had to be backwards
compatible for releases prior to danny.
(From yocto-docs rev: 8283eed4b0b9ec164b87db99c35231f8731ac443)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Danny, the "kernel-example-repo-<release>.png" file changed to
"kernel-example-repo-danny.png". To correctly make the dev-manual
and the mega-manual some things needed to change:
1. New figure created and added to both the dev-manual and the
mega-manuals figures directory.
2. The "kernel-example-repo-denzil.png" files from the dev-manual
and mega-manual figures directory was removed.
3. The Makefile was adjusted so a new BRANCH=danny area now exists
to set TARFILES for both dev-manual and mega-manual.
(From yocto-docs rev: 8b2ff6b657a1486559799e219baaec9fde2e5c6c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Three things done to the Makefile:
1. Added logic so that the user can generate the mega-manual HTML
document. It includes processing links using mega-manual.sed
2. Added and updated the comments for 1.3 and inclusive of
mega-manual generation.
3. Added a test for the existance of HTML file in the publish
task. Previously you got some error that was geeky.
(From yocto-docs rev: 99b865ab96b086d818375d1c00f98a3e3a4f4e9f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added new style.css names for the individual manuals.
Also, created a new entry for the mega-manual. This will generate
an HTML file only (similar to the QS). No PDF file will be generated.
The entry creates an appropriate mega-manual.tgz file as well and
can be branch-dependent (like the dev manual) since it will
obviously include the dev manual.
(From yocto-docs rev: be8c0b965a89e3517a09647eeda06c2ff163d260)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I discovered a bug when publishing documents. There are two scp
commands that copy a document's files and figures to the appropriate
directory in the srifenbark@yocto-www:~/www.yoctoproject.or-docs
server where the manuals are published. The second scp command
had a "/figures" at the end. This was causing a new "figures"
directory to be created within the "figures" directory. This
redundancy shows up as missing figures in the manuals if a new figure
or changed figure is ever added to the book after initial
publishing. I removed the extra "/figures" at the end of the scp
command.
(From yocto-docs rev: cef3634e695f61bfb8465f1fb7a88e4e8a9a00f1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A new figure was needed in the Kernel appendix. I added that
figure to the block of code that creates the tarball for the
denzil branch.
(From yocto-docs rev: 352093f3eabf64052d78a41fd997993d09aa10ef)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
dev-manual/dev-manual-model.xml: The Bare Clone and Copy of the Bare
Clone figures are out of date for denzil. These needed to be
re-done so they use "linux-yocto-3.2.git" and "my-linux-yocto-3.0-work"
as the root names. This presents a Makefile issue when making the
denzil and pre-denzil versions of the manuals. Whenever you use a
different figure for a different release, you need to involve the
BRANCH variable in the Makefile. This is necessary because you are
using different figures in the generated tarballs. The set of figures
could be unique to the release. The outdated figure is
"kernel-overview-3.png" and will eventually be removed (later commit).
I created a new figure named "kernel-overview-3-denzil.png" and used
that in the dev-manual-model.xml file.
documentation/Makefile: I updated the Makefile to test for a
"denzil" release build and if so include the new file in the
generated tarball. This commit adds the new .PNG file as well.
Fixed the Makefile so that if you don't supply a BRANCH value, it
uses the latest figures (denzil).
(From yocto-docs rev: b3550d7640343cd5459efb04c591b81a1e41bc1b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I discovered that the figures used in this manual differ depending
on the branch. There are two figures that are different. Thus,
the TARFILES variable in the makefile needed to be conditionalized.
If it is not, then the process that makes the tarball throws errors
because it cannot find the two figures from the other branch.
To fix this I introduced the 'BRANCH' variable. It is to be used
only when you make or publish the YP Development Manual. And, you
only use it to specify 'edison'. If you are building from the 'master'
branch you don't need to use it.
Comments in the file have been updated to explain usage.
(From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I had added some edison-specific figures and they needed to
be included in the TARFILE variable for the YP development manual.
The fix now makes the TARFILE variable all-inclusive for all
.PNG files regardless of branch. Consequently, there can be
some missing files when the manual is made but the errors are okay.
I documented the exceptions above the variable.
(From yocto-docs rev: 500d4102c5496cb834b93378242599715810386a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert Day correctly pointed out that the usage comments in the Makefile
were not exactly accurate. The VER argument is necessary only if you
are going to publish a document to the YP website. I updated the usage
comments accordingly.
(From yocto-docs rev: dd033227af0f88e45b539b92be8f1321fcd4f975)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added the figures/kernel-example-repos.png to the list of tarfiles.
(From yocto-docs rev: 8967a9b8ae6fb27f7c0aeb44c2d04eacba98ed81)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
[BUGID#_1025] - I added some conditionals to handle the
Yocto Project Quick Start case. This manual does not have
a PDF version. I put in tests for publishing and for a case
where a user might attempt to specifically generate a PDF
using 'make pdf'. I also converted the version variable into
a command-line argument so we don't have to edit the make file
when a new release comes out.
(From yocto-docs rev: 8e98871c9771096ec635f592cca752c63697bd5e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was some URL problems with the publish statement.
Beth debugged it.
(From yocto-docs rev: 6c13bce3cbdd576463f5e3b1e61ab6f4046e47c3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These changes fix the following issues:
1. Multiple Makefiles. There really is no need for this.
2. Unable to maintain more than one version of the docs on the webserver.
This is a quick fix to enable the above.
In order to build the documentation, at the top level, issue a:
make all DOC=<doc directory name>
make all DOC=kernel-manual
Also, some changes need to occur on the webserver to fully
incorporate these fixes.
http://www.yoctoproject.org/documentation/
The docs are now published to:
http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name>
The main page should be changed to point not only to the current doc release,
but also to the prior releases. This will enable us to maintain prior release
documentation without stomping over it when we publish new docs. Also, we'll
need to repoint the yocto-quick-start link to yocto-project-qs. Or rename
documentation/yocto-project-qs/* to support the website naming.
(From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda)
Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Beth Flanagan