This is an automated email from the ASF dual-hosted git repository. vy pushed a commit to branch mvn-site-simplified in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 77af9b17304678ca6fc8d42f88ce5a52d82a95ed Author: Volkan Yazıcı <[email protected]> AuthorDate: Sun Nov 27 22:30:54 2022 +0100 LOG4J2-3628 More `maven-changes-plugin` clean up. --- pom.xml | 6 ++---- src/site/xdoc/guidelines.xml | 10 +++++----- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/pom.xml b/pom.xml index 380ee29dc1..23718acd67 100644 --- a/pom.xml +++ b/pom.xml @@ -1555,11 +1555,9 @@ <configuration> <!-- only build English site even on other language OS --> <locales>en</locales> - <!-- Exclude the navigation file for Maven 1 sites - and the changes file used by the changes-plugin, - as they interfere with the site generation. --> + <!-- Exclude the navigation file for Maven 1 sites as it interferes with the site generation. --> <moduleExcludes> - <xdoc>navigation.xml,changes.xml</xdoc> + <xdoc>navigation.xml</xdoc> </moduleExcludes> <asciidoc> <attributes> diff --git a/src/site/xdoc/guidelines.xml b/src/site/xdoc/guidelines.xml index 8cd6d88845..b1e69300c2 100644 --- a/src/site/xdoc/guidelines.xml +++ b/src/site/xdoc/guidelines.xml @@ -233,10 +233,10 @@ change can be included in any public release.</p> </subsection> <a name="changelogs"/> - <subsection name="changes.xml and Git logs"> - <p>Many code changes should be noted in the changes.xml file, and all should be + <subsection name="Changelog and Git logs"> + <p>Many code changes should be noted in a <code>changelog/.unreleased-*/<issueId>_<shortSummary>.xml</code> file, and all should be documented in Git commit messages. Often the text of the Git - log and the changes.xml entry are the same, but the distinct requirements + log and the changelog entry are the same, but the distinct requirements sometimes result in different information.</p> <h3 id="subversion-log">Git log</h3> <p>The Git commit log message contains any information needed by</p> @@ -264,8 +264,8 @@ crash if requests contain an invalid content length. Submitted by: Jane Doe <janedoe example.com> Reviewed by: susiecommitter ]]></pre> - <h3 id="changes">changes.xml</h3> - <p>changes.xml is the subset of the information that end users need to see when + <h3 id="changes">changelog</h3> + <p>changelog is a subset of the information that end users need to see when they upgrade from one release to the next:</p> <ul> <li>
