(Commit created by redmine exporter script from page "Repository_Access" version 27)

[xonotic/xonotic.wiki.git] / Repository_Access.textile

diff --git a/Repository_Access.textile b/Repository_Access.textile
index 9e88370225915b077ae1c2e269476ab3e99a7df6..b721e9b504085e5f479f0c4e0a390e57ddf18591 100644 (file)
--- a/Repository_Access.textile
+++ b/Repository_Access.textile
@@ -42,28 +42,80 @@ After that, you can write to the reposiotry using the usual git commands (commit
 
 h3. Working with the helper script "all"
 
-TODO: Work on this to actually not be wrong!
-
 To make working with the repo a little easier there's a little helper script (it's called all, as mentioned in above clone commands). It supports the following commands:
 
 <pre>
 ./all update
 </pre>
 
+This command updates all the xonotic repositories.
+
 <pre>
 ./all branch
 </pre>
 
+Lists the branches you are currrently on, in the respective repositories
+
+<pre>
+./all branches
+</pre>
+
+Lists all the branches known for all the respective repositories
 
 <pre>
-./all push
+./all compile
 </pre>
 
+Compiles the game given that you have the required libs installed
+
 <pre>
 ./all checkout
 </pre>
 
+<pre>
+./all run xonotic
+</pre>
+
+Starts the xonotic client
+
+<pre>
+./all run dedicated xonotic
+</pre>
+
+Starts a xonotic dedicated server
+
+h3. Further git information
+
+About tracking remote branches:
+
+http://www.gitready.com/beginner/2009/03/09/remote-tracking-branches.html
+
+This wiki's [[Git]] page.
+
+A tutorial for SVN users:
+
+http://git-scm.org/course/svn.html
 
 h2. Windows
 
-TODO info for TortoiseGit
+Info for TortoiseGit / msysgit:
+
+To get a GIT clone using mysysgit and Tortoise GIT, do the following:
+
+- Go to the folder where you intend to clone, right click and choose Git Clone from the context menu. Clone the repository from git://git.xonotic.org/xonotic/xonotic.git and wait for everything to download.
+
+- Once the first step is ready, open a command prompt or git bash and browse to the root folder of your clone. Write "./all update" as described above to get the separate data repos. After that you have a working GIT clone.
+
+To write your own changes to the Xonotic git, do the following:
+
+- You must first have a putty SSH key, containing your private key. To generate one use "puttygen":http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html which creates a ppk file. Choose SSH-2 RSA format and once the key has been generated save it as a private key.
+
+- Make sure the public key is accepted on the GIT server (see getting access above). To find it, open the generated key in a text editor and read the "public-lines".
+
+- Open the Settings menu of Tortoise GIT (right click anywhere in the folder you are setting this for) and go to Git -> Remote. Select "origin" for remote, "ssh://xonotic@git.xonotic.org/xonotic-data.pk3dir.git" for URL (data.pk3dir is the example for the "data" branch, each pk3dir is separate!) and for Putty Key browse and select the key file previously mentioned.
+
+- In order to make a new branch, right click somewhere and choose Create Branch from the Tortoise GIT context menu. This will create a local branch you can do anything with. Once you locally committed your changes to your branch, select Push to upload or update the branch on the GIT server. From the Push window, choose your local branch for Local, leave Remote empty, and select origin for Destination.
+
+NOTE 1: Before creating your local branch and committing to it, make sure you've configured your user settings from Settings -> Git - > Config (such as your name which will display in the logs).
+
+NOTE 2: Try naming your branch myname/mychange for each patch. For instance, if your name is Alex and the change you are committing is a menu fix, use something like alex/menufix.