added files
[bcm963xx.git] / userapps / opensource / net-snmp / dist / README.build-scripts
1 ******************************************************************************
2 *
3 * README.build-scripts
4 *
5 * Author: Robert Story <rstory@freesnmp.com>
6 *
7 * $Id: README.build-scripts,v 1.6.2.1 2003/03/05 22:58:35 rstory Exp $
8 *
9 ******************************************************************************
10
11
12 Introduction
13 ============
14
15 The automated build script will automatically run configure, 'make all',
16 'make test' and 'make install'. Log files are kept for each step, and the
17 scripts should abort when errors occur.
18
19 The usage of nsb-package is:
20
21  Usage: nsb-package [-c] [-d] [-p] [-s SRCD] [-b BUILDD] [-i INSTALLD] VERSION
22   
23     VERSION    : relase number (eg 5.0.3)
24     -s SRCDIR  : soure directory [$HOME/src/net-snmp-VERSION]
25     -b BUILDD  : build directory [$HOME/build/]
26                  NOTE-platform will be appended to build directory
27     -i INSTALLD: install directory [$HOME/build/\$PLATFORM/usr/local]
28    
29     -c : skip configure
30     -d : dirty build (don't make distclean)
31     -m : skip 'make all'
32     -p : don't pause at prompts in between stages
33     -t : skip 'make test'
34
35
36 The defaults assume you have a 'src', 'build' and 'binaries' directory in
37 your home directory.
38
39
40
41 Recommended Procedure
42 =====================
43
44 1) Log into Sourceforge Compile Farm Server
45
46 2) Update source (this will likely be automated in the future)
47
48    For example, for release 5.0.3:
49
50    $ cd ~/src
51    $ CVS_RSH=ssh cvs -d $USER@cvs.net-snmp.org:/cvsroot/net-snmp \
52          -q co -r Ext-5-0-3 -d ~/src/net-snmp-Ext-5-0-3 net-snmp
53
54 3) Run the package script. 
55
56    $ $HOME/src/net-snmp-cvs/dist/nsb-package -r \
57         -s $HOME/src/net-snmp-5.0.5 5.0.5
58
59 4) Create tarball (assuming no errors; see next section if there are errors)
60
61    $ cd ~/build/`nsb-platform`
62    $ tar cvf net-snmp-5.0.3-`nsb-platform`.tar usr
63    $ gzip --best *.tar
64
65 5) Copy tarball to Sourceforge shell sever
66
67    $ scp *.gz net-snmp.sourceforge.net:~/binaries/
68
69 6) Log out of compile farm server, log into shell server
70
71 7) Upload to Sourceforge
72
73    $ ftp upload.sourceforge.net
74      >bin
75      >put *.gz
76
77 8) Update binaries vi Sourceforge admin page
78
79
80
81 Builds with errors
82 ==================
83
84 Should you encounter a build error, you will most likely want to skip the
85 'make distclean' and configure step (assuming the problem wasn't with
86 configure!). To do this, specify the 'dirty' and 'skip configure' options:
87
88    $ nsb-package -p -d -c Ext-5-0-3
89
90
91 Should the build succeed, but some tests fail during 'make test', you probably
92 can to skip the test step to get to the install step:
93
94    $ nsb-package -p -d -c -t Ext-5-0-3
95
96
97 OTHER PROBLEMS
98 --------------
99 * "Cannot find nsb-functions"
100   
101    It's a hack, but symlink nsb-functions and nsb-package to your local
102    bin directory ($HOME/bin).  I'm trying to think of a better solution.
103
104 * "gcc: snmp_version.lo: No such file or directory"
105
106    This is a good indication that you have previously built in your
107    source directory. 'make distclean' in your source directory, or
108    check out a fresh new version from CVS.