use.username.instead.of.owner
[tfs.git] / README
blob039c95349ac5295d8c01a5b0002d1641a455ac0b
1 NOTE: THIS SOFTWARE IS ALPHA QUALITY. USE AT YOUR OWN RISK.
3 Team Foundation is a "collection of collaborative technologies that 
4 support a team effort to deliver a product." It includes bug tracking, 
5 source control, and other features (*).
7 For example, Microsoft's CodePlex site (http://codeplex.com/) 
8 uses Team Foundation for source control.
10 Namespaces under Development
11 -----------------------------------------------------------------
13   Microsoft.TeamFoundation
14   Microsoft.TeamFoundation.Common
15   Microsoft.TeamFoundation.Client
16   Microsoft.TeamFoundation.VersionControl.Client 
17   Microsoft.TeamFoundation.VersionControl.Common
19 To build:
21         ./configure [--prefix=/yourprefix]
23         make
25 To install:
27         make install
29 The TF.EXE tool
30 -----------------------------------------------------------------
32 An in progress implementation of the Team Foundation client, tf.exe,
33 can be found in tools/tf/. If found, it will make use of libmagic 
34 to compute file permissions, as TF servers do not track/store
35 permissions.
37 Documentation on the tool can be found on msdn at:
38 http://msdn2.microsoft.com/en-us/cc31bk2e(VS.80).aspx
40 Supported Informational Commands:
41   dir, get, labels, status, view, workfold, workspace, workspaces
43 Most importantly, you can now track a repository using the 
44 following commands:
46   tf.exe /server:<server-ip> /login:<domain>\\<username>,<password> workspace /new "<workspace name>;<username>";
47   tf.exe /server:<server-ip> /login:<domain>\\<username>,<password> workfold "$/<project name>" /usr/local/src/somedir
49 Then as often as you like run:
50   tf.exe /server:<server-ip> /login:<domain>\\<username>,<password> /recursive get /usr/local/src/somedir /workspace:neo
52 Supported Utility Commands:
53   add, checkin, checkout, delete, undo, rename
55   These utility commands will modify the state of the server, but checkin
56   has a bug which prevents the changes being completed. undo can be used to
57   revert add/delete/edit type changes on the server.
59 Running the Unit Tests
60 -----------------------------------------------------------------
62 Most of the unit tests require a working TeamFoundation server. Currently, the unit
63 tests use the following environment variables to configure which server, user account, 
64 password, project, etc. to use for testing purposes.
66 export TFS_URL=<url to server, eg. http://192.168.0.1:8080/>;
67 export TFS_USERNAME=<your-username>; 
68 export TFS_DOMAIN=<your-domain>; 
69 export TFS_PASSWORD=<your-password>; 
70 export TFS_PROJECT=<a top-level project name, eg. MyProject>;
72 TFS Web Services
73 -----------------------------------------------------------------
74 Here's the list of available TFS web services, as noted by
75 a post at http://converttostring.com/archive/2007/03/01/359.aspx
77 /Services/v1.0/AuthorizationService.asmx
78 /Services/v1.0/CommonStructureService.asmx
79 /Services/v1.0/EventService.asmx
80 /Services/v1.0/GroupSecurityService.asmx
81 /Services/v1.0/ProjectMaintenance.asmx
82 /Services/v1.0/ProcessTemplate.asmx
83 /Services/v1.0/Registration.asmx
84 /Services/v1.0/ServerStatus.asmx
86 /Warehouse/v1.0/WarehouseController.asmx
87 /Warehouse/v1.0/WarehouseController.asmx
89 /Build/v1.0/BuildStore.asmx
90 /Build/v1.0/BuildController.asmx
91 /Build/v1.0/Integration.asmx
92 /Build/v1.0/Integration.asmx
93 /Build/v1.0/Integration.asmx
94 /Build/v1.0/PublishTestResultsBuildService.asmx
96 /WorkItemTracking/v1.0/ClientService.asmx
97 /WorkItemTracking/v1.0/ConfigurationSettingsService.asmx
98 /WorkItemTracking/v1.0/Integration.asmx
99 /WorkItemTracking/v1.0/Integration.asmx
100 /WorkItemTracking/v1.0/Integration.asmx
101 /WorkItemTracking/v1.0/Integration.asmx
103 /VersionControl/v1.0/repository.asmx
104 /VersionControl/v1.0/administration.asmx
105 /VersionControl/v1.0/integration.asmx
106 /VersionControl/v1.0/item.asmx
107 /VersionControl/v1.0/upload.asmx
109 /Build/v1.0/PublishTestResultsBuildService.asmx
110 /Build/v1.0/PublishTestResultsBuildService.asmx
113 Code Samples
114 -----------------------------------------------------------------
115 Buck Hodges has written numerous examples of using the TFS API.
116 You can find a list of these samples here:
118 http://blogs.msdn.com/buckh/archive/2006/08/12/tfs_api_links.aspx
120 The following examples have been compiled and tested against
121 TF for Mono:
123 http://blogs.msdn.com/buckh/archive/2005/10/26/485458.aspx
126 Links of Interest
127 -----------------------------------------------------------------
129 http://msdn2.microsoft.com/en-us/library/bb130146(VS.80).aspx
130 http://msdn2.microsoft.com/en-us/teamsystem/default.aspx
131 http://msdn2.microsoft.com/en-us/cc31bk2e(VS.80).aspx