Revision: 198a66fdbd8c
Author: nogu.dev <[email protected]>
Date: Sun Mar 11 06:14:54 2012
Log: * DevelopUim.wiki
- Update.
http://code.google.com/p/uim/source/detail?r=198a66fdbd8c&repo=wiki
Modified:
/DevelopUim.wiki
=======================================
--- /DevelopUim.wiki Sat Mar 10 23:41:01 2012
+++ /DevelopUim.wiki Sun Mar 11 06:14:54 2012
@@ -1,10 +1,12 @@
#summary This page describes how to develop uim.
+<wiki:toc max_depth="3" />
+
= Introduction =
This page describes how to develop uim and contribute to the uim project
with Git. The intended audience of this page includes not only the uim
committers but also non-committers.
-= Work flow =
+= Git Work flow =
{{{
+----------------+ +------------------+
+-------------+
| | ---git pull--> | | ---git pull --->
| |
@@ -12,7 +14,7 @@
| | <--git push--- | | <--git commit---
| |
+----------------+ +------------------+
+-------------+
}}}
-== Clone the uim repository ==
+== Cloning the uim repository ==
To develop uim, create your local repository from the uim repository and
move to the source tree in your local repository:
{{{
$ git clone https://code.google.com/p/uim/
@@ -31,7 +33,7 @@
If you have a Google Account, you should set one here.
-== Commit to your local repository ==
+== Committing to your local repository ==
After changing files in the source tree, you can check your changes to the
source tree with the following commands:
{{{
$ git status
@@ -50,7 +52,7 @@
$ git commit -a
}}}
-== Apply changes to the uim repository ==
+== Applying changes to the uim repository ==
=== For committers ===
If you are a committer, you can push your changes to the uim repository
directly:
{{{
@@ -70,14 +72,14 @@
One of the committers may push your patches to the uim repository.
-== Update your local repository ==
+== Updating your local repository ==
You can follow changes in the uim repository:
{{{
$ git pull
}}}
-= Misc =
-== Work on a stable branch ==
+== Misc ==
+=== Working on a stable branch ===
If you want to create a branch which tracks a stable branch in the uim
repository, create a tracking branch:
{{{
$ git checkout --track -b x.y origin/x.y
@@ -89,7 +91,7 @@
$ git push origin x.y
}}}
-== Apply a patch by a contributor ==
+=== Applying a patch by a contributor ===
If you are a committer and you want to apply a patch by a contributor to
the uim repository, you can use `git apply` or `git am`.
If the patch was generated by `git diff` or `diff`, use the former:
@@ -103,14 +105,14 @@
$ git am patch-by-contributor.patch
}}}
-== Copy a commit from a branch to another ==
+=== Copying a commit from a branch to another ===
You can commit a change to the master branch which was committed to a
stable branch and vice versa:
{{{
$ git cherry-pick -e -x abcde
}}}
where _abcde_ is the change which was committed to one branch and will be
committed to another branch.
-== Use an external repository ==
+=== Using an external repository ===
You can create an external repository outside Google Code. If you want to
create your external repository in GitHub, the operation will be as follows:
{{{
$ git remote add github [email protected]:foo/bar.git
@@ -133,3 +135,23 @@
$ git merge baz
$ git push origin master
}}}
+
+= Translation =
+== Updating translation files ==
+You can update translation files with `make update-po`:
+{{{
+$ cd po
+$ make update-po
+}}}
+
+== Clear fuzzy ==
+Committers should remove translations marked as "fuzzy" before release.
+
+See also https://bugs.freedesktop.org/show_bug.cgi?id=15255
+
+= Update copyright =
+Committers should update a copyright line in the source files every year:
+{{{
+$ git ls-files | egrep -v '/$' | xargs perl -i
-pe 's/\b(20\d\d)([,-\s]+20\d\d)*\s+uim\b/\1-20xx uim/'
+}}}
+where _20xx_ is the current year.
