doc/testing/testing.texi
changeset 6757 857fbe08a634
parent 6756 8823005cb588
child 6758 1ed6a802a8ca
equal deleted inserted replaced
6756:8823005cb588 6757:857fbe08a634
     1 \input texinfo  @c -*-texinfo-*-
       
     2 @c %**start of header
       
     3 @setfilename ns-3-testing.info
       
     4 @settitle ns-3 testing and validation
       
     5 @c @setchapternewpage odd
       
     6 @c %**end of header
       
     7 
       
     8 @ifinfo
       
     9 Documentation for the @command{ns-3} project is available in
       
    10 Doxygen, several documents, and the wiki:
       
    11 @itemize @bullet
       
    12 @item @uref{http://www.nsnam.org/doxygen/index.html,,ns-3 Doxygen/Manual}:  Documentation of the public APIs of the simulator
       
    13 @item @uref{http://www.nsnam.org/tutorial/index.html,,ns-3 Tutorial}
       
    14 @item @uref{http://www.nsnam.org/doc//index.html,,ns-3 Tutorial}
       
    15 @item ns-3 Testing and Validation (this document)
       
    16 @item @uref{http://www.nsnam.org/wiki/index.php,, ns-3 wiki}
       
    17 @end itemize
       
    18 
       
    19 This document is written in GNU Texinfo and is to be maintained in
       
    20 revision control on the @command{ns-3} code server.  Both PDF and HTML versions
       
    21 should be available on the server.  Changes to 
       
    22 the document should be discussed on the ns-developers@@isi.edu mailing list.
       
    23 @end ifinfo
       
    24 
       
    25 @copying
       
    26 
       
    27 This is an @command{ns-3} reference manual.
       
    28 Primary documentation for the @command{ns-3} project is available in
       
    29 Doxygen, several documents, and the wiki:
       
    30 @itemize @bullet
       
    31 @item @uref{http://www.nsnam.org/doxygen/index.html,,ns-3 Doxygen}:  Documentation of the public APIs of the simulator
       
    32 @item @uref{http://www.nsnam.org/docs/tutorial/index.html,,ns-3 Tutorial}
       
    33 @item @uref{http://www.nsnam.org/docs/manual/index.html,,ns-3 Manual}
       
    34 @item ns-3 Testing and Validation (this document)
       
    35 @item @uref{http://www.nsnam.org/wiki/index.php,, ns-3 wiki}
       
    36 @end itemize
       
    37  
       
    38 This document is written in GNU Texinfo and is to be maintained in
       
    39 revision control on the @command{ns-3} code server.  Both PDF and HTML 
       
    40 versions should be available on the server.  Changes to 
       
    41 the document should be discussed on the ns-developers@@isi.edu mailing list.
       
    42 
       
    43 This software is free software; you can redistribute it and/or modify
       
    44 it under the terms of the GNU General Public License as published by
       
    45 the Free Software Foundation; either version 2 of the License, or
       
    46 (at your option) any later version.
       
    47 
       
    48 This software is distributed in the hope that it will be useful,
       
    49 but WITHOUT ANY WARRANTY; without even the implied warranty of
       
    50 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       
    51 GNU General Public License for more details.
       
    52 
       
    53 You should have received a copy of the GNU General Public License
       
    54 along with this program.  If not, see @uref{http://www.gnu.org/licenses/}.
       
    55 @end copying
       
    56 
       
    57 @titlepage
       
    58 @title ns-3 Testing and Validation
       
    59 @author ns-3 project
       
    60 @author feedback:  ns-developers@@isi.edu
       
    61 
       
    62 @b{Simulator version: }
       
    63 @include VERSION
       
    64 @today{}
       
    65 
       
    66 @c @page
       
    67 @vskip 0pt plus 1filll
       
    68 @insertcopying
       
    69 @end titlepage
       
    70 
       
    71 @c So the toc is printed at the start.
       
    72 @ifnottex
       
    73 @anchor{Full Table of Contents}
       
    74 @end ifnottex
       
    75 @shortcontents
       
    76 
       
    77 @ifnottex
       
    78 @node Top, Overview, Full Table of Contents 
       
    79 @top ns-3 Testing and Validation (html version)
       
    80 
       
    81 For a pdf version of this document, 
       
    82 see @uref{http://www.nsnam.org/docs/testing.pdf}.
       
    83 
       
    84 Simulator version:
       
    85 @include VERSION
       
    86 
       
    87 @insertcopying
       
    88 @end ifnottex
       
    89 
       
    90 @menu
       
    91 * Overview::
       
    92 * Background::
       
    93 * TestingFramework::
       
    94 * How to write tests::
       
    95 * Random Variables::
       
    96 * Propagation Loss Models::
       
    97 * References::
       
    98 @end menu
       
    99 
       
   100 @include overview.texi
       
   101 @include background.texi
       
   102 @include testing-framework.texi
       
   103 @include how-to-write-tests.texi
       
   104 @include validation.texi
       
   105 @include random-variables.texi
       
   106 @include propagation-loss.texi
       
   107 @include references.texi
       
   108 
       
   109 @printindex cp
       
   110 
       
   111 @bye