From 8e591bab75914695baaa8003cab61465ad393fc8 Mon Sep 17 00:00:00 2001 From: Gregor Dschung Date: Mon, 24 Jan 2022 22:49:56 +0100 Subject: [PATCH] Update docs --- README.md | 14 +++++++------- .../plugin/truststorebuilder/CheckCertsSpec.kt | 6 ++++-- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index bf04da9..54d3a35 100644 --- a/README.md +++ b/README.md @@ -80,13 +80,13 @@ A `TrustStoreSpec` consists the following settings: The function `checkCertificates` takes a `CheckCertsSpec`, consisting of the following settings: -| Setting | Description | Default | Type | -|----------------------------------|--------------------------------------------------------------|--------------------------------------|---------------------| -| source(directory: Any*) | The directory which is scanned for certificates and bundles. | $projectDir/src/main/certs | function | -| include(vararg patterns: String) | Filter for the source directory. | ['**/*.crt', '**/*.cer', '**/*.pem'] | function | -| exclude(vararg patterns: String) | Exclusions for the source directory. | ['**/*.crt', '**/*.cer', '**/*.pem'] | function | -| atLeastValidDays | Number of days the certificates have to be at least valid. | 90 | Property\ | -| checkEnabled | Should the `check`-task depend on `checkCertificates`? | true | Property\ | +| Setting | Description | Default | Type | +|----------------------------------|--------------------------------------------------------------------|--------------------------------------|---------------------| +| source(directory: Any*) | The directory which is scanned for certificates and bundles. | $projectDir/src/main/certs | function | +| include(vararg patterns: String) | Filter for the source directory, can be called multiple times. | ['**/*.crt', '**/*.cer', '**/*.pem'] | function | +| exclude(vararg patterns: String) | Exclusions for the source directory, can be called multiple times. | [] | function | +| atLeastValidDays | Number of days the certificates have to be at least valid. | 90 | Property\ | +| checkEnabled | Should the `check`-task depend on `checkCertificates`? | true | Property\ | _\* Anything, that can be handled by [project.file(...)](https://docs.gradle.org/current/dsl/org.gradle.api.Project.html#org.gradle.api.Project:file%28java.lang.Object%29)._ diff --git a/src/main/kotlin/de/chkpnt/gradle/plugin/truststorebuilder/CheckCertsSpec.kt b/src/main/kotlin/de/chkpnt/gradle/plugin/truststorebuilder/CheckCertsSpec.kt index cd473d2..1e38d0d 100644 --- a/src/main/kotlin/de/chkpnt/gradle/plugin/truststorebuilder/CheckCertsSpec.kt +++ b/src/main/kotlin/de/chkpnt/gradle/plugin/truststorebuilder/CheckCertsSpec.kt @@ -53,7 +53,8 @@ class CheckCertsSpec(private val project: Project) { } /** - * Filter for the source directory. + * Filter for the source directory, can be called multiple times. + * * Defaults to ['**/*.crt', '**/*.cer', '**/*.pem']. */ fun include(vararg patterns: String) { @@ -61,7 +62,8 @@ class CheckCertsSpec(private val project: Project) { } /** - * Exclusions for the source directory. + * Exclusions for the source directory, can be called multiple times. + * * Defaults to []. */ fun exclude(vararg patterns: String) {