]> rtime.felk.cvut.cz Git - omk.git/commitdiff
Added some content to OMK Development section in manual
authorMichal Sojka <sojkam1@fel.cvut.cz>
Mon, 14 Jul 2008 15:47:00 +0000 (15:47 +0000)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Mon, 14 Jul 2008 15:47:00 +0000 (15:47 +0000)
darcs-hash:20080714154750-f2ef6-5530b89f357e0377fd8594b3bae5d3bb049e37a1.gz

doc/omk-manual.texinfo

index 8b2fa8a8df5e852843b4505a6b292eb907007119..8320a6ddcf78e42b3dfed2dd684b40ebe6b021f3 100644 (file)
@@ -1382,7 +1382,34 @@ list for all options if Kconfig is used.
 @node OMK Development, Variable Index, Original README, Top
 @chapter OMK 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
+who hack OMK itself.
 
+@section Passes
+
+A pass is created by instantiation of @code{omk_pass_template} with
+@var{pass-name} as one of arguments. This defines several targets which
+are described here:
+
+@table @code
+@item @var{pass-name}
+Target used to invoke the individual pass either from command line or
+from inside of @file{Makefile.rules}.
+
+@item @var{pass-name}-submakes
+Invoked recursively from @var{pass-name}. The reason for this is the
+fact that 
+
+@item @var{pass-name}-this-dir
+This target calls make recursively once again with @var{pass-name}-local
+target, which does the real-work. Make's working directory is set to the
+corresponding directory in @file{_build} tree and the -local
+
+@item @var{pass-name}-@var{dirname}-subdir
+This target is responsible for recursive invocation of @command{make} in
+subdirectories specified in @ref{@code{SUBDIRS}} variable.
+@end table
 
 @node Variable Index,  , OMK Development, Top
 @unnumbered Variable Index