Updates and fixes to documentation

darcs-hash:20080418192402-f2ef6-305f192e04e58888ed9bb342147a640d45624640.gz

diff --git a/doc/omk-manual.texinfo b/doc/omk-manual.texinfo
index 46e5959c8ddc5b9c23d8d2f81d1403462cb37bfa..db4fadca13ca763a14516dea9c0b9e2c2e70dffd 100644 (file)
--- a/doc/omk-manual.texinfo
+++ b/doc/omk-manual.texinfo
@@ -188,7 +188,9 @@ in the respective directory (e.g. compile a program from several source
 files). Its syntax is very simple -- see the following sections.
 
 Since make searches by default for a @file{Makefile} and not for
-@file{Makefile.rules} or @file{Makefile.omk}, there must be a small
+@file{Makefile.rules} or @file{Makefile.omk}, there must@footnote{When
+USE_LEAF_MAKEFILES is set to @samp{n}, this @file{Makefile} can be
+omitted in subdirectories. @xref{USE_LEAF_MAKEFILES}.} be a small
 generic @file{Makefile} in every directory, whose task is only to find
 @file{Makefile.rules} in the actual or any parent directory and include
 it. This search is performed only once at the beginning of compilation.
@@ -806,7 +808,7 @@ the leaf @file{Makefile} only when it is invoked by simple
 directly.
 
 This feature is useful if you are integrating some non-OMK project into
-your project. You only add @file{Makefile.omk} files to the other
+your project. You only add @file{Makefile.omk} files to the non-OMK
 project and don't need to modify project's original Makefiles.
 
 This variable can be set either globally in a @file{config.*} file or
@@ -910,20 +912,33 @@ sugest, but also for other Unices and even for Windows.
   parameters to interface QT application to the rest of the compilation
   tree.  Then @command{make} is called there to compile QT
   application. Variable @samp{QTDIR} must be set to the directory with
-  QT instalation (e.g. /usr/share/qt4 on Debian).
+  QT installation (e.g. /usr/share/qt4 on Debian).
 @end defvar
 
 
 @node System-Less, RTEMS, Linux, Properties of Specific Makefile.rules
 @subsection System-Less
 
+This @file{Makefile.rules} is deigned for compilation of code for
+(small) micro-controllers without operating systems. See
+@uref{http://rtime.felk.cvut.cz/hw/index.php/System-Less_Framework} for
+more information about our framework, which uses this rules.
+
 @node RTEMS,  , System-Less, Properties of Specific Makefile.rules
 @subsection RTEMS
+
+TODO
  
  
 @node Running OMK under Windows OS, Interfacing OMK to popular IDEs, Properties of Specific Makefile.rules, OMK User's Manual
 @section Running OMK under Windows OS
 
+It is possible to use OMK under Windows OS with MinGW (see
+@uref{http://www.mingw.org/}). Unfortunately, the compilation speed is
+much lower than on UNIX systems.
+
+TODO: Is it necessary to install anything special?
+
 @node Interfacing OMK to popular IDEs, Troubleshooting, Running OMK under Windows OS, OMK User's Manual
 @section Interfacing OMK to popular IDEs
 
@@ -1015,15 +1030,19 @@ commands as you are used to do.
   Sometimes, you may want to compile one file the same way as OMK does
   it, but run the compilation manually from command line. For example,
   you want to debug some preprocessor macros and you only want to
-  produce preprocessed source instead of object file.
+  produce preprocessed source instead of an object file.
 
-  To compile something manually, you can run OMK with @command{make
+  To compile something manually, you can run OMK by @command{make
   V=2}. This will print all commands executed together with directory
   navigation messages. Find the command you want to execute manually in
   the output. To run it, you need to change the working directory to the
   correct one in the @file{_build} tree. The correct directory can be
   found in make output on the line @samp{Entering directory} preceding
   the desired command.
+
+@item
+  Currently, C++ sources are supposed to have @file{.cc} or @file{.cxx}
+  extensions. The @file{.cpp} extension is not supported (yet).
 @end itemize
 
 @node Original README, OMK Development, OMK User's Manual, Top
@@ -1054,7 +1073,7 @@ different kernel, RT-Linux etc would be nightmare in other case).
 @item
 Make system should allow to freely move cross-dependant components in
 directory structure without need to update users of moved component (I
-hate somethink like @option{-I../../sched/rtlshwq/include} in CAN makefiles for
+hate something like @option{-I../../sched/rtlshwq/include} in CAN makefiles for
 example. If a component is renamed or version is added to then name,
 all Makefiles in CAN will require update).
 @item
@@ -1118,7 +1137,7 @@ sources directory. Alternatively this file could be moved
 to link tree pointing into readonly media or can be anywhere
 else if @code{MAKERULES_DIR} and @code{SOURCES_DIR} are specified.
 
-@c !!! tohle tam nejak zmizelo, mozna by to chtelo skontrolovat, ze to
+@c !!! tohle tam nejak zmizelo, mozna by to chtelo zkontrolovat, ze to
 @c     sedi s aktualnim stavem