include .conf files in the Makefile dependencies
authorChristian Thaeter <ct@pipapo.org>
Tue, 10 Aug 2010 03:25:34 +0000 (05:25 +0200)
committerChristian Thaeter <ct@pipapo.org>
Tue, 10 Aug 2010 03:25:34 +0000 (05:25 +0200)
Makefile.am
doc/logflags.txt

index f860d82..331f5c4 100644 (file)
@@ -84,7 +84,7 @@ manual_ASCIIDOCS = \
        $(libnobugmt_la_SOURCES) \
        $(nobug_rbdump_SOURCES)
 
-nobug_manual.txt: doc/nobug_manual.conf doc/asciidoc.pawk doc/verbatim.pawk $(manual_ASCIIDOCS) $(wildcard $(top_srcdir)/doc/*.txt)
+nobug_manual.txt: doc/nobug_manual.conf doc/asciidoc.pawk doc/verbatim.pawk $(manual_ASCIIDOCS) $(wildcard $(top_srcdir)/doc/*.txt) $(wildcard $(top_srcdir)/doc/*.conf)
        @which gawk >/dev/null || ( echo "gawk not installed!"; exit 1; )
        ( cd $(top_srcdir) ; ./pipadoc doc/nobug_manual.conf doc/asciidoc.pawk doc/verbatim.pawk        \
                $(patsubst $(top_srcdir)/%,%,$(wildcard $(top_srcdir)/doc/*.txt))               \
index d30e35a..b4346e2 100644 (file)
@@ -4,19 +4,15 @@ Flags are used to inform NoBug about subsystems/modules or even finer
 grained sections of the code. These are referred to as 'channels' in other
 logging libraries.
 
-Flags are generally used as follows:
-    * Declare the flag.
-    * Define the flag.
-    * Initialise the flag.
-
-To declare a flag, it is suggested to do so in a header file: 
+A flag should be declared in a headerfile using the following mechanism:
 
 INDEX DECLARE_FLAG; DECLARE_FLAG; declaring a flag
  NOBUG_DECLARE_FLAG(flagname)
 
-The flag should then be defined most appropriately in some implementation file
-by using one of the following macros:
+It is advisable to do so in one of your header files.
+
+Furthermore, the flag must be defined in some implementation file by using one
+of the following schemes:
 
 INDEX DEFINE_FLAG; DEFINE_FLAG; defining a flag
  NOBUG_DEFINE_FLAG(flagname)
@@ -37,7 +33,7 @@ or
 INDEX DEFINE_FLAG_PARENT_LIMIT; DEFINE_FLAG_PARENT_LIMIT; defining a flag hierarchy, w/ log limit
  NOBUG_DEFINE_FLAG_PARENT_LIMIT(flagname, parent, limit)
 
-This can be used to create hierachies of flags.
+This can be used to create hierachies of flags
 
 
 PARA C\++ support, C++ logflags; Cplusplus_logflags; C\++ support for log flags
@@ -49,13 +45,13 @@ Additional macros are available for applications written in C++:
  NOBUG_CPP_DEFINE_FLAG_LIMIT(name, default)
  NOBUG_CPP_DEFINE_FLAG_PARENT_LIMIT(name, parent, default)
 
-These macros statically initialize the flags when they are defined, there is no
-need to call `NOBUG_INIT_FLAG()` (see below).
+These macros initialize the flags when they are defined, there is no need to
+call `NOBUG_INIT_FLAG()` (see below).
 
 
 .Force declarations only
 
-When `INDEX DECLARE_ONLY` is defined to be `1` then *all* definitions here
+When `INDEX DECLARE_ONLY` defined to be `1` then *all* definitions here
 (`NOBUG_DEFINE_*`) become declarations only. When this is defined to be `0`
 (which is the default) then all definitions behave as described. This can be
 used to construct a headerfile which only contains definitions, but, by
@@ -98,7 +94,7 @@ NOBUG_DEFINE_FLAG(example);
 
 .Logging Flag Initialization
 
-After a flag has been declared and defined, it has to be initialised:
+Next you should call
 
  NOBUG_INIT_FLAG(flagname)
 
@@ -106,7 +102,7 @@ or
 
  NOBUG_INIT_FLAG_LIMIT(flagname, default)
 
-Use either of these macros once at the begining your prrogramme for each flag.
+once at the start of your program for each flag.
 
 For flags defined with `NOBUG_DEFINE_FLAG(flagname)` the defaults are initialized
 as in the xref:logdefaults[table above], while