xref: /aosp_15_r20/external/giflib/build.adoc (revision 324bb76b8d05e2a05aa88511fff61cf3f9ca5892)
1*324bb76bSAndroid Build Coastguard Worker= Build instructions =
2*324bb76bSAndroid Build Coastguard Worker
3*324bb76bSAndroid Build Coastguard Worker== Building ==
4*324bb76bSAndroid Build Coastguard Worker
5*324bb76bSAndroid Build Coastguard WorkerBuilding this package from a distribution tarball should be as simple as
6*324bb76bSAndroid Build Coastguard Workerrunning make.  Install with "make install" as root.
7*324bb76bSAndroid Build Coastguard Worker
8*324bb76bSAndroid Build Coastguard WorkerYou will need xmlto to build the derived forms of the documentation
9*324bb76bSAndroid Build Coastguard Workerfrom the DocBook-XML sources.  If you are going no modify the website,
10*324bb76bSAndroid Build Coastguard Workeryou will also need to have asciidoc and the ImageMagick convert(1)
11*324bb76bSAndroid Build Coastguard Workerutility installed.
12*324bb76bSAndroid Build Coastguard Worker
13*324bb76bSAndroid Build Coastguard Worker== Testing ==
14*324bb76bSAndroid Build Coastguard Worker
15*324bb76bSAndroid Build Coastguard WorkerYou can run "make check" after the library and utilities have been built
16*324bb76bSAndroid Build Coastguard Workerto see a regression test of the codebase. No output (other than
17*324bb76bSAndroid Build Coastguard Workerthe test header lines) is good news.
18*324bb76bSAndroid Build Coastguard Worker
19*324bb76bSAndroid Build Coastguard Worker== Portability note ==
20*324bb76bSAndroid Build Coastguard Worker
21*324bb76bSAndroid Build Coastguard WorkerThis codebase now assumes your compiler is C99-conformant.  If it
22*324bb76bSAndroid Build Coastguard Workerisn't, the most likely trouble spot is "#include <stdint.h>"; your
23*324bb76bSAndroid Build Coastguard Workercompiler may be looking for "inttypes.h" instead.  By test, the code
24*324bb76bSAndroid Build Coastguard Workeris backward-conformant to C89 except that it uses bool/true/false.
25*324bb76bSAndroid Build Coastguard Worker
26*324bb76bSAndroid Build Coastguard WorkerOne (minimal but sufficient) concession to Windows portability has been
27*324bb76bSAndroid Build Coastguard Workermake; inclusion of <unistd.h> is conditional on _WIN32 not being
28*324bb76bSAndroid Build Coastguard Workerdefined by the compiler (if it is <io.h> is included
29*324bb76bSAndroid Build Coastguard Workerinstead). Requests to go any further out of the way to accommodate
30*324bb76bSAndroid Build Coastguard WorkerMicrosoft's toolchains are unlikely be looked on favorably.
31*324bb76bSAndroid Build Coastguard Worker
32*324bb76bSAndroid Build Coastguard Worker== Release Procedure ==
33*324bb76bSAndroid Build Coastguard Worker
34*324bb76bSAndroid Build Coastguard Worker1. Check the SourceForge tracker for bugs and patches.
35*324bb76bSAndroid Build Coastguard Worker
36*324bb76bSAndroid Build Coastguard Worker2. Bump the version number in gif_lib.h.  Do "make version"
37*324bb76bSAndroid Build Coastguard Worker   to confirm that it looks sane when extracted to the Makefile.
38*324bb76bSAndroid Build Coastguard Worker
39*324bb76bSAndroid Build Coastguard Worker3. Version-stamp the top entry in the NEWS file.
40*324bb76bSAndroid Build Coastguard Worker
41*324bb76bSAndroid Build Coastguard Worker4. If you are changing major versions, sync the XBS-SourceForge-Folder
42*324bb76bSAndroid Build Coastguard Worker   attribute in the control file.
43*324bb76bSAndroid Build Coastguard Worker
44*324bb76bSAndroid Build Coastguard Worker5. 'make dist' to make a tarball.
45*324bb76bSAndroid Build Coastguard Worker
46*324bb76bSAndroid Build Coastguard Worker6. Tag the release in the repo.
47*324bb76bSAndroid Build Coastguard Worker
48*324bb76bSAndroid Build Coastguard Worker7. Ship the release tarball.
49*324bb76bSAndroid Build Coastguard Worker
50*324bb76bSAndroid Build Coastguard WorkerThe last three steps can be done with "make release" if you have shipper
51*324bb76bSAndroid Build Coastguard Workerinstalled.
52*324bb76bSAndroid Build Coastguard Worker
53