File: README.md

package info (click to toggle)
jnr-constants 0.9.9-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 1,108 kB
  • ctags: 6,401
  • sloc: java: 8,027; ruby: 1,143; xml: 110; makefile: 11
file content (51 lines) | stat: -rw-r--r-- 2,215 bytes parent folder | download | duplicates (2)
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
Java Native Runtime Constants
=============================================
[![Build Status](https://travis-ci.org/jnr/jnr-constants.svg?branch=master)](https://travis-ci.org/jnr/jnr-constants)

Overview
--------

This project contains Java enums for common POSIX constants.  It is predominately used to make calls into jnr-posix
far simpler.

Adding Constants
----------------

If you want to add new constants to the project, note that all the Java source code is generated.  The gen/ directory
contains Ruby code to declare the constants you want.  The constant values themselves are exctracted by inspection.
In order to do so, the code generator will compile a small program that outputs the values of the constants as discovered
in declared header files.  When the program is run, the output is parsed, and these are the values that are used when
generating the Java source.

To run the code generator, you must have Rake installed in Ruby 1.9+.  There are three tasks you must run in order to
generate all the necessary files:

    $ rake generate:xplatform
    $ rake generate:platform
    $ rake generate:fake

The _generate:xplatform_ variant generates the top-level enum file.  While this contains the necessary fields, it does
not contain the integer values for those fields.  The values lookup is delegated to either an OS-specific (and possibly
architecture-specific) implementation or a so-called "fake" implementation.

To generate the OS-specific file, you use the _generate:platform_ task.  This must be run on each platform you'd like
to generate the files for.  As that can be cumbersome and you might not have access to a machine running each OS, you
should also generate the "fake" implementation as a fail-safe.  The _generate:fake_ task is responsible for that.

The generated files are version-controlled.  Please remember to commit them in addition to the Ruby templates for the
generator.

Building
--------

The project is maven-based.  It uses standard maven lifecycle events.  To build the code:

    $ mvn package

To install the code into your local maven repository:

    $ mvn install

To push snapshots out to Sonatype (you must have the necessary permissions):

    $ mvn deploy