Changes between Version 3 and Version 4 of TesterDocumentation

Timestamp:

09/09/10 12:17:32 (14 years ago)

Author:

Samuli Seppänen

Comment:

--

TesterDocumentation

@@ -1 @@
- = Reporting bugs =
+= Building development versions of OpenVPN =
 
-You should document a few things:
+== Downloading OpenVPN snapshots ==
 
- * Operating system (e.g. OpenBSD 4.3)
- * Your ''./configure'' command-line
- * The complete output of: 
-{{{
-$ openvpn --version
-}}}
+There are two ways to get development versions of OpenVPN. First option is to get snapshot builds available here:
 
+ * http://build.openvpn.net/downloads/
 
- = Building OpenVPN testing from git =
+There are several directories there, one per git branch. New features are available in the [http://build.openvpn.net/downloads/allmerged/ allmerged branch]. [ftp://ftp.secure-computing.net/pub/FreeBSD/ports/openvpn-devel/ Weekly snapshots] of various OpenVPN branches are also available [ftp://ftp.secure-computing.net/pub/FreeBSD/ports/openvpn-devel/ here].
 
- == Fetching the sources ==
+Once you've downloaded a snapshot package, extract it:
+
+ {{{
+ gzip -dc openvpn-<something>.tar.gz | tar xvf -
+ cd openvpn-<something>/
+ }}}
+
+== Fetching sources using git ==
 
  * If you have not cloned the git repository:
@@ -31 +34 @@
  }}}
 
+== Building ==
+
  * Prepare for building:
  
@@ -36 +41 @@
  autoreconf -vi
  }}}
-
- = Building OpenVPN testing from snapshots =
-
- * Download the latest snapshot tarball from: ftp://ftp.secure-computing.net/pub/FreeBSD/ports/openvpn-devel/
- * Unpack it
-
- {{{
- gzip -dc openvpn-YYYYWW.tar.gz | tar xvf -
- cd openvpn-devel/
- }}}
-
- == Configure and compile ==
 
 When testing this version of OpenVPN, we would appreciate if all deprecated features would be disabled by default.  We want to know how OpenVPN behaves for you without these features.
@@ -70 +63 @@
 in addition to the ./configure line use used for the compilation and all the configuration files you used.  We would like to have both success and fail reports.
 
- = Debugging =
+= Debugging =
 
 If OpenVPN crashes, you can help developers figure out the problem by giving them a backtrace of the crash. If you're running released (stable) version of OpenVPN, you should install the ''openvpn debug'' and ''gdb'' packages and then run openvpn via gdb. On "testing" turn on debugging before compilation. In either case you can get a backtrace of the crash like this:
@@ -83 +76 @@
  }}}
 
- = Enable core dump =
+= Enable core dump =
 
 In some cases, it's not possible to trigger the bug when running via gdb directly.  In this case, you can enable core dumps.  On most distributions and *nix OSes today, you need to enable this from your shell before starting OpenVPN.
@@ -102 +95 @@
 
 Beware that if you start OpenVPN via init scripts, it will most likely not dump core files, unless you change the ulimit inside the init script.
+
+= Reporting bugs =
+
+You should document a few things:
+
+ * Operating system (e.g. OpenBSD 4.3)
+ * Your ''./configure'' command-line
+ * The complete output of: 
+{{{
+$ openvpn --version
+}}}