forked from apache/couchdb
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README-DEV
200 lines (127 loc) · 4.83 KB
/
README-DEV
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
Apache CouchDB DEVELOPERS
=========================
Before you start here, read `INSTALL.Unix` (or `INSTALL.Windows`) and
follow the setup instructions including the installation of all the
listed dependencies for your system.
Only follow these instructions if you are building from a source checkout.
If you're unsure what this means, ignore this document.
Dependencies
------------
You will need the following installed:
* Rebar (>=2.5.0) (https://github.com/rebar/rebar)
You may also need:
* Sphinx (http://sphinx.pocoo.org/)
* LaTex (http://www.latex-project.org/)
* GNU Texinfo (http://www.gnu.org/software/texinfo/)
* GNU help2man (http://www.gnu.org/software/help2man/)
* GnuPG (http://www.gnupg.org/)
* md5sum (http://www.microbrew.org/tools/md5sha1sum/)
* sha1sum (http://www.microbrew.org/tools/md5sha1sum/)
The first of these optional dependencies are required for building the
documentation. The last three are needed to build releases.
You will need these optional dependencies installed if:
* You are working on the documentation, or
* You are preparing a distribution archive
However, you do not need them if:
* You are building from a distribution archive, or
* You don't care about building the documentation
Here is a list of *optional* dependencies for various operating systems.
Installation will be easiest, when you install them all.
Debian-based (inc. Ubuntu) Systems
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
sudo apt-get install help2man
sudo apt-get install python-sphinx
sudo apt-get install texlive-latex-base
sudo apt-get install texlive-latex-recommended
sudo apt-get install texlive-latex-extra
sudo apt-get install texlive-fonts-recommended
sudo apt-get install texinfo
sudo apt-get install gnupg
Gentoo-based Systems
~~~~~~~~~~~~~~~~~~~~
sudo emerge texinfo
sudo emerge gnupg
sudo emerge coreutils
sudo emerge pkgconfig
sudo emerge help2man
sudo USE=latex emerge sphinx
RedHat-based (Fedora, Centos, RHEL) Systems
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
sudo yum install help2man
sudo yum install python-sphinx
sudo yum install python-docutils
sudo yum install python-pygments
sudo yum install texlive-latex
sudo yum install texlive-latex-fonts
sudo yum install texinfo
sudo yum install gnupg
Mac OS X
~~~~~~~~
Install Homebrew, if you do not have it already:
https://github.com/mxcl/homebrew
Unless you want to install the optional dependencies, skip to the next section.
Install what else we can with Homebrew:
brew install help2man
brew install gnupg
brew install md5sha1sum
If you don't already have pip installed, install it:
sudo easy_install pip
Now, install the required Python packages:
sudo pip install sphinx
sudo pip install docutils
sudo pip install pygments
Download MaxTeX from here:
http://www.tug.org/mactex/
Follow the instructions to get a working LaTeX install on your system.
Windows
~~~~~~~
Follow the instructions in INSTALL.Windows and build all components from
source, using the same Visual C++ compiler and runtime.
Configuring
-----------
Configure the source by running:
./configure
If you intend to run the test suites:
./configure -c
If you want to build it into different destination than `/usr/local`.
./configure --prefix=/<your directory path>
Testing
-------
Check the test suite by running:
make check
Generate a coverage report by running:
make cover
Please report any problems to the developer's mailing list.
Testing a cluster
-----------------
We use Docker (https://docker.io) to safely run a local three node
cluster all inside a single docker container.
Assuming you have Docker installed and running:
make docker-image
This will create a docker image (tagged 'couchdb/dev-cluster') capable
of running a joined three node cluster.
To start it up:
make docker-start
A three node cluster should now be running (you can now use `docker ps`
to find the exposed ports of the nodes).
To stop it:
make docker-stop
Releasing
---------
The release procedure is documented here:
https://wiki.apache.org/couchdb/Release_Procedure
Unix-like Systems
~~~~~~~~~~~~~~~~~
Prepare the release artefacts by running:
make distcheck
You can prepare signed release artefacts by running:
make distsign
The release artefacts can be found in the root source directory.
Microsoft Windows
~~~~~~~~~~~~~~~~~
Prepare the release artefacts by running:
make dist
The release artefacts can be found in the `etc/windows` directory.
Until the build system has been improved, you must make sure that you run this
command from a clean source checkout. If you do not, your test database and log
files will be bundled up in the release artefact.