This is an automated email from the ASF dual-hosted git repository. vy pushed a commit to branch 2.x in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit a1c62db911eb06fe27bde5e8f3d325ec814c17f7 Author: Volkan Yazıcı <[email protected]> AuthorDate: Mon Jul 8 20:22:46 2024 +0200 Rename certain `Resources` pages in the site --- src/site/antora/modules/ROOT/nav.adoc | 7 +++---- src/site/antora/modules/ROOT/pages/_log4j1-eol.adoc | 2 +- src/site/antora/modules/ROOT/pages/faq.adoc | 4 ++-- .../antora/modules/ROOT/pages/{manual/webapp.adoc => jakarta.adoc} | 3 ++- src/site/antora/modules/ROOT/pages/manual/appenders.adoc | 2 +- src/site/antora/modules/ROOT/pages/manual/compatibility.adoc | 2 +- src/site/antora/modules/ROOT/pages/manual/configuration.adoc | 4 ++-- src/site/antora/modules/ROOT/pages/manual/index.adoc | 2 +- src/site/antora/modules/ROOT/pages/manual/logsep.adoc | 2 +- .../ROOT/pages/{manual/migration.adoc => migrate-from-log4j1.adoc} | 0 src/site/antora/modules/ROOT/pages/{manual/cloud.adoc => soa.adoc} | 0 .../manual/systemproperties/properties-context-selector.adoc | 2 +- .../ROOT/partials/manual/systemproperties/properties-jndi.adoc | 2 +- .../partials/manual/systemproperties/properties-log4j-12-api.adoc | 2 +- src/site/resources/.htaccess | 3 +++ 15 files changed, 20 insertions(+), 17 deletions(-) diff --git a/src/site/antora/modules/ROOT/nav.adoc b/src/site/antora/modules/ROOT/nav.adoc index 88dd977612..f7b7314b1e 100644 --- a/src/site/antora/modules/ROOT/nav.adoc +++ b/src/site/antora/modules/ROOT/nav.adoc @@ -62,12 +62,12 @@ .Resources * xref:faq.adoc[F.A.Q.] -* xref:manual/migration.adoc[] +* xref:migrate-from-log4j1.adoc[] * xref:migrate-from-logback.adoc[] * xref:migrate-from-slf4j.adoc[] * xref:hibernate.adoc[] -* xref:manual/webapp.adoc[] -* xref:manual/cloud.adoc[] +* xref:jakarta.adoc[] +* xref:soa.adoc[] * xref:development.adoc[] .Components @@ -82,7 +82,6 @@ * xref:log4j-jul.adoc[] * xref:log4j-to-jul.adoc[] - .Related projects * {logging-services-url}/log4j/jakarta[Log4j Jakarta EE] * {logging-services-url}/log4j/jmx-gui[Log4j JMX GUI] diff --git a/src/site/antora/modules/ROOT/pages/_log4j1-eol.adoc b/src/site/antora/modules/ROOT/pages/_log4j1-eol.adoc index b15526c6fe..48fe195689 100644 --- a/src/site/antora/modules/ROOT/pages/_log4j1-eol.adoc +++ b/src/site/antora/modules/ROOT/pages/_log4j1-eol.adoc @@ -19,5 +19,5 @@ ==== http://logging.apache.org/log4j/1.x[Log4j 1] has https://blogs.apache.org/foundation/entry/apache_logging_services_project_announces[reached End of Life] in 2015, and is no longer supported. Vulnerabilities reported after August 2015 against Log4j 1 are not checked and will not be fixed. -Users should xref:manual/migration.adoc[upgrade to Log4j 2] to obtain security fixes. +Users should xref:migrate-from-log4j1.adoc[upgrade to Log4j 2] to obtain security fixes. ==== diff --git a/src/site/antora/modules/ROOT/pages/faq.adoc b/src/site/antora/modules/ROOT/pages/faq.adoc index c766fc42f1..da2a9d4525 100644 --- a/src/site/antora/modules/ROOT/pages/faq.adoc +++ b/src/site/antora/modules/ROOT/pages/faq.adoc @@ -37,7 +37,7 @@ You can also specify the full path of the configuration file using a system prop That property can also be included in a classpath resource file named `log4j2.component.properties`. Web applications can specify the Log4j configuration file location with a servlet context parameter. -See xref:manual/webapp.adoc#ContextParams[the related page on web applications]. +See xref:jakarta.adoc#ContextParams[the related page on web applications]. Refer to xref:manual/configuration.adoc[the Configuration page] for further details. @@ -65,7 +65,7 @@ Configurator.reconfigure(configSourceUri); Normally there is no need to do this manually. Each `LoggerContext` registers a shutdown hook that takes care of releasing resources when the JVM exits, unless the `log4j.shutdownHookEnabled` system property is set to `false`. -Likewise, xref:manual/webapp.adoc[Web applications] replace the shutdown hook with their own resource management mechanisms. +Likewise, xref:jakarta.adoc[Web applications] replace the shutdown hook with their own resource management mechanisms. That is, they clean up necessary resources when the web application is stopped. However, if you need to manually shut down Log4j, you can use one of the `shutdown()` methods of link:../javadoc/log4j-api/org/apache/logging/log4j/LogManager.html#shutdown()[`LogManager`]. diff --git a/src/site/antora/modules/ROOT/pages/manual/webapp.adoc b/src/site/antora/modules/ROOT/pages/jakarta.adoc similarity index 99% rename from src/site/antora/modules/ROOT/pages/manual/webapp.adoc rename to src/site/antora/modules/ROOT/pages/jakarta.adoc index 8de25f076b..ff4ae60178 100644 --- a/src/site/antora/modules/ROOT/pages/manual/webapp.adoc +++ b/src/site/antora/modules/ROOT/pages/jakarta.adoc @@ -15,7 +15,8 @@ limitations under the License. //// [#jakarta-ee] -= Using Log4j in a Jakarta EE environment += Integrating with Jakarta EE + :jetty-latest-url: https://jetty.org/docs/jetty/12 :tomcat-latest-url: https://tomcat.apache.org/tomcat-11.0-doc :wildfly-latest-url: https://docs.wildfly.org/32 diff --git a/src/site/antora/modules/ROOT/pages/manual/appenders.adoc b/src/site/antora/modules/ROOT/pages/manual/appenders.adoc index 011684c957..d37ce1139f 100644 --- a/src/site/antora/modules/ROOT/pages/manual/appenders.adoc +++ b/src/site/antora/modules/ROOT/pages/manual/appenders.adoc @@ -3858,7 +3858,7 @@ Additional runtime dependencies are required for using the servlet appender: include::partial$manual/dependencies-log4j-jakarta-web.adoc[] -See xref:manual/webapp.adoc[] for more information. +See xref:jakarta.adoc[] for more information. [CAUTION] ==== diff --git a/src/site/antora/modules/ROOT/pages/manual/compatibility.adoc b/src/site/antora/modules/ROOT/pages/manual/compatibility.adoc index 1383161987..e1c71f445c 100644 --- a/src/site/antora/modules/ROOT/pages/manual/compatibility.adoc +++ b/src/site/antora/modules/ROOT/pages/manual/compatibility.adoc @@ -19,4 +19,4 @@ Licensed to the Apache Software Foundation (ASF) under one or more == Compatibility with Log4j 1 -See the xref:manual/migration.adoc#Log4j12Bridge[Log4j 1.x bridge (log4j-1.2-api)] section of the Log4j 1.x Migration page. +See the xref:migrate-from-log4j1.adoc#Log4j12Bridge[Log4j 1.x bridge (log4j-1.2-api)] section of the Log4j 1.x Migration page. diff --git a/src/site/antora/modules/ROOT/pages/manual/configuration.adoc b/src/site/antora/modules/ROOT/pages/manual/configuration.adoc index a271a7719f..fbb82f3a5d 100644 --- a/src/site/antora/modules/ROOT/pages/manual/configuration.adoc +++ b/src/site/antora/modules/ROOT/pages/manual/configuration.adoc @@ -42,7 +42,7 @@ A name derived from the runtime environment: + * For standalone Java SE applications, it is a random identifier. * For web applications, it is an identifier derived from the application descriptor. -See xref:manual/webapp.adoc#configuration[Log4j Web application configuration] for details. +See xref:jakarta.adoc#configuration[Log4j Web application configuration] for details. <extension>:: A file extension supported by a `ConfigurationFactory`. @@ -100,7 +100,7 @@ Starting with Log4j 2, the configuration file syntax has been considered part of ==== The syntax of the configuration file changed between Log4j{nbsp}1 and Log4j{nbsp}2. Files in the Log4j{nbsp}1 syntax are ignored by default. -To enable partial support for old configuration syntax, see xref:manual/migration.adoc#ConfigurationCompatibility[configuration compatibility]. +To enable partial support for old configuration syntax, see xref:migrate-from-log4j1.adoc#ConfigurationCompatibility[configuration compatibility]. ==== The Log4j runtime is composed of xref:manual/plugins.adoc[plugins], which are like beans in the Spring Framework and Java EE. diff --git a/src/site/antora/modules/ROOT/pages/manual/index.adoc b/src/site/antora/modules/ROOT/pages/manual/index.adoc index 99b0423f1f..40f5760680 100644 --- a/src/site/antora/modules/ROOT/pages/manual/index.adoc +++ b/src/site/antora/modules/ROOT/pages/manual/index.adoc @@ -62,5 +62,5 @@ include::partial$log4j-features.adoc[] * xref:manual/configuration.adoc[How can I configure Log4j?] * xref:manual/api.adoc[How can I use Log4j API?] * xref:manual/performance.adoc[How can I tune my Log4j setup for performance?] -* xref:manual/migration.adoc[How can I migrate from Log4j 1 to Log4j 2]? +* xref:migrate-from-log4j1.adoc[How can I migrate from Log4j 1 to Log4j 2]? * xref:manual/plugins.adoc[What are Log4j plugins] and xref:manual/extending.adoc[how can I use them to extend Log4j?] diff --git a/src/site/antora/modules/ROOT/pages/manual/logsep.adoc b/src/site/antora/modules/ROOT/pages/manual/logsep.adoc index 21675680c6..09bf222e42 100644 --- a/src/site/antora/modules/ROOT/pages/manual/logsep.adoc +++ b/src/site/antora/modules/ROOT/pages/manual/logsep.adoc @@ -99,7 +99,7 @@ create a single LoggerContext using a single configuration that will be shared across all applications. 2. Place the logging jars in the container's classpath and use the default ClassLoaderContextSelector. -See the instructions shared in xref:manual/webapp.adoc[Log4j Web]. +See the instructions shared in xref:jakarta.adoc[Log4j Web]. Each application can be configured to share the same configuration used at the container or can be individually configured. If xref:manual/status-logger.adoc[status logging] is set to debug in the configuration there will be diff --git a/src/site/antora/modules/ROOT/pages/manual/migration.adoc b/src/site/antora/modules/ROOT/pages/migrate-from-log4j1.adoc similarity index 100% rename from src/site/antora/modules/ROOT/pages/manual/migration.adoc rename to src/site/antora/modules/ROOT/pages/migrate-from-log4j1.adoc diff --git a/src/site/antora/modules/ROOT/pages/manual/cloud.adoc b/src/site/antora/modules/ROOT/pages/soa.adoc similarity index 100% rename from src/site/antora/modules/ROOT/pages/manual/cloud.adoc rename to src/site/antora/modules/ROOT/pages/soa.adoc diff --git a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-context-selector.adoc b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-context-selector.adoc index 551f7b9bc2..f65706205d 100644 --- a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-context-selector.adoc +++ b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-context-selector.adoc @@ -51,4 +51,4 @@ link:../javadoc/log4j-core/org/apache/logging/log4j/core/osgi/BundleContextSelec Creates a separate logger context per OSGi bundle and synchronous loggers link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/JndiContextSelector.html[`org.apache.logging.log4j.core.selector.JndiContextSelector`]:: -Creates loggers contexts based on a JNDI lookup and synchronous loggers See xref:manual/webapp.adoc#use-jndi-context-selector[Web application] for details. \ No newline at end of file +Creates loggers contexts based on a JNDI lookup and synchronous loggers See xref:jakarta.adoc#use-jndi-context-selector[Web application] for details. \ No newline at end of file diff --git a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-jndi.adoc b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-jndi.adoc index bd2f07ba13..c9db5b37f3 100644 --- a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-jndi.adoc +++ b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-jndi.adoc @@ -25,7 +25,7 @@ |=== When `true` the `JndiContextSelector` is enabled for the `java:` protocol. -See xref:manual/webapp.adoc#use-jndi-context-selector[Web application] for more details. +See xref:jakarta.adoc#use-jndi-context-selector[Web application] for more details. [id=log4j2.enableJndiJdbc] == `log4j2.enableJndiJdbc` diff --git a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-12-api.adoc b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-12-api.adoc index efc5f2930a..05c81b08db 100644 --- a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-12-api.adoc +++ b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-12-api.adoc @@ -52,4 +52,4 @@ https://docs.oracle.com/javase/{java-target-version}/docs/api/java/net/URI.html[ If not `null`, Log4j 2 will try to retrieve a **Log4j 1** configuration file from the given location. The configuration file name must end in `.properties` (Log4j 1 properties format) or `.xml` (Log4j 1 XML format). See also -xref:manual/migration.adoc#configuration-limitations[limitations of Log4j 1 configuration compatibility layer]. \ No newline at end of file +xref:migrate-from-log4j1.adoc#configuration-limitations[limitations of Log4j 1 configuration compatibility layer]. diff --git a/src/site/resources/.htaccess b/src/site/resources/.htaccess index b40af8fb96..feaab01a40 100644 --- a/src/site/resources/.htaccess +++ b/src/site/resources/.htaccess @@ -48,8 +48,11 @@ RewriteRule "^log4j-mongodb4(/index)?\.html$" "manual/appenders.html#log4j-mongo RewriteRule "^log4j-slf4j2?-impl(/index)?\.html$" "manual/installation.html#impl-core-bridge-slf4j" [R=permanent,NE] RewriteRule "^log4j-taglib(/index)?\.html$" "manual/webapp.html#log4j-taglib" [R=permanent,NE] RewriteRule "^manual/api-separation\.html$" "manual/api.html" [R=permanent] +RewriteRule "^manual/cloud\.html$" "soa.html" [R=permanent] +RewriteRule "^manual/migration\.html$" "migrate-from-log4j1.html" [R=permanent] RewriteRule "^manual/scala-api\.html$" "/log4j/scala/latest/index.html" [R=permanent] RewriteRule "^manual/usage\.html$" "manual/api.html" [R=permanent] +RewriteRule "^manual/webapp\.html$" "jakarta.html" [R=permanent] RewriteRule "^runtime-dependencies\.html$" "manual/installation.html" [R=permanent] RewriteRule "^thanks\.html$" "/support.html#sponsors" [R=permanent,NE]
