Working with the development version - Revision history

Timo 6: Various improvements, including add information about working with subversion

2012-08-26T20:39:47Z

Various improvements, including add information about working with subversion

Timo 6: 46 revisions: Import from old wiki (on 15 May 2012)

2012-08-26T17:31:11Z

46 revisions: Import from old wiki (on 15 May 2012)

Timo 6: /* Updating */ Spelling!

2012-02-08T22:35:26Z

Updating: Spelling!

New page

See this documentation for more info: http://help.github.com/

===Making your own changes===
If you want to make your own changes to improve VDrift, the easiest way is to fork the main VDrift repo on GitHub (https://github.com/VDrift/vdrift/). Just click the button near the top right of the page. You will need a free GitHub account.
Then clone your new repo onto your computer:
git clone git@github.com:''username''/vdrift.git
And link this to the original VDrift repo:
git remote add upstream git://github.com/VDrift/vdrift.git
git fetch upstream

===Updating===
Once the repository has been checked out, it can be updated without downloading the entire thing again. For command line git, use the command
git pull
to check for updates and apply them.
If you have made some changes, use the following instead to prevent these being lost:
git fetch upstream
git merge upstream/master

===Uploading changes===
To upload any changes you've made, first add the files to the commit:
git add ''filename''
Then do the commit:
git commit -m 'Commit message'
And finally send this to GitHub:
git push origin master

===Checking in changes===
You can request a VDrift developer to incorporate your changes by initiating a GitHub pull request. See this documentation for more info: http://help.github.com/send-pull-requests/

Thank you for helping make VDrift better for everyone!

[[Category:Development]]
[[Category:Review]]
[[Category:Operating Systems:Linux]]
[[Category:Operating Systems:FreeBSD]]
[[Category:Operating Systems:Windows]]
[[Category:Operating Systems:Mac OS X]]

Timo 6: Update for new platform dependancies repos.

2011-08-18T09:16:33Z

Update for new platform dependancies repos.

Timo 6 at 20:46, 3 July 2011

2011-07-03T20:46:30Z

Timo 6: Added a few more git commands.

2011-07-03T20:45:02Z

Added a few more git commands.

Venzon at 18:58, 3 July 2011

2011-07-03T18:58:50Z

Timo 6: Clean up Mac section.

2011-06-01T20:52:13Z

Clean up Mac section.

Timo 6: Use links instead of 'at the top of the page'.

2011-06-01T20:02:03Z

Use links instead of 'at the top of the page'.

New page

VDrift's code is kept in a Subversion repository. To get the development version, you must "check out" the code from this repository.

==Browsing the repositories==
There is a VDrift SVN web site at http://svn.vdrift.net/. Here you may browse the VDrift repositories and even download single files. This is very useful for examining changes between different revisions, in a user-friendly manner.

==Checking out the code==
If you want to do much work on VDrift you'll need to check out an entire copy of the development tree.

===Linux/Unix===
Install a svn ([http://subversion.tigris.org/ Subversion]) client. If you are using a Linux distribution you can search for it in the package manager. When you have installed it you need to open a terminal and run the following code:

svn checkout http://svn.vdrift.net/repos/vdrift/trunk vdrift

It will download the current development version in the subfolder vdrift. Next, [[Getting_the_development_version#Checking_out_the_data|check out the data]].

===Windows===
The best solution for Windows is to download [http://tortoisesvn.net/ TortoiseSVN]. After installing it, open Windows explorer and go to the directory where you want to download the VDrift development version. Right-click and click SVN checkout. In the next screen you need to fill in the URL of the repository which is http://svn.vdrift.net/repos/vdrift/trunk. Simply click OK, and the development version will be downloaded. Next, [[Getting_the_development_version#Checking_out_the_data|check out the data]].

===Mac OS X===
This is the same as working with Linux/UNIX as above however Mac OS X does not ship with a SVN client, prior to version 10.5.

If you are running 10.4 you will need to obtain an SVN client:

If you are a [http://fink.sourceforge.net/ Fink user] information about the latest Fink packages can be found here: [http://pdb.finkproject.org/pdb/package.php/svn http://pdb.finkproject.org/pdb/package.php/svn]. If you want to download a binary version of the SVN client go here: [http://metissian.com/projects/macosx/subversion/ http://metissian.com/projects/macosx/subversion/].

If you are running on a Macintosh with an Intel processor make sure that you download the universal binary version of the SVN client. PowerPC exclusive binaries will not execute on an Intel based Macintosh.

Once you have a working SVN client see the [[Getting_the_development_version#Linux/Unix|Linux/Unix]] instructions.

==Checking out the data==
The data set is currently only available from the SourceForge SVN. Get it from https://vdrift.svn.sourceforge.net/svnroot/vdrift/vdrift-data to the vdrift/data from svn.vdrift.net. If you are using a command-line SVN client and have the VDrift repository checked out in a directory called /home/user/code, you would do this:
cd /home/user/code
svn co https://vdrift.svn.sourceforge.net/svnroot/vdrift/vdrift-data data
If you are using the Tortoise SVN client, see the documentation on the Tortoise SVN website for more information on how to check out a repository.

==Working with the repository==
===Updating===
Once the reposotory has been checked out, it can be updated without downloading the entire thing again. For command line SVN, use the command
svn update
to check for updates and apply them.

===Checking in changes===
If you have been authorized as a VDrift developer and given a login for the repository, you may check in the changes to the repository. Subversion collects information on all the changes you make, so all you have to do is issue the command.
svn commit
Please remember to always add a commit message. This should be a summary of the changes you made. It helps let the other developers know what you've done, and also helps when writing change logs at release time.

===Adding and removing files===
Every file you introduce to the checkout on your computer is not automatically added to the repository. First you must add it:
svn add ''filename''
Where ''filename'' is the file you wish to add. Similarly you may remove files that are no longer needed with <code>svn del ''filename''</code>.

[[Category:Development]]
[[Category:Review]]
[[Category:Operating Systems:Linux]]
[[Category:Operating Systems:FreeBSD]]
[[Category:Operating Systems:Windows]]
[[Category:Operating Systems:Mac OS X]]

Timo 6: /* Linux/Unix */

2009-11-28T09:35:16Z

Linux/Unix

@@ Line 20: / Line 20: @@
 ==Checking out the data==
-The data set is currently only available from the SourceForge SVN ([https://vdrift.svn.sourceforge.net/svnroot/vdrift/vdrift-data]). It needs to be checked out in a ''/data'' directory in the main vdrift directory. If you are using a command-line SVN client and have the VDrift repository checked out in a directory called ''/home/user/vdrift'', you would do this:
+The data set is currently only available from the SourceForge SVN (https://vdrift.svn.sourceforge.net/svnroot/vdrift/vdrift-data). It needs to be checked out in a ''/data'' directory in the main vdrift directory. If you are using a command-line SVN client and have the VDrift repository checked out in a directory called ''/home/user/vdrift'', you would do this:
   cd /home/user/vdrift
   svn co https://vdrift.svn.sourceforge.net/svnroot/vdrift/vdrift-data data

@@ Line 1: / Line 1: @@
-See this documentation for more info: http://help.github.com/
+This page describes some of the most common commands used when working with VDrift's source code. It assumes you have followed the instructions in the [[Getting the development version#Cloning/Checking out|Cloning/Checking out]] section of [[Getting the development version]].
-===Making your own changes===
+See this documentation for more up to date and complete information: http://help.github.com/
-If you want to make your own changes to improve VDrift, the easiest way is to fork the main VDrift repo on GitHub (https://github.com/VDrift/vdrift/). Just click the button near the top right of the page. You will need a free GitHub account.
-Then clone your new repo onto your computer:
+==Updating==
   git clone git@github.com:''username''/vdrift.git
 And link this to the original VDrift repo:
   git remote add upstream git://github.com/VDrift/vdrift.git
   git fetch upstream
-===Updating===
+====Uploading changes====
 To upload any changes you've made, first add the files to the commit:
   git add ''filename''
@@ Line 25: / Line 31: @@
   git push origin master
-===Checking in changes===
+====Checking in changes====
 You can request a VDrift developer to incorporate your changes by initiating a GitHub pull request. See this documentation for more info: http://help.github.com/send-pull-requests/
-Thank you for helping make VDrift better for everyone!
+====Thank you for helping make VDrift better for everyone!====
 [[Category:Development]]

← Older revision	Revision as of 17:31, 26 August 2012
(No difference)

@@ Line 5: / Line 5: @@
 ==Checking out the code==
-If you want to do much work on VDrift you'll need to check out an entire copy of the development tree.
+If you want to do much work on VDrift you'll need to check out an copy of the source code and your platform's dependencies.
 ===Linux/Unix===
 Install a git client (eg. [http://git-scm.com/ Git]). If you are using a Linux distribution you can search for it in the package manager. When you have installed it you need to open a terminal and run the following code:
   git clone git://github.com/VDrift/vdrift.git vdrift
-It will download the current development version in the subfolder vdrift. Next, [[Getting_the_development_version#Checking_out_the_data|check out the data]].
+It will download the current development version in the subfolder ''vdrift''. Next, [[Getting_the_development_version#Checking_out_the_data|check out the data]].
 ===Windows===
-The best solution for Windows is to download [http://code.google.com/p/msysgit/ MSysGit]. After installing it, open Windows Explorer and go to the directory to which you want to download the VDrift development version. Right-click and click Git GUI Here. Select Open Existing Repository. In the next screen you need to fill in the URL of the repository which is git://github.com/VDrift/vdrift.git. Simply click OK, and the development version will be downloaded. Next, [[Getting_the_development_version#Checking_out_the_data|check out the data]].
+The best solution for Windows is to download [http://code.google.com/p/msysgit/ MSysGit]. After installing it, open Windows Explorer and go to the directory to which you want to download the VDrift source code. Right-click and click Git GUI Here. Select Open Existing Repository. In the next screen you need to fill in the URL of the repository which is git://github.com/VDrift/vdrift.git. Simply click OK, and the source code will be downloaded. Then do the same, but with the URL git://github.com/VDrift/vdrift-win.git and make sure that it downloads in a ''/vdrift-win'' directory in the main vdrift directory. Next, [[Getting_the_development_version#Checking_out_the_data|check out the data]].
 ===Mac OS X===
-This is the same as working with [[Getting_the_development_version#Linux/Unix|Linux/Unix]] however you will need to obtain a git client (eg. [http://mac.github.com/ GitHub for Mac]).
+First you will need to obtain a git client (eg. [http://mac.github.com/ GitHub for Mac]). Once you have a working Git client open a terminal and navigate to where you wish to download the VDrift source code. Then run the following code:
-Once you have a working SVN client see the [[Getting_the_development_version#Linux/Unix|Linux/Unix]] instructions.
+ git clone git://github.com/VDrift/vdrift.git vdrift
 ==Checking out the data==
@@ Line 32: / Line 37: @@
   git clone git@github.com:''username''/vdrift.git
 And link this to the original VDrift repo:
-  git remote add upstream git://github.com/octocat/Spoon-Knife.git
+  git remote add upstream git://github.com/VDrift/vdrift.git
   git fetch upstream
@@ Line 39: / Line 44: @@
   git pull
 to check for updates and apply them.
-If you have made some changes, use the following to prevent these being lost:
+If you have made some changes, use the following instead to prevent these being lost:
   git fetch upstream
   git merge upstream/master

@@ Line 1: / Line 1: @@
-VDrift's code is kept in a Subversion repository. To get the development version, you must "check out" the code from this repository.
+VDrift's code is kept in a Git repository on GitHub. To get the development version, you must "check out" the code from this repository.
 ==Browsing the repositories==
-There is a VDrift SVN web site at http://svn.vdrift.net/. Here you may browse the VDrift repositories and even download single files. This is very useful for examining changes between different revisions, in a user-friendly manner.
+VDrift's source on the GitHub web site is at https://github.com/VDrift/vdrift/. Here you may browse the VDrift repositories and even download single files. This is very useful for examining changes between different revisions, in a user-friendly manner.
 ==Checking out the code==
@@ Line 8: / Line 8: @@
 ===Linux/Unix===
-Install a svn ([http://subversion.tigris.org/ Subversion]) client. If you are using a Linux distribution you can search for it in the package manager. When you have installed it you need to open a terminal and run the following code:
+Install a git ([http://git-scm.com/ Git]) client. If you are using a Linux distribution you can search for it in the package manager. When you have installed it you need to open a terminal and run the following code:
-  svn checkout http://svn.vdrift.net/repos/vdrift/trunk vdrift
+  git clone git://github.com/VDrift/vdrift.git vdrift
 It will download the current development version in the subfolder vdrift.  Next, [[Getting_the_development_version#Checking_out_the_data|check out the data]].
 ===Windows===
-The best solution for Windows is to download [http://tortoisesvn.net/ TortoiseSVN]. After installing it, open Windows explorer and go to the directory where you want to download the VDrift development version. Right-click and click SVN checkout. In the next screen you need to fill in the URL of the repository which is http://svn.vdrift.net/repos/vdrift/trunk. Simply click OK, and the development version will be downloaded.  Next, [[Getting_the_development_version#Checking_out_the_data|check out the data]].
+The best solution for Windows is to download [http://code.google.com/p/msysgit/ MSysGit]. After installing it, open Windows explorer and go to the directory where you want to download the VDrift development version. Right-click and click Git GUI Here. Select Open Existing Repository. In the next screen you need to fill in the URL of the repository which is git://github.com/VDrift/vdrift.git. Simply click OK, and the development version will be downloaded.  Next, [[Getting_the_development_version#Checking_out_the_data|check out the data]].
 ===Mac OS X===
-This is the same as working with [[Getting_the_development_version#Linux/Unix|Linux/Unix]] however if you are running Mac OS X 10.4 or older you will need to obtain an SVN client:
+This is the same as working with [[Getting_the_development_version#Linux/Unix|Linux/Unix]] however you will need to obtain a git client.
 Once you have a working SVN client see the [[Getting_the_development_version#Linux/Unix|Linux/Unix]] instructions.
@@ Line 27: / Line 25: @@
   cd /home/user/code
   svn co https://vdrift.svn.sourceforge.net/svnroot/vdrift/vdrift-data data
-If you are using the Tortoise SVN client, see the documentation on the Tortoise SVN website for more information on how to check out a repository.
+If you are using the Tortoise SVN client, see the documentation on the Tortoise SVN [http://tortoisesvn.tigris.org/ website] for more information on how to check out a repository.
 ==Working with the repository==
 ===Updating===
-Once the reposotory has been checked out, it can be updated without downloading the entire thing again. For command line SVN, use the command
+Once the reposotory has been checked out, it can be updated without downloading the entire thing again. For command line git, use the command
-  svn update
+  git pull
 to check for updates and apply them.
 ===Checking in changes===
-If you have been authorized as a VDrift developer and given a login for the repository, you may check in the changes to the repository. Subversion collects information on all the changes you make, so all you have to do is issue the command.
+You can request a VDrift developer to incorporate your changes by initiating a GitHub pull request. See this documentation for more info: http://help.github.com/send-pull-requests/
 ===Adding and removing files===
 Every file you introduce to the checkout on your computer is not automatically added to the repository. First you must add it:
-  svn add ''filename''
+  git add ''filename''
-Where ''filename'' is the file you wish to add. Similarly you may remove files that are no longer needed with <code>svn del ''filename''</code>.
+Where ''filename'' is the file you wish to add. Similarly you may remove files that are no longer needed with <code>git rm ''filename''</code>.

@@ Line 18: / Line 18: @@
 ===Mac OS X===
-This is the same as working with Linux/UNIX as above however Mac OS X does not ship with a SVN client, prior to version 10.5.
+This is the same as working with [[Getting_the_development_version#Linux/Unix|Linux/Unix]] however if you are running Mac OS X 10.4 or older you will need to obtain an SVN client:
+* If you are a [http://fink.sourceforge.net/ Fink user] information about the latest Fink packages can be found here: http://pdb.finkproject.org/pdb/package.php/svn
-If you are running 10.4 you will need to obtain an SVN client:
+* If you want to download a binary version of the SVN client go here: http://metissian.com/projects/macosx/subversion/
 Once you have a working SVN client see the [[Getting_the_development_version#Linux/Unix|Linux/Unix]] instructions.