RFR: 7903128: Overhaul jextract README [v7]
Jorn Vernee
jvernee at openjdk.java.net
Thu Mar 24 15:41:07 UTC 2022
On Thu, 24 Mar 2022 15:28:46 GMT, Maurizio Cimadamore <mcimadamore at openjdk.org> wrote:
>> I've improved the README file, by putting the expanding the build section, and putting it more front and center.
>> I have also streamlined the remaining contents a little, and removed the parts that were describing the foreign API (not really needed here).
>
> Maurizio Cimadamore has updated the pull request incrementally with three additional commits since the last revision:
>
> - Fix issue with libclang version
> - More table tweaks
> - Tweak table
Looks good.
README.md line 119:
> 117: | Option | Meaning |
> 118: | :----------------------------------------------------------- | ------------------------------------------------------------ |
> 119: | `--header-class-name <String>` | specify the name the main header class |
Suggestion:
| `--header-class-name <String>` | specify the name of the main header class |
README.md line 126:
> 124: | `--source` | generate java sources instead of classfiles |
> 125: | `--dump-includes <String>` | dump included symbols into specified file (see below) |
> 126: | `--include-[function,macro,struct,union,typedef,var]<String>` | Include a symbol of the given name and kind in the generated bindings (see below). When one of these options is specified, any symbols that is not matched by any specified filters is omitted from the generated bindings. |
Suggestion:
| `--include-[function,macro,struct,union,typedef,var]<String>` | Include a symbol of the given name and kind in the generated bindings (see below). When one of these options is specified, any symbol that is not matched by any specified filters is omitted from the generated bindings. |
-------------
Marked as reviewed by jvernee (no project role).
PR: https://git.openjdk.java.net/jextract/pull/3
More information about the jextract-dev
mailing list