Fixed QT compilation from subdirectory and documented QT_SUBDIRS variable

[omk/sssa.git] / doc / omk-manual.texinfo

diff --git a/doc/omk-manual.texinfo b/doc/omk-manual.texinfo
index c40751f21a3353e86449772ff32d4207fc38d475..9a5b094d98aca2c376b9375528a58614430223f6 100644 (file)
--- a/doc/omk-manual.texinfo
+++ b/doc/omk-manual.texinfo
@@ -195,7 +195,8 @@ it. This search is performed only once at the beginning of compilation.
 
 @c TODO: Pavel's note about qmake.
 
-The compilation process itself is comprised of several passes. Every
+@anchor{passes}
+The compilation process itself is comprised of several @emph{passes}. Every
 pass traverses the whole directory structure@footnote{In future, we are
 planning some optimization that allows OMK to traverse the directories
 only once and thus decrease compilation time.} and does a particular
@@ -740,6 +741,14 @@ to the desired configuration.
 In this section we list several OMK features, which are more complicated
 or rarely used so they were omitted in previous sections.
 
+@menu
+* Unsorted Advanced Features::  
+* Adding Hooks to Passes::      
+@end menu
+
+@node  Unsorted Advanced Features, Adding Hooks to Passes, Advanced OMK Features, Advanced OMK Features
+@subsection Unsorted Advanced Features
+
 @itemize
 @item
   The @file{_compiled} directory can be shared between multiple projects
@@ -792,6 +801,7 @@ locally in some @file{Makefile.omk}. In the latter case, it influences
 only subdirectories of the directory containing @file{Makefile.omk}.
 @end defvar
 
+@anchor{SOURCES_DIR}
 @defvar{SOURCES_DIR}
 This variable is set internally by OMK and its value is the absolute
 path to the directory with compiled sources. It can be used if you need
@@ -804,12 +814,54 @@ include_HEADERS = $(notdir $(wildcard $(SOURCES_DIR)/*.h))
 @end example
 @end defvar
 
+@defvar{srcdir}
+The same as @ref{SOURCES_DIR}. Provided for Automake compatibility.
+@end defvar
+
 @defvar{MAKERULES_DIR}
 This variable is set internally by OMK and its value is the absolute
 path to the directory containing @file{Makefile.rules} currently used
 during compilation.
 @end defvar
 
+@defvar{OMK_RULES_TYPE}
+Identification the type of @file{Makefile.rules} used for
+compilation. Values are like @samp{linux}, @samp{rtems}, @samp{sysless},
+... This variable is automatically generated during creation of
+@file{Makefile.rules} and can be used in configuration files (see
+@ref{Configuration and Conditional Compilation}) or in
+@file{Makefile.omk} to tweak compilation for specific targets.
+@end defvar
+
+@node Adding Hooks to Passes,  , Unsorted Advanced Features, Advanced OMK Features
+@subsection Adding Hooks to Passes
+
+Sometimes it is necessary to run some special commands as a part of
+compilation. Typical example might be a tool which generates source
+files on the fly. OMK supports calling additional commands during
+compilation by so called @emph{pass hooks}. A pass hook is an ordinary
+make target which is invoked as part of compilation during a particular
+pass (see @ref{passes}). Pass hooks can be defined by assigning their
+names to @code{xxx_HOOKS} variable.
+
+@defvar{xxx_HOOKS}
+Specifies one or more hooks (make targets) which are invoked during pass
+@var{xxx}. The working directory of commands or this target is under the
+@file{_build} tree.
+
+In the example bellow header file @file{generated_header.h} is created
+during @samp{include-pass} by @file{convert_data} program. The program
+takes @file{data_file.txt} in the source directory as the input and
+creates the header file in the in the correct directory under the
+@file{_build} tree.
+
+@example
+include-pass_HOOKS = generated_header.h
+
+generated_header.h: $(SOURCES_DIR)/data_file.txt
+            convert_data < $^ > $@@
+@end example
+@end defvar
 
 @node Properties of Specific Makefile.rules, Running OMK under Windows OS, Advanced OMK Features, OMK User's Manual
 @section Properties of Specific Makefile.rules
@@ -839,6 +891,14 @@ sugest, but also for other Unices and even for Windows.
   used. If not specified manually, it equals to BUILD_OS. 
 @end defvar
 
+@defvar QT_SUBDIRS
+  Lists subdirectories with QT project (.pro) file. OMK will generate
+  there @file{Makefile} by calling @command{qmake} with correct
+  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).
+@end defvar
 
 
 @node System-Less, RTEMS, Linux, Properties of Specific Makefile.rules