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.
or rarely used so they were omitted in previous sections.
@menu
-* Unsorted Advanced Features::
+* Organization of the Source Tree::
+* Additional Variables::
* Adding Hooks to Passes::
@end menu
-@node Unsorted Advanced Features, Adding Hooks to Passes, Advanced OMK Features, Advanced OMK Features
-@subsection Unsorted Advanced Features
+@node Organization of the Source Tree, Additional Variables, Advanced OMK Features, Advanced OMK Features
+@subsection Organization of the Source Tree
@itemize
@item
top-level @file{Makefile.omk}, adjust @file{Makefile.omk} to contain
only required components and then call @command{make} in the top
directory or even in read-only directories after changing working
- directory from your tree to readonly media.
+ directory from your tree to the readonly media.
@end itemize
(re)compiled, even if @command{make} is called from a subdirectory.
@end defvar
+@node Additional Variables, Adding Hooks to Passes, Organization of the Source Tree, Advanced OMK Features
+@subsection Additional Variables
+
@anchor{USE_LEAF_MAKEFILES}
@defvar USE_LEAF_MAKEFILES
If this variable equals to @samp{n} (default is unset), then OMK uses
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
@file{Makefile.omk} to tweak compilation for specific targets.
@end defvar
-@node Adding Hooks to Passes, , Unsorted Advanced Features, Advanced OMK Features
+@node Adding Hooks to Passes, , Additional Variables, Advanced OMK Features
@subsection Adding Hooks to Passes
Sometimes it is necessary to run some special commands as a part of
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
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
@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
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
projects / omk.git / blobdiff