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