Skip to content

Commit

Permalink
#817 added section "Known Issues" to manual (#821)
Browse files Browse the repository at this point in the history
  • Loading branch information
DirkMahler authored Feb 24, 2025
1 parent 39e673b commit dc47d50
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 1 deletion.
2 changes: 1 addition & 1 deletion manual/src/main/asciidoc/include/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ If an entry contained in the baseline file is no longer detected during an analy

TIP: Entries in the baseline can be removed manually if these entries no longer shall be suppressed during analysis. To achieve this the according `<row> ... </row>` must be deleted and the baseline file updated in the VCS.

If baseline management is enabled the by default all constraint violations will be included.
If baseline management is enabled then by default all constraint violations will be included.
This can be fine-tuned by adding further configuration properties:

[source,yaml]
Expand Down
66 changes: 66 additions & 0 deletions manual/src/main/asciidoc/include/known-issues.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
= Known Issues

This section describes known issues and their solutions.

== Maven

=== Cannot re-use store instance from reactor

This error may occur in cases where a Maven project contains build extensions, e.g.

.pom.xml
[source,xml]
----
<build>
<extensions>
<extension>
<groupId>kr.motd.maven</groupId>
<artifactId>os-maven-plugin</artifactId>
<version>${os-maven-plugin.version}</version>
</extension>
</extensions>
</build>
----

The problem be resolved by adding the following option to the `.jqassistant.yml`:

..jqassistant.yml
[source,yaml]
----
jqassistant:
maven:
reuse-store: false
----

Alternatively the option can be specified on the Maven command line:

[source,bash]
----
mvn -Djqassistant.maven.reuse-store=false jqassistant:scan jqassistant:analyze
----

== General

=== UnsatisfiedLinkError on Linux systems

On Linux systems using the `noexec` option on the `/home` mount the following error occurs on startup:

----
java.lang.UnsatisfiedLinkError: /home/jqa-user/.cache/JNA/temp/jna1503285157168624171.tmp: /home/jqa-user.cache/JNA/temp/jna1503285157168624171.tmp: failed to map segment from shared object
----

The problem can be resolved by setting the system property `-Djna.tmpdir` pointing to a temporary directory without the noexec limitation:

.Maven
[source,bash]
```
mvn -Djna.tmpdir=/tmp jqassistant:scan jqassistant:analyze
```

.Command line interface
[source,bash]
```
export JQASSISTANT_OPTIONS=-Djna.tmpdir=/tmp
jqassistant.sh scan analyze
```

4 changes: 4 additions & 0 deletions manual/src/main/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,8 @@ include::include/configuration.adoc[]

include::include/plugins.adoc[]

:leveloffset: +1

include::include/known-issues.adoc[]

:leveloffset: -1

0 comments on commit dc47d50

Please sign in to comment.