[Xorp-cvs] SF.net SVN: xorp:[11567] trunk/xorp/BUILD_NOTES

[bms_fbsd at users.sourceforge.net]

Revision: 11567
          http://xorp.svn.sourceforge.net/xorp/?rev=11567&view=rev
Author:   bms_fbsd
Date:     2009-10-03 10:41:28 +0000 (Sat, 03 Oct 2009)

Log Message:
-----------
SConsify basic build instructions.

Modified Paths:
--------------
    trunk/xorp/BUILD_NOTES

Modified: trunk/xorp/BUILD_NOTES
===================================================================
--- trunk/xorp/BUILD_NOTES	2009-10-02 12:14:58 UTC (rev 11566)
+++ trunk/xorp/BUILD_NOTES	2009-10-03 10:41:28 UTC (rev 11567)
@@ -5,34 +5,36 @@
 	Build Notes for XORP (eXtensible Open Router Platform)
 
 
+0. Preface
+==========
 
+As of September 2009, much of the information in this file may be outdated,
+and should probably be moved to a Wiki. Some instructions refer to the
+old GNU Autotools based build system, which is now deprecated. SNMP support
+is currently deprecated and requires a rewrite.
+
 1. Compilation
 ==============
 
 1.1 Compiling the binaries
 ==========================
 
-To compile XORP, you must have GNU make (gmake) installed. Then just
+To compile XORP, you must have SCons installed. Then just
 run the following commands in the top-level directory:
 
-./configure
-gmake
+scons
 
 To change the default C and C++ compilers, then assign the binary
 names to the CC and CXX user environmental variables respectively.
 E.g., if you want to use the gcc34/g++34 compilers, then use (in case
-of csh/tcsh) the following commands before running "./configure":
+of csh/tcsh) the following commands before running "scons":
 
 setenv CC gcc34
 setenv CXX g++34
 
 To compile XORP with additional user-specified compiler flags, assign
 those flags to the CFLAGS and CXXFLAGS environmental variables (for the
-C and C++ compiler respectively) before running "./configure".
-If the flags must be after all other compiler flags (e.g., if they
-are suppose to overwrite some internally added flags), then use
-environmental variables CFLAGS_END and CXXFLAGS_END (for the C and C++
-compiler respectively).
+C and C++ compiler respectively) before running "scons".
 
 1.2 Generating documentation
 ============================
@@ -41,6 +43,9 @@
 site. The following procedure can be used to generate the
 documentation directly from the source files.
 
+The documentation is now in a separate area of the XORP SVN repository,
+and is no longer part of the source tree itself.
+
 1.2.1. Install TeX and LaTeX
 
   * FreeBSD
@@ -59,17 +64,17 @@
 
 1.2.2. Compile the documentation.
 
-# Note that this must be done directly in the XORP directory with the
+# Note that this must be done directly in the XORP docs directory with the
 # original source files.
-cd /path/to/xorp
-./configure
-cd docs
-gmake
-gmake
+cd /path/to/xorp/docs
+scons
 
 2. Internal tests
 =================
 
+As of September 2009, not all of the regression tests are active in
+the public SVN tree.
+
 To run the internal tests, you must have "bash" and "python" installed.
 Note that if the python's executable filename is not "python", then
 you would have to create a symbolic link with such name. E.g., execute
@@ -81,7 +86,7 @@
 After the code is compiled, you need to run the following command
 in the top-level XORP directory:
 
-gmake check
+scons check
 
 
 3. OS-specific notes


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.