]> rtime.felk.cvut.cz Git - omk.git/commitdiff
Whitespace and copyright
authorMichal Sojka <sojkam1@fel.cvut.cz>
Tue, 12 Nov 2013 07:47:15 +0000 (08:47 +0100)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Tue, 12 Nov 2013 07:47:15 +0000 (08:47 +0100)
doc/omk-manual.texinfo

index 4da5145c15ed867595314f8230c42022e1f6ec97..9d9b9ae22d41cd0287ec051204fd46d2c8be9b01 100644 (file)
@@ -8,7 +8,7 @@
 @copying
 Manual for Ocera Make System (OMK) version @include .version
 
-Copyright @copyright{} 2007, 2008, 2009, 2010, 2011 Michal Sojka, Pavel Pisa
+Copyright @copyright{} 2007, 2008, 2009, 2010, 2011, 2013 Michal Sojka, Pavel Pisa
 @end copying
 
 @titlepage
@@ -29,11 +29,11 @@ Copyright @copyright{} 2007, 2008, 2009, 2010, 2011 Michal Sojka, Pavel Pisa
 
 
 @menu
-* Overview::                    
-* User's Manual::               
-* Original README::             
-* Development::                 
-* Variable Index::              
+* Overview::
+* User's Manual::
+* Original README::
+* Development::
+* Variable Index::
 @end menu
 
 @node Overview, User's Manual, Top, Top
@@ -62,9 +62,9 @@ Cygwin and MinGW. MS DOS was not tested.
 @c @end itemize
 
 @menu
-* Why to Use OMK?::             
-* Quick Start::                 
-* History::                     
+* Why to Use OMK?::
+* Quick Start::
+* History::
 @end menu
 
 @node Why to Use OMK?, Quick Start, Overview, Overview
@@ -165,18 +165,18 @@ about the process of modularization.
 @chapter User's Manual
 
 @menu
-* Basic Concepts::              
-* Invoking OMK::                
-* Compiling Programs::          
-* Compiling Libraries::         
-* Recursing into Subdirectories::  
-* Dependency Tracking::         
-* Configuration and Conditional Compilation::  
-* Advanced OMK Features::       
-* Properties of Specific Makefile.rules::  
-* Running OMK under Windows OS::  
-* Interfacing OMK to popular IDEs::  
-* Troubleshooting::             
+* Basic Concepts::
+* Invoking OMK::
+* Compiling Programs::
+* Compiling Libraries::
+* Recursing into Subdirectories::
+* Dependency Tracking::
+* Configuration and Conditional Compilation::
+* Advanced OMK Features::
+* Properties of Specific Makefile.rules::
+* Running OMK under Windows OS::
+* Interfacing OMK to popular IDEs::
+* Troubleshooting::
 @end menu
 
 @node Basic Concepts, Invoking OMK, User's Manual, User's Manual
@@ -431,7 +431,7 @@ by other programs.
 @end defvar
 
 @defvar shared_LIBRARIES
-  Specifies a list of dynamically linked libraries to be compiled. 
+  Specifies a list of dynamically linked libraries to be compiled.
 @end defvar
 
 @defvar xxx_SOURCES
@@ -442,7 +442,7 @@ by other programs.
 @end defvar
 
 @menu
-* Header Files::                
+* Header Files::
 @end menu
 
 @node Header Files,  , Compiling Libraries, Compiling Libraries
@@ -480,7 +480,7 @@ and what is their destination file name.
   in this whitespace separated list is: @var{real name}@code{->}@var{new
   name}.
 
-@example 
+@example
   renamed_include_HEADERS = orte_config_omk_win32.h->orte_config.h
 @end example
 @end defvar
@@ -498,7 +498,7 @@ and what is their destination file name.
 
 @c   Another reason for having single include directory for the whole
 @c   project is tat every component knows where to find header files of
-@c   other components. 
+@c   other components.
 
   On the other side, the copying could make problems during
   development. Most @acronym{IDE}s, allows you to jump directly to the
@@ -506,7 +506,7 @@ and what is their destination file name.
   a header file, IDE opens you the copy of the header file. If you
   correct the error there, after the next compilation, your header file
   will be overwritten by the old version from your source tree.
-  
+
   This option is not typically used in @file{Makefile.omk}, but in the
   top level configuration file @file{config.omk} or on command line.
 @end defvar
@@ -600,7 +600,7 @@ values:
 @item config.target
   Stores default configuration for a project or target hardware. This
   file is intended to be stored in a version control system and should
-  be modified only by the maintainer of the project. 
+  be modified only by the maintainer of the project.
 
   For cross compiled projects, this file typically contains settings of
   variables like @var{CC} and @var{CFLAGS}.
@@ -623,9 +623,9 @@ globally for all people working with the project in
 @file{config.target}.
 
 @menu
-* Specifying Configuration Parameters::  
-* Using Configuration Parameters::  
-* Common Variables::            
+* Specifying Configuration Parameters::
+* Using Configuration Parameters::
+* Common Variables::
 @end menu
 
 @node Specifying Configuration Parameters, Using Configuration Parameters, Configuration and Conditional Compilation, Configuration and Conditional Compilation
@@ -639,17 +639,17 @@ To specify names and default values of configuration parameters use the
   default values. The format of every item in this list is
   @var{CONFIG_xxxx}=@var{value}. You can name the parameter as you want,
   but it is good practice to start the name with @samp{CONFIG_} prefix.
-   
+
   OMK can automatically generate header files, with C preprocessor macro
   definitions according to the OMK's configuration parameters. The
   actual content of generated header files depends on the form of the
   @var{value}. The possible forms are:
-  
-@table @code 
+
+@table @code
 @item @samp{y}, @samp{n} or @samp{x}
   This defines boolean parameters. If the value of the parameter is
   @samp{y}, the @samp{#define CONFIG_@var{xxx} 1} is generated, if it is
-  @samp{n}, no @code{#define} is generated. 
+  @samp{n}, no @code{#define} is generated.
 
   @samp{x} is a special value called @emph{recessive 'n'}. The meaning
   is that this parameter influences the component in the current
@@ -741,10 +741,10 @@ LOCAL_CONFIG_H = myconfig.h
 @example
 default_CONFIG = CONFIG_LINCAN=y CONFIG_LINCANRTL=n CONFIG_LINCANVME=n
 config_include_HEADERS = global.h
-global_DEFINES = CONFIG_OC_LINCAN CONFIG_OC_LINCANRTL 
+global_DEFINES = CONFIG_OC_LINCAN CONFIG_OC_LINCANRTL
 @end example
 
-@noindent Here, we include only two out of the three configuration 
+@noindent Here, we include only two out of the three configuration
 parameters defined in the current @file{Makefile.omk}. It is also
 possible to include configuration parameters defined in a different
 directory.
@@ -781,10 +781,10 @@ In this section we list several OMK features, which are more complicated
 or rarely used so they were omitted in previous sections.
 
 @menu
-* Organization of the Source Tree::  
-* Additional Variables::        
-* Adding Hooks to Passes::      
-* Integration of Wvtest Framework::  
+* 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
@@ -965,9 +965,9 @@ documented. This section contains documentation to features found only
 in some particular @file{Makefile.rules}.
 
 @menu
-* Linux::                       
-* System-Less::                 
-* RTEMS::                       
+* Linux::
+* System-Less::
+* RTEMS::
 @end menu
 
 @node Linux, System-Less, Properties of Specific Makefile.rules, Properties of Specific Makefile.rules
@@ -982,7 +982,7 @@ suggests, but also for other Unices and even for Windows.
 
 @defvar TARGET_OS
   Should specify the name of OS where the resulting binary should be
-  used. If not specified manually, it equals to BUILD_OS. 
+  used. If not specified manually, it equals to BUILD_OS.
 @end defvar
 
 @defvar QT_SUBDIRS
@@ -1013,8 +1013,8 @@ more information about our framework, which uses this rules.
 @subsection RTEMS
 
 TODO
+
+
 @node Running OMK under Windows OS, Interfacing OMK to popular IDEs, Properties of Specific Makefile.rules, User's Manual
 @section Running OMK under Windows OS
 
@@ -1028,9 +1028,9 @@ TODO: Is it necessary to install anything special?
 @section Interfacing OMK to popular IDEs
 
 @menu
-* KDevelop::                    
-* Eclipse/CDT::                 
-* Emacs/Vim/etc.::              
+* KDevelop::
+* Eclipse/CDT::
+* Emacs/Vim/etc.::
 @end menu
 
 @node KDevelop, Eclipse/CDT, Interfacing OMK to popular IDEs, Interfacing OMK to popular IDEs
@@ -1247,31 +1247,31 @@ list of the user-space shared libraries
 list of the kernel-space libraries
 @item rtlinux_LIBRARIES
 list of the RT-Linux kernel-space libraries
-@item include_HEADERS  
+@item include_HEADERS
 list of the user-space header files
-@item nobase_include_HEADERS 
+@item nobase_include_HEADERS
 headers copied even with directory part
-@item kernel_HEADERS   
+@item kernel_HEADERS
 list of the kernel-space  header files
-@item rtlinux_HEADERS  
+@item rtlinux_HEADERS
 list of the RT-Linux kernel-space  header files
-@item bin_PROGRAMS     
+@item bin_PROGRAMS
 list of the require binary programs
-@item utils_PROGRAMS   
+@item utils_PROGRAMS
 list of the development utility programs
-@item kernel_MODULES   
+@item kernel_MODULES
 list of the kernel side modules/applications
-@item rtlinux_MODULES  
+@item rtlinux_MODULES
 list of RT-Linux the kernel side modules/applications
-@item xxx_SOURCES      
+@item xxx_SOURCES
 list of specific target sources
-@item INCLUDES         
+@item INCLUDES
 additional include directories and defines for user-space
-@item kernel_INCLUDES  
+@item kernel_INCLUDES
 additional include directories and defines for kernel-space
-@item rtlinux_INCLUDES 
+@item rtlinux_INCLUDES
 additional include directories and defines for RT-Linux
-@item default_CONFIG   
+@item default_CONFIG
 list of default config assignments CONFIG_XXX=y/n ...
 @end vtable
 
@@ -1339,9 +1339,9 @@ Next passes are defined
 @table @samp
 @item default-config
 generates @file{config.omk-default} or xxx-default (FIXME) configuration file
-@item check-dir 
+@item check-dir
 checks and creates required build directories
-@item include-pass   
+@item include-pass
 copies header files to @code{USER_INCLUDE_DIR} and @code{KERN_INCLUDE_DIR}
 @item library-pass
 builds objects in USER_BUILD_DIR/@var{relative path} and creates libraries
@@ -1351,7 +1351,7 @@ links respective binaries in USER_@{BIN,UTILS@}_DIR directory. If some
 object file is missing it compiles it in USER_BUILD_DIR/@var{relative path}
 @item kernel-lib-pass
 builds libraries for kernel space targets
-@item kernel-pass 
+@item kernel-pass
 builds kernel modules
 @end table
 
@@ -1381,7 +1381,7 @@ corrected in newer sources (FIXME)
 @end itemize
 
 The last point is critical. I have not noticed it first, because
-I use Slackware-9.2 and it contains latest released version 
+I use Slackware-9.2 and it contains latest released version
 of MAKE (version 3.80).
 The problem appears when I have tried to build bigger libraries.
 There is bug in version 3.80, which results in misleading
@@ -1439,7 +1439,7 @@ The next line, if enabled, controls compilation in OCERA project tree
 The LinCAN driver has been updated to compile out of source directories.
 
 Please, check, if you could compile CAN package and help us with integration
-into OCERA SF CVS. Send your comments and objections. 
+into OCERA SF CVS. Send your comments and objections.
 
 The OMK system has been adapted to support actual OCERA configuration process.
 I am not happy with ocera.mk mix of defines and poor two or three rules,
@@ -1475,7 +1475,7 @@ 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 
+fact that
 
 @item @var{pass-name}-this-dir
 This target calls make recursively once again with @var{pass-name}-local