]> rtime.felk.cvut.cz Git - omk.git/commitdiff
doc: Add skeleton of documentation for wvtest integration
authorMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 17 Feb 2011 16:25:53 +0000 (17:25 +0100)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 17 Feb 2011 16:25:53 +0000 (17:25 +0100)
doc/omk-manual.texinfo

index 211ba50114f61a3c85559cc369a141cc2cffb646..bbff545d0c18d816ba360309acbaa084de2d0945 100644 (file)
@@ -331,6 +331,7 @@ source @file{test.c}.
   compiled in this directory.
 @end defvar
 
+@anchor{test_PROGRAMS}
 @defvar test_PROGRAMS
   Almost the same as @ref{bin_PROGRAMS}, but resulting binaries are
   stored in @file{bin-tests} directory instead of @file{bin}. This
@@ -783,6 +784,7 @@ or rarely used so they were omitted in previous sections.
 * Organization of the Source Tree::  
 * Additional Variables::        
 * Adding Hooks to Passes::      
+* Integration of Wvtest Framework::  
 @end menu
 
 @node   Organization of the Source Tree, Additional Variables, Advanced OMK Features, Advanced OMK Features
@@ -875,7 +877,7 @@ compilation. Values are like @samp{linux}, @samp{rtems}, @samp{sysless},
 @file{Makefile.omk} to tweak compilation for specific targets.
 @end defvar
 
-@node Adding Hooks to Passes,  , Additional Variables, Advanced OMK Features
+@node Adding Hooks to Passes, Integration of Wvtest Framework, Additional Variables, Advanced OMK Features
 @subsection Adding Hooks to Passes
 
 Sometimes it is necessary to run some special commands as a part of
@@ -905,6 +907,26 @@ generated_header.h: $(SOURCES_DIR)/data_file.txt
 @end example
 @end defvar
 
+@node Integration of Wvtest Framework,  , Adding Hooks to Passes, Advanced OMK Features
+@subsection Integration of Wvtest Framework
+
+OMK has integrated support for Wvtest unit testing framework (see
+@uref{https://github.com/apenwarr/wvtest}).
+
+@defvar wvtest_PROGRAMS
+This variable is the same as @ref{test_PROGRAMS} with the exception that
+the program is automatically executed by @command{make wvtest} (see
+below).
+@end defvar
+
+@defvar wvtest_SCRIPT
+TODO
+@end defvar
+
+@command{make wvtest} TODO
+
+
+
 @node Properties of Specific Makefile.rules, Running OMK under Windows OS, Advanced OMK Features, User's Manual
 @section Properties of Specific Makefile.rules