Mercurial > ecos

changeset 659:007ddf4d1979

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* sgml/doclist: Reorder in a slightly more logical order with related bits grouped together. Add docs for power management, USB (slave, eth slave, and SA11x0 and NEC uPD8985xx drivers), and synthetic target HAL, eth and watchdog drivers. * sgml/.cvsignore: Add gifs and rename ecos.* to ecos-ref.*
author jlarmour
date Mon, 24 Feb 2003 14:04:35 +0000
parents ddc030bc26c9
children 2531a99fbf4a
files doc/ChangeLog doc/sgml/.cvsignore doc/sgml/doclist doc/sgml/makemakefile
diffstat 4 files changed, 79 insertions(+), 36 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,20 @@
+2003-02-24  Jonathan Larmour  <jifl@eCosCentric.com>
+
+	* sgml/doclist: Reorder in a slightly more logical order with
+	related bits grouped together.
+	Add docs for power management, USB (slave, eth slave, and SA11x0
+	and NEC uPD8985xx drivers), and synthetic target HAL, eth and
+	watchdog drivers.
+
+	* sgml/.cvsignore: Add gifs and rename ecos.* to ecos-ref.*
+
+	* sgml/makemakefile: Rename ecos.sgml/html/etc. to ecos-ref.
+	Copy over GIFs where they exist.
+	Don't treat porting guide specially at the top... treat it only as
+	specially as the other special cases.
+	Update (C) holders.
+	Update licence/warranty blurb.
+
 2003-01-30  Andrew Lunn  <andrew.lunn@ascom.ch>
 
 	* sgml/doclist: Added snmp-manpages.sgml 
--- a/doc/sgml/.cvsignore
+++ b/doc/sgml/.cvsignore
@@ -1,8 +1,9 @@
-ecos.sgml
-ecos.tex
-ecos.log
-ecos.aux
-ecos.out
-ecos.pdf
+ecos-ref.sgml
+ecos-ref.tex
+ecos-ref.log
+ecos-ref.aux
+ecos-ref.out
+ecos-ref.pdf
 makefile
-*.html
\ No newline at end of file
+*.html
+*.gif
--- a/doc/sgml/doclist
+++ b/doc/sgml/doclist
@@ -1,26 +1,35 @@
 kernel/current/doc/kernel.sgml
-compat/uitron/current/doc/uitron.sgml
-hal/common/current/doc/hal.sgml
-io/common/current/doc/io.sgml
-io/pci/current/doc/pci.sgml
-language/c/libc/common/current/doc/libc.sgml
-compat/posix/current/doc/posix.sgml
-io/fileio/current/doc/fileio.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
+io/pci/current/doc/pci.sgml
+compat/posix/current/doc/posix.sgml
+compat/uitron/current/doc/uitron.sgml
 net/common/current/doc/tcpip.sgml
 net/common/current/doc/tcpip-manpages.sgml
+net/bsd_tcpip/current/doc/freebsd.sgml
 net/tcpip/current/doc/openbsd.sgml
-net/bsd_tcpip/current/doc/freebsd.sgml
+net/ns/dns/current/doc/dns.sgml
 io/eth/current/doc/ethdrv.sgml
 net/snmp/agent/current/doc/snmp.sgml
 net/snmp/agent/current/doc/snmp-manpages.sgml
-net/ns/dns/current/doc/dns.sgml
 net/httpd/current/doc/httpd.sgml
 net/ftpclient/current/doc/ftpclient.sgml
 services/crc/current/doc/crc.sgml
 services/cpuload/current/doc/cpuload.sgml
 services/profile/gprof/current/doc/profile.sgml
+services/power/common/current/doc/power.sgml
+io/usb/slave/current/doc/usbs.sgml
+io/usb/eth/slave/current/doc/usbseth.sgml
+hal/synth/arch/current/doc/synth.sgml
+devs/usb/sa11x0/current/doc/usbs_sa11x0.sgml
+devs/usb/nec_upd985xx/current/doc/usbs_upd985xx.sgml
+devs/eth/synth/ecosynth/current/doc/syntheth.sgml
+devs/watchdog/synth/current/doc/synth_watchdog.sgml
--- a/doc/sgml/makemakefile
+++ b/doc/sgml/makemakefile
@@ -1,8 +1,8 @@
 #!/bin/sh
 
-touch ecos.sgml
+touch ecos-ref.sgml
 touch makefile
-chmod +w ecos.sgml 
+chmod +w ecos-ref.sgml 
 chmod +w makefile
 
 cat > makefile <<EOF
@@ -17,6 +17,7 @@ cat > makefile <<EOF
 # -------------------------------------------
 # This file is part of eCos, the Embedded Configurable Operating System.
 # Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
+# Copyright (C) 2003 Jonathan Larmour
 #
 # 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
@@ -55,10 +56,10 @@ cat > makefile <<EOF
 
 TOPLEVEL   := ../../packages
 EOF
-/bin/echo MAIN_SGML   := ecos.sgml >> makefile
+/bin/echo MAIN_SGML   := ecos-ref.sgml >> makefile
 /bin/echo -n OTHER_SGML   :=  >> makefile
 
-cat >ecos.sgml <<EOF
+cat >ecos-ref.sgml <<EOF
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
 
 <!-- Begin Document Specific Declarations -->
@@ -75,27 +76,36 @@ for i in `cat doclist`; do
   if (test ! -z $line); then
    /bin/echo -n " ../../packages/$i" | sed "s@/current/@/${PACKAGEVER}/@g" >> makefile
    entityi="`echo $i | sed 's@/@-@g; s@\.@-@g; s@_@-@g; s@-current-doc@@g; s@-current@@g'`"
-   echo "<!ENTITY $entityi SYSTEM \"../../packages/$i\">" | sed "s@/current/@/${PACKAGEVER}/@g" >> ecos.sgml
+   echo "<!ENTITY $entityi SYSTEM \"../../packages/$i\">" | sed "s@/current/@/${PACKAGEVER}/@g" >> ecos-ref.sgml
   fi
 done
-echo "<!ENTITY hal-common-current-doc-porting-sgml SYSTEM \"../../packages/hal/common/${PACKAGEVER}/doc/porting.sgml\">" >> ecos.sgml
+
+# Go through again but find GIFs to copy
+for i in `for j in \`cat doclist\` ; do dirname $j ; done | sort | uniq` ; do
+  diri=`echo ../../packages/$i | sed "s@/current/@/${PACKAGEVER}/@g"`
+  dirigifs=`ls $diri/*.gif 2>/dev/null | tr '\n' ' '`
+  if [ x"$dirigifs" != x ]; then
+        copyfiles="$copyfiles $dirigifs"
+  fi
+done
 
 cat >> makefile <<EOF
 
-MAIN_HTML  := ecos.html
-MAIN_PDF   := ecos.pdf
+MAIN_HTML  := ecos-ref.html
+MAIN_PDF   := ecos-ref.pdf
 PICTURES   :=
+COPYFILES  := $copyfiles
 
 include \$(TOPLEVEL)/pkgconf/rules.doc
 EOF
 
-cat >> ecos.sgml <<EOF
+cat >> ecos-ref.sgml <<EOF
 <!-- End Document Specific Declarations -->
 ]>
 
-<BOOK ID="ECOS">
+<BOOK ID="ECOS-REF">
   <bookinfo>
-    <TITLE>eCos</TITLE>
+    <TITLE>eCos Reference Manual</TITLE>
 
     <copyright>
       <year>1998</year>
@@ -103,7 +113,13 @@ cat >> ecos.sgml <<EOF
       <year>2000</year>
       <year>2001</year>
       <year>2002</year>
+      <year>2003</year>
       <holder>Red Hat, Inc.</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>
@@ -153,12 +169,14 @@ property of their respective owners. </p
       </legalnotice>
       <legalnotice>
 <title>Warranty</title>
-<para>eCos and RedBoot are open source software, covered by the Red Hat eCos Public License,
+<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. The supplied version of eCos and/or RedBoot is supported for customers of Red Hat. See <ulink
+conditions. See <ulink
 url="http://sources.redhat.com/ecos/license-overview.html">http://sources.redhat.com/ecos/license-overview.html
-</ulink></para>
-<para>For non-customers, eCos and RedBoot software has NO WARRANTY. </para>
+</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
@@ -186,12 +204,10 @@ for i in `cat doclist`; do
   if (test ! -z $line); then
    entityi="`echo $i | sed 's@/@-@g; s@\.@-@g; s@_@-@g; s@-current-doc@@g; s@-current@@g'`"
    # special kludge
-   if [ "`basename $i`" != "tcpip-manpages.sgml" -a "`basename $i`" != "snmp-manpages.sgml" ]; then
-     echo "&$entityi;" >> ecos.sgml
+   if [ "`basename $i`" != "tcpip-manpages.sgml" -a "`basename $i`" != "snmp-manpages.sgml" -a "`basename $i`" != "porting.sgml" ]; then
+     echo "&$entityi;" >> ecos-ref.sgml
    fi
   fi
 done
 
-echo '</book>' >> ecos.sgml
-
-
+echo '</book>' >> ecos-ref.sgml