You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@maven.apache.org by GitBox <gi...@apache.org> on 2022/08/31 20:31:51 UTC

[GitHub] [maven-javadoc-plugin] alzimmermsft opened a new pull request, #159: Log javadoc warnings and errors to file

alzimmermsft opened a new pull request, #159:
URL: https://github.com/apache/maven-javadoc-plugin/pull/159

Following this checklist to help us incorporate your
contribution quickly and easily:

- [x] Make sure there is a [JIRA issue](https://issues.apache.org/jira/browse/MJAVADOC) filed
for the change (usually before you start working on it). Trivial changes like typos do not
require a JIRA issue. Your pull request should address just this issue, without
pulling in other changes.
- [x] Each commit in the pull request should have a meaningful subject line and body.
- [ ] Format the pull request title like `[MJAVADOC-XXX] - Fixes bug in ApproximateQuantiles`,
where you replace `MJAVADOC-XXX` with the appropriate JIRA issue. Best practice
is to use the JIRA issue title in the pull request title and in the first line of the
commit message.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Run `mvn clean verify -Prun-its` to make sure basic checks pass. A more thorough check will
be performed on your pull request automatically.

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.

- [x] 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).

Adds a new `@errors` file to the output directory, similar to the `@options`, `@packages`, `@argfile`, and `@files`, that contains the warnings and errors returned by the Javadoc process and won't be contained in a Javadoc JAR. This allows for external processes to capture warnings and errors produced during Javadoc generation without the need for complex logging processes and ensures that the Javadoc warnings and errors aren't interleaved with other data if the logger is handling requests from multiple threads.

--
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: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [MJAVADOC-722] Log javadoc warnings and errors to file [maven-javadoc-plugin]

Posted by "michael-o (via GitHub)" <gi...@apache.org>.

michael-o commented on PR #159:
URL: https://github.com/apache/maven-javadoc-plugin/pull/159#issuecomment-1830747943

   So I reviewed it again and still consider is as flawed. `@files` are pure input files to the Javadoc process, they have nothing in common with the output of the process. I still consider `errorFile` as the param to go.


-- 
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: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org