Quassel IRC

h1. Creating Translation git patches

{{toc}}

h2. About these instructions

There are two sets of instructions here; one for first-time setup, one for already existing setups.

h2. First-time setup

1. Create a directory to hold the git repository

<pre>$ mkdir quassel-dev

$ cd quassel-dev</pre>

2. Create a git copy of the master from git.quassel-irc.org

<pre>$ git clone git://git.quassel-irc.org/quassel.git</pre>

3. Change into your new copy of the git repository

<pre>$ cd quassel</pre>

4. Set your personal preferences

<pre>$ git config --global user.name "Your full name here"

$ git config --global user.email "your.email@address.here"</pre>

5. At this point you have your very own working copy of the central git repository which you can make changes to. Now is a good time to fire up your favorite .po-editor, and start editing your language file (you should edit the file in your local git repository).

As an example based on the path I've used here, the Norwegian Bokmaal translation file: <pre>~/quassel-dev/quassel/po/quassel_nb_NO.po</pre>

When you have edited the file(s), you should follow the steps in the "Existing setups" below to create the git patch file(s).

h2. Existing setups

Here, I assume you have either followed the instructions above, or already have a git repository clone from the master.

Also, I expect that you are inside the local 'quassel' repository as per 3. in the "First-time setup" above.

1. If you want to keep your local repository up to date with the central one, you just need to synchronize

<pre>$ git pull --rebase</pre>

2. After you have done your changes to the .po file for your language, you can chech that the changes are recorded by git

(all your changes will be shown, press <space> to move one page further, and <q> to stop showing the differences/changes)

<pre>$ git diff</pre>

3. Then it's time to add your changes to the local index (change <path-to-file> with complete path to your .po-file)

<pre>$ git add <path-to-file></pre>

4. You then commit the changes you have done (which will give some feedback like the one I've provided below)

(You should change the "Fixed some small inconsistencies" text with some short description of your changes)

<pre>$ git commit -m "Fixed some small inconsistencies."

[master edc8b8a] Fixed some small inconsistencies.

 1 files changed, 8 insertions(+), 9 deletions(-)</pre>

5. You can now check the status of you git repository (which will give some feedback like the one I've provided below)

<pre>$ git status

# On branch master

# Your branch is ahead of 'origin/master' by 1 commit.

#

nothing to commit (working directory clean)</pre>

6. You then create the actual patch-file (note that the name of the file is the description provided in 4. above)

<pre>$ git format-patch origin/master

0001-Fixed-some-small-inconsistencies.patch</pre>

7. Congratulations! :-) 

This file is now ready and you can send it to: devel _at_ quassel-irc.org.

h2. The Process

The process of keeping a translation up to date, is simply summed up as "git add / commit / format-patch".

But you also need to follow what's written in the README.Translations file in the 'quassel/po' directory. Here's an excerpt from it:

bq. In order to create or update a translatable file, run the following command

in the directory po/:

bq. ./update.sh xx

bq. where xx is the two-letter language code according to ISO 639 (which,

if needed, may be suffixed by a country code according to ISO 3166).

Quassel will automatically load these translation files based on the

system locale. Examples for valid codes: de, en_US

bq. You can open translation files with poedit for example and add/edit translated strings.

bq. The *.po files can and should be kept in sync with the source code by running

update.sh regularly (existing translations won't be removed).

bq. NOTE: Remember to remove X-Virgin-Header line if you want to preserve your header.

Note that the X-Virgin-Header line referred to above, is inside the .po-file for your language.