File: README.cvs

package info (click to toggle)
pcb 20060822-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 11,260 kB
  • ctags: 6,230
  • sloc: ansic: 62,222; sh: 4,062; pascal: 3,569; yacc: 1,097; makefile: 792; lex: 348; perl: 299; awk: 158; tcl: 63
file content (115 lines) | stat: -rw-r--r-- 4,110 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# $Id: README.cvs,v 1.7 2006/08/01 12:33:00 danmc Exp $
#

This file describes how to build from CVS sources.  If you are building from a
released version or snapshot, please refer to the 'INSTALL' document instead.
Take the time to read this file, it's not that long and it addresses some 
questions which come up with some frequency.

-------------
Prerequisites
-------------

You will need the following tools to obtain and build a CVS version of pcb:

To download and track sources you will need:

cvs
ssh

To compile you will need a C compiler, a lex (or flex) and a yacc (or bison)
implementation.  If you do not have lex or yacc, try installing:

bison     -- ftp://ftp.gnu.org/pub/gnu/bison/
flex      -- ftp://ftp.gnu.org/pub/non-gnu/flex/

In addition, if you make any edits to configure.ac or any of the 
Makefile.am's, you will need recent versions of:

autoconf  -- ftp://ftp.gnu.org/pub/gnu/autoconf/
             Please note that version 2.13 is too old.  Current development
             is done with 2.59.

automake  -- ftp://ftp.gnu.org/pub/gnu/automake/
             The developers use the 1.9.* versions of automake.  Older versions
             have not been as well tested (or tested at all).  Versions 1.7 and
             older are too old and will not work.

texinfo   -- ftp://ftp.gnu.org/pub/gnu/texinfo/
             You will need at least version 4.6 to be able to build
             the documentation.

You can find the version of autoconf, automake, and makeinfo by running them with the 
--version flag.

If you do not wish to build the documentation, use --disable-doc when you run
configure.  If you do wish to build the documentation, you should enable
maintainer-mode (--enable-maintainer-mode) which will turn on various
dependency rules for documentation building.  In addition you must build
pcb with the png export HID enabled (it is enabled by default) because some
of the figures in the manual are drawn with pcb.

Please note that maintainer-mode and the png HID are only needed when building
documentation from cvs sources.  If you are building pcb from a distfile you 
do not need maintainer-mode and the png export HID is optional.

Finally, if you edit any of the actions identified by 
/* ACTION(Foo,ActionFoo) */
comments, you will need perl and in addition, you must have used
the --enable-maintainer-mode flag to the configure script.

---------
Check out
---------

If you already have a checked out PCB source tree, please proceed to the
'Updating' section.

To check out sources from the anonymous CVS server, run the following:

	cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/pcb login 
	cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/pcb co pcb

---------
Updating
---------

To update an already checked out copy of the PCB source tree, run these commands
from your top level pcb directory:

	cvs login 
	cvs -z3 update -PdA

----------------------------------
Bootstrapping with the auto* tools
----------------------------------
If you have made any edits to configure.ac in the top level pcb directory
or any of the Makefile.am's, you will need to run 

./autogen.sh

from the top level pcb directory.  This will run the various auto* tools
which creates the configure script, the config.h.in file and the various
Makefile.in's.

If you have not edited configure.ac or Makefile.am's, you can skip this
step.

If you plan on making changes to configure.ac, Makefile.am's, or actions
defined by the 
/* ACTION(Foo,ActionFoo) */
comments, you may want to enable maintainer mode by passing the
--enable-maintainer mode flag to ./autogen.sh

At this point you can proceed to configure and build PCB as outlined in
the INSTALL document.

-------------------
Building a Snapshot
-------------------
The file README.snapshots documents what is currently done to create a
snapshot release for PCB.  Most of what is in there has to do with the
cvs repository and how we tag and branch the sources.  If you are interested
in building your own .tar.gz file from CVS sources, you can still use
the information in README.snapshots as a guide.