[Openvas-commits] r12990 - trunk/doc/website

[scm-commit at wald.intevation.org]

Author: jan
Date: 2012-03-09 15:29:38 +0100 (Fri, 09 Mar 2012)
New Revision: 12990

Added:
   trunk/doc/website/nvt-dev.htm4
Modified:
   trunk/doc/website/template_header.m4
Log:
Added a simple first page for NVT developers.


Added: trunk/doc/website/nvt-dev.htm4
===================================================================
--- trunk/doc/website/nvt-dev.htm4	                        (rev 0)
+++ trunk/doc/website/nvt-dev.htm4	2012-03-09 14:29:38 UTC (rev 12990)
@@ -0,0 +1,90 @@
+m4_dnl -*-html-*-
+m4_include(`template.m4')
+
+m4_dnl OpenVAS
+m4_dnl $Id$
+m4_dnl Description: This page summarizes all that NVT developers should know.
+m4_dnl
+m4_dnl Authors:
+m4_dnl Jan-Oliver Wagner <jan-oliver.wagner at greenbone.net>
+m4_dnl
+m4_dnl Copyright:
+m4_dnl Copyright (C) 2012 Greenbone Networks GmbH
+m4_dnl
+m4_dnl This program is free software; you can redistribute it and/or modify
+m4_dnl it under the terms of the GNU General Public License version 2,
+m4_dnl as published by the Free Software Foundation.
+m4_dnl
+m4_dnl This program is distributed in the hope that it will be useful,
+m4_dnl but WITHOUT ANY WARRANTY; without even the implied warranty of
+m4_dnl MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+m4_dnl GNU General Public License for more details.
+m4_dnl
+m4_dnl You should have received a copy of the GNU General Public License
+m4_dnl along with this program; if not, write to the Free Software
+m4_dnl Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+
+m4_define(`EN')
+
+m4_define(`TITLE', `NVT Development')
+m4_define(`MAIN', `development')
+
+PAGE_START
+
+<h2>NVT Development</h2>
+
+<p>
+This page collects hints and guides for developing
+Network Vulnerability Tests.
+</p>
+
+<h3>How to start</h3>
+
+<p>
+The NVT development is not well documented.<br/ >
+But you will find other developers for questions and discussions
+on the <a href="mail.html">NVT Development Mailing List</a>
+</p>
+
+<p>
+The best start is to learn from existing NASL scripts.<br/ >
+There is also a template you can begin with:
+<a href="https://wald.intevation.org/scm/viewvc.php/trunk/openvas-plugins/template.nasl?root=openvas&view=log">template.nasl</a>
+</p>
+
+<p>
+License requirements: We welcome any contribution licensed under GNU GPLv2+.<br/>
+These can easily go into the OpenVAS Feed to benefit everyone.<br/>
+Other licenses might create legal conflicts and in doubt you should simply
+ask the other NVT developers.
+</p>
+
+<h3>Golden Rules</h3>
+
+<p>
+This is a collection assembled over time from lessons learned.
+</p>
+
+<ul>
+
+<li> <p>
+     Don't add any port scanner as dependency.
+     </p>
+     <p>
+     Rationale: Since the user should decide on her own which scanner to use,
+     this could lead to situations where more then one port scanner is concurrently executed.
+     </p>
+
+<li> <p>
+     Don't use "toolchecks.nasl" as dependency if your NVT does not directly(!) use one of
+     the tools listed in toolcheck.nasl.
+     </p>
+     <p>
+     Rationale: It's simply useless. Though it has not effect it creates a wrong
+     impression when reading the code.
+     </p>
+
+</li>
+
+</ul>
+

Modified: trunk/doc/website/template_header.m4
===================================================================
--- trunk/doc/website/template_header.m4	2012-03-09 13:36:25 UTC (rev 12989)
+++ trunk/doc/website/template_header.m4	2012-03-09 14:29:38 UTC (rev 12990)
@@ -96,6 +96,7 @@
      MENU_EXIT(`http://wald.intevation.org/projects/openvas/', `Entwicklungsplattform', `Development Platform',SUB ,LANG_DE)
      MENU(`team_tasks', `Team & Tasks', `Team & Tasks',SUB ,LANG_DE)
      MENU(`openvas-crs', `Änderungswünsche', `Change Requests',SUB ,LANG_DE)
+     MENU(`nvt-dev', `NVT Entwicklung', `NVT Development',SUB ,LANG_DE)
      MENU(`openvas-oids', `NVT OID Zuweisung', `NVT OID Assignment',SUB ,LANG_DE)
      MENU(`devcons', `Entwickler Konferenzen', `Developer Conferences',SUB ,LANG_DE)
      MENU(`src-doc', `Entwickler Dokumentation', `Code Documentation',SUB ,LANG_DE)
@@ -157,6 +158,7 @@
      MENU_EXIT(`http://wald.intevation.org/projects/openvas/index.html', `Entwicklungsplattform', `Development Platform',SUB ,LANG_DE)
      MENU(`team_tasks', `Team & Tasks', `Team & Tasks',SUB ,LANG_DE)
      MENU(`openvas-crs', `Änderungswünsche', `Change Requests',SUB ,LANG_DE)
+     MENU(`nvt-dev', `NVT Entwicklung', `NVT Development',SUB ,LANG_DE)
      MENU(`openvas-oids', `NVT OID Zuweisung', `NVT OID Assignment',SUB ,LANG_DE)
      MENU(`devcons', `Entwickler Konferenzen', `Developer Conferences',SUB ,LANG_DE)
      MENU(`src-doc', `Entwickler Dokumentation', `Code Documentation',SUB ,LANG_DE)