nar-maven-plugin - nar:nar-validate

nar:nar-validate

Full name:

com.github.maven-nar:nar-maven-plugin:3.4.1-SNAPSHOT:nar-validate

Description:

Validates the configuration of the NAR project (aol and pom)

Attributes:

Requires a Maven project to be executed.
Binds by default to the lifecycle phase: validate.

Required Parameters

Name	Type	Since	Description
failOnError	`boolean`	`-`	Fail on compilation/linking error. Default value is: `true`.
gnuSourceDirectory	`File`	`-`	Source directory for GNU style project Default value is: `${basedir}/src/gnu`.
layout	`String`	`-`	Layout to be used for building and unpacking artifacts Default value is: `com.github.maven_nar.NarLayout21`. User property is: `nar.layout`.
libtool	`boolean`	`-`	Set use of libtool. If set to true, the "libtool " will be prepended to the command line for compatible processors. Default value is: `false`.
runtime	`String`	`-`	Sets the type of runtime library, possible values "dynamic", "static". Default value is: `dynamic`.

Optional Parameters

Name	Type	Since	Description
aol	`String`	`-`	Architecture-OS-Linker name. Defaults to: arch-os-linker.
architecture	`String`	`-`	The Architecture for the nar, Some choices are: "x86", "i386", "amd64", "ppc", "sparc", ... Defaults to a derived value from ${os.arch} User property is: `nar.arch`.
c	`C`	`-`	C Compiler
classifiers	`List`	`-`	List of classifiers which you want download/unpack/assemble Example ppc-MacOSX-g++, x86-Windows-msvc, i386-Linux-g++. Not setting means all.
commandLogLevel	`int`	`-`	Do we log commands that is executed to produce the end-result? Conception was to allow eclipse to sniff out include-paths from compile.
cpp	`Cpp`	`-`	C++ Compiler
decorateLinkerOptions	`boolean`	`-`	Flag to cpptasks to indicate whether linker options should be decorated or not
excludeArtifactIds	`String`	`2.0`	Comma separated list of Artifact names to exclude. User property is: `excludeArtifactIds`.
excludeGroupIds	`String`	`2.0`	Comma separated list of GroupId Names to exclude. User property is: `excludeGroupIds`.
fortran	`Fortran`	`-`	Fortran Compiler
idl	`IDL`	`-`	IDL Compiler
ignore	`boolean`	`-`	Ignore errors and failures. Default value is: `false`. User property is: `nar.ignore`.
includeArtifactIds	`String`	`2.0`	Comma separated list of Artifact names to include. User property is: `includeArtifactIds`.
includeGroupIds	`String`	`2.0`	Comma separated list of GroupIds to include. User property is: `includeGroupIds`.
java	`Java`	`-`	Java info for includes and linking
javah	`Javah`	`-`	Javah info
libraries	`List`	`-`	List of libraries to create
libsName	`String`	`-`	Name of the libraries included
linker	`Linker`	`-`	Linker
maxCores	`int`	`-`	Maximum number of Cores/CPU's to use. 0 means unlimited.
message	`Message`	`-`	Message Compiler
msvc	`Msvc`	`-`	(no description)
onlySpecifiedCompilers	`boolean`	`-`	By default NAR compile will attempt to compile using all known compilers against files in the directories specified by convention. This allows configuration to a reduced set, you will have to specify each compiler to use in the configuration. Default value is: `false`.
os	`String`	`-`	The Operating System for the nar. Some choices are: "Windows", "Linux", "MacOSX", "SunOS", ... Defaults to a derived value from ${os.name} FIXME table missing User property is: `nar.os`.
output	`String`	`-`	Name of the output - for jni default-value="${project.artifactId}-${project.version}" - for libs default-value="${project.artifactId}-${project.version}" - for exe default-value="${project.artifactId}" -- for tests default-value="${test.name}"
resource	`Resource`	`-`	Resource Compiler
skip	`boolean`	`-`	Skip running of NAR plugins (any) altogether. Default value is: `false`. User property is: `nar.skip`.
skipTests	`boolean`	`-`	Skip the tests. Listens to Maven's general 'maven.skip.test'. User property is: `maven.test.skip`.
targetDirectory	`File`	`-`	Target directory for Nar file construction. Defaults to "${project.build.directory}/nar" for "nar-compile" goal
testTargetDirectory	`File`	`-`	Target directory for Nar test construction. Defaults to "${project.build.directory}/test-nar" for "nar-testCompile" goal
testUnpackDirectory	`File`	`-`	Target directory for Nar test unpacking. Defaults to "${testTargetDirectory}"
tests	`List`	`-`	List of tests to create
unpackDirectory	`File`	`-`	Target directory for Nar file unpacking. Defaults to "${targetDirectory}"

Parameter Details

aol:

Architecture-OS-Linker name. Defaults to: arch-os-linker.

Type: java.lang.String
Required: No

architecture:

The Architecture for the nar, Some choices are: "x86", "i386", "amd64", "ppc", "sparc", ... Defaults to a derived value from ${os.arch}

Type: java.lang.String
Required: No
User Property: nar.arch

C Compiler

Type: com.github.maven_nar.C
Required: No

classifiers:

List of classifiers which you want download/unpack/assemble Example ppc-MacOSX-g++, x86-Windows-msvc, i386-Linux-g++. Not setting means all.

Type: java.util.List
Required: No

commandLogLevel:

Do we log commands that is executed to produce the end-result? Conception was to allow eclipse to sniff out include-paths from compile.

Type: int
Required: No

cpp:

C++ Compiler

Type: com.github.maven_nar.Cpp
Required: No

decorateLinkerOptions:

Flag to cpptasks to indicate whether linker options should be decorated or not

Type: boolean
Required: No

excludeArtifactIds:

Comma separated list of Artifact names to exclude.

Type: java.lang.String
Since: 2.0
Required: No
User Property: excludeArtifactIds

excludeGroupIds:

Comma separated list of GroupId Names to exclude.

Type: java.lang.String
Since: 2.0
Required: No
User Property: excludeGroupIds

failOnError:

Fail on compilation/linking error.

Type: boolean
Required: Yes
Default: true

fortran:

Fortran Compiler

Type: com.github.maven_nar.Fortran
Required: No

gnuSourceDirectory:

Source directory for GNU style project

Type: java.io.File
Required: Yes
Default: ${basedir}/src/gnu

idl:

IDL Compiler

Type: com.github.maven_nar.IDL
Required: No

ignore:

Ignore errors and failures.

Type: boolean
Required: No
User Property: nar.ignore
Default: false

includeArtifactIds:

Comma separated list of Artifact names to include.

Type: java.lang.String
Since: 2.0
Required: No
User Property: includeArtifactIds

includeGroupIds:

Comma separated list of GroupIds to include.

Type: java.lang.String
Since: 2.0
Required: No
User Property: includeGroupIds

java:

Java info for includes and linking

Type: com.github.maven_nar.Java
Required: No

javah:

Javah info

Type: com.github.maven_nar.Javah
Required: No

layout:

Layout to be used for building and unpacking artifacts

Type: java.lang.String
Required: Yes
User Property: nar.layout
Default: com.github.maven_nar.NarLayout21

libraries:

List of libraries to create

Type: java.util.List
Required: No

libsName:

Name of the libraries included

Type: java.lang.String
Required: No

libtool:

Set use of libtool. If set to true, the "libtool " will be prepended to the command line for compatible processors.

Type: boolean
Required: Yes
Default: false

linker:

Linker

Type: com.github.maven_nar.Linker
Required: No

maxCores:

Maximum number of Cores/CPU's to use. 0 means unlimited.

Type: int
Required: No

message:

Message Compiler

Type: com.github.maven_nar.Message
Required: No

msvc:

(no description)

Type: com.github.maven_nar.Msvc
Required: No

onlySpecifiedCompilers:

By default NAR compile will attempt to compile using all known compilers against files in the directories specified by convention. This allows configuration to a reduced set, you will have to specify each compiler to use in the configuration.

Type: boolean
Required: No
Default: false

os:

The Operating System for the nar. Some choices are: "Windows", "Linux", "MacOSX", "SunOS", ... Defaults to a derived value from ${os.name} FIXME table missing

Type: java.lang.String
Required: No
User Property: nar.os

output:

Name of the output - for jni default-value="${project.artifactId}-${project.version}" - for libs default-value="${project.artifactId}-${project.version}" - for exe default-value="${project.artifactId}" -- for tests default-value="${test.name}"

Type: java.lang.String
Required: No

resource:

Resource Compiler