
Documentation Conventions
[/Brackets] represent options that are not required to complete a command. Non-bracketed items represent parameters that are required to complete the operation. For example, in the following command, itemspec is required and /recursive is optional:
Syntax Example: c:\projects>tf getitemspec [/recursive]
Actual Command: c:\projects>tf get c:\projects /recursive
Alternative Command: c:\projects>tf get /recursive
In the Alternative Command example, Team Foundation infers that you intend to get the contents of the current directory, c:\projects, and all its subfolders. Therefore, even though the itemspec parameter is required, you do not necessarily have to type it.
When two, pipe (|)-separated options are enclosed by a set of brackets, you can specify either of, but not both of the options. For example, tf Changeset [/comment:comment|@commentfile] indicates that you can type a comment for a Changeset following the /comment: option or (|) you can use the @commentfile syntax to specify a path of a file that contains a comment you want to use. However, you cannot specify both a comment and a commentfile.
In syntax examples, italic items are parameters that you must replace with actual characters to perform a command. Bold items are options that you include verbatim. For example:
Syntax Example:tf shelvesetsshelvesetname [/recursive]
Actual Command:c:\projects>tf shelvesets BuddyTest_23