[Openvas-commits] r1144 - in trunk/openvas-compendium: . images

[scm-commit@wald.intevation.org]

Author: mwiegand
Date: 2008-08-19 08:52:19 +0200 (Tue, 19 Aug 2008)
New Revision: 1144

Added:
   trunk/openvas-compendium/images/OpenVAS-Module-Internals.png
   trunk/openvas-compendium/images/OpenVAS-Module-Overview.png
Modified:
   trunk/openvas-compendium/ChangeLog
   trunk/openvas-compendium/openvas-compendium.tex
Log:
* openvas-compendium.tex: Added source code maps.


Modified: trunk/openvas-compendium/ChangeLog
===================================================================
--- trunk/openvas-compendium/ChangeLog	2008-08-18 12:59:21 UTC (rev 1143)
+++ trunk/openvas-compendium/ChangeLog	2008-08-19 06:52:19 UTC (rev 1144)
@@ -1,3 +1,7 @@
+2008-08-19  Michael Wiegand <michael.wiegand at intevation.de>
+
+	* openvas-compendium.tex: Added source code maps.
+
 2008-08-18  Michael Wiegand <michael.wiegand at intevation.de>
 
 	* openvas-compendium.tex: Expanded NASL documentation.

Added: trunk/openvas-compendium/images/OpenVAS-Module-Internals.png
===================================================================
(Binary files differ)


Property changes on: trunk/openvas-compendium/images/OpenVAS-Module-Internals.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/openvas-compendium/images/OpenVAS-Module-Overview.png
===================================================================
(Binary files differ)


Property changes on: trunk/openvas-compendium/images/OpenVAS-Module-Overview.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Modified: trunk/openvas-compendium/openvas-compendium.tex
===================================================================
--- trunk/openvas-compendium/openvas-compendium.tex	2008-08-18 12:59:21 UTC (rev 1143)
+++ trunk/openvas-compendium/openvas-compendium.tex	2008-08-19 06:52:19 UTC (rev 1144)
@@ -2256,7 +2256,6 @@
  \item Booleans
 \end{itemize}
 
-
 \subsection{Numbers and Strings}
 
 \subsection{Function Arguments}
@@ -2307,12 +2306,12 @@
  \item <
  \item <=
  \item !
- \item &&
+ \item \verb|&&|
  \item ||
  \item ~
- \item &
+ \item \verb|&|
  \item |
- \item ^
+ \item \verb|^|
  \item <<
  \item >>
  \item >>>
@@ -3507,6 +3506,21 @@
 \compendiumauthor{Jan-Oliver Wagner}
 \section{The OpenVAS Source Code Map}
 
+A large chunk of the OpenVAS codebase was inherited from Nessus. As with
+any project of this size, it can be quite difficult to find your way around if
+you are new to the code. While the Nessus code was very well structured in some
+places, it proved to be rather chaotic and difficult to understand in other. In
+order to better visualize the codebase, the OpenVAS project has begun to create
+maps of the source code and its structure.
+
+Below you will find a first draft of the overview and internal structure. Keep
+in mind that this is a work in progress; updated maps are likely to be
+available on the OpenVAS website.
+
+\IncludeImage[width=10cm]{images/OpenVAS-Module-Overview}
+
+\IncludeImage[width=14cm]{images/OpenVAS-Module-Internals}
+
 \section{Source Code Branches for Stable and In-Development}
 
 If you look at the OpenVAS source code for the first time, you might wonder what