vy commented on a change in pull request #2: URL: https://github.com/apache/logging-log4j-tools/pull/2#discussion_r732216398
########## File path: log4j-maven-plugins/log4j-maven-plugins-shade-transformer/pom.xml ########## @@ -0,0 +1,233 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.logging.maven</groupId> + <artifactId>log4j-maven-plugins</artifactId> + <version>2.14.1-SNAPSHOT</version> + <relativePath>../</relativePath> + </parent> + <artifactId>log4j-maven-plugins-shade-transformer</artifactId> Review comment: I think this is a good spot to talk about the module naming and hiearchy. @edwgiz, I see that you have created a nested module structure: `log4j-maven-plugins-shade-transformer` under `log4j-maven-plugins`. I share my remarks below. 1. I see some things are named `shade` and some `shaded`. I think we need to stick to one. 1. I don't think there is a need for a nested structure; `log4j-maven-plugins-shade-transformer` at the top is good enough. 1. I propose naming the module to `log4j-maven-shade-plugin-extensions`. Because, 1. `log4j-` prefix in the artifact IDs is a convention we stick to everywhere, I don't see why this needs to be an exception. 1. I see `-extensions` suffix is used by [others extending Maven Shade plugin](https://search.maven.org/search?q=shade%20plugin) too. 1. Whatever the consensus on the module name is, JPMS module name and Java package path need to reflect that too. @jvz, @rgoers, @garydgregory, comments? ########## File path: log4j-maven-plugins/log4j-maven-plugins-shade-transformer/src/site/markdown/index.md ########## @@ -0,0 +1,81 @@ +<!-- vim: set syn=markdown : --> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +# Log4j Maven Shaded Plugin Support + +This module provides support for [Apache Maven Shade Plugin](https://maven.apache.org/plugins/maven-shade-plugin/). + +## Overview + +This module includes the transformer for [Apache Maven Shade Plugin](https://maven.apache.org/plugins/maven-shade-plugin/), that concatenates `Log4j2Plugins.dat` files, Review comment: Before technically explaining what the transformer does, maybe it is good to have some introduction to the problem: _"Log4j 2 is composed of [plugins](https://logging.apache.org/log4j/2.x/manual/plugins.html) and they are loaded from `Log4j2Plugins.dat` file found in the classpath at runtime. Shading overrides the cache files provided by each individual module. For instance, `-web` and `-core`, etc. ... So if you happen to shade libraries providing Log4j 2 plugins, you need this thing."_ Something along these lines. It is also important to keep the Log4j *2* emphasis here. Since, 1) Log4j 1 doesn't have plugins and 2) Log4j 3 plugins doesn't suffer from this problem. ########## File path: log4j-maven-plugins/log4j-maven-plugins-shade-transformer/src/site/markdown/index.md ########## @@ -0,0 +1,81 @@ +<!-- vim: set syn=markdown : --> Review comment: I don't know the details, yet, is it possible to use AsciiDoc instead? That became the _de facto_ documentation format in Log4j `master` and supersedes Markdown and XML used in `release-2.x`. Using AsciiDoc, you can also save you some typing by creating some variables, e.g., the link to the Apache Maven Shade Plugin, etc. ########## File path: log4j-maven-plugins/log4j-maven-plugins-shade-transformer/src/site/site.xml ########## @@ -0,0 +1,52 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +--> +<project name="Log4j Maven Shade Plugin Transformer" + xmlns="http://maven.apache.org/DECORATION/1.4.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.4.0 http://maven.apache.org/xsd/decoration-1.4.0.xsd";> + <body> + <links> + <item name="Apache" href="http://www.apache.org/"; /> + <item name="Logging Services" href="http://logging.apache.org/"/> + <item name="Log4j" href="../index.html"/> Review comment: Is this `href` correct? -- 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]
