]> rtime.felk.cvut.cz Git - omk.git/blobdiff - doc/omk-manual.texinfo
Simplify titles in documentation
[omk.git] / doc / omk-manual.texinfo
index af17477a9db93e4b7ca7bf5bb6c08ab84314bb89..b7866654b8a6d0199abfbe569af654c2c9dd3640 100644 (file)
@@ -8,7 +8,7 @@
 @copying
 Manual for Ocera Make System (OMK) version $Id$
 
-Copyright @copyright{} 2007, 2008, 2009 Michal Sojka, Pavel Pisa
+Copyright @copyright{} 2007, 2008, 2009, 2010 Michal Sojka, Pavel Pisa
 @end copying
 
 @titlepage
@@ -21,7 +21,7 @@ Copyright @copyright{} 2007, 2008, 2009 Michal Sojka, Pavel Pisa
 @contents
 
 @ifnottex
-@node Top, Overview of OMK, (dir), (dir)
+@node Top, Overview, (dir), (dir)
 @top Ocera Make System
 
 @insertcopying
@@ -29,15 +29,15 @@ Copyright @copyright{} 2007, 2008, 2009 Michal Sojka, Pavel Pisa
 
 
 @menu
-* Overview of OMK::             
-* OMK User's Manual::           
+* Overview::                    
+* User's Manual::               
 * Original README::             
-* OMK Development::             
+* Development::                 
 * Variable Index::              
 @end menu
 
-@node Overview of OMK, OMK User's Manual, Top, Top
-@chapter OMK Overview
+@node Overview, User's Manual, Top, Top
+@chapter Overview
 @cindex overview
 
 OMK is an advanced make system written entirely in GNU make. Compiling
@@ -67,7 +67,7 @@ Cygwin and MinGW. MS DOS was not tested.
 * History::                     
 @end menu
 
-@node Why to Use OMK?, Quick Start, Overview of OMK, Overview of OMK
+@node Why to Use OMK?, Quick Start, Overview, Overview
 @section Why to Use OMK?
 
 Here we list some of OMK features, which we think are important for
@@ -114,7 +114,7 @@ choosing of a make system.
 
 
 
-@node Quick Start, History, Why to Use OMK?, Overview of OMK
+@node Quick Start, History, Why to Use OMK?, Overview
 @section Quick Start
 
 If you get some sources, which are distributed with OMK, usually the
@@ -138,7 +138,7 @@ make
   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
+  compile something. Please refer to @ref{User's Manual} to learn
   what to write in @file{Makefile.omk} files.
 @item
   Run @command{make omkize} in the root directory.
@@ -147,7 +147,7 @@ make
 @noindent Your project is now ready to compile.
 
 
-@node History,  , Quick Start, Overview of OMK
+@node History,  , Quick Start, Overview
 @section History
 
 OMK was originally written by Pavel Píša as a solution to have one
@@ -161,8 +161,8 @@ As a number of projects using OMK grew it was necessary to modularize
 the make system to support more ``targets''. Michal Sojka took care
 about the process of modularization.
 
-@node OMK User's Manual, Original README, Overview of OMK, Top
-@chapter OMK User's Manual
+@node User's Manual, Original README, Overview, Top
+@chapter User's Manual
 
 @menu
 * Basic Concepts::              
@@ -179,7 +179,7 @@ about the process of modularization.
 * Troubleshooting::             
 @end menu
 
-@node Basic Concepts, Invoking OMK, OMK User's Manual, OMK User's Manual
+@node Basic Concepts, Invoking OMK, User's Manual, User's Manual
 @section Basic Concepts
 
 The main concept of OMK is very simple. In the root directory of the
@@ -246,7 +246,7 @@ Automake's @file{Makefile.am} syntax. Also, the scheme for naming
 variables was inspired by Automake so most OMK variables have the name
 like @samp{@var{target}_@var{TYPE}}.
 
-@node Invoking OMK, Compiling Programs, Basic Concepts, OMK User's Manual
+@node Invoking OMK, Compiling Programs, Basic Concepts, User's Manual
 @section Invoking OMK
 
 Before using OMK for the first time, you have to call:
@@ -309,7 +309,7 @@ as with @samp{1} and in addition directory navigation messages are
 printed.
 @end defvar
 
-@node Compiling Programs, Libraries, Invoking OMK, OMK User's Manual
+@node Compiling Programs, Libraries, Invoking OMK, User's Manual
 @section Compiling Programs
 
 To tell OMK to compile a program, you need to set some variables in
@@ -403,7 +403,7 @@ source @file{test.c}.
 
 @c FIXME: INCLUDES variable should not be set by rtlinux rules.
 
-@node Libraries, Multiple Directories, Compiling Programs, OMK User's Manual
+@node Libraries, Multiple Directories, Compiling Programs, User's Manual
 @section Libraries
 
 
@@ -509,7 +509,7 @@ these copies.
   top level configuration file @file{config.omk} or on command line.
 @end defvar
 
-@node Multiple Directories, Dependency Tracking, Libraries, OMK User's Manual
+@node Multiple Directories, Dependency Tracking, Libraries, User's Manual
 @section Multiple Directories
 
 OMK is probably most useful in projects consisting of multiple
@@ -554,7 +554,7 @@ You can instruct OMK to descend to a (sub)directory by setting the
   value @code{$(ALL_OMK_SUBDIRS)}.
 @end defvar
 
-@node Dependency Tracking, Configuration and Conditional Compilation, Multiple Directories, OMK User's Manual
+@node Dependency Tracking, Configuration and Conditional Compilation, Multiple Directories, User's Manual
 @section Dependency Tracking
 
 OMK automatically handles tracking of dependencies of files in compiled
@@ -566,7 +566,7 @@ Dependencies are also maintained for libraries and binaries. To find the
 dependencies, OMK parses linker map files, so a change to some library
 causes recompilation of all programs using that library.
 
-@node Configuration and Conditional Compilation, Advanced OMK Features, Dependency Tracking, OMK User's Manual
+@node Configuration and Conditional Compilation, Advanced OMK Features, Dependency Tracking, User's Manual
 @section Configuration and Conditional Compilation
 
 In many projects, it is necessary to configure the compilation process. By
@@ -772,7 +772,7 @@ to the desired configuration.
   compiler.
 @end vtable
 
-@node Advanced OMK Features, Properties of Specific Makefile.rules, Configuration and Conditional Compilation, OMK User's Manual
+@node Advanced OMK Features, Properties of Specific Makefile.rules, Configuration and Conditional Compilation, User's Manual
 @section Advanced OMK Features
 
 In this section we list several OMK features, which are more complicated
@@ -904,7 +904,7 @@ generated_header.h: $(SOURCES_DIR)/data_file.txt
 @end example
 @end defvar
 
-@node Properties of Specific Makefile.rules, Running OMK under Windows OS, Advanced OMK Features, OMK User's Manual
+@node Properties of Specific Makefile.rules, Running OMK under Windows OS, Advanced OMK Features, User's Manual
 @section Properties of Specific Makefile.rules
 
 In previous sections, general properties of @file{Makefile.rules} were
@@ -956,7 +956,7 @@ more information about our framework, which uses this rules.
 TODO
  
  
-@node Running OMK under Windows OS, Interfacing OMK to popular IDEs, Properties of Specific Makefile.rules, OMK User's Manual
+@node Running OMK under Windows OS, Interfacing OMK to popular IDEs, Properties of Specific Makefile.rules, User's Manual
 @section Running OMK under Windows OS
 
 It is possible to use OMK under Windows OS with MinGW (see
@@ -965,7 +965,7 @@ 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
+@node Interfacing OMK to popular IDEs, Troubleshooting, Running OMK under Windows OS, User's Manual
 @section Interfacing OMK to popular IDEs
 
 @menu
@@ -1040,7 +1040,7 @@ many common editors can work easily with OMK.
 Under Emacs, you can use @command{compile} or @command{recompile}
 commands as you are used to do.
 
-@node Troubleshooting,  , Interfacing OMK to popular IDEs, OMK User's Manual
+@node Troubleshooting,  , Interfacing OMK to popular IDEs, User's Manual
 @section Troubleshooting & Knows Bugs
 
 @itemize
@@ -1076,7 +1076,7 @@ commands as you are used to do.
   distclean} before you run @command{make}.
 @end itemize
 
-@node Original README, OMK Development, OMK User's Manual, Top
+@node Original README, Development, User's Manual, Top
 @chapter Original README
 
 Since this manual still doesn't cover all aspects of OMK, we include
@@ -1396,8 +1396,8 @@ list for all options if Kconfig is used.
 
 @c @chapter OMK Reference
 
-@node OMK Development, Variable Index, Original README, Top
-@chapter OMK Development
+@node Development, Variable Index, Original README, Top
+@chapter Development
 
 This section is far from complete. Its purpose is to document internals
 of @file{Makefile.rules} as well as other things needed only by people
@@ -1428,7 +1428,7 @@ This target is responsible for recursive invocation of @command{make} in
 subdirectories specified in @code{@ref{SUBDIRS}} variable.
 @end table
 
-@node Variable Index,  , OMK Development, Top
+@node Variable Index,  , Development, Top
 @unnumbered Variable Index
 
 @printindex vr