doc: small documentation fixes, new title
authorChristian Thaeter <ct@pipapo.org>
Sun, 8 Aug 2010 20:31:23 +0000 (22:31 +0200)
committerChristian Thaeter <ct@pipapo.org>
Sun, 8 Aug 2010 20:31:23 +0000 (22:31 +0200)
doc/buildinstall.txt
doc/nobug_manual.conf
doc/overview.txt

index a32f328..75c7cc4 100644 (file)
@@ -21,15 +21,15 @@ x86     OpenSolaris     mostly          Builds, but target check fails
 
 NoBug has few mandatory dependencies on other software and libraries,
 some things such as valgrind support are optional and should be automatially
-detected during the build, i.e., when ./configure is called. Nevertheless it
+detected during the build, i.e., when `./configure` is called. Nevertheless it
 requires 'pkg-config' to be installed, you get some weird errors already at
 bootstrapping (autoreconf) when this is not available.
 
 
 HEAD== Release Tarballs;;
 
-Releases are available on:
-  http://www.pipapo.org/nobug-releases/
+Releases are available at:
+ http://www.pipapo.org/nobug-releases/[]
 
 Gpg signed tarballs are being used for distribution. The first step involves
 checking the signature:
@@ -53,10 +53,9 @@ will work:
 
 
 HEAD== Development Version via git;;
+
 You can obtain a development version by using git.  The git repository can be
-cloned via:
-`git://git.pipapo.org/nobug` or mirrored at repo.or.cz
-`git://repo.or.cz/nobug.git`.
+cloned from `git://git.pipapo.org/nobug`.
 
 Clone the git repository by:
 
@@ -67,8 +66,15 @@ After cloning the repository, then bootstrap the autotools:
  $ cd nobug
  $ autoreconf -i               # creates the configure file
 
-Then the usual `cd build && ../configure && make && make install` (as above) will work.
-Careful users may run `make check` to run a testsuite before installing.
+Then the usual
+
+ $ cd build && ../configure && make && make install
+
+(as above) will work. Careful users may run
+
+ $ make check
+
+to run a testsuite before installing.
 
 
 HEAD++ Keeping Git Up To Date;;
@@ -77,9 +83,12 @@ To update to any new revision, just enter the nobug dir and
 
  $ git pull
 
-After that you can build as above (cd build && ../configure && make && make install).
+After that you can build as above
+
+ $ cd build && ../configure && make && make install
+
 This default pull will update from the 'master' branch which is meant to be an on-going
-stable version (latest release + bugfixes).
+stable version (latest release and bugfixes).
 
 HEAD-- What Is Installed;;
 
index 22147a8..0708c54 100644 (file)
@@ -1,5 +1,5 @@
-//_ NoBug
-//_ =====
+//_ NoBug Reference Manual
+//_ ======================
 //_ Christian_Th├Ąter,_Benny_Lyons
 //_
 //=overview
index 89127a6..dd7cac2 100644 (file)
@@ -34,6 +34,6 @@ NoBug is a (macro-)library, it is not a C/C++ language extension. This
 means that code must be called at runtime to benefit from the set up
 contracts. Whats not tested is likely slipping through the net. Being
 part of the program itself it is affected by memory corruption,
-certain kinds of misuse may introduce new bugs (test expressions with
+certain kinds of misuse may introduce new bugs (assert expressions with
 side effects for example).