You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by jodersky <gi...@git.apache.org> on 2015/10/14 07:01:34 UTC
[GitHub] spark pull request: [SPARK-11092] [Docs] Add source links to scala...
GitHub user jodersky opened a pull request:
https://github.com/apache/spark/pull/9110
[SPARK-11092] [Docs] Add source links to scaladoc generation
Modify the SBT build script to include GitHub source links for generated Scaladocs, on releases only (no snapshots).
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/jodersky/spark unidoc
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/9110.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #9110
----
commit b29df5243000896bce4d58890cd42bc4786f3e44
Author: Jakob Odersky <jo...@gmail.com>
Date: 2015-10-14T04:35:24Z
Add source links to scaladoc generation
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] spark pull request: [SPARK-11092] [Docs] Add source links to scala...
Posted by AmplabJenkins <gi...@git.apache.org>.
Github user AmplabJenkins commented on the pull request:
https://github.com/apache/spark/pull/9110#issuecomment-147935824
Can one of the admins verify this patch?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] spark pull request: [SPARK-11092] [Docs] Add source links to scala...
Posted by jodersky <gi...@git.apache.org>.
Github user jodersky commented on the pull request:
https://github.com/apache/spark/pull/9110#issuecomment-148141041
It works fine on my machine, however maybe someone else should still test it. (You can just replace `isSnapshot` with `true` in case you don't want to change the version of your Spark fork)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] spark pull request: [SPARK-11092] [Docs] Add source links to scala...
Posted by srowen <gi...@git.apache.org>.
Github user srowen commented on a diff in the pull request:
https://github.com/apache/spark/pull/9110#discussion_r41973779
--- Diff: project/SparkBuild.scala ---
@@ -531,8 +535,16 @@ object Unidoc {
"-noqualifier", "java.lang"
),
- // Group similar methods together based on the @group annotation.
- scalacOptions in (ScalaUnidoc, unidoc) ++= Seq("-groups")
+ scalacOptions in (ScalaUnidoc, unidoc) ++= Seq(
+ "-groups" // Group similar methods together based on the @group annotation.
+ ) ++ (
+ // Add link to github sources when generating scaladoc for a non-snapshot release
+ if (!isSnapshot.value) {
+ Opts.doc.sourceUrl(s"https://github.com/apache/spark/tree/v${version.value}€{FILE_PATH}.scala")
--- End diff --
I suspect this is fine if, y'know, it builds correctly and outputs the links you expect. Have you tried it?
The € is a typo, right?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] spark pull request: [SPARK-11092] [Docs] Add source links to scala...
Posted by SparkQA <gi...@git.apache.org>.
Github user SparkQA commented on the pull request:
https://github.com/apache/spark/pull/9110#issuecomment-148374359
[Test build #1905 has finished](https://amplab.cs.berkeley.edu/jenkins/job/NewSparkPullRequestBuilder/1905/console) for PR 9110 at commit [`7a7d21e`](https://github.com/apache/spark/commit/7a7d21efca9485a368e80260be4b1653ea19b308).
* This patch **passes all tests**.
* This patch merges cleanly.
* This patch adds no public classes.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] spark pull request: [SPARK-11092] [Docs] Add source links to scala...
Posted by srowen <gi...@git.apache.org>.
Github user srowen commented on the pull request:
https://github.com/apache/spark/pull/9110#issuecomment-148344776
OK thank you, I probably should have suspected it was on purpose. Seems OK to me.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] spark pull request: [SPARK-11092] [Docs] Add source links to scala...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/spark/pull/9110
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] spark pull request: [SPARK-11092] [Docs] Add source links to scala...
Posted by jodersky <gi...@git.apache.org>.
Github user jodersky commented on the pull request:
https://github.com/apache/spark/pull/9110#issuecomment-148135705
The € is not a typo, I don't know why it was chosen but it €{FILE_PATH} gets replaced by scaladoc with the corresponding source file.
Btw, I factored out the base URL to a separate setting in the newest commit
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] spark pull request: [SPARK-11092] [Docs] Add source links to scala...
Posted by SparkQA <gi...@git.apache.org>.
Github user SparkQA commented on the pull request:
https://github.com/apache/spark/pull/9110#issuecomment-148345206
[Test build #1905 has started](https://amplab.cs.berkeley.edu/jenkins/job/NewSparkPullRequestBuilder/1905/consoleFull) for PR 9110 at commit [`7a7d21e`](https://github.com/apache/spark/commit/7a7d21efca9485a368e80260be4b1653ea19b308).
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org