]> rtime.felk.cvut.cz Git - omk.git/commitdiff
Update introduction
authorMichal Sojka <sojkam1@fel.cvut.cz>
Tue, 12 Nov 2013 08:20:10 +0000 (09:20 +0100)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Tue, 12 Nov 2013 08:20:10 +0000 (09:20 +0100)
doc/omk-manual.texinfo

index 9d9b9ae22d41cd0287ec051204fd46d2c8be9b01..c7f649436e6838e37014f9a0179832bd0c510981 100644 (file)
@@ -6,7 +6,8 @@
 @c %**end of header
 
 @copying
-Manual for Ocera Make System (OMK) version @include .version
+Manual for Ocera Make System (OMK) version
+@include .version
 
 Copyright @copyright{} 2007, 2008, 2009, 2010, 2011, 2013 Michal Sojka, Pavel Pisa
 @end copying
@@ -133,8 +134,7 @@ make
 @item
   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}
+  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
@@ -182,22 +182,26 @@ about the process of modularization.
 @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
-projects resides a file called @file{Makefile.rules}. This file contains
-all compilation rules needed for compilation of a particular
-project. There are different @file{Makefile.rules} for different
-platforms (Unix, RTEMS, system-less, ...). In every subdirectory a
-@file{Makefile.omk} is stored. This file determines what should be done
-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@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.
+The main concept of OMK is very simple. In the heart of OMK are two
+files @file{Makefile.rules} and @file{Makefile.omk}. The former one
+resides in project root directory and contains all compilation rules
+needed for compilation of the particular project. There are different
+@file{Makefile.rules} for different platforms (Unix, RTEMS, system-less,
+...). @file{Makefile.omk} is stored in every (sub)directory and
+describes what should @command{make} perform in that directory (e.g.
+compile a program from several source files). It uses declarative syntax
+(assign values to variables) similar to Automake files
+@file{Makefile.am}. The content of @file{Makefile.omk} is described in
+the following sections.
+
+Since @command{make} searches by default for a @file{Makefile} and not
+for @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.
 
 @c TODO: Pavel's note about qmake.