From 0e569650e0e1ba930d42116aa9546eb84d4a42e9 Mon Sep 17 00:00:00 2001 From: Mark Raynsford Date: Sat, 4 May 2024 16:53:06 +0000 Subject: [PATCH] Eliminate kstructural Affects: https://github.com/io7m-com/.github/issues/3 --- README.in | 63 +++++ README.md | 64 +++++ com.io7m.jaffirm.documentation/pom.xml | 242 ------------------ .../src/main/assembly/documentation.xml | 20 -- .../jaffirm/documentation/Documentation.java | 30 --- .../jaffirm/documentation/package-info.java | 22 -- .../src/main/java/module-info.java | 27 -- .../com/io7m/jaffirm/documentation/api.sdi | 4 - .../com/io7m/jaffirm/documentation/brand.xml | 9 - .../jaffirm/documentation/documentation.css | 118 --------- .../jaffirm/documentation/documentation.sd | 3 - .../jaffirm/documentation/pkg-install.sdi | 23 -- .../jaffirm/documentation/pkg-license.sdi | 20 -- .../jaffirm/documentation/pkg-overview.sdi | 5 - .../jaffirm/documentation/pkg-platform.sdi | 3 - .../com/io7m/jaffirm/documentation/pkg.sdi | 5 - pom.xml | 8 - src/site/resources/documentation.xml | 8 +- 18 files changed, 130 insertions(+), 544 deletions(-) create mode 100644 README.in delete mode 100644 com.io7m.jaffirm.documentation/pom.xml delete mode 100644 com.io7m.jaffirm.documentation/src/main/assembly/documentation.xml delete mode 100644 com.io7m.jaffirm.documentation/src/main/java/com/io7m/jaffirm/documentation/Documentation.java delete mode 100644 com.io7m.jaffirm.documentation/src/main/java/com/io7m/jaffirm/documentation/package-info.java delete mode 100644 com.io7m.jaffirm.documentation/src/main/java/module-info.java delete mode 100644 com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/api.sdi delete mode 100644 com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/brand.xml delete mode 100644 com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/documentation.css delete mode 100644 com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/documentation.sd delete mode 100644 com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-install.sdi delete mode 100644 com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-license.sdi delete mode 100644 com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-overview.sdi delete mode 100644 com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-platform.sdi delete mode 100644 com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg.sdi diff --git a/README.in b/README.in new file mode 100644 index 0000000..71a6a85 --- /dev/null +++ b/README.in @@ -0,0 +1,63 @@ + +## jaffirm + +The `jaffirm` package provides simple and fast pre/postcondition and invariant +checking functions. + +## Features + +* Static invocation, zero-allocation code paths for the common case of non-failing contracts. +* Specialized and generic variants of all functions for use in low-latency software. +* Detailed contract failure messages by construction. +* Written in pure Java 21. +* High coverage test suite. +* [OSGi-ready](https://www.osgi.org/) +* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System) +* ISC license. + +## Usage + +Declare preconditions with the `Preconditions` class. +Declare postconditions with the `Postconditions` class. +Declare invariants with the `Invariants` class. + +``` +import static com.io7m.jaffirm.core.Contracts.conditionI; +import static com.io7m.jaffirm.core.Preconditions.checkPreconditionI; +import static com.io7m.jaffirm.core.Preconditions.checkPreconditionsI; + +int exampleSingles(final int x) +{ + checkPreconditionI(x, x > 0, i -> "Input " + i + " must be > 0"); + checkPreconditionI(x, x % 2 == 0, i -> "Input " + i + " must be even"); + return x * 2; +} + +int exampleMultis(final int x) +{ + checkPreconditionsI( + x, + conditionI(i -> i > 0, i -> "Input " + i + " must be > 0"), + conditionI(i -> i % 2 == 0, i -> "Input " + i + " must be even")); + return x * 2; +} + +> exampleSingles(0) +Exception in thread "main" com.io7m.jaffirm.core.PreconditionViolationException: Precondition violation. + Received: 0 + Violated conditions: + [0]: Input 0 must be > 0 + +> exampleSingles(1) +Exception in thread "main" com.io7m.jaffirm.core.PreconditionViolationException: Precondition violation. + Received: 1 + Violated conditions: + [0]: Input 1 must be even + +> exampleMultis(-1) +Exception in thread "main" com.io7m.jaffirm.core.PreconditionViolationException: Precondition violation. + Received: -1 + Violated conditions: + [0]: Input -1 must be > 0 + [1]: Input -1 must be even +``` diff --git a/README.md b/README.md index 157f5df..12a0a5e 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,67 @@ jaffirm | OpenJDK (Temurin) LTS | Linux | [![Build (OpenJDK (Temurin) LTS, Linux)](https://img.shields.io/github/actions/workflow/status/io7m-com/jaffirm/main.linux.temurin.lts.yml)](https://www.github.com/io7m-com/jaffirm/actions?query=workflow%3Amain.linux.temurin.lts)| | OpenJDK (Temurin) Current | Windows | [![Build (OpenJDK (Temurin) Current, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/jaffirm/main.windows.temurin.current.yml)](https://www.github.com/io7m-com/jaffirm/actions?query=workflow%3Amain.windows.temurin.current)| | OpenJDK (Temurin) LTS | Windows | [![Build (OpenJDK (Temurin) LTS, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/jaffirm/main.windows.temurin.lts.yml)](https://www.github.com/io7m-com/jaffirm/actions?query=workflow%3Amain.windows.temurin.lts)| + +## jaffirm + +The `jaffirm` package provides simple and fast pre/postcondition and invariant +checking functions. + +## Features + +* Static invocation, zero-allocation code paths for the common case of non-failing contracts. +* Specialized and generic variants of all functions for use in low-latency software. +* Detailed contract failure messages by construction. +* Written in pure Java 21. +* High coverage test suite. +* [OSGi-ready](https://www.osgi.org/) +* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System) +* ISC license. + +## Usage + +Declare preconditions with the `Preconditions` class. +Declare postconditions with the `Postconditions` class. +Declare invariants with the `Invariants` class. + +``` +import static com.io7m.jaffirm.core.Contracts.conditionI; +import static com.io7m.jaffirm.core.Preconditions.checkPreconditionI; +import static com.io7m.jaffirm.core.Preconditions.checkPreconditionsI; + +int exampleSingles(final int x) +{ + checkPreconditionI(x, x > 0, i -> "Input " + i + " must be > 0"); + checkPreconditionI(x, x % 2 == 0, i -> "Input " + i + " must be even"); + return x * 2; +} + +int exampleMultis(final int x) +{ + checkPreconditionsI( + x, + conditionI(i -> i > 0, i -> "Input " + i + " must be > 0"), + conditionI(i -> i % 2 == 0, i -> "Input " + i + " must be even")); + return x * 2; +} + +> exampleSingles(0) +Exception in thread "main" com.io7m.jaffirm.core.PreconditionViolationException: Precondition violation. + Received: 0 + Violated conditions: + [0]: Input 0 must be > 0 + +> exampleSingles(1) +Exception in thread "main" com.io7m.jaffirm.core.PreconditionViolationException: Precondition violation. + Received: 1 + Violated conditions: + [0]: Input 1 must be even + +> exampleMultis(-1) +Exception in thread "main" com.io7m.jaffirm.core.PreconditionViolationException: Precondition violation. + Received: -1 + Violated conditions: + [0]: Input -1 must be > 0 + [1]: Input -1 must be even +``` + diff --git a/com.io7m.jaffirm.documentation/pom.xml b/com.io7m.jaffirm.documentation/pom.xml deleted file mode 100644 index 1143c1c..0000000 --- a/com.io7m.jaffirm.documentation/pom.xml +++ /dev/null @@ -1,242 +0,0 @@ - - - - 4.0.0 - - - com.io7m.jaffirm - com.io7m.jaffirm - 4.0.1-SNAPSHOT - - - com.io7m.jaffirm.documentation - jar - - com.io7m.jaffirm.documentation - Contract checking (Documentation) - https://www.io7m.com/software/jaffirm - - - true - - - - - ${project.groupId} - com.io7m.jaffirm.core - ${project.version} - - - - com.io7m.primogenitor - com.io7m.primogenitor.support - - - - org.osgi - org.osgi.annotation.bundle - provided - - - org.osgi - org.osgi.annotation.versioning - provided - - - org.immutables - value - provided - - - com.io7m.immutables.style - com.io7m.immutables.style - provided - - - - - - - - org.apache.maven.plugins - maven-resources-plugin - - - copy-documentation-resources - - copy-resources - - generate-resources - - ${project.build.directory}/documentation/ - - - src/main/resources/com/io7m/jaffirm/documentation/ - true - - - - - - - - - - org.apache.maven.plugins - maven-dependency-plugin - - - unpack-sources - package - - unpack-dependencies - - - module-info.java - ${project.groupId} - sources - false - ${project.build.directory}/javadoc-sources - - - - make-classpath - package - - build-classpath - - - ${project.build.directory}/javadoc-classpath - - - - - - - - com.io7m.kstructural - io7m-kstructural-maven-plugin - - - exec-multi - - compileXHTML - - process-resources - - ${project.build.directory}/documentation/documentation.sd - ${project.build.directory}/documentation/ - XHTML_MULTI_PAGE - - documentation.css - - - - - exec-single - - compileXHTML - - process-resources - - ${project.build.directory}/documentation/documentation.sd - ${project.build.directory}/documentation/ - XHTML_SINGLE_PAGE - - documentation.css - - - - - exec-plain - - compilePlain - - process-resources - - ${project.build.directory}/documentation/documentation.sd - ${project.build.directory}/documentation/ - - - - - - - - org.codehaus.mojo - exec-maven-plugin - - - - java - - package - - com.io7m.primogenitor.support.TrivialJavadoc - - ${project.build.directory}/javadoc-sources - ${project.build.directory}/javadoc-classpath - ${project.build.directory}/documentation/apidocs - ${project.build.directory}/javadoc-log.txt - ${project.build.directory}/javadoc-options - - - - - - - - - org.apache.maven.plugins - maven-assembly-plugin - - - src/main/assembly/documentation.xml - - - - - make-assembly - package - - single - - - false - - - - - - - - - org.codehaus.mojo - truezip-maven-plugin - false - - - copy-site-documentation - - copy - - site - - true - - - ${project.build.directory}/${project.name}-${project.version}.zip/${project.name}-${project.version}/ - - ${project.parent.build.directory}/minisite/documentation/ - - - - - - - - - diff --git a/com.io7m.jaffirm.documentation/src/main/assembly/documentation.xml b/com.io7m.jaffirm.documentation/src/main/assembly/documentation.xml deleted file mode 100644 index b888871..0000000 --- a/com.io7m.jaffirm.documentation/src/main/assembly/documentation.xml +++ /dev/null @@ -1,20 +0,0 @@ - - documentation - ${project.name}-${project.version} - - zip - - - - ${project.build.directory}/documentation - / - - - ${project.build.directory}/site/apidocs - /apidocs - - - diff --git a/com.io7m.jaffirm.documentation/src/main/java/com/io7m/jaffirm/documentation/Documentation.java b/com.io7m.jaffirm.documentation/src/main/java/com/io7m/jaffirm/documentation/Documentation.java deleted file mode 100644 index 5164371..0000000 --- a/com.io7m.jaffirm.documentation/src/main/java/com/io7m/jaffirm/documentation/Documentation.java +++ /dev/null @@ -1,30 +0,0 @@ -/* - * Copyright © 2016 Mark Raynsford https://www.io7m.com - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY - * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR - * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -package com.io7m.jaffirm.documentation; - -/** - * Marker class for looking up files by resource. - */ - -public final class Documentation -{ - private Documentation() - { - throw new AssertionError("Unreachable code"); - } -} - diff --git a/com.io7m.jaffirm.documentation/src/main/java/com/io7m/jaffirm/documentation/package-info.java b/com.io7m.jaffirm.documentation/src/main/java/com/io7m/jaffirm/documentation/package-info.java deleted file mode 100644 index 54aecb1..0000000 --- a/com.io7m.jaffirm.documentation/src/main/java/com/io7m/jaffirm/documentation/package-info.java +++ /dev/null @@ -1,22 +0,0 @@ -/* - * Copyright © 2016 Mark Raynsford https://www.io7m.com - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY - * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR - * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -/** - * Documentation. - */ - -package com.io7m.jaffirm.documentation; - diff --git a/com.io7m.jaffirm.documentation/src/main/java/module-info.java b/com.io7m.jaffirm.documentation/src/main/java/module-info.java deleted file mode 100644 index c1ff925..0000000 --- a/com.io7m.jaffirm.documentation/src/main/java/module-info.java +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Copyright © 2016 Mark Raynsford https://www.io7m.com - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY - * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR - * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -/** - * Documentation. - */ - -module com.io7m.jaffirm.documentation -{ - requires com.io7m.jaffirm.core; - requires static com.io7m.immutables.style; - - exports com.io7m.jaffirm.documentation; -} \ No newline at end of file diff --git a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/api.sdi b/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/api.sdi deleted file mode 100644 index ca17cb5..0000000 --- a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/api.sdi +++ /dev/null @@ -1,4 +0,0 @@ -[part [title API] [id api]] -[section [title JavaDoc] [id api.javadoc]] -[paragraph] -API documentation for the package is provided via the included [link-ext [target "apidocs"] Javadoc]. diff --git a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/brand.xml b/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/brand.xml deleted file mode 100644 index 0cd038f..0000000 --- a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/brand.xml +++ /dev/null @@ -1,9 +0,0 @@ - -
-
- io7m -
-
- ${project.parent.name} ${project.version} -
-
diff --git a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/documentation.css b/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/documentation.css deleted file mode 100644 index 3f34ec9..0000000 --- a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/documentation.css +++ /dev/null @@ -1,118 +0,0 @@ -.brand -{ - font-size: 75%; - font-family: monospace; -} - -.brand_left -{ - float: left; -} - -.brand_right -{ - text-align: right; -} - -.package -{ - font-family: monospace; - font-weight: bold; -} - -.emphasis, -.term -{ - font-style: italic; -} - -.attribute, -.class, -.command, -.constant, -.element, -.expression, -.file, -.function, -.keyword, -.parameter, -.protocol, -.variable, -.type -{ - font-family: monospace; -} - -.example, .license, .terminal -{ - font-family: monospace; - border: 1px solid #ccc; - padding-top: 1.0em; - padding-left: 1.0em; - padding-bottom: 1.0em; - margin-top: 1.2em; - overflow: auto; -} - -.monospace -{ - font-family: monospace; -} -.italic -{ - font-style: italic; -} -.bold -{ - font-weight: bold; -} - -.example_3x3 td, -.example_3x3 th -{ - padding-right: 3.0em; - font-family: monospace; - font-size: 9pt; -} - -.comparison_good -{ - background-color: #ccffcc; -} - -.comparison_neutral -{ - background-color: #ffffcc; -} - -.comparison_bad -{ - background-color: #ffcccc; -} - -.comparison td, .comparison th -{ - padding-right: 1.0em; - font-family: monospace; - font-size: 9pt; - vertical-align: top; -} - -.dependencies table td -{ - padding-right: 3.0em; - font-family: monospace; - font-size: 9pt; -} - -.platforms table td -{ - padding-right: 2.0em; -} -.platforms table tbody, -.platforms table thead -{ - font-size: 8pt; - font-family: monospace; -} - diff --git a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/documentation.sd b/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/documentation.sd deleted file mode 100644 index 9acbc63..0000000 --- a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/documentation.sd +++ /dev/null @@ -1,3 +0,0 @@ -[document [title ${project.parent.name} ${project.version} Documentation] - [import "pkg.sdi"] - [import "api.sdi"]] diff --git a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-install.sdi b/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-install.sdi deleted file mode 100644 index 244e315..0000000 --- a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-install.sdi +++ /dev/null @@ -1,23 +0,0 @@ -[section [title Installation] [id pkg.install]] -[subsection [title Source compilation] [id pkg.install.source]] -[paragraph] -The project can be compiled and installed with -[link-ext [target "http://maven.apache.org"] Maven]: - -[paragraph] -[verbatim [type example] "$ mvn -C clean install"] - -[subsection [title Maven] [id pkg.install.maven]] -[paragraph] -Regular releases are made to the -[link-ext [target "http://search.maven.org/#search%7Cga%7C1%7C${project.parent.name}"] Central Repository]. - -[paragraph] -All [link-ext [target "http://io7m.com"] io7m.com] packages use -Semantic Versioning [footnote-ref semver], which implies that it is -always safe to use version ranges with an exclusive upper bound equal -to the next major version - the API of the package will not change in -a backwards-incompatible manner before the next major version. - -[footnote [id semver]] -[link-ext [target "http://semver.org"] http://semver.org] diff --git a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-license.sdi b/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-license.sdi deleted file mode 100644 index 72fa987..0000000 --- a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-license.sdi +++ /dev/null @@ -1,20 +0,0 @@ -[section [title License] [id pkg.license]] -[paragraph] -All files distributed with the [term [type package] ${project.parent.name}] -package are placed under the following license: - -[formal-item [title License]] -[verbatim [type license] -"Copyright © 2017 http://io7m.com - -Permission to use, copy, modify, and/or distribute this software for any -purpose with or without fee is hereby granted, provided that the above -copyright notice and this permission notice appear in all copies. - -THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE."] diff --git a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-overview.sdi b/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-overview.sdi deleted file mode 100644 index d7ed008..0000000 --- a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-overview.sdi +++ /dev/null @@ -1,5 +0,0 @@ -[section [title Orientation] [id pkg.orientation]] -[subsection [title Overview] [id pkg.orientation.overview]] -[paragraph] -The [term [type package] ${project.parent.name}] package provides simple and -fast pre/postcondition and invariant checking functions. diff --git a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-platform.sdi b/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-platform.sdi deleted file mode 100644 index 3719fa5..0000000 --- a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg-platform.sdi +++ /dev/null @@ -1,3 +0,0 @@ -[section [title Platform Specific Issues] [id pkg.platform]] -[paragraph] -There are no known platform-specific issues. diff --git a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg.sdi b/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg.sdi deleted file mode 100644 index 9006f31..0000000 --- a/com.io7m.jaffirm.documentation/src/main/resources/com/io7m/jaffirm/documentation/pkg.sdi +++ /dev/null @@ -1,5 +0,0 @@ -[part [title Package Information] [id pkg]] -[import "pkg-overview.sdi"] -[import "pkg-install.sdi"] -[import "pkg-platform.sdi"] -[import "pkg-license.sdi"] \ No newline at end of file diff --git a/pom.xml b/pom.xml index 0cd762c..29421b6 100644 --- a/pom.xml +++ b/pom.xml @@ -23,7 +23,6 @@ com.io7m.jaffirm.core - com.io7m.jaffirm.documentation com.io7m.jaffirm.tests @@ -152,13 +151,6 @@ - - - com.io7m.kstructural - io7m-kstructural-maven-plugin - 0.3.1 - - com.github.spotbugs diff --git a/src/site/resources/documentation.xml b/src/site/resources/documentation.xml index d240953..7b88642 100644 --- a/src/site/resources/documentation.xml +++ b/src/site/resources/documentation.xml @@ -2,9 +2,7 @@

User documentation

- +

+ See the README. +