You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@heron.apache.org by GitBox <gi...@apache.org> on 2020/06/10 03:09:24 UTC
[GitHub] [incubator-heron] joshfischer1108 opened a new pull request #3537: adjusting packages for javadocs
joshfischer1108 opened a new pull request #3537:
URL: https://github.com/apache/incubator-heron/pull/3537
I don't know if this is the correct fix. 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.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-heron] joshfischer1108 merged pull request #3537: adjusting packages for javadocs
Posted by GitBox <gi...@apache.org>.
joshfischer1108 merged pull request #3537:
URL: https://github.com/apache/incubator-heron/pull/3537
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org