en-US/about_PoshSvnTarget.help.txt

TOPIC
    about_poshsvntarget
 
Short description
    Describes how to specify cmdlet target.
 
Long description
    Some Subversion operations support specifying either a local Path to a
    working copy or a remote Url to a repository as a target.
    You can specify target of the operation by setting the `-Target` parameter
    to either Path or Url. However, if you prefer to directly indicate whether
    it's a URL or a Path, you may use the `-Url` or `-Path` parameters
    respectively.
 
    SPECIFING THE TARGET VIA `-TARGET` PARAMETER
    This method of specifying the target is optimal for basic usage of
    Subversion. You can pass either a Path or Url to the `-Target` parameter,
    which PoshSvn will interpret accordingly.
    The following examples retrieve `svn-info` from the remote repository and
    the working copy:
 
    svn-info -Target https://svn.apache.org/repos/asf/serf/trunk
    svn-info -Target .\path\to\wc
 
    However, you don't need to write `-Target` before specifing, as it accepts
    value from remaining arguments. That's why it almost repeat the Subversion
    CLI behaivior:
 
    svn-info https://svn.apache.org/repos/asf/serf/trunk
    svn-info .\path\to\wc
 
    If no target is specified, PoshSvn will default to the current directory.
    This means that the following example will retrieve `svn-info` about the
    working copy located at `C:\path\to\wc`:
 
    cd C:\path\to\wc
    svn-info
 
    SPECIFING THE TARGET VIA DIRECTLY INDICATING ITS TYPE
    If you write a script, you can explicitly specify whether the target is a
    Url or a Path. This approach is optimal for scripts as it ensures
    readability, understandability, and helps prevent mistakes caused by
    incorrect detection of the target type:
 
    svn-info -Url https://svn.apache.org/repos/asf/serf/trunk
    svn-info -Path .\path\to\wc
 
    If a target with a different type is specified, it will result in an error:
 
    svn-info -Path https://svn.apache.org/repos/asf/serf/trunk
    # Error
    svn-info -Url .\path\to\wc
    # Error
 
    Additionally, you may utilize
    `$PSScriptRoot`
    variable, if your working copy is located near the script. This automatic
    variable provides the path to the directory containing the script.
 
    svn-info -Path $PSScriptRoot\path\to\wc