File: DEVELOPER

package info (click to toggle)
coda 2.21.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 9,320 kB
  • sloc: ansic: 125,785; javascript: 6,732; java: 2,391; yacc: 1,007; python: 872; makefile: 615; lex: 204; sh: 99; fortran: 60; xml: 5
file content (39 lines) | stat: -rw-r--r-- 1,463 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
Developer Documentation
=======================

This document contains specific instructions for CODA developers.

Commit steps
------------
If your changes impact any of the autogenerated parts, make sure these
get regenerated (all using the autotools build system):

Run 'make doc' to regenerate the documentation with doxygen 1.8.20.

Run 'make dist' to have config.h.cmake.in and coda.h.cmake.in updated to be
in line with config.h.in and coda.h.in.

If any interface in the C library has changed check Fortran, IDL, MATLAB,
Python and Java interfaces for consistency. Use SWIG 4.0.2 to regenerate
Python and Java bindings.

Run 'make indent' using GNU indent (2.2.11) to update the indentation of the C
code. You may have to run it twice to work around flipping indentation choices
of GNU indent.

Release checklist
-----------------
- make sure all 'commit steps' (see above) have been performed
- ensure automake and CMake builds are consistent
- check compiler warnings
- increase CODA version number in configure.ac + CMakeLists.txt
  format version is x.y(.z).
  Increase x for big backward compatibility breaking changes.
  Otherwise, increase y if any features were introduced.
  Only add/increase z for bug fix releases.
- update version number of shared libcoda library (both in configure.ac and
  CMakeLists.txt)
- make sure all documentation is updated accordingly
- update INSTALL and LICENSES
- update README (version number!)
- update CHANGES