Repository_Access.textile

   1 h1. Repository Access
   2
   3 {{>toc}}
   4
   5 Xonotic uses several GIT repositories. There's a helperscript in the main repository to aid in checking out all relevant repositories and help you building and running Xonotic.
   6 The repository also contains several branches next to the stable "master" branch. So if you're interested in the progress of a certain feature, or want to help or create a new one, checkout the appropriate branches.
   7 For information on how to obtain write access, skip down to the [[Repository Access#Getting write access|Getting write access]]" section.
   8
   9 For more information about git we have a [[Git]] page on the wiki [[Git|here]].
  10
  11 h2. Linux/OS X:
  12
  13 First, you install git using your favorite package manager. Then, do the following to download and compile (execute the first line only to download)::
  14
  15 <pre>
  16 git clone git://git.xonotic.org/xonotic/xonotic.git
  17 cd xonotic
  18 ./all update
  19 </pre>
  20
  21 The git:// protocol uses port 9418, which may be a problem if you're behind a strict firewall. You may instead use the clone url http://git.xonotic.org/xonotic/xonotic.git however using the git protocol directly is preferred for performance reasons.
  22
  23 After that, you have a working checkout of the repository.
  24
  25 h2. Getting write access
  26
  27 A condition for write (push) access is that you agree that any code or data you push will be licensed under the General Public License, version 2, with or without the "or any later version" clause. In case the directory the changes apply to contains a LICENSE or COPYING file indicating another license, your pushed code has to be dual licensed appropriately. Subdirectories currently having a dual license:
  28 * data/qcsrc/warpzonelib - dual licensed as "GPLv2 or later" or MIT license.
  29
  30 In case code you pushed was not written by you, it is your responsibility to ensure proper licensing.
  31
  32 To apply for write access, make an issue of type "Support" in the category "Repository" and attach your public SSH key to it.
  33
  34 To cleanly check out then, you would do:
  35
  36 <pre>
  37 git clone ssh://xonotic@git.xonotic.org/xonotic.git
  38 cd xonotic
  39 ./all update
  40 </pre>
  41
  42 If you already have a checkout, you would do:
  43
  44 <pre>
  45 git config remote.origin.url ssh://xonotic@git.xonotic.org/xonotic.git
  46 ./all update
  47 </pre>
  48
  49 After that, you can write to the reposiotry using the usual git commands (commit, push).
  50
  51 h2. Working with the helper script "all"
  52
  53 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:
  54
  55 <pre>
  56 ./all update
  57 </pre>
  58
  59 This command updates all the xonotic repositories.
  60
  61 <pre>
  62 ./all branch
  63 </pre>
  64
  65 Lists the branches you are currrently on, in the respective repositories
  66
  67 <pre>
  68 ./all branches
  69 </pre>
  70
  71 Lists all the branches known for all the respective repositories
  72
  73 <pre>
  74 ./all compile
  75 </pre>
  76
  77 Compiles the game given that you have the required libs installed
  78
  79 <pre>
  80 ./all checkout BRANCH
  81 </pre>
  82
  83 Switch to that branch in all repositories where its available
  84
  85 <pre>
  86 ./all run xonotic
  87 </pre>
  88
  89 Starts the xonotic client
  90
  91 <pre>
  92 ./all run dedicated xonotic
  93 </pre>
  94
  95 Starts a xonotic dedicated server
  96
  97 h2. Further git information
  98
  99 About tracking remote branches:
 100
 101 http://www.gitready.com/beginner/2009/03/09/remote-tracking-branches.html
 102
 103 This wiki's [[Git]] page.
 104
 105 A tutorial for SVN users:
 106
 107 http://git-scm.org/course/svn.html
 108
 109 h2. Windows
 110
 111 Info for TortoiseGit / msysgit:
 112
 113 To get a GIT clone using mysysgit and Tortoise GIT, do the following:
 114
 115 - 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.
 116
 117 - 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.
 118
 119 To write your own changes to the Xonotic git, do the following:
 120
 121 - 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.
 122
 123 - 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".
 124
 125 - 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.
 126
 127 - 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.
 128
 129 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).
 130
 131 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.