You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@activemq.apache.org by "ASF GitHub Bot (Jira)" <ji...@apache.org> on 2022/09/07 14:00:00 UTC

[jira] [Work logged] (AMQ-9074) remove various .js dependencies and source listing from javadoc output

     [ https://issues.apache.org/jira/browse/AMQ-9074?focusedWorklogId=806712&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-806712 ]

ASF GitHub Bot logged work on AMQ-9074:
---------------------------------------

                Author: ASF GitHub Bot
            Created on: 07/Sep/22 13:59
            Start Date: 07/Sep/22 13:59
    Worklog Time Spent: 10m 
      Work Description: gemmellr opened a new pull request, #906:
URL: https://github.com/apache/activemq/pull/906

   use -noindex to remove various .js files, disable html source listings for javadoc




Issue Time Tracking
-------------------

            Worklog Id:     (was: 806712)
    Remaining Estimate: 0h
            Time Spent: 10m

> remove various .js dependencies and source listing from javadoc output
> ----------------------------------------------------------------------
>
>                 Key: AMQ-9074
>                 URL: https://issues.apache.org/jira/browse/AMQ-9074
>             Project: ActiveMQ
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 5.17.2
>            Reporter: Robbie Gemmell
>            Priority: Major
>             Fix For: 5.18.0
>
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> Following https://openjdk.org/jeps/225), the javadoc output on JDK9+ has included a search box. To enable this various javascript files and a zipped index are included in the javadoc output. This means they were introduced to the javadoc output once the project required Java 11, i.e from 5.17.0, as previously Java 8 was used to run the release builds. These files are of whatever version the JDK used to run the build has included, and can tend to get stale (as per ARTEMIS-3971)
> Setting the -noindex option when building the javadoc removes the search, so we can add this option and remove the need to deal with these files going stale in future. 
> Many of the javadoc build configs currently configure inclusion of an HTML source listing, which results in a fairly huge (>200MB) and yet often redundant output. Complete sources are easily available via github etc, and the sources and javadocs are also published to Maven Central where IDEs will grab them, which is likely how/where many people will look at sources+javadocs these days. There seems to be little need to burn the time and space including a HTML source listing, so this also looks to disable that.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)