Skip to content

[JENKINS-52417] Javadoc clarifications now that INFRA-1600 is cleared up #3548

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.

Sign up for GitHub

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

Merged
oleg-nenashev merged 1 commit into from
Jul 16, 2018
Merged

[JENKINS-52417] Javadoc clarifications now that INFRA-1600 is cleared up #3548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions core/src/main/java/hudson/FilePath.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -963,9 +963,10 @@ private final class Unpack extends MasterToSlaveFileCallable<Void> {
}

/**
* Reads the URL on the current VM, and writes all the data to this {@link FilePath}
* (this is different from resolving URL remotely.)
*
* Reads the URL on the current VM, and streams the data to this file using the Remoting channel.
* <p>This is different from resolving URL remotely.
* If you instead wished to open an HTTP(S) URL on the remote side,
* prefer <a href="http://javadoc.jenkins.io/plugin/apache-httpcomponents-client-4-api/io/jenkins/plugins/httpclient/RobustHTTPClient.html#copyFromRemotely-hudson.FilePath-java.net.URL-hudson.model.TaskListener-">{@code RobustHTTPClient.copyFromRemotely}</a>.
* @since 1.293
*/
public void copyFrom(URL url) throws IOException, InterruptedException {
Expand Down
3 changes: 1 addition & 2 deletions core/src/main/java/jenkins/util/VirtualFile.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,8 +337,7 @@ public <V> V run(Callable<V,IOException> callable) throws IOException {
* Optionally obtains a URL which may be used to retrieve file contents from any process on any node.
* For example, given cloud storage this might produce a permalink to the file.
* <p>Only {@code http} and {@code https} protocols are permitted.
* It is recommended to use the {@code RobustHTTPClient.downloadFile} utility method
* from the {@code apache-httpcomponents-client-4-api} plugin to work with these URLs.
* It is recommended to use <a href="http://javadoc.jenkins.io/plugin/apache-httpcomponents-client-4-api/io/jenkins/plugins/httpclient/RobustHTTPClient.html#downloadFile-java.io.File-java.net.URL-hudson.model.TaskListener-">{@code RobustHTTPClient.downloadFile}</a> to work with these URLs.
* <p>This is only meaningful for {@link #isFile}:
* no ZIP etc. archiving protocol is defined to allow bulk access to directory trees.
* <p>Any necessary authentication must be encoded somehow into the URL itself;
Expand Down