Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SPARK-16353][BUILD][DOC] Missing javadoc options for java unidoc #14031

Closed
wants to merge 2 commits into from

Conversation

@mallman
Copy link
Contributor

mallman commented Jul 2, 2016

Link to Jira issue: https://issues.apache.org/jira/browse/SPARK-16353

What changes were proposed in this pull request?

The javadoc options for the java unidoc generation are ignored when generating the java unidoc. For example, the generated index.html has the wrong HTML page title. This can be seen at http://spark.apache.org/docs/latest/api/java/index.html.

I changed the relevant setting scope from doc to (JavaUnidoc, unidoc).

How was this patch tested?

I ran docs/jekyll build and verified that the java unidoc index.html has the correct HTML page title.

generation are not honored. The scope of the relevant javacOptions key
should be `(JavaUnidoc, unidoc)` not `doc`
@@ -723,8 +723,8 @@ object Unidoc {
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/hadoop")))
},

// Javadoc options: create a window title, and group key packages on index page

This comment has been minimized.

Copy link
@mallman

mallman Jul 2, 2016

Author Contributor

BTW, I removed the mention of package groupings because none are defined.

@@ -723,8 +723,8 @@ object Unidoc {
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/hadoop")))
},

// Javadoc options: create a window title, and group key packages on index page
javacOptions in doc := Seq(
// Javadoc options: create a window title

This comment has been minimized.

Copy link
@jaceklaskowski

jaceklaskowski Jul 2, 2016

Contributor

Do we really need that line? It's in the git history at the very least and JIRA.

This comment has been minimized.

Copy link
@mallman

mallman Jul 3, 2016

Author Contributor

I think we can either change it to just // Javadoc options to clarify that the following javacOptions are in fact for Javadoc, or we can remove the comment entirely.

This comment has been minimized.

Copy link
@mallman

mallman Jul 4, 2016

Author Contributor

I removed the comment entirely.

@srowen

This comment has been minimized.

Copy link
Member

srowen commented Jul 3, 2016

Jenkins add to whitelist

@srowen

This comment has been minimized.

Copy link
Member

srowen commented Jul 3, 2016

Jenkins test this please

@srowen

This comment has been minimized.

Copy link
Member

srowen commented Jul 3, 2016

LGTM

@SparkQA

This comment has been minimized.

Copy link

SparkQA commented Jul 3, 2016

Test build #61687 has finished for PR 14031 at commit 939e8b5.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.
@SparkQA

This comment has been minimized.

Copy link

SparkQA commented Jul 4, 2016

Test build #61728 has finished for PR 14031 at commit fcc45c7.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.
asfgit pushed a commit that referenced this pull request Jul 4, 2016
Link to Jira issue: https://issues.apache.org/jira/browse/SPARK-16353

## What changes were proposed in this pull request?

The javadoc options for the java unidoc generation are ignored when generating the java unidoc. For example, the generated `index.html` has the wrong HTML page title. This can be seen at http://spark.apache.org/docs/latest/api/java/index.html.

I changed the relevant setting scope from `doc` to `(JavaUnidoc, unidoc)`.

## How was this patch tested?

I ran `docs/jekyll build` and verified that the java unidoc `index.html` has the correct HTML page title.

Author: Michael Allman <michael@videoamp.com>

Closes #14031 from mallman/spark-16353.

(cherry picked from commit 7dbffcd)
Signed-off-by: Sean Owen <sowen@cloudera.com>
asfgit pushed a commit that referenced this pull request Jul 4, 2016
Link to Jira issue: https://issues.apache.org/jira/browse/SPARK-16353

## What changes were proposed in this pull request?

The javadoc options for the java unidoc generation are ignored when generating the java unidoc. For example, the generated `index.html` has the wrong HTML page title. This can be seen at http://spark.apache.org/docs/latest/api/java/index.html.

I changed the relevant setting scope from `doc` to `(JavaUnidoc, unidoc)`.

## How was this patch tested?

I ran `docs/jekyll build` and verified that the java unidoc `index.html` has the correct HTML page title.

Author: Michael Allman <michael@videoamp.com>

Closes #14031 from mallman/spark-16353.

(cherry picked from commit 7dbffcd)
Signed-off-by: Sean Owen <sowen@cloudera.com>
@srowen

This comment has been minimized.

Copy link
Member

srowen commented Jul 4, 2016

Merged to master/2.0/1.6

@asfgit asfgit closed this in 7dbffcd Jul 4, 2016
@mallman

This comment has been minimized.

Copy link
Contributor Author

mallman commented Jul 4, 2016

Thank you.

@mallman mallman deleted the VideoAmp:spark-16353 branch Jul 4, 2016
zzcclp added a commit to zzcclp/spark that referenced this pull request Jul 5, 2016
Link to Jira issue: https://issues.apache.org/jira/browse/SPARK-16353

## What changes were proposed in this pull request?

The javadoc options for the java unidoc generation are ignored when generating the java unidoc. For example, the generated `index.html` has the wrong HTML page title. This can be seen at http://spark.apache.org/docs/latest/api/java/index.html.

I changed the relevant setting scope from `doc` to `(JavaUnidoc, unidoc)`.

## How was this patch tested?

I ran `docs/jekyll build` and verified that the java unidoc `index.html` has the correct HTML page title.

Author: Michael Allman <michael@videoamp.com>

Closes apache#14031 from mallman/spark-16353.

(cherry picked from commit 7dbffcd)
Signed-off-by: Sean Owen <sowen@cloudera.com>
(cherry picked from commit 4fcb888)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.