git.txt

   1 If you are commit to the i18n-zh project repository, please read this first.
   2
   3                 ============================================
   4                     Guide to i18n-zh project repository
   5                 ============================================
   6
   7 * Introduction
   8 * Software version requirements
   9 * Configuration
  10 * Repository on repo.or.cz
  11 * Repository maintenance
  12 * Common git operation
  13 * Getting the latest upstream code
  14 * Using git-svn
  15 * Diff & Patch
  16 * File permission & encoding
  17 * Verifying your po file
  18 * Formating your po file
  19
  20 Introduction
  21 ============
  22 *) l10n
  23
  24 *) doc
  25
  26     1. Translation
  27
  28     2. Write document
  29
  30 *) i18n
  31
  32
  33 Software version requirements
  34 =============================
  35 *) GNU gettext 0.16.1
  36 *) Python 2.4.4
  37 *) translate-toolkit(pomerge & pofilter) 1.0.1
  38
  39
  40 Configuration
  41 =============
  42 The flowwing is the sample configuration, please modify some fields.
  43
  44 *) ~/.gitconfig
  45     [core]
  46             compression = 9
  47
  48     [diff]
  49         color = auto
  50
  51     [pack]
  52             window = 128
  53             depth = 64
  54
  55     [color]
  56             branch = auto
  57             diff = auto
  58             status = auto
  59
  60     [user]
  61         # email = dongsheng.song@gmail.com
  62         # name = Dongsheng Song
  63
  64 *) ~/.ssh/config
  65     # Host repo.or.cz
  66     #     HostName 152.69.94.80
  67     #     Port 2222
  68     #     User cauchy
  69
  70
  71 Repository on repo.or.cz
  72 ========================
  73 *) gitweb
  74
  75     http://repo.or.cz/w/i18n-zh.git
  76
  77 *) clone
  78
  79     # cat .git/branches/origin
  80
  81     git://repo.or.cz/i18n-zh.git
  82     http://repo.or.cz/r/i18n-zh.git
  83
  84 *) push
  85
  86     git+ssh://repo.or.cz/srv/git/i18n-zh.git
  87
  88
  89 Repository maintenance
  90 =====================
  91 *) pack
  92
  93     git-repack -a -d -f --window=128 --depth=64
  94
  95 *) fsck
  96
  97     git-fsck --unreachable --strict HEAD $(cat .git/refs/heads/*)
  98     git-prune
  99
 100
 101 Common git operation
 102 ====================
 103 *) clone
 104     git-clone git://repo.or.cz/i18n-zh.git
 105
 106 *) update
 107
 108     "git-pull -v" or "git fetch", See section "Getting the latest upstream code".
 109
 110 *) restore
 111     git-checkout -f filename
 112
 113 *) commit
 114
 115     git-commit -a -m "your log messages"
 116
 117     if you commit patch by someone, use option "--author":
 118
 119     git-commit -a --author someone -m "your log messages"
 120
 121 *) reset
 122
 123     git reset --soft HEAD^
 124
 125 *) push
 126
 127     git-push git+ssh://repo.or.cz/srv/git/i18n-zh.git master:master
 128
 129
 130 Getting the latest upstream code
 131 ================================
 132 There are two ways to update your local repository. Which one to use depends on
 133 whether you have committed changes in the meantime.
 134
 135 *) No changes: pull
 136
 137     The command to update your local repository is:
 138
 139     git pull
 140
 141     It will pull down the latest repository information from the origin remote
 142     file (which points at where you initially cloned the repository from), then
 143     merge. If the new changes don't conflict with anything locally, the merge
 144     will "fast-forward" your branch reference to the new head. If new changes
 145     do conflict, it will try to do an automatic merge using a couple of
 146     different schemes, and then automatically commits the merge if it's
 147     satisfied. If you notice that your pull resulted in a merge (in the output
 148     of pull), you might want to use gitk to see if the merge did what you
 149     expected it to. If it isn't satisfied, then you have to resolve the
 150     conflict manually.
 151
 152 *) You've made changes: fetch and rebase
 153
 154     If you have committed local changes, then git-pull will create a spurious
 155     "Merge" commit, which will pollute the change list when you later push
 156     upstream. To avoid this, do these two commands:
 157
 158     git fetch
 159     git rebase origin
 160
 161     Instead of merging, this attempts to insert the changes you pull from the
 162     origin repository before your local changes, avoiding the merge message.
 163
 164
 165 Using git-svn
 166 =============
 167 *) Clone a repo (like git clone)
 168
 169     git-svn clone -T trunk -b branches -t tags https://i18n-zh.googlecode.com/svn/trunk
 170
 171 *) Reset your master to trunk (or any other branch)
 172
 173     git reset --hard remotes/trunk
 174
 175 *) Do some work and commit locally to git
 176
 177     git commit ...
 178
 179 *) Something is committed to SVN, rebase your local changes against the latest
 180 changes in SVN
 181
 182     git-svn rebase
 183
 184 *) Now commit your changes (that were committed previously using git) to SVN,
 185 as well as automatically updating your working HEAD:
 186
 187     git-svn dcommit
 188
 189
 190 Diff & Patch
 191 ============
 192 *) diff
 193     diff -wBNr -x .git . i18n-zh.origin
 194
 195 *) patch
 196     patch -p0 < zh_CN.patch
 197
 198
 199 File permission & encoding
 200 ==========================
 201 *) permission
 202
 203     set umask to 002, i.e.
 204
 205         set directory to 0775
 206         set common file to 0664
 207         set execute file to 0775
 208
 209 *) encoding
 210     using utf-8 without signature(no BOM)
 211
 212
 213 Verifying your po file
 214 ======================
 215 Please verify your po file is valid:
 216
 217     msgfmt --check-accelerators --statistics -c -o zh_CN.mo zh_CN.po
 218
 219
 220 Formating your po file
 221 ======================
 222 Please format your translation before send po to the mailing list,
 223 or commit to the repository.
 224
 225     msgmerge --no-wrap -F -o zh_CN-new.po zh_CN.po example.pot
 226     mv -f zh_CN-new.po zh_CN.po
 227
 228 This can minimize the diff output, review your translation is easy.