Skip to content
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.

adjusting packages for javadocs #3537

Conversation

joshfischer1108
Copy link
Member

@joshfischer1108 joshfischer1108 commented Jun 10, 2020

I don't know if this is the correct fix, but this PR does resolve the issue causing the build to fail. But figured I use these changes to get a conversation started. The reason the java_doc command was failing for the storm-compatibility target is because the source files were getting structured in the resulting jar differently than expected. The reason for this is unknown to me still.

If you execute on this branch

$ bazel build storm-compatibility/src/java:heron-storm-javadoc

The output will be a zip file with the javadocs at

bazel-bin/storm-compatibility/src/java/heron-storm-javadoc.zip.source

If you cd into the above directory you will see that some javadoc files are under the folder org and others are under java if you cd into java you will see other packages such as backtype or storm which is why the javadoc command could not find the source files. See my abbreviated tree output from the file bazel-bin/storm-compatibility/src/java/heron-storm-javadoc.zip.source below:

$ heron-storm-javadoc.zip.source joshfischer$ tree
.
├── META-INF
│   └── MANIFEST.MF
├── java
│   ├── backtype
│   │   └── storm
│   │       ├── Config.java
│   │       ├── Constants.java
│   │       ├── ILocalCluster.java
   left out for brevity....
│   │       │       ├── BaseBasicBolt.java
│   │       │       ├── BaseComponent.java
│   │       │       ├── BaseRichBolt.java
│   │       │       └── BaseRichSpout.java
│   │       ├── tuple
│   │       │   ├── Fields.java
│   │       │   ├── Tuple.java
│   │       │   ├── TupleImpl.java
│   │       │   └── Values.java
│   │       └── utils
│   │           ├── ConfigUtils.java
│   │           ├── DefaultMaxSpoutPendingTuner.java
│   │           ├── ListDelegate.java
│   │           └── Utils.java
│   ├── clojure
│   │   └── lang
│   │       └── Atom.java
│   └── storm
│       └── trident
│           ├── spout
│           │   └── ISpoutPartition.java
│           └── state
│               └── Serializer.java
└── org
    └── apache
        └── storm
            ├── Config.java
            ├── Constants.java
       .. left out for brevity
            │   └── Utils.java
            └── windowing
                ├── TimestampExtractor.java
                ├── TupleWindow.java
                ├── TupleWindowImpl.java
                └── Window.java

So the java_doc rule couldn't find the module backtype because it was under the java folder in the jar. Either way this PR fixes the problem.

@joshfischer1108 joshfischer1108 merged commit c666100 into apache:master Jun 10, 2020
@joshfischer1108 joshfischer1108 deleted the joshfischer/storm-compatibility-javadoc-fix branch June 10, 2020 10:21
nicknezis pushed a commit that referenced this pull request Sep 14, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants