This is the mail archive of the
ecos-patches@sources.redhat.com
mailing list for the eCos project.
Build RedBoot User's Guide as a separate document
- From: John Dallaway <jld at ecoscentric dot com>
- To: ecos-patches at ecos dot sourceware dot org
- Date: Mon, 19 Apr 2004 15:02:25 +0100
- Subject: Build RedBoot User's Guide as a separate document
- Organization: eCosCentric Limited
The current eCos Reference Guide PDF build is running very close to the
hardcoded string resource limit of pdfjadetex. This patch separates the
RedBoot User's Guide into a separate document as it was prior to eCos 2.0.
The change gives us room for further expansion of the eCos Reference Guide
pending a more thorough overhall of the documentation build system. To
build the RedBoot User's Guide:
cd packages/redboot/current/doc
make html
make pdfa4
make pdfletter
John Dallaway
eCosCentric Limited
? packages/redboot/current/doc/makefile
? packages/redboot/current/doc/redboot_main.sgml
Index: doc/ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos/doc/ChangeLog,v
retrieving revision 1.22
diff -u -5 -r1.22 ChangeLog
--- doc/ChangeLog 14 Apr 2004 15:11:45 -0000 1.22
+++ doc/ChangeLog 19 Apr 2004 13:50:15 -0000
@@ -1,5 +1,10 @@
+2004-04-19 John Dallaway <jld@ecoscentric.com>
+
+ * sgml/doclist: Remove RedBoot documentation which is now built
+ separately.
+
2004-04-14 Nick Garnett <nickg@calivar.com>
* sgml/doclist: Added PPP package documentation.
2003-11-25 Manu Sharma <manu.sharma@ascom.com>
Index: doc/sgml/doclist
===================================================================
RCS file: /cvs/ecos/ecos/doc/sgml/doclist,v
retrieving revision 1.13
diff -u -5 -r1.13 doclist
--- doc/sgml/doclist 14 Apr 2004 15:11:45 -0000 1.13
+++ doc/sgml/doclist 19 Apr 2004 13:50:15 -0000
@@ -1,11 +1,6 @@
kernel/current/doc/kernel.sgml
-redboot/current/doc/redboot.sgml
-redboot/current/doc/redboot_cmds.sgml
-redboot/current/doc/redboot_rebuilding.sgml
-redboot/current/doc/redboot_installing.sgml
-redboot/current/doc/redboot_epilogue.sgml
hal/common/current/doc/hal.sgml
hal/common/current/doc/porting.sgml
language/c/libc/common/current/doc/libc.sgml
io/common/current/doc/io.sgml
io/fileio/current/doc/fileio.sgml
Index: packages/redboot/current/ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos/packages/redboot/current/ChangeLog,v
retrieving revision 1.190
diff -u -5 -r1.190 ChangeLog
--- packages/redboot/current/ChangeLog 30 Mar 2004 19:09:14 -0000 1.190
+++ packages/redboot/current/ChangeLog 19 Apr 2004 13:50:23 -0000
@@ -1,5 +1,13 @@
+2004-04-19 John Dallaway <jld@ecoscentric.com>
+
+ * doc/makefile, doc/redboot_main.sgml: New files to build the RedBoot
+ User's Guide as a self-contained document.
+
+ * doc/redboot.sgml: Eliminate <part> tag to build the RedBoot User's
+ Guide as a self-contained document.
+
2004-03-30 Mark Salter <msalter@redhat.com>
* src/net/udp.c (__udp_recvfrom_handler): Protect against back-to-back
duplicate packets.
Index: packages/redboot/current/doc/redboot.sgml
===================================================================
RCS file: /cvs/ecos/ecos/packages/redboot/current/doc/redboot.sgml,v
retrieving revision 1.8
diff -u -5 -r1.8 redboot.sgml
--- packages/redboot/current/doc/redboot.sgml 20 Feb 2004 03:38:18 -0000 1.8
+++ packages/redboot/current/doc/redboot.sgml 19 Apr 2004 13:50:27 -0000
@@ -27,12 +27,14 @@
<!-- ####DESCRIPTIONEND#### -->
<!-- =============================================================== -->
<!-- }}} -->
+<!-- uncomment to build this documentation as a DocBook part
<part id="redboot"><beginpage>
<title>RedBoot™ User's Guide</title>
+-->
<toc id="Getting-Started-with-Redboot2"></toc>
<chapter id="Getting-Started-with-RedBoot">
<title>Getting Started with RedBoot</title>
<para><indexterm><primary>Red Boot</primary><secondary>getting started</secondary>
</indexterm>RedBoot™ is an acronym for "Red Hat Embedded Debug and Bootstrap",
Index: packages/net/common/current/ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos-opt/net/net/common/current/ChangeLog,v
retrieving revision 1.59
diff -u -5 -r1.59 ChangeLog
--- packages/net/common/current/ChangeLog 13 Apr 2004 14:36:27 -0000 1.59
+++ packages/net/common/current/ChangeLog 19 Apr 2004 13:50:28 -0000
@@ -1,5 +1,10 @@
+2004-04-19 John Dallaway <jld@ecoscentric.com>
+
+ * doc/tcpip.sgml: Remove reference to RedBoot documentation
+ which is now built separately.
+
2004-04-13 Sandeep Kumar <sandeep@codito.com>
* src/network_support.c (init_all_network_interfaces): Fix argument to
cyg_dns_res_start and removed errneaous extra closing brace around it.
Index: packages/net/common/current/doc/tcpip.sgml
===================================================================
RCS file: /cvs/ecos/ecos-opt/net/net/common/current/doc/tcpip.sgml,v
retrieving revision 1.7
diff -u -5 -r1.7 tcpip.sgml
--- packages/net/common/current/doc/tcpip.sgml 21 Oct 2003 18:14:21 -0000 1.7
+++ packages/net/common/current/doc/tcpip.sgml 19 Apr 2004 13:50:30 -0000
@@ -58,11 +58,10 @@
the associated API can be found in the generic ethernet device driver
documentation
<xref linkend="io-eth-drv-generic">
The driver and API is the same as the minimal debug stack used by
the RedBoot application. See the RedBoot documentation
-<xref linkend="redboot">
for further
information.</PARA>
</CHAPTER>
<CHAPTER id="net-common-sample-code">
<TITLE>Sample Code</TITLE>
#=============================================================================
#
# makefile
#
# For building the eCos RedBoot docs
#
#=============================================================================
#####ECOSGPLCOPYRIGHTBEGIN####
# -------------------------------------------
# This file is part of eCos, the Embedded Configurable Operating System.
# Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
# Copyright (C) 2004 eCosCentric Limited
#
# eCos is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation; either version 2 or (at your option) any later version.
#
# eCos is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
# for more details.
#
# You should have received a copy of the GNU General Public License along
# with eCos; if not, write to the Free Software Foundation, Inc.,
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
#
# As a special exception, if other files instantiate templates or use macros
# or inline functions from this file, or you compile this file and link it
# with other works to produce a work based on this file, this file does not
# by itself cause the resulting work to be covered by the GNU General Public
# License. However the source code for this file must still be made available
# in accordance with section (3) of the GNU General Public License.
#
# This exception does not invalidate any other reasons why a work based on
# this file might be covered by the GNU General Public License.
# -------------------------------------------
#####ECOSGPLCOPYRIGHTEND####
#=============================================================================
#####DESCRIPTIONBEGIN####
#
# Author(s): bartv, jlarmour
# Date: 2001-01-11
#####DESCRIPTIONEND####
#=============================================================================
TOPLEVEL := ../../..
MAIN_SGML := redboot_main.sgml
MAIN_HTML := redboot.html
MAIN_PDF := redboot.pdf
OTHER_SGML := redboot_cmds.sgml redboot_rebuilding.sgml redboot_installing.sgml
PICTURES :=
include $(TOPLEVEL)/pkgconf/rules.doc
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!-- Begin Document Specific Declarations -->
<!ENTITY ui "µITRON">
<!ENTITY versiondir CDATA "v2_0">
<!ENTITY version CDATA "2.0">
<!ENTITY lt SDATA "[lt ]">
<!ENTITY redboot-sgml SYSTEM "redboot.sgml">
<!ENTITY redboot-cmds-sgml SYSTEM "redboot_cmds.sgml">
<!ENTITY redboot-rebuilding-sgml SYSTEM "redboot_rebuilding.sgml">
<!ENTITY redboot-installing-sgml SYSTEM "redboot_installing.sgml">
<!-- End Document Specific Declarations -->
]>
<BOOK ID="REDBOOT-GUIDE">
<bookinfo>
<TITLE>RedBoot User's Guide</TITLE>
<copyright>
<year>1998</year>
<year>1999</year>
<year>2000</year>
<year>2001</year>
<year>2002</year>
<year>2003</year>
<year>2004</year>
<holder>Red Hat, Inc.</holder>
<holder>John Dallaway (eCosCentric)</holder>
<holder>Nick Garnett (eCosCentric)</holder>
<holder>Jonathan Larmour (eCosCentric)</holder>
<holder>Andrew Lunn (Ascom)</holder>
<holder>Gary Thomas (MLB Associates)</holder>
<holder>Bart Veer (eCosCentric)</holder>
</copyright>
<legalnotice>
<title>Documentation licensing terms</title>
<para>This material may be distributed only subject to the terms
and conditions set forth in the Open Publication License, v1.0
or later (the latest version is presently available at
<ulink url="http://www.opencontent.org/openpub/";>http://www.opencontent.org/openpub/</ulink>).
</para>
<para>
Distribution of substantively modified versions of this
document is prohibited without the explicit permission of the
copyright holder.</para>
<para>
Distribution of the work or derivative of the work in any
standard (paper) book form is prohibited unless prior
permission is obtained from the copyright holder.
</para>
</legalnotice>
<legalnotice>
<title>Trademarks</title>
<para>Altera® and Excalibur™ are trademarks of Altera Corporation.</para>
<para>AMD® is a registered trademark of Advanced Micro Devices, Inc.</para>
<para>ARM®, StrongARM®, Thumb®, ARM7™, ARM9™ is a registered trademark of Advanced RISC Machines, Ltd.</para>
<para>Cirrus Logic® and Maverick™ are registered trademarks of Cirrus Logic, Inc.</para>
<para>Cogent™ is a trademark of Cogent Computer Systems, Inc.</para>
<para>Compaq® is a registered trademark of the Compaq Computer Corporation.</para>
<para>Fujitsu® is a registered trademark of Fujitsu Limited.</para>
<para>IBM®, and PowerPC™ are trademarks of International Business Machines Corporation.</para>
<para>IDT® is a registered trademark of Integrated Device Technology Inc.</para>
<para>Intel®, i386™, Pentium®, StrataFlash® and XScale™ are trademarks of Intel Corporation.</para>
<para>Intrinsyc® and Cerf™ are trademarks of Intrinsyc Software, Inc.</para>
<para>Linux® is a registered trademark of Linus Torvalds. </para>
<para>Matsushita™ and Panasonic® are trademarks of the Matsushita Electric Industrial Corporation.</para>
<para>Microsoft®, Windows®, Windows NT® and Windows XP® are registered trademarks of Microsoft Corporation, Inc. </para>
<para>MIPS®, MIPS32™ MIPS64™, 4K&trade, 5K™ Atlas™ and Malta™ are trademarks of MIPS Technologies, Inc.</para>
<para>Motorola®, ColdFire® is a trademark of Motorola, Inc.</para>
<para>NEC® V800™, V850™, V850/SA1™, V850/SB1™, VR4300™, and VRC4375™ are trademarks of NEC Corporation.</para>
<para>PMC-Sierra® RM7000™ and Ocelot™ are trademarks of PMC-Sierra Incorporated. </para>
<para>Red Hat, eCos™, RedBoot™, GNUPro®, and Insight™ are trademarks of Red Hat, Inc. </para>
<para>Samsung® and CalmRISC™ are trademarks or registered trademarks of Samsung, Inc. </para>
<para>Sharp® is a registered trademark of Sharp Electronics Corp.</para>
<para>SPARC® is a registered trademark of SPARC International, Inc., and is used under license by Sun Microsystems, Inc. </para>
<para>Sun Microsystems® and Solaris® are registered trademarks of Sun Microsystems, Inc. </para>
<para>SuperH™ and Renesas™ are trademarks owned by Renesas Technology Corp.</para>
<para>Texas Instruments®, OMAP™ and Innovator™ are trademarks of Texas Instruments Incorporated.</para>
<para>Toshiba® is a registered trademark of the Toshiba Corporation.</para>
<para>UNIX® is a registered trademark of The Open Group. </para>
<para>All other brand and product names, trademarks, and copyrights are the
property of their respective owners. </para>
</legalnotice>
<legalnotice>
<title>Warranty</title>
<para>eCos and RedBoot are open source software, covered by a
modified version of the <ulink url="http://www.gnu.org/copyleft/gpl.html";>GNU
General Public Licence</ulink>,
and you are welcome to change it and/or distribute copies of it under certain
conditions. See <ulink
url="http://ecos.sourceware.org/license-overview.html";>http://ecos.sourceware.org/license-overview.html
</ulink> for more information about the license.</para>
<para>eCos and RedBoot software have NO WARRANTY. </para>
<para>Because this software is licensed free of charge, there are no warranties
for it, to the extent permitted by applicable law. Except when otherwise stated
in writing, the copyright holders and/or other parties provide the software
“as is” without warranty of any kind, either expressed or implied,
including, but not limited to, the implied warranties of merchantability and
fitness for a particular purpose. The entire risk as to the quality and performance
of the software is with you. Should the software prove defective, you assume
the cost of all necessary servicing, repair or correction.</para>
<para> In no event, unless required by applicable law or agreed to in writing,
will any copyright holder, or any other party who may modify and/or redistribute
the program as permitted above, be liable to you for damages, including any
general, special, incidental or consequential damages arising out of the use
or inability to use the program (including but not limited to loss of data
or data being rendered inaccurate or losses sustained by you or third parties
or a failure of the program to operate with any other programs), even if such
holder or other party has been advised of the possibility of such damages.
</para>
</legalnotice>
</bookinfo>
<toc id="redboot-toc"></toc>
&redboot-sgml;
&redboot-cmds-sgml;
&redboot-rebuilding-sgml;
&redboot-installing-sgml;
</book>