Skip to content
This repository has been archived by the owner on Oct 15, 2024. It is now read-only.

JNI docu updates #3882

Merged
merged 6 commits into from
Jun 8, 2021
Merged

JNI docu updates #3882

merged 6 commits into from
Jun 8, 2021

Conversation

markus2330
Copy link
Contributor

Many parts of the README.md in the JNI plugins were still wrong (outdated things, not mentioned new requirements, like jna version). This should fix most of it but I did not find a solution to actually mount JNI plugins with Debian Buster yet, see: #3881

Basics

These points need to be fulfilled for every PR:

  • Short descriptions of your changes are in the release notes
    (added as entry in doc/news/_preparation_next_release.md which
    contains _(my name)_)
    Please always add something to the release notes.
  • Details of what you changed are in commit messages
    (first line should have module: short statement syntax)
  • References to issues, e.g. close #X, are in the commit messages.
  • The buildservers are happy. If not, fix in this order:
    • add a line in doc/news/_preparation_next_release.md
    • reformat the code with scripts/dev/reformat-all
    • make all unit tests pass
    • fix all memleaks
  • The PR is rebased with current master.

If you have any troubles fulfilling these criteria, please write
about the trouble as comment in the PR. We will help you.
But we cannot accept PRs that do not fulfill the basics.

Checklist

Check relevant points but please do not remove entries.
For docu fixes, spell checking, and similar none of these points below
need to be checked.

  • I added unit tests for my code
  • I fully described what my PR does in the documentation
    (not in the PR description)
  • I fixed all affected documentation
  • I added code comments, logging, and assertions as appropriate (see Coding Guidelines)
  • I updated all meta data (e.g. README.md of plugins and METADATA.ini)
  • I mentioned every code not directly written by me in THIRD-PARTY-LICENSES

Review

Reviewers will usually check the following:

Labels

If you are already Elektra developer:

  • Add the "work in progress" label if you do not want the PR to be reviewed yet.
  • Add the "ready to merge" label if the basics are fulfilled and you also
    say that everything is ready to be merged.

@markus2330 markus2330 requested a review from tucek June 7, 2021 06:38
@markus2330 markus2330 mentioned this pull request Jun 7, 2021
14 tasks
@mpranj
Copy link
Member

mpranj commented Jun 7, 2021

Can I cancel this on Jenkins and rerun once the release is done so that we get the release out sooner?

EDIT: never mind, it failed by itself.

@markus2330
Copy link
Contributor Author

Ok, I'll not push anything here to avoid delaying the release.

@tucek
Copy link
Contributor

tucek commented Jun 7, 2021

@markus2330 Thank you for the updates to the documentation.
I propose to install the fat jar -all.jar alongside the normal JNA binding jar. This relieves the user from having the additional necessary java dependencies installed...

@markus2330 markus2330 merged commit 63d10da into master Jun 8, 2021
@markus2330 markus2330 deleted the release branch June 8, 2021 05:47
@tucek tucek added the lang/java label Aug 9, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants