Preparing documentation for release

darcs-hash:20080423200729-f2ef6-f105a825b8e6fdf1aaf6179b164ac80e4b15914a.gz

diff --git a/doc/Makefile b/doc/Makefile
index c56449efc67224ffb35bf14c5f4153e660f77b28..075c013659628072f858a01b42151b1b7e466744 100644 (file)
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,21 +1,30 @@
 SOURCE = omk-manual
 SOURCE = omk-manual

+VERSION ?= $(shell date +%Y-%m-%d)
+
+.PHONY: FORCE

 
 all: $(SOURCE).pdf $(SOURCE).txt $(SOURCE).html
 
 
 all: $(SOURCE).pdf $(SOURCE).txt $(SOURCE).html
 

+.version: FORCE
+       echo $(VERSION) | cmp -s $@ - || echo $(VERSION) > $@
+
+%.texi: %.texinfo .version
+       sed -e 's/\$$Id\$$/$(VERSION)/g' < $< > $@
+

 PNG_FIGS = $(wildcard *.png)
 PDF_FIGS = $(patsubst %.png,%.pdf,$(PNG_FIGS))
 
 %.pdf: %.png
        convert $< -density 150 $@
 
 PNG_FIGS = $(wildcard *.png)
 PDF_FIGS = $(patsubst %.png,%.pdf,$(PNG_FIGS))
 
 %.pdf: %.png
        convert $< -density 150 $@
 

-$(SOURCE).pdf: $(SOURCE).texinfo $(PDF_FIGS)
+%.pdf: %.texi $(PDF_FIGS)

        texi2dvi --pdf $<
        texi2dvi --pdf $<
 
        texi2dvi --pdf $<
        texi2dvi --pdf $<
 

-$(SOURCE).txt: $(SOURCE).texinfo
+%.txt: %.texi

        makeinfo --no-headers --force -o $@ $<
 
        makeinfo --no-headers --force -o $@ $<
 

-$(SOURCE).html: $(SOURCE).texinfo
+%.html: %.texi

        makeinfo --html --no-split -o $@ $<
 #      texi2html --l2h $<
 # Fix texinfo HTML output
        makeinfo --html --no-split -o $@ $<
 #      texi2html --l2h $<
 # Fix texinfo HTML output


@@ -26,7 +35,7 @@ $(SOURCE).html: $(SOURCE).texinfo
 #      mv $@.tmp $@
 
 clean:
 #      mv $@.tmp $@
 
 clean:

-       rm -f $(SOURCE).{aux,cp,cps,fn,ky,log,pg,toc,tp,vr,vrs} $(PDF_FIGS)
+       rm -f $(SOURCE).{aux,cp,cps,fn,ky,log,pg,toc,tp,vr,vrs} $(PDF_FIGS) .version

 
 WWW ?= www
 
 
 WWW ?= www
 

diff --git a/doc/omk-manual.texinfo b/doc/omk-manual.texinfo
index db4fadca13ca763a14516dea9c0b9e2c2e70dffd..c9c7bc768db6b7f45c519ccad7a1a85a76ac60a7 100644 (file)
--- a/doc/omk-manual.texinfo
+++ b/doc/omk-manual.texinfo
@@ -1,13 +1,14 @@
 \input texinfo   @c -*-texinfo-*-
 @c %**start of header
 @setfilename omk-manual
 \input texinfo   @c -*-texinfo-*-
 @c %**start of header
 @setfilename omk-manual

+@documentencoding UTF-8

 @settitle OMK: Ocera Make System
 @c %**end of header
 
 @copying
 @settitle OMK: Ocera Make System
 @c %**end of header
 
 @copying

-Manual for Ocera Make System (OMK)
+Manual for Ocera Make System (OMK) version $Id$

 
 

-Copyright @copyright{} 2007 Michal Sojka, Pavel Pisa
+Copyright @copyright{} 2007, 2008 Michal Sojka, Pavel Píša

 @end copying
 
 @titlepage
 @end copying
 
 @titlepage


@@ -40,12 +41,10 @@ Copyright @copyright{} 2007 Michal Sojka, Pavel Pisa
 @cindex overview
 
 OMK is an advanced make system written entirely in GNU make. Compiling
 @cindex overview
 
 OMK is an advanced make system written entirely in GNU make. Compiling

-software using OMK requires only GNU make binary and standard UNIX
-utilities (@command{sh}, @command{sed}, @command{cmp} and
-@command{tr}@footnote{@command{tr} is needed only for OMK to be
-compatible with MinGW.}) installed. OMK aims to be developer friendly;
-to use OMK, you do not need to understand (sometimes) cryptic syntax of
-Makefiles.
+software using OMK requires only GNU Make and standard UNIX
+utilities (@command{sh}, @command{sed}, @command{cmp}, ...)
+installed. OMK aims to be developer friendly; to use OMK, you do not
+need to understand (sometimes) cryptic syntax of Makefiles.

 
 You can use OMK on all platforms where you can run GNU Make including
 Cygwin and MinGW. MS DOS was not tested.
 
 You can use OMK on all platforms where you can run GNU Make including
 Cygwin and MinGW. MS DOS was not tested.


@@ -113,6 +112,8 @@ choosing of a make system.
 @end itemize
 
 
 @end itemize
 
 

+
+

 @node Quick Start, History, Why to Use OMK?, Overview of OMK
 @section Quick Start
 
 @node Quick Start, History, Why to Use OMK?, Overview of OMK
 @section Quick Start
 


@@ -130,8 +131,11 @@ make
 
 @enumerate
 @item
 
 @enumerate
 @item

-  Take appropriate @file{Makefile.rules}, put it together with leaf
-  @file{Makefile} to the root directory of your project.
+  The newest version of OMK can be found at @uref{http://rtime.felk.cvut.cz/omk/}.
+@item
+  Take appropriate @file{Makefile.rules} (see @ref{Properties of
+  Specific Makefile.rules}), put it together with leaf @file{Makefile}
+  to the root directory of your project.

 @item
   Create @file{Makefile.omk} files in all directories you want to
   compile something. Please refer to @ref{OMK User's Manual} to learn
 @item
   Create @file{Makefile.omk} files in all directories you want to
   compile something. Please refer to @ref{OMK User's Manual} to learn


@@ -146,7 +150,7 @@ make
 @node History,  , Quick Start, Overview of OMK
 @section History
 
 @node History,  , Quick Start, Overview of OMK
 @section History
 

-OMK was originally written by Pavel Pisa as a solution to have one
+OMK was originally written by Pavel Píša as a solution to have one

 common make system for OCERA project, where we needed to compile
 user-space programs, Linux kernel modules and RT Linux modules in one
 package. Although this system was not accepted for the whole OCERA
 common make system for OCERA project, where we needed to compile
 user-space programs, Linux kernel modules and RT Linux modules in one
 package. Although this system was not accepted for the whole OCERA


@@ -1310,9 +1314,9 @@ separate lookup and download for .po files and full Autoheader... cycle.
 I have put together package similar to release. Only ./configure --prefix=...
 and make is required. CVS sources contains version 3.81beta1.
 You can download prepared sources archive from
 I have put together package similar to release. Only ./configure --prefix=...
 and make is required. CVS sources contains version 3.81beta1.
 You can download prepared sources archive from

-  @indicateurl{http://paulandlesley.org/make/make-3.81beta1.tar.bz2}
+  @uref{http://paulandlesley.org/make/make-3.81beta1.tar.bz2}

 Or you can get our local copy from
 Or you can get our local copy from

-  @indicateurl{http://cmp.felk.cvut.cz/~pisa/can/make-3.81beta1.tar.gz}
+  @uref{http://cmp.felk.cvut.cz/~pisa/can/make-3.81beta1.tar.gz}

 
 The archive contains even "make" binary build by me, which should work
 on other Linux distributions as well.  Older version of MAKE (3.79.x
 
 The archive contains even "make" binary build by me, which should work
 on other Linux distributions as well.  Older version of MAKE (3.79.x


@@ -1324,7 +1328,7 @@ bug.
 The local CTU archive with our CAN components prepared for inclusion
 into OCERA SF CVS could be found in my "can" directory
 
 The local CTU archive with our CAN components prepared for inclusion
 into OCERA SF CVS could be found in my "can" directory
 

-  @indicateurl{http://cmp.felk.cvut.cz/~pisa/can/ocera-can-031212.tar.gz}
+  @uref{http://cmp.felk.cvut.cz/~pisa/can/ocera-can-031212.tar.gz}

 
 The code should build for user-space with new make on most of Linux distros
 when make is updated.
 
 The code should build for user-space with new make on most of Linux distros
 when make is updated.