README.txt
1 Annotation File Utilities README file
2
3 For user documentation, see file annotation-file-utilities.html .
4
5 ===========================================================================
6
7 Contents
8
9 The contents of this directory are:
10
11 annotation-file-utilities.html
12 Annotation File Utilities documentation.
13 Most users should only have to read this file.
14 annotation-file-format.{html,pdf}
15 Describes the annotation file format.
16 scripts/
17 Contains Unix and Windows programs for transferring annotations among
18 Java, class, and annotation files.
19 annotation-file-utilities.jar
20 Java library used by the programs.
21 build.xml, src/, lib/, tests/
22 For developers only: buildfile, source code, libraries, tests.
23
24 ===========================================================================
25
26 Notes
27
28 To build annotation-file-format.{html,pdf} your BIBINPUTS environment
29 variable must be set like so:
30
31 export BIBINPUTS=.:/path/to/plume/bib
32
33 plume-bib is available at https://github.com/mernst/plume-bib .
34
35 ===========================================================================
36
37 Making a release
38
39 To make a release (a distribution):
40
41 Be sure to run these instructions in an account that uses JDK 7, not JDK 8.
42
43 Write a description of the most significant changes in:
44 changelog.html
45 It may be helpful to examine the changes since the last release:
46 git log v3.5.3..
47 git diff v3.5.3..
48
49 Manually update the version number and date in the following places:
50 annotation-file-utilities.html (in "Installation" section)
51 changelog.html
52 annotations/scene-lib/src/annotations/io/classfile/ClassFileReader.java
53
54 Create and post to the web the entire distribution:
55 ant -e web
56
57 Run
58 checklink -q -r https://checkerframework.org/annotation-file-utilities/
59 and if there are any problems, re-make the distribution.
60
61 Tag the release, for example:
62 git tag v3.5.3
63
64 Send email to: checker-framework-discuss (a] googlegroups.com
65
66 ===========================================================================
67