Browse Source

Document that path parameters should use '/' as separator

Bug: 421600
Change-Id: I505d994518aa608aaa797252433b6c97e2def5b4
Signed-off-by: Robin Stocker <robin@nibor.org>
tags/v3.2.0.201312181205-r
Robin Stocker 10 years ago
parent
commit
97b8115be4

+ 8
- 4
org.eclipse.jgit/src/org/eclipse/jgit/api/AddCommand.java View File

} }


/** /**
* Add a path to a file/directory whose content should be added.
* <p>
* A directory name (e.g. <code>dir</code> to add <code>dir/file1</code> and
* <code>dir/file2</code>) can also be given to add all files in the
* directory, recursively. Fileglobs (e.g. *.c) are not yet supported.
*
* @param filepattern * @param filepattern
* File to add content from. Also a leading directory name (e.g.
* dir to add dir/file1 and dir/file2) can be given to add all
* files in the directory, recursively. Fileglobs (e.g. *.c) are
* not yet supported.
* repository-relative path of file/directory to add (with
* <code>/</code> as separator)
* @return {@code this} * @return {@code this}
*/ */
public AddCommand addFilepattern(String filepattern) { public AddCommand addFilepattern(String filepattern) {

+ 2
- 1
org.eclipse.jgit/src/org/eclipse/jgit/api/BlameCommand.java View File

} }


/** /**
* Set file path
* Set file path.
* *
* @param filePath * @param filePath
* file path (with <code>/</code> as separator)
* @return this command * @return this command
*/ */
public BlameCommand setFilePath(String filePath) { public BlameCommand setFilePath(String filePath) {

+ 4
- 3
org.eclipse.jgit/src/org/eclipse/jgit/api/CheckoutCommand.java View File

} }


/** /**
* Add a single path to the list of paths to check out. To check out all
* paths, use {@link #setAllPaths(boolean)}.
* Add a single slash-separated path to the list of paths to check out. To
* check out all paths, use {@link #setAllPaths(boolean)}.
* <p> * <p>
* If this option is set, neither the {@link #setCreateBranch(boolean)} nor * If this option is set, neither the {@link #setCreateBranch(boolean)} nor
* {@link #setName(String)} option is considered. In other words, these * {@link #setName(String)} option is considered. In other words, these
* options are exclusive. * options are exclusive.
* *
* @param path * @param path
* path to update in the working tree and index
* path to update in the working tree and index (with
* <code>/</code> as separator)
* @return {@code this} * @return {@code this}
*/ */
public CheckoutCommand addPath(String path) { public CheckoutCommand addPath(String path) {

+ 1
- 1
org.eclipse.jgit/src/org/eclipse/jgit/api/CleanCommand.java View File

* If paths are set, only these paths are affected by the cleaning. * If paths are set, only these paths are affected by the cleaning.
* *
* @param paths * @param paths
* the paths to set
* the paths to set (with <code>/</code> as separator)
* @return {@code this} * @return {@code this}
*/ */
public CleanCommand setPaths(Set<String> paths) { public CleanCommand setPaths(Set<String> paths) {

+ 4
- 4
org.eclipse.jgit/src/org/eclipse/jgit/api/CommitCommand.java View File

} }


/** /**
* Commit dedicated path only
*
* Commit dedicated path only.
* <p>
* This method can be called several times to add multiple paths. Full file * This method can be called several times to add multiple paths. Full file
* paths are supported as well as directory paths; in the latter case this * paths are supported as well as directory paths; in the latter case this
* commits all files/ directories below the specified path.
* commits all files/directories below the specified path.
* *
* @param only * @param only
* path to commit
* path to commit (with <code>/</code> as separator)
* @return {@code this} * @return {@code this}
*/ */
public CommitCommand setOnly(String only) { public CommitCommand setOnly(String only) {

+ 3
- 3
org.eclipse.jgit/src/org/eclipse/jgit/api/LogCommand.java View File



/** /**
* Show only commits that affect any of the specified paths. The path must * Show only commits that affect any of the specified paths. The path must
* either name a file or a directory exactly. Note that regex expressions or
* wildcards are not supported.
* either name a file or a directory exactly and use <code>/</code> (slash)
* as separator. Note that regex expressions or wildcards are not supported.
* *
* @param path * @param path
* a path is relative to the top level of the repository
* a repository-relative path (with <code>/</code> as separator)
* @return {@code this} * @return {@code this}
*/ */
public LogCommand addPath(String path) { public LogCommand addPath(String path) {

+ 5
- 4
org.eclipse.jgit/src/org/eclipse/jgit/api/ResetCommand.java View File

} }


/** /**
* @param file
* the file to add
* @param path
* repository-relative path of file/directory to reset (with
* <code>/</code> as separator)
* @return this instance * @return this instance
*/ */
public ResetCommand addPath(String file) {
public ResetCommand addPath(String path) {
if (mode != null) if (mode != null)
throw new JGitInternalException(MessageFormat.format( throw new JGitInternalException(MessageFormat.format(
JGitText.get().illegalCombinationOfArguments, "<paths>...", JGitText.get().illegalCombinationOfArguments, "<paths>...",
"[--mixed | --soft | --hard]")); //$NON-NLS-1$ "[--mixed | --soft | --hard]")); //$NON-NLS-1$
filepaths.add(file);
filepaths.add(path);
return this; return this;
} }



+ 2
- 1
org.eclipse.jgit/src/org/eclipse/jgit/api/RmCommand.java View File



/** /**
* @param filepattern * @param filepattern
* File to remove.
* repository-relative path of file to remove (with
* <code>/</code> as separator)
* @return {@code this} * @return {@code this}
*/ */
public RmCommand addFilepattern(String filepattern) { public RmCommand addFilepattern(String filepattern) {

+ 2
- 1
org.eclipse.jgit/src/org/eclipse/jgit/api/StatusCommand.java View File

* supported. * supported.
* *
* @param path * @param path
* a path is relative to the top level of the repository
* repository-relative path of file/directory to show status for
* (with <code>/</code> as separator)
* @return {@code this} * @return {@code this}
* @since 3.1 * @since 3.1
*/ */

+ 1
- 0
org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleAddCommand.java View File

* Set repository-relative path of submodule * Set repository-relative path of submodule
* *
* @param path * @param path
* (with <code>/</code> as separator)
* @return this command * @return this command
*/ */
public SubmoduleAddCommand setPath(final String path) { public SubmoduleAddCommand setPath(final String path) {

+ 1
- 0
org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleInitCommand.java View File

* Add repository-relative submodule path to initialize * Add repository-relative submodule path to initialize
* *
* @param path * @param path
* (with <code>/</code> as separator)
* @return this command * @return this command
*/ */
public SubmoduleInitCommand addPath(final String path) { public SubmoduleInitCommand addPath(final String path) {

+ 1
- 0
org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleStatusCommand.java View File

* Add repository-relative submodule path to limit status reporting to * Add repository-relative submodule path to limit status reporting to
* *
* @param path * @param path
* (with <code>/</code> as separator)
* @return this command * @return this command
*/ */
public SubmoduleStatusCommand addPath(final String path) { public SubmoduleStatusCommand addPath(final String path) {

+ 1
- 0
org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleSyncCommand.java View File

* Add repository-relative submodule path to synchronize * Add repository-relative submodule path to synchronize
* *
* @param path * @param path
* (with <code>/</code> as separator)
* @return this command * @return this command
*/ */
public SubmoduleSyncCommand addPath(final String path) { public SubmoduleSyncCommand addPath(final String path) {

+ 1
- 0
org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleUpdateCommand.java View File

* Add repository-relative submodule path to initialize * Add repository-relative submodule path to initialize
* *
* @param path * @param path
* (with <code>/</code> as separator)
* @return this command * @return this command
*/ */
public SubmoduleUpdateCommand addPath(final String path) { public SubmoduleUpdateCommand addPath(final String path) {

Loading…
Cancel
Save