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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
<html>
<head>
<meta http-equiv=Content-Type content="text/html; charset=utf-8">
<title>An Automake Primer for HDF5</title>
</head>
<!--
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
-->
<h2>An Automake Primer for HDF5</h2>
<h4>James Laird - May 2005</h4>
<h4>Last updated: September 2005</h4><br>
<p><h2><u>How to:</u><h2></p>
<p><h3>Change a Makefile</h3></p>
<p><h3>Add a source file to an existing program or library</h3></p>
<p><h3>Add a simple test</h3></p>
<p><h3>Add a test with multiple sources</h3></p>
<p><h3>Add a test script</h3></p>
<p><h3>Add a new directory</h3></p>
<p><h3>Add a program that is only compiled in parallel</h3></p>
<p><h3>Change a program's name when it is compiled in parallel</h3></p>
<p><h3>Add a new library</h3></p>
<p><h3>Change the library's API</h3></p>
<br>
<p><h4>Changing a Makefile</h4></p>
<p>Suppose you need to make a minor change to the Makefile in the test directory
(<code>hdf5/test/Makefile</code>). You have checked out hdf5 from the CVS repository into
<code>~/scratch/hdf5</code>. You want to build the library in a directory named
<code>~/scratch/build</code>.<br>
First, edit the Makefile.am in the source tree. You must make any changes in the Makefile.am,
not the Makefile, since the Makefile is automatically generated.</p>
<p><code>cd ~/scratch/hdf5/test<br>
vi Makefile.am</code></p>
<p>Now, go to the root of the source tree and run the reconfigure script, which updates the
source tree. It will create a new Makefile.in in the test directory with your changes.</p>
<p><code>cd ~/scratch/hdf5<br>
./bin/reconfigure</code></p>
<p>After running <code>bin/reconfigure</code>, you will want to test your change. Go to
<code>~/scratch/build</code> and run <code>configure</code>.</p>
<p><code>cd ~/scratch/build<br>
../hdf5/configure<br>
make check</code></p>
<p>Configure generates Makefiles from the Makefiles.in in the source tree. The dependencies are:</p>
<p><code>Makefile.am -> (bin/reconfigure) -> Makefile.in -> (configure) -> Makefile</code></p>
<p>Reconfigure should also be used when any change is made to configure.in.</p>
<br>
<p><h4>Adding a source file to an existing program or library</h4></p>
<p>Suppose you want to add the source file <code>h5testfoo.c</code> to the HDF5 test
library in the test directory. You open up <code>test/Makefile.am</code> in your
favorite text editor and scroll down until you see the line:</p>
<p><code>libh5test_la_SOURCES=h5test.c testframe.c</code></p>
<p>Just add <code>h5testfoo.c</code> to the list of sources. You're done!<br>
Now run <code>bin/reconfigure</code> to create a new Makefile.in from the Makefile.am you just
edited.</p>
<br>
<p><h4>Adding a simple test</h4></p>
<p>Suppose you want to create a new test executable named <code>newtest</code> with one
source file, <code>newtest.c</code>. You open up <code>test/Makefile.am</code> and find
the line</p>
<p><code>TEST_PROG=testhdf5 lheap ohdr ...</code></p>
<p>Just add <code>newtest</code> to the list of programs. That's it! Automake will by
default guess that your program <code>newtest</code> has one source file named
<code>newtest.c</code>.<br>
Now run <code>bin/reconfigure</code> to update the Makefile.in.</p>
<br>
<p><h4>Adding a slightly more complicated test</h4></p>
<p>Suppose you want to create a new test executable named <code>newertest</code> with
several source files. You open up <code>test/Makefile.am</code> as before and find the line</p>
<p><code>TEST_PROG=testhdf5 lheap ohdr ...</code></p>
<p>Add <code>newertest</code> to the list of programs.<br>
Now you need to tell Automake how to build newertest. Add a new line below
<code>TEST_PROG</code>:</p>
<p><code>newtest_SOURCES = source1.c source2.c source3.c</code></p>
<p>You don't need to mention header files, as these will be automatically detected.<br>
Now run <code>bin/reconfigure</code> to update the Makefile.in.</p>
<br>
<p><h4>Adding a test script</h4></p>
<p>For the most part, test scripts are handled like test programs, except that
they don't need to be compiled. You can specify a test script using the
<code>check_SCRIPT</code> variable:</p>
<p><code>TEST_SCRIPT=testh5dump.sh</code></p>
When your build directory is not the same as your source directory, scripts
are often located in the source directory (unlike tests, they are not created
when the library is built). If this is the case, be careful to specify the
full name of the script using the <code>${srcdir}</code> variable.</p>
<p><code>TEST_SCRIPT=testh5dump.sh ${srcdir}/testh5dumpxml.sh</code></p>
<p>Scripts also need to be told which program they're testing. Do this using
the <code>SCRIPT_DEPEND</code> variable.</p>
<p><code>SCRIPT_DEPEND=h5dump${EXEEXT}</code></p>
<p>This way, whenever <code>h5dump</code> changes, the Makefile will know that
these test scripts need to be run again. After you make changes to a
Makefile.am, don't forget to run <code>bin/reconfigure</code>!</p>
<br>
<p><h4>Adding a directory</h4></p>
<p>To add the directory for a new tool, <code>h5merge</code>, go to the Makefile.am
in the tools directory (the parent directory of the directory you want to add).
Find the line that reads</p>
<p><code>SUBDIRS=lib h5dump...</code></p>
<p>Add <code>h5merge</code> to this list of subdirectories.<br>
Now you probably want to create a Makefile.am in the h5merge directory. A good starting
point for this Makefile.am might be the sample Makefile.am in the config directory
(<code>config/Makefile.am.blank</code>). Alternately, you could copy the Makefile.am
from another directory.<br>
Once you have your new Makefile.am in place, edit <code>configure.in</code> in the root
directory. Near the end of the file is a list of files generated by configure.
Add <code>tools/h5merge/Makefile.in</code> to this list.<br>
Now run <code>bin/reconfigure</code>. This will update configure and generate a Makefile.in in the
<code>tools/h5merge</code> directory. Don't forget to add both the Makefile.am and the Makefile.in to
CVS, and to update the manifest!.</p>
<br>
<p><h4>Adding a program that is only compiled in parallel</h4></p>
<p>Suppose you only want to compile a program when HDF5 is configured to run in
parallel--for example, a parallel version of h5repack called <code>h5prepack</code>.
Open up the h5repack Makefile.am<br>
The simple solution is:</p>
<p><code>if BUILD_PARALLEL_CONDITIONAL<br>
H5PREPACK=h5prepack<br>
endif</code></p>
<p>Now the variable <code>$H5PREPACK</code> will be "h5prepack" if parallel is
enabled and "" if parallel is disabled. Add <code>$H5PREPACK</code> to the list of
programs to be built:</p>
<p><code>bin_PROGRAMS=h5repack $(H5PREPACK)</code></p>
<p>Add sources for this program as usual:</p>
<p><code>h5prepack_SOURCES=...</code></p>
<p>Don't forget to run <code>bin/reconfigure</code> when you're done!</p>
<br>
<p><h4>Changing a program's name when it is compiled in parallel</h4></p>
<p>Automake conditionals can be a very powerful tool. Suppose that instead of building
two versions of h5repack during a parallel build, you want to change the name of
the tool depending on whether or not HDF5 is configured to run in parallel--you
want to create either h5repack or h5prepack, but not both.<br>
Open up the h5repack Makefile.am and use an automake conditional:</p>
<p><code>if BUILD_PARALLEL_CONDITIONAL<br>
H5REPACK_NAME=h5prepack<br>
else<br>
H5REPACK_NAME=h5repack<br>
endif<br>
bin_PROGRAMS=$(H5REPACK_NAME)</p>
<p>Now you only build one program, but the name of that program changes. You still need
to define sources for both h5repack and h5prepack, but you needn't type them out twice if
they are the same:</p>
<p><code>h5repack_SOURCES=...<br>
h5prepack_SOURCES=$(h5repack_SOURCES)</code></p>
<p>Don't forget to run <code>bin/reconfigure</code> when you're done!</p>
<br>
<p><h4>Adding a new library</h4></p>
<p>Suppose you want to add a new library to the HDF5 build tree, libfoo. The procedure for
building libraries is very similar to that for building programs:</p>
<p><code>lib_LTLIBRARIES=libfoo.la<br>
libfoo_la_SOURCES=sourcefoo.c sourcefootwo.c </code></p>
<p>This library will be installed in the lib directory when a user types
"<code>make install</code>".<br>
You might instead be building a convenience library for testing purposes (like
<code>libh5test.la</code>) and not want it to be installed. If this is the case, you
would type</p>
<p><code>check_LTLIBRARIES=libfoo.la</code><br>
instead of<br>
<code>lib_LTLIBRARIES=libfoo.la</code></p>
<p>To make it easier for other directories to link to your library,
you might want to assign its path to a variable in all HDF5 Makefiles. You can
make changes to all Makefiles by editing <code>config/commence.am</code> and adding a line
like</p>
<p><code>LIBFOO=$(top_builddir)/foo/src/libfoo.la</code></p>
<p><code>config/commence.am</code> is textually included in all Makefiles.am when automake
processes them.<br>
As always, if you change a Makefile.am or <code>config/commence.am</code>, don't forget to run
<code>bin/reconfigure</code>.</p>
<br>
<p><h4>Changing HDF5's API</h4></p>
<p>If you have added or removed a function from HDF5, or if you have changed a
function signature, you should indicate this by updating the file
<code>lt_vers.am</code> located in the <code>config</code> directory. The
libtool shared library version number helps users who use HDF5 applications
to link dynamically against new versions of the library. Don't confuse
libtool's versioning system with HDF5's library version--the two numbers
are not related!</p>
<p>If you have changed the API at all, increment
<code>LT_VERS_INTERFACE</code> and set <code>LT_VERS_REVISION</code> to zero.
This tells users (and their linkers) that the interface has changed.</p>
<p>If you have added functions but not altered or removed existing ones,
also increment <code>LT_VERS_AGE</code>. The age of an interface is its
"backwards compatibility," the number of previous interfaces that can use
this interface. When you increase both the interface number and the age,
you are telling linkers that programs that could use the previous interface can
still use this one.</p>
<p>If instead you have altered or removed any functions, reset
<code>LT_VERS_AGE</code> to zero. Previous interfaces should not count on
being able to use this interface, since some functions might not be present
(or might have changed their signatures).</p>
<p>LT_VERS_REVISION is incremented when the library changes internally but
the API does not. You shouldn't need to increment it, since this should be
done automatically during a snapshot release.</p>
<hr>
<address>
Last modified: 22 September 2005
</address>
</body>
</html>
|
