CodePlexClient Wiki & Documentation Rss Feed

New Comment on "HowToContribute"

ManeshG — Wed, 29 Jul 2009 10:56:07 GMT

New Task

Updated Wiki: Home

colint — Mon, 15 Jun 2009 23:10:42 GMT

PLEASE READ THIS FIRST

The CodePlex Client is not currently being maintained. The focus of the CodePlex team now is on the SvnBridge project (based on overwhelming user feedback). The CodePlex Client will continue to work going forward, and we'll do our best to answer any questions, but unless there is a serious security bug, please don't expect any further releases.

What is the CodePlex Source Control Client?

The CodePlex Client is a command line source control client for CodePlex users. It supports working fully offline in a traditional edit-merge-commit style. It requires .NET 2.0.

The release ZIP file includes two executables: cpc.exe and tfc.exe.

cpc.exe can be used to talk to the CodePlex source control servers, and has a CodePlex project-based command line. It hides the fact that there are multiple TFS servers. It allows users to enter their CodePlex username & password rather than having to know their domain credentials. Finally, it supports the anonymous access features of CodePlex TFS servers for non-coordinator/developer access.
tfc.exe can be used to talk to any TFS server, and has a TFS url-based command line. It supports automatic authentication with your currently logged in credentials.

Common Help Topics

Community contributions to projects

Download

CodePlex Client June 2009 Release

New Comment on "Installation"

shbang — Mon, 20 Apr 2009 23:59:42 GMT

Release

New Comment on "Installation"

cactus402 — Tue, 10 Mar 2009 07:17:52 GMT

..............

Updated Wiki: Home

BradWilson — Wed, 16 Jul 2008 20:57:52 GMT

PLEASE READ THIS FIRST

What is the CodePlex Source Control Client?

cpc.exe can be used to talk to the CodePlex source control servers, and has a CodePlex project-based command line. It hides the fact that there are multiple TFS servers. It allows users to enter their CodePlex username & password rather than having to know their domain credentials. Finally, it supports the anonymous access features of CodePlex TFS servers for non-coordinator/developer access.
tfc.exe can be used to talk to any TFS server, and has a TFS url-based command line. It supports automatic authentication with your currently logged in credentials.

Common Help Topics

Community contributions to projects

Download

CodePlex Client June 2007 Release

UPDATED WIKI: Installation

jwanageladmin — Thu, 13 Dec 2007 01:01:07 GMT

This CodePlex Client is distributed in binary form in a ZIP file, without an installer. It requires .NET 2.0 or later (not included).

To install:

Unzip the files to a directory on your machine, such as C:\Program Files\CodePlex Client
Place the directory in your PATH environment variable so that it will be available from the command line.

Right click on My Computer
Choose Properties
Click the Advanced tab
Click the Environment Variables button
In "System Variables", double click the PATH variable and add your directory to the end of the list, separated with a semi-colon (";"). Alternatively, you may add/edit the PATH variable under "User Variables" to only affect the current user.

Close and re-start any open command prompt windows to get the new PATH value.

UPDATED WIKI: Installation

jwanageladmin — Thu, 13 Dec 2007 00:55:58 GMT

This CodePlex Client is distributed in binary form in a ZIP file, without an installer. It requires .NET 2.0 or later (not included).

To install:

Unzip the files to a directory on your machine, such as C:\Program Files\CodePlex Client
Place the directory in your PATH environment variable so that it will be available from the command line.

Right click on My Computer
Choose Properties
Click the Advanced tab
Click the Environment Variables button
In "System Variables", double click the PATH variable and add your directory to the end of the list, separated with a semi-colon (";"). Alternatively, you may add/edit the PATH variable under "User Variables" to only affect the current user.

Close and re-start any open command prompt windows to get the new PATH value.

UPDATED WIKI: Home

BradWilson — Tue, 06 Nov 2007 18:20:58 GMT

What is the CodePlex Source Control Client?

cpc.exe can be used to talk to the CodePlex source control servers, and has a CodePlex project-based command line. It hides the fact that there are multiple TFS servers. It allows users to enter their CodePlex username & password rather than having to know their domain credentials. Finally, it supports the anonymous access features of CodePlex TFS servers for non-coordinator/developer access.
tfc.exe can be used to talk to any TFS server, and has a TFS url-based command line. It supports automatic authentication with your currently logged in credentials.

Common Help Topics

Community contributions to projects

Download

CodePlex Client June 2007 Release

UPDATED WIKI: Home

BradWilson — Tue, 06 Nov 2007 18:20:30 GMT

What is the CodePlex Source Control Client?

cpc.exe can be used to talk to the CodePlex source control servers, and has a CodePlex project-based command line. It hides the fact that there are multiple TFS servers. It allows users to enter their CodePlex username & password rather than having to know their domain credentials. Finally, it supports the anonymous access features of CodePlex TFS servers for non-coordinator/developer access.
tfc.exe can be used to talk to any TFS server, and has a TFS url-based command line. It supports automatic authentication with your currently logged in credentials.

Common Help Topics

Community contributions to projects

Download

CodePlex Client June 2007 Release

UPDATED WIKI: Installation

BradWilson — Mon, 01 Oct 2007 07:11:11 GMT

This CodePlex Client is distributed in binary form in a ZIP file, without an installer. It requires .NET 2.0 or later (not included).

To install:

Unzip the files to a directory on your machine, such as C:\Program Files\CodePlex Client
Place the directory in your PATH environment variable so that it will be available from the command line.

Right click on My Computer
Choose Properties
Click the Advanced tab
Click the Environment Variables button
In "System Variables", double click the PATH variable and add your directory to the end of the list, separated with a semi-colon (";"). Alternatively, you may add/edit the PATH variable under "User Variables" to only affect the current user.

Close and re-start any open command prompt windows to get the new PATH value.

UPDATED WIKI: Workflow

BradWilson — Mon, 03 Sep 2007 11:54:20 GMT

Typical Workflow

Introduction
Listing Projects
Getting Your First Copy of The Source Code
Editing Files
Adding Files
Deleting Files
Undoing Changes
Getting Status on Your Changes
Updating Your Code
Resolving Conflicts
Using Syncup
Committing Your Changes

Introduction

Client/server source control systems generally fall into two categories:

The first is called "checkout-edit-checkin" (or "server-side state"), where the system requires that you notify the system before you begin editing the file. Visual Source Safe and Team Explorer work in this way.
The second is called "edit-merge-commit" (or "client-side state"), where the system allows you to just start editing files without notifying the system ahead of time. Because you don't need to contact the server when you begin editing files, this allows you to work completely offline from the server until the time when you're ready to commit your source code to the server. The CodePlex Client works in this way.

In an edit-merge-commit system, many of the commands in the system do not require a connection to the server to complete. As a general rule, when you look at the help for a CodePlex Client command, if it does not offer an option for specifying your username and password, it doesn't connect to the server (and thus can be performed while offline).

This is a streamlined introduction to the way you will typically use the CodePlex Client. Many of the commands shown here have many options that we do not cover in this introduction. For in-depth help on a specific command, type:

cpc help [commandname]

Listing Projects

The listprojects command can be used to list which projects in which you have commit rights. Issue the command along with your CodePlex username:

cpc listprojects johndoe

Getting Your First Copy of The Source Code

From the command prompt, make a directory to hold the source code and change to that directory:

C:
md \MyProject
cd \MyProject

Then issue the checkout command:

cpc checkout MyProjectName

This will get your first copy of the source code into the current directory. If you've never used cpc before, it will prompt you for your CodePlex username and password.

You should see messages similar to these:

A    .
A    Branches
A    EULA.rtf
A    Main
A    Main\ObjectBuilder
A    Main\ObjectBuilder.sln
A    Main\ObjectBuilder\Builder.cs
A    Main\ObjectBuilder\BuilderBase.cs
A    Main\ObjectBuilder\BuilderContext.cs
A    Main\ObjectBuilder\BuilderPolicyKey.cs
A    Main\ObjectBuilder\BuilderStage.cs
[...]

Editing Files

Since CodePlex Client is an edit-merge-commit style system, you don't need to take any explicit steps to begin working. All the files are already writable. Just go ahead and start editing!

Adding Files

If you want to add items, use the add command:

cpc add filename

This will schedule the add to happen during your next commit. If you change your mind before you commit, you can revert your change.

You do not need a connection to the server to issue this command.

See also: Using Syncup

Deleting Files

If you want to delete items, use the delete command:

cpc delete filename

This will schedule the delete to happen during your next commit. Deleted files will be removed from your filesystem. If you change your mind before you commit, you can revert your change.

You do not need a connection to the server to issue this command.

See also: Using Syncup

Undoing Changes

If you've made a change you wish to undo, use the revert command:

cpc revert filename

The actions for revert depend on the item's current status. If the item has been scheduled for add, it reverts back to the unversioned state. If the item has been scheduled for delete, it reverts back to the unmodified state (and the file is restored). If the file has been modified, it reverts back to the unmodified state (and the original file contents are restored).

You do not need a connection to the server to issue this command.

Getting Status on Your Changes

The status command will tell you the status of changes on your system:

cpc status

You will see output similar to this:

A    .tfs-ignore
M    Main\ObjectBuilder\Builder.cs
?    Main\ObjectBuilder\Builder.cs.new
A    Samples\DependencyContainer
!    Samples\DependencyContainer\DepedencyContainer
?    Samples\DependencyContainer\DependencyContainer
M    Samples\DependencyContainer\DependencyContainer.sln
?    Samples\DependencyContainer\DependencyContainer.Tests
?    Samples\DependencyContainer\Samples

The letter describes the state of the item. For a list of the status codes, type "cpc help status".

You can also get a GUI version of the status command:

cpc status /gui

Which will show a window similar to this:

From this status window, you can perform CodePlex Client operations by right clicking on items in the list. Additionally, you can double click a file in the Modified state to get a diff of that file, and you can double click a file in the Conflicted state to perform a merge of that file. For diff and merge to work, you must have a diff/merge tool installed and properly configured. For more information, see the description of the .exe.config file.

You do not need a connection to the server to issue this command.

Updating Your Code

The update command will update your copy of the source code to the latest version stored on the server:

cpc update

This command will show status as it updates your local copies of files to be in sync with the server versions. For a list of the status codes provided by update, type "cpc help update".

Resolving Conflicts

When you update a file that you have edited, it's possible that someone else may have committed a change to that file since your last update. When this happens you may end up in a conflicted state. This means the system could not automatically merge your changes with the other changes on the server.

The best way to resolve conflicts is to use the status GUI (cpc status /gui) and double click your conflicted file(s) to run your configured merge tool. If you save your merge changes, the system will automatically prompt you to mark the file as resolved when you're finished.

If you choose to merge the files by hand, you can use the resolve command to mark a file as resolved:

cpc resolve filename

Note: You will not be able to commit when you're in the conflicted state. Use the status GUI (or the resolve command) to help you resolve your conflicts.

You do not need a connection to the server to issue this command.

Using Syncup

When working, you will typically want to be able to edit, add, and delete files without worrying about running cpc commands to make sure the files are properly scheduled for add or delete. The syncup command will prepare you for a commit operation by figuring out what add and delete operations should be performed.

It does this in three phases:

Delete: If an item was previously under source control, but has been deleted from the file system, the item is scheduled to be deleted from source control.
Update: An update command is run to get your files up to date.
Add: If an item exists on the file system, but is not under source control, the item is scheduled to be added to source control. You will be prompted before adding each item.

The syncup process uses an ignore file which is described in the the description of the .exe.config file.

Committing Your Changes

When you're ready to send your source code into the server, use the commit command:

cpc commit

Committing requires a commit message. If you don't specify the commit message from the command line (using the /message option), then cpc will open notepad with a temporary text file for you to provide your commit message (it will also show you a list of files that will be committed). For more information, see cpc help commit.

A commit GUI is also available, which can be launched with the /gui switch:

cpc commit /gui

Which will show a window similar to this:

UPDATED WIKI: ConfigFile

BradWilson — Mon, 03 Sep 2007 11:50:55 GMT

Unless otherwise noted, all settings here apply to both cpc.exe.config and tfc.exe.config. If a default value is not specified, then there is no default value.

Creating the config file

To create the config file, make a new file named cpc.exe.config (of tfc.exe.config, for tfc.exe) in the same directory as cpc.exe (or tfc.exe). It should contain the following text:

<configuration>
    <appSettings>
        <add key='...' value='...' />
        <add key='...' value='...' />
    </appSettings>
</configuration>

Environmental Overrides

For each configuration file element, there is a corresponding environment variable that can also be set. When the environment variable is set, it takes precedence over the configuration file element. This allows multiple users on the same box to set and override any of the default configuration values.

Note: environmental overrides were introduced in build 10127. Previous builds do not support this feature.

Rarely Set Options

AnonymousUsername (added in build 10127)
CodePlexWebServiceUrl
ForceBasicAuth (added in build 10127)
TryDefaultCredentials (added in build 10127)

DefaultToGuiForCommit

Environmental override: CpcDefaultToGuiForCommit (cpc.exe), TfcDefaultToGuiForCommit (tfc.exe)
Default value: false (both)

Set this value to true and the "commit" command will use the GUI by default.

Sample:

<add key='DefaultToGuiForCommit' value='true'/>

DefaultToGuiForStatus

Environmental override: CpcDefaultToGuiForStatus (cpc.exe), TfcDefaultToGuiForStatus (tfc.exe)
Default value: false (both)

Set this value to true and the "status" command will use the GUI by default.

Sample:

<add key='DefaultToGuiForStatus' value='true'/>

Diff and Merge tool settings

Environmental overrides: CpcDiffTool, CpcDiffArgs, CpcMergeTool, CpcMergeArgs (cpc.exe), TfcDiffTool, TfcDiffArgs, TfcMergeTool, TfcMergeArgs (tfc.exe)

DiffTool and DiffArgs allows you to configure a graphical diff tool to be used for status /gui and commit /gui.

MergeTool and MergeArgs allows you to configure a graphical merge tool to be used for status /gui and commit /gui.

DiffTool and MergeTool should point to the executable. DiffArgs and MergeArgs are the arguments passed to the executable. The following values are available for the arguments:

Token	Meaning
{basepath}	Full path to base filename
{mypath}	Full path to my changes
{theirpath}	Full path to their changes (merge only)
{mergepath}	full path for merge output (merge only)
{basename}	descriptive text of base filename
{myname}	descriptive text of my filename
{theirname}	descriptive text of their filename (merge only)
{mergename}	descriptive text of merge filename (merge only)

If DiffTool or DiffArgs is omitted, then diffing from the status and commit GUIs is not supported.
If MergeTool or MergeArgs is omitted, then merging from the status and commit GUIs is not supported.

Sample for Araxis Merge:

<add key='DiffTool'
 value='C:\Path\To\compare.exe'/>
<add key='DiffArgs'
 value='/wait /2 /title1:{basename} /title2:{myname} {basepath} {mypath}'/>
<add key='MergeTool'
 value='C:\Path\To\compare.exe'/>
<add key='MergeArgs'
 value='/wait /swap /a3 /3 /title1:{theirname} /title2:{myname} /title3:{basename}
    {theirpath} {mypath} {basepath} {mergepath}'/>

Sample for Beyond Compare 2.x: (only supports 2-way merging)

<add key='DiffTool'
 value='C:\Path\To\bc2.exe'/>
<add key='DiffArgs'
 value='{basepath} {mypath} /title1={basename} /title2={myname}'/>
<add key='MergeTool'
 value='C:\Path\To\bc2.exe'/>
<add key='MergeArgs'
 value='{basepath} {mypath} /title1={basename} /title2={myname}'/>

Sample for KDiff3:

<add key='DiffTool'
 value='C:\Path\To\kdiff3.exe'/>
<add key='DiffArgs'
 value='{basepath} --fname {basename} {mypath} --fname {myname}'/>
<add key='MergeTool'
 value='C:\Path\To\kdiff3.exe'/>
<add key='MergeArgs'
 value='{basepath} --fname {basename} {mypath} --fname {myname} {theirpath}
    --fname {theirname} -o {mergepath}'/>

Sample for SourceGear DiffMerge:

<add key='DiffTool'
 value='C:\Program Files\SourceGear\DiffMerge\DiffMerge.exe'/>
<add key='DiffArgs'
 value='/t1={basename} /t2={myname} {basepath} {mypath}'/>
<add key='MergeTool'
 value='C:\Program Files\SourceGear\DiffMerge\DiffMerge.exe'/>
<add key='MergeArgs'
 value='/m /t1={theirname} /t2={myname} /t3={basename} {theirpath} {mypath} {basepath} /r={mergepath}'/>

Sample for TFS Team Explorer:

<add key='DiffTool'
 value='C:\Path\To\diffmerge.exe'/>
<add key='DiffArgs'
 value='{basepath} {mypath} {basename} {myname} /ignorespace'/>
<add key='MergeTool'
 value='C:\Path\To\diffmerge.exe'/>
<add key='MergeArgs'
 value='/merge {theirpath} {mypath} {basepath} {mergepath} {theirname} {myname}'/>

Sample for TortoiseMerge:

<add key='DiffTool'
 value='C:\Path\To\TortoiseMerge.exe'/>
<add key='DiffArgs'
 value='/base:{basepath} /mine:{mypath} /basename:{basename} /minename:{myname}'/>
<add key='MergeTool'
 value='C:\Path\To\TortoiseMerge.exe'/>
<add key='MergeArgs'
 value='/base:{basepath} /mine:{mypath} /theirs:{theirpath} /basename:{basename}
    /minename:{myname} /theirsname:{theirname} /merged:{mergepath} /mergedname:{mergename}'/>

Sample for WinDiff: (does not support merging)

<add key='DiffTool'
 value='C:\Path\To\WinDiff.exe'/>
<add key='DiffArgs'
 value='{basepath} {mypath}'/>

Sample for WinMerge: (only supports 2-way merging)

<add key='DiffTool'
 value='C:\Path\To\WinMerge.exe'/>
<add key='DiffArgs'
 value='/ub /dl {basename} /dr {myname} {basepath} {mypath}'/>
<add key='MergeTool'
 value='C:\Path\To\WinMerge.exe'/>
<add key='MergeArgs'
 value='/ub /dl {theirname} /dr {myname} {theirpath} {mypath} {mergepath}'/>

Editor

Environmental override: CpcEditor (cpc.exe), TfcEditor (tfc.exe)
Default value: notepad.exe (both)

The Editor value specifies the text editor to be used for editing the commit message, when running commit without the /gui option.

Note: If an editor is not configured via the standard environment variables or the configuration file, the EDITOR and VISUAL environment variables are consulted before defaulting to notepad.exe.

Sample:

<add key='Editor' value='notepad.exe'/>

IgnoreFile

Environmental override: CpcIgnoreFile
Default value: .tfs-ignore (both) (default added in build 10144)

IgnoreFile specifies the file name where ignore information is gathered from.

Ignore files are XML files which describe which files should be ignored during an implicit add operation (for both "add" of a directory with /recursive and "syncup"). They support recursion. They should be checked into your source tree so they are shared among the all the developers.

An ignore file can list ignore delete and add operations. Deletes are used to remove ignores from parent directories. Add operations can be local-only or recursive.

Sample ignore file:

<ignore xmlns='http://www.codeplex.com/schema/IgnoreListSchema-1.0.xsd'>
  <delete>foo</delete>
  <add recursive='true'>bar</add>
  <add>baz</add>
</ignore>

Delete operations must be listed before add operations. Add operations by default are local-only unless overridden with recursive='true'. Wildcards are supported (* and ?).

We use a .tfs-ignore file like this in the root of our project:

Sample ignore file:

<ignore xmlns='http://www.codeplex.com/schema/IgnoreListSchema-1.0.xsd'>
  <add recursive='true'>bin</add>
  <add recursive='true'>obj</add>
  <add recursive='true'>_Resharper*</add>
  <add recursive='true'>*.resharper</add>
  <add recursive='true'>*.suo</add>
  <add recursive='true'>*.user</add>
  <add>*.xml</add>
</ignore>

See IgnoreFileScheme-1.0.xsd for the schema of the XML file.

If IgnoreFile is omitted, ignore files are not supported.

Sample:

<add key='IgnoreFile' value='.tfs-ignore'/>

AnonymousUsername

Environmental override: CpcAnonymousUsername (cpc.exe)
Default value: anonymous (cpc.exe)
Introduced: Build 10127

All read-only operations are initially attempted with this username and an empty password, to support anonymous access to the CodePlex source control repository.

Sample:

<add key='AnonymousUsername' value='anonymous'/>

CodePlexWebServiceUrl

Environment override: CpcCodePlexWebServiceUrl (cpc.exe)
Default value: http://www.codeplex.com/services/ProjectInfoService.asmx (cpc.exe)
Introduced: Build 10127

Points to the CodePlex project information web service, which is used to translate project names into TFS server information, as well as translate CodePlex usernames into TFS domain usernames.

Sample:

<add key='CodePlexWebServiceUrl' value='http://www.codeplex.com/services/ProjectInfoService.asmx'/>

ForceBasicAuth

Environmental override: CpcForceBasicAuth (cpc.exe), TfcForceBasicAuth (tfc.exe)
Default value: true (cpc.exe), false (tfc.exe)
Introduced: Build 10127

Setting to 'true' causes authentication to always happen with basic authentication. This is necessary for CodePlex anonymous user support. This is a safe setting for the CodePlex TFS servers, because they require SSL.

Warning: Setting this to 'true' on tfc.exe could cause your credentials to be sent in the clear over the Internet, so use this setting with extreme caution!

Sample:

<add key='ForceBasicAuth' value='true'/>

TryDefaultCredentials

Environmental override: TfcTryDefaultCredentials (tfc.exe)
Default value: true (tfc.exe)
Introduced: Build 10127

When set to 'true', the logged in user credentials are tried when there are no cached credentials for the server. This allows tfc.exe to work against intranet TFS servers with domain authentication without prompting for credentials. If set for 'false', then the user is prompted for credentials without trying the logged in user credentials.

Sample:

<add key='TryDefaultCredentials' value='true'/>

UPDATED WIKI: HowToContribute

BradWilson — Mon, 04 Jun 2007 22:17:30 GMT

How to contribute to an Open Source project on CodePlex

Who is this for?

This document is for people who want to contribute patches to an Open Source project on CodePlex, but are not developers or coordinators on the project.

Get the CodePlex Client

Download CodePlex Client (installation instructions).

Install a diff/merge tool

You will need to install a diff/merge tool in order to be able to validate your changes. Our configuration information contains pre-canned configuration items for many free (and a couple for-pay) diff/merge tools. I would strongly recommend you choose a tool which does 3-way merges. I personally use and love TortoiseMerge from TortoiseSVN. If you don't know which one to choose, you might start with that one.

Get the source code

Open a command prompt (Start -> Run -> cmd.exe)
Create a directory for the source code
Run the checkout command

Sample:

C:\> md MyProjectSrc
C:\> cd MyProjectSrc
C:\MyProjectSrc> cpc checkout MyProject

The checkout command requires a CodePlex project name. You can find the project name by looking at the project's URL. For example, the ObjectBuilder Dependency Injection project has this URL:

http://www.codeplex.com/ObjectBuilder

The project name is ObjectBuilder. If you only need a part of the source, you can specify that with the :/ syntax, like:

cpc checkout MyProject:/trunk/src

Build the project

How you build the project will depend on what type of project it is. For projects that are done with Visual Studio, for example, you will open the .sln file and build it inside of Visual Studio. Ensuring the project builds okay is critical before you contribute.

If you can't get the project to build, ask the project coordinators/developers what's necessary to get it to build.

What are you going to work on?

Sometimes you want to work on a cool new feature. Sometimes you want to fix an annoying bug. All CodePlex projects have an issue tracker where bugs and features are stored. For example, here is the issue tracker for the CodePlex Client: http://www.codeplex.com/CodePlexClient/WorkItem/List.aspx. Even if you want to work on something that's not in the issue tracker, you may want to open a new issue tracker item to describe the work you're doing.

When working on a bug fix, it's wise to make sure you have a clean and new copy of the source code. That means you should use the "cpc update" command to get the newest source, and "cpc status" to ensure that you don't have any pending changes that aren't appropriate for the bug in question. If necessary, you may even want to delete the source code directory and re-check it out.

As a helpful hint, when fixing a bug and submitting it via a patch, it's considered "good form" to make as few changes as possible to fix the bug. Just as important, respect the coding style of the original code (tabs vs. spaces, curly brace placement, etc.). Reformating the files into your own style will just annoy the developers on the project, I promise you. :)

Now... fix the bug!

Time passes...

Making the patch

After you've fixed everything up, use the "cpc syncup" command to find your deleted and added files, and make sure you're up to date with the newest copy of the source code. Then run the status GUI with "cpc status /gui". This will show you all your pending adds, deletes, and modifications. You can double click on any file that's in the "Modified" state, and it will launch your diff tool. If you find files in the "Conflicted" state, that means they have been touched by both you and someone else; double clicking on these will launch the merge tool which will allow you to fix the conflict.

When you are happy with the state of your changes, run the makepatch command:

cpc makepatch C:\MyPatch.xml

This will write a patch file which describes all the changes you've made.

Uploading the patch

Visit the project page, click on the Source Control tab, then click on the Upload Patch link. In the Description field, fill out a description of the work that was done in the patch. Use the "Browse" button to find the patch XML file you just created. If the patch fixed any work items, be sure to enter their number(s) and add them before submitting the patch.

Sit back and collect your kudos. :)

Notes

This document borrows from Scott Hanselman's excellent blog post How To Contribute A Patch To An Open Source Project which is licensed under Creative Commons.

UPDATED WIKI: HowToAcceptContributions

BradWilson — Mon, 04 Jun 2007 20:14:59 GMT

How to accept contributions to your CodePlex project

Who is this for?

This document is for developers/coordinators on a CodePlex project that wish to accept and apply patches from the community.

Get the CodePlex Client

Download CodePlex Client (installation instructions).

Install a diff/merge tool

Get a clean copy of the source code and apply the patch

You will want to apply the patch to a clean copy of the source code, rather than your current working area. Download a copy of the patch file from your project Source Code tab to your local disk (f.e., to C:\Patch.xml).

Make a new directory
Checkout a clean copy of the source code
Apply the patch

C:\> md MyProjectSrc
C:\> cd MyProjectSrc
C:\MyProjectSrc> cpc checkout MyProject
[...checkout output...]
C:\MyProjectSrc> cpc applypatch C:\Patch.xml
[...patch output...]

Inspecting the patch results

The apply patch process will roll back individual files to the version that the person patched from, and then apply their differences. Note that these changes files remain the older version, so that it's easy to see the exact changes the user made. You can use "cpc status /gui" to view the changes using your installed GUI diff tool.

However, the codebase may have progressed since the patch was submitted, so they may not build properly any more. After you've inspected the patch results, and want to see how well they work, you should run "cpc syncup" to get all the source back to current versions. This may cause conflicts for files that have revved since the patch, so after running syncup, you will want to run "cpc status /gui" again to examine and resolve the conflicts with your installed GUI merge tool.

Happy with the patch?

If you're happy with the patch, you will want to take the following steps:

Ensure the patch is fully functional, by testing your application and/or running your unit tests.
Commit the patch using "cpc commit".
Mark the patch as Accepted on the Source Control tab of your project.
If the patch resolved any issues, visit those issues on the Issue Tracker for your project and mark them as fixed or closed as appropriate.

Not happy with the patch?

If you've decided to reject the patch, you will want to take the following steps:

Mark the patch as Declined on the Source Control tab of your project.

Note: Once a patch has been declined, only project coordinators/developers will be able to download it.

Cleaning up

Once you're done, you can delete the temporary folder you made for your source code.

UPDATED WIKI: HowToContribute

BradWilson — Mon, 04 Jun 2007 20:13:56 GMT

How to contribute to an Open Source project on CodePlex

Who is this for?

This document is for people who want to contribute patches to an Open Source project on CodePlex, but are not developers or coordinators on the project.

Get the CodePlex Client

Download CodePlex Client (installation instructions).

Install a diff/merge tool

Get the source code

Open a command prompt (Start -> Run -> cmd.exe)
Create a directory for the source code
Run the checkout command

Sample:

C:\> md MyProjectSrc
C:\> cd MyProjectSrc
C:\MyProjectSrc> cpc checkout MyProject

The checkout command requires a CodePlex project name. You can find the project name by looking at the project's URL. For example, the ObjectBuilder Dependency Injection project has this URL:

http://www.codeplex.com/ObjectBuilder

The project name is ObjectBuilder. If you only need a part of the source, you can specify that with the :/ syntax, like:

cpc checkout MyProject:/trunk/src

Build the project

What are you going to work on?

Making the patch

cpc makepatch C:\MyPatch.xml

This will write a patch file which describes all the changes you've made.

Uploading the patch

Notes

_This document borrows from Scott Hanselman's excellent blog post How To Contribute A Patch To An Open Source Project which is licensed under Creative Commons.

UPDATED WIKI: Home

BradWilson — Mon, 04 Jun 2007 20:13:32 GMT

What is the CodePlex Source Control Client?

The CodePlex Client is a command line source control client for CodePlex users. It supports working fully offline in a traditional edit-merge-commit style. It requires .NET 2.0.

Common Help Topics

Community contributions to projects

Download

CodePlex Client June 2007 Release

UPDATED WIKI: Home

BradWilson — Mon, 04 Jun 2007 17:55:08 GMT

What is the CodePlex Source Control Client?

The CodePlex Client is a command line source control client for CodePlex users. It supports working fully offline in a traditional edit-merge-commit style. It requires .NET 2.0.

Common Help Topics

Download

CodePlex Client June 2007 Release

UPDATED WIKI: Installation

BradWilson — Mon, 04 Jun 2007 17:54:31 GMT

This CodePlex Client is distributed in binary form in a ZIP file, without an installer.

To install:

Unzip the files to a directory on your machine, such as C:\Program Files\CodePlex Client
Place the directory in your PATH environment variable so that it will be available from the command line.

Right click on My Computer
Choose Properties
Click the Advanced tab
Click the Environment Variables button
In "System Variables", double click the PATH variable and add your directory to the end of the list, separated with a semi-colon (";"). Alternatively, you may add/edit the PATH variable under "User Variables" to only affect the current user.

Close and re-start any open command prompt windows to get the new PATH value.

UPDATED WIKI: ConfigFile

BradWilson — Mon, 04 Jun 2007 15:45:23 GMT

Unless otherwise noted, all settings here apply to both cpc.exe.config and tfc.exe.config. If a default value is not specified, then there is no default value.

Creating the config file

To create the config file, make a new file named cpc.exe.config (of tfc.exe.config, for tfc.exe) in the same directory as cpc.exe (or tfc.exe). It should contain the following text:

<configuration>
    <appSettings>
        <add key='...' value='...' />
        <add key='...' value='...' />
    </appSettings>
</configuration>

Environmental Overrides

Commonly Set Options

DefaultToGuiForCommit
DefaultToGuiForStatus
DiffArgs
DiffTool
Editor
IgnoreFile
MergeArgs
MergeTool

Rarely Set Options

AnonymousUsername (added in build 10127)
CodePlexWebServiceUrl
ForceBasicAuth (added in build 10127)
TryDefaultCredentials (added in build 10127)

DefaultToGuiForCommit

<add key='DefaultToGuiForCommit' value='true'/>

DefaultToGuiForStatus

<add key='DefaultToGuiForStatus' value='true'/>

Diff and Merge tool settings

Token	Meaning
{basepath}	Full path to base filename
{mypath}	Full path to my changes
{theirpath}	Full path to their changes (merge only)
{mergepath}	full path for merge output (merge only)
{basename}	descriptive text of base filename
{myname}	descriptive text of my filename
{theirname}	descriptive text of their filename (merge only)
{mergename}	descriptive text of merge filename (merge only)

<add key='DiffTool'
 value='C:\Path\To\compare.exe'/>
<add key='DiffArgs'
 value='/wait /2 /title1:{basename} /title2:{myname} {basepath} {mypath}'/>
<add key='MergeTool'
 value='C:\Path\To\compare.exe'/>
<add key='MergeArgs'
 value='/wait /swap /a3 /3 /title1:{theirname} /title2:{myname} /title3:{basename}
    {theirpath} {mypath} {basepath} {mergepath}'/>

Sample for Beyond Compare 2.x: (only supports 2-way merging)

<add key='DiffTool'
 value='C:\Path\To\bc2.exe'/>
<add key='DiffArgs'
 value='{basepath} {mypath} /title1={basename} /title2={myname}'/>
<add key='MergeTool'
 value='C:\Path\To\bc2.exe'/>
<add key='MergeArgs'
 value='{basepath} {mypath} /title1={basename} /title2={myname}'/>

Sample for KDiff3:

<add key='DiffTool'
 value='C:\Path\To\kdiff3.exe'/>
<add key='DiffArgs'
 value='{basepath} --fname {basename} {mypath} --fname {myname}'/>
<add key='MergeTool'
 value='C:\Path\To\kdiff3.exe'/>
<add key='MergeArgs'
 value='{basepath} --fname {basename} {mypath} --fname {myname} {theirpath}
    --fname {theirname} -o {mergepath}'/>

Sample for TFS Team Explorer:

<add key='DiffTool'
 value='C:\Path\To\diffmerge.exe'/>
<add key='DiffArgs'
 value='{basepath} {mypath} {basename} {myname} /ignorespace'/>
<add key='MergeTool'
 value='C:\Path\To\diffmerge.exe'/>
<add key='MergeArgs'
 value='/merge {theirpath} {mypath} {basepath} {mergepath} {theirname} {myname}'/>

Sample for TortoiseMerge:

<add key='DiffTool'
 value='C:\Path\To\TortoiseMerge.exe'/>
<add key='DiffArgs'
 value='/base:{basepath} /mine:{mypath} /basename:{basename} /minename:{myname}'/>
<add key='MergeTool'
 value='C:\Path\To\TortoiseMerge.exe'/>
<add key='MergeArgs'
 value='/base:{basepath} /mine:{mypath} /theirs:{theirpath} /basename:{basename}
    /minename:{myname} /theirsname:{theirname} /merged:{mergepath} /mergedname:{mergename}'/>

Sample for WinDiff: (does not support merging)

<add key='DiffTool'
 value='C:\Path\To\WinDiff.exe'/>
<add key='DiffArgs'
 value='{basepath} {mypath}'/>

Sample for WinMerge: (only supports 2-way merging)

<add key='DiffTool'
 value='C:\Path\To\WinMerge.exe'/>
<add key='DiffArgs'
 value='/ub /dl {basename} /dr {myname} {basepath} {mypath}'/>
<add key='MergeTool'
 value='C:\Path\To\WinMerge.exe'/>
<add key='MergeArgs'
 value='/ub /dl {theirname} /dr {myname} {theirpath} {mypath} {mergepath}'/>

Editor

<add key='Editor' value='notepad.exe'/>

IgnoreFile

<ignore xmlns='http://www.codeplex.com/schema/IgnoreListSchema-1.0.xsd'>
  <delete>foo</delete>
  <add recursive='true'>bar</add>
  <add>baz</add>
</ignore>

<ignore xmlns='http://www.codeplex.com/schema/IgnoreListSchema-1.0.xsd'>
  <add recursive='true'>bin</add>
  <add recursive='true'>obj</add>
  <add recursive='true'>_Resharper*</add>
  <add recursive='true'>*.resharper</add>
  <add recursive='true'>*.suo</add>
  <add recursive='true'>*.user</add>
  <add>*.xml</add>
</ignore>

See IgnoreFileScheme-1.0.xsd for the schema of the XML file.

If IgnoreFile is omitted, ignore files are not supported.

Sample:

<add key='IgnoreFile' value='.tfs-ignore'/>

AnonymousUsername

<add key='AnonymousUsername' value='anonymous'/>

CodePlexWebServiceUrl

<add key='CodePlexWebServiceUrl' value='http://www.codeplex.com/services/ProjectInfoService.asmx'/>

ForceBasicAuth

<add key='ForceBasicAuth' value='true'/>

TryDefaultCredentials

<add key='TryDefaultCredentials' value='true'/>

UPDATED WIKI: Home

BradWilson — Tue, 22 May 2007 23:07:21 GMT

What is the CodePlex Source Control Client?

The CodePlex Client is a command line source control client for CodePlex users. It supports working fully offline in a traditional edit-merge-commit style. It requires .NET 2.0.

Common Help Topics

Download

CodePlex Client Beta 2 (build 10138)

CodePlexClient Wiki & Documentation Rss Feed

New Comment on "HowToContribute"

Updated Wiki: Home

PLEASE READ THIS FIRST

What is the CodePlex Source Control Client?

Common Help Topics

Community contributions to projects

Download

New Comment on "Installation"

New Comment on "Installation"

Updated Wiki: Home

PLEASE READ THIS FIRST

What is the CodePlex Source Control Client?

Common Help Topics

Community contributions to projects

Download

UPDATED WIKI: Installation

UPDATED WIKI: Installation

UPDATED WIKI: Home

What is the CodePlex Source Control Client?

Common Help Topics

Community contributions to projects

Download

UPDATED WIKI: Home

What is the CodePlex Source Control Client?

Common Help Topics

Community contributions to projects

Download

UPDATED WIKI: Installation

UPDATED WIKI: Workflow

Typical Workflow

Table of Contents

Introduction

Listing Projects

Getting Your First Copy of The Source Code

Editing Files

Adding Files

Deleting Files

Undoing Changes

Getting Status on Your Changes

Updating Your Code

Resolving Conflicts

Using Syncup

Committing Your Changes

UPDATED WIKI: ConfigFile

Creating the config file

Environmental Overrides

Table of Contents

Commonly Set Options

Rarely Set Options

DefaultToGuiForCommit

DefaultToGuiForStatus

Diff and Merge tool settings

Editor

IgnoreFile

AnonymousUsername

CodePlexWebServiceUrl

ForceBasicAuth

TryDefaultCredentials

UPDATED WIKI: HowToContribute

How to contribute to an Open Source project on CodePlex

Who is this for?

Get the CodePlex Client

Install a diff/merge tool

Get the source code

Build the project

What are you going to work on?

Making the patch

Uploading the patch

Notes

UPDATED WIKI: HowToAcceptContributions

How to accept contributions to your CodePlex project

Who is this for?

Get the CodePlex Client

Install a diff/merge tool

Get a clean copy of the source code and apply the patch

Inspecting the patch results

Happy with the patch?

Not happy with the patch?

Cleaning up