diff --git a/htmlSanityCheck-cli/README.adoc b/htmlSanityCheck-cli/README.adoc index cfae51ff..61194b47 100644 --- a/htmlSanityCheck-cli/README.adoc +++ b/htmlSanityCheck-cli/README.adoc @@ -34,7 +34,7 @@ Alternatively, == Usage -The CLI tool can be executed with the following command. +Execute the CLI tool with the following command. If the `sourceDirectory` is omitted, HSC uses the current directory as base-directory to search for HTML files. Linux / macOS:: @@ -56,7 +56,7 @@ hsc.bat [ options ] [ sourceDirectory ] The CLI tool exposes a few options as part of its configuration: [horizontal] - (optional):: Directory where the HTML files are located. + (optional):: HSC searches this directory for HTML files. + Type: Directory + @@ -75,13 +75,13 @@ Type: Directory Default: `./reports/htmlSanityCheck/` `--junitResultsDir` <...> (optional):: Directory where HSC writes the results in JUnit XML format. -JUnit XML can be read by many tools, including CI environments. +Many tools can read JUnit XML, including CI environments. + Type: Directory + Default: `./test-results/htmlchecks/` -`--failOnErrors` (optional):: Fail the build if any error was found in the checked pages. +`--failOnErrors` (optional):: Fail the build if HSC detected any error in the checked pages. + Type: Boolean + @@ -134,7 +134,8 @@ include::../htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/tools/W [NOTE] .HTTP Redirects ==== -Note that HTTP redirects are treated as a warning to make the user aware of the correct or new location (cf. {project-issues}/244[Issue 244]). +Note that HSC treats HTTP redirects as a warning to make the user aware of the correct +or new location (cf.{nbsp}{project-issues}/244[Issue 244]). Some HSC reports contain the respective location. ==== @@ -149,7 +150,7 @@ Default: include::../htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/tools/Web.java[tag=HTTP_ERROR_CODES,indent=0] ---- -`--httpSuccessCodes` (optional):: HTTP response codes treated as success. +`--httpSuccessCodes` (optional):: HTTP response codes that HSC treats as success. + Type: List + @@ -190,7 +191,7 @@ java -jar htmlSanityCheck-cli-.jar \ == Compatibility -The CLI tool has been tested with the following Java versions: +We test the HSC CLI tool with the following Java versions: * Java 8 * Java 11 diff --git a/src/docs/development/publishing.adoc b/src/docs/development/publishing.adoc index d3185caa..fc9291f8 100644 --- a/src/docs/development/publishing.adoc +++ b/src/docs/development/publishing.adoc @@ -136,8 +136,7 @@ gpg: Sorry, we are in batchmode - can't get input FAILURE: Build failed with an exception. ---- -In this case, you have to make sure you started the agent and cached the password, -e.g., by executing +In this case, you have to start the agent and cache the password, e.g., by executing [source,shell] ----