AlexanderAshitkin opened a new pull request, #460:
URL: https://github.com/apache/maven-build-cache-extension/pull/460
Documentation fixes and improvement.
### Fixes
- Fix typo `prodiuce` → `produce` in `concepts.md`
- Fix broken sentence in `concepts.md` that mixed a fragment from one
paragraph into another
- Fix XML snippet in `remote-cache.md`: wrap `<plugin>` inside `<plugins>`
and `<excludeProperty>` inside `<excludeProperties>` to match the actual schema
- Remove spurious trailing semicolons from command-line flag examples in
`performance.md`
- Fix typo `soring` → `storing` in `performance.md`
- Fix typo `environnement` → `environment` in `parameters.md`
- Remove duplicate "Minimal config" heading in `how-to.md`
### Documentation additions and improvements
- **`parameters.md`**: Add missing `-Dmaven.build.cache.location` and
`-Dmaven.build.cache.cacheCompile` command-line flags to the parameter table;
add default value for
`mandatoryClean`; add new "XML configuration reference" section
documenting `<local>`, `<remote>`, `<attachedOutputs>`, `<projectVersioning>`,
`<debugs>`, and
`<executionControl>/<ignoreMissing>` XML elements that previously had no
reference documentation
- **`performance.md`**: Replace the prose description of hash algorithms
with a structured table listing all supported identifiers (`XX`, `XXMM`,
`METRO`, `METRO+MM`,
`SHA-1`, `SHA-256`, `SHA-384`, `SHA-512`) with descriptions
- **`how-to.md`**: Add inline comment on the default `hashAlgorithm`
pointing readers to the performance page; add new how-to section for disabling
compile-only build
caching (`-Dmaven.build.cache.cacheCompile=false`)
- **`usage.md`**: Clarify that caching also applies to compile-phase
builds by default, not only `package` and above
- **`index.md.vm`**: Clarify Maven version requirement as "3.9.0 or later
(including Maven 4)"; add Maven 4 compatibility note; improve "See also" link
descriptions
- **`maven-build-cache-config.xml`**: Add comment explaining the choice of
`SHA-256` in the sample config and pointing to the performance page
### No behavior changes
All changes are documentation-only.
Following this checklist to help us incorporate your
contribution quickly and easily:
- [ ] Your pull request should address just one issue, without pulling in
other changes.
- [ ] Write a pull request description that is detailed enough to understand
what the pull request does, how, and why.
- [ ] Each commit in the pull request should have a meaningful subject line
and body.
Note that commits might be squashed by a maintainer on merge.
- [ ] Write unit tests that match behavioral changes, where the tests fail
if the changes to the runtime are not applied.
This may not always be possible but is a best-practice.
- [ ] Run `mvn verify` to make sure basic checks pass.
A more thorough check will be performed on your pull request automatically.
- [ ] You have run the integration tests successfully (`mvn -Prun-its
verify`).
If your pull request is about ~20 lines of code you don't need to sign an
[Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the [Apache License Version 2.0, January
2004](http://www.apache.org/licenses/LICENSE-2.0)
you have to acknowledge this by using the following check-box.
- [ ] I hereby declare this contribution to be licenced under the [Apache
License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
- [ ] In any other case, please file an [Apache Individual Contributor
License Agreement](https://www.apache.org/licenses/icla.pdf).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
