[ECOS] building ecos docs

[ECOS] building ecos docs

[Koeller, T.]

Hi,

I tried to build the ecos documentation from the SGML sources.
Since I had installed all the jade/docbook stuff anyway, I did not expect
any major difficulties, but that was obviously wrong. After executing
'makemakefile', I got a makefile that uses strange hardcoded paths,
such as 'TOPLEVEL = ../../ecc'. I created a link with that name to
my packages directory, but then the makefile obviously tried to make
'smart' guesses as to where I have my things installed (catalog files and
so on), and again it wouldn't work.

Can anybody explain the coditions that must be met in order to
successfully build the docs?

tk
----------------------------------------------- 
Thomas Koeller, Software Development 

Basler Vision Technologies 
An der Strusbek 60-62 
22926 Ahrensburg 
Germany 

Tel +49 (4102) 463-390 
Fax +49 (4102) 463-46390

mailto:Thomas.Koeller@baslerweb.com 
http://www.baslerweb.com 




-- 
Before posting, please read the FAQ: http://sources.redhat.com/fom/ecos
and search the list archive: http://sources.redhat.com/ml/ecos-discuss

Re: [ECOS] building ecos docs

[Gary Thomas]

On Mon, 2002-06-03 at 04:40, Koeller, T. wrote:
> Hi,
> 
> I tried to build the ecos documentation from the SGML sources.
> Since I had installed all the jade/docbook stuff anyway, I did not expect
> any major difficulties, but that was obviously wrong. After executing
> 'makemakefile', I got a makefile that uses strange hardcoded paths,
> such as 'TOPLEVEL = ../../ecc'. I created a link with that name to
> my packages directory, but then the makefile obviously tried to make
> 'smart' guesses as to where I have my things installed (catalog files and
> so on), and again it wouldn't work.
> 
> Can anybody explain the coditions that must be met in order to
> successfully build the docs?

Yes, there do seem to be a few little problems here, mostly due to
the fact that the public CVS repository is only a reflection of the
internal one used by Red Hat.  

However, it's not too bad.  Here's what I just did:
    % cd /work/anonCVS/eCos
    % ln -s packages ecc
    % cd doc/sgml
    % patch -p0 <<EOF
    Index: doclist
    ===================================================================
    RCS file: /cvs/ecos/ecos/doc/sgml/doclist,v
    retrieving revision 1.1
    diff -u -5 -p -r1.1 doclist
    --- doclist     20 May 2002 22:19:26 -0000      1.1
    +++ doclist     3 Jun 2002 11:39:10 -0000
    @@ -1,7 +1,6 @@
     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
    EOF
    % ./makemakefile
    % make html

Notes:
 * The only useful format is HTML.  Red Hat used a separate SGML processor
   for producing PDF files, as JADE is not very good at it.  YMMV
 * The process is [somewhat] based on the internal CVS tree layout, which
   differs only slightly from the public one.  The symbolic link I added
   makes this happy.
 * Somehow, the documentation for the uItron package is missing.  The 
   patch works around this for the moment.
    
    


-- 
Before posting, please read the FAQ: http://sources.redhat.com/fom/ecos
and search the list archive: http://sources.redhat.com/ml/ecos-discuss