Sending Patches: Difference between revisions

From Bluefish Wiki
Jump to navigation Jump to search
m (space fix.)
(Refer to Getting Bluefish.)
 
(6 intermediate revisions by 2 users not shown)
Line 3: Line 3:


This is a short document how you should send your patches.
This is a short document how you should send your patches.
==Before starting to code==
We have two main branches in our [https://bluefish.svn.sourceforge.net Subversion] tree:
* the [http://bluefish.svn.sourceforge.net/viewvc/bluefish/http://bluefish.svn.sourceforge.net/viewvc/bluefish/branches/bluefish_1_0/ stable 1.0 branch] (gets mainly bugfixes; no major rewrites)
* the [http://bluefish.svn.sourceforge.net/viewvc/bluefish/trunk/bluefish/ development 1.3 branch] (major rewrites, new features).
Make a checkout of the branch you want to work on. Sometimes we also have some branches, when we work on new major features or rewrites. But you usually want one of the above.




==Getting the code==
==Getting the code==


To checkout one of the branches
To get the bluefish source see [[Getting Bluefish]]. If you have checked out the code, then please first update it to retrieve the latest revision:
 
<pre>svn co https://bluefish.svn.sourceforge.net/svnroot/bluefish/trunk/bluefish/
svn co https://bluefish.svn.sourceforge.net/svnroot/bluefish/branches/bluefish_1_0/</pre>
 
If you already have checked out the code, then please first update it to retrieve the latest revision:
 
<pre>svn update</pre>


Alternatively download the latest snapshot (see also [[Downloading from CVS]]). In this case make a copy of the
svn update




Line 32: Line 15:


The following information is for people wanting to hack on Bluefishs source code.
The following information is for people wanting to hack on Bluefishs source code.


===While coding===
===While coding===
Line 42: Line 24:
* for gtk callback functions, use the name of the signal in the name, and append '''_lcb''' to the function name if it is local, or '''_cb''' for non-local callbacks
* for gtk callback functions, use the name of the signal in the name, and append '''_lcb''' to the function name if it is local, or '''_cb''' for non-local callbacks
* more to come...
* more to come...


===Before creating the patch===
===Before creating the patch===
Line 54: Line 35:


The following information is for people wanting to translate Bluefish into their language and update an existing language.
The following information is for people wanting to translate Bluefish into their language and update an existing language.


===Before you start===
===Before you start===
Line 60: Line 40:
Before you start contact our translation coordinator. To get a very last and complete template file run:
Before you start contact our translation coordinator. To get a very last and complete template file run:


<pre>LINGUAS="your_lang" make update-po</pre>
LINGUAS="your_lang" make update-po
 
After this step you can begin to work on these translations. For a list of all <tt>.po</tt> files for your language use <code>find . -name your_lang.po</code>. If there are no <tt>.po</tt> file for your language, please contact our translaton coordinator. Files for a new translation can also be obtained with:


<pre>find . -name "*.pot" -execdir cp "{}" your_lang.po ";"</pre>
After this step you can begin to work on these translations. For a list of all ''.po'' files for your language use '''find . -name your_lang.po'''. If there are no ''.po'' file for your language please contact our translaton coordinator. Files for a new translation can also be obtained with:


find . -name "*.pot" -execdir msginit -l your_lang_code --no-translator ";"


===Before creating the patch===
===Before creating the patch===
Line 71: Line 50:
The following step is not necessary but it will help you finding issues, which must be fixed, before your changes can be committed to the subversion tree. It requires an installation of the gettext tools.
The following step is not necessary but it will help you finding issues, which must be fixed, before your changes can be committed to the subversion tree. It requires an installation of the gettext tools.


<pre>find . -name lang.po | xargs msgcat --use-first -o - | msgfmt -o /dev/null --statistics -</pre>
find . -name lang.po | xargs msgcat --use-first -o - | msgfmt -o /dev/null --statistics -  
 
This step should report missing or fuzzy translations and even errors in your .po file. It won't report wrong translations hough.


This step should report missing or fuzzy translations and even errors in your .po file. It won't report wrong translations though.


==Create the patch==
==Create the patch==
Line 82: Line 60:
Before you create a patch in the subversion tree you should again update it to the latest SVN revision via <code>svn update</code> and resolve all occuring conflicts (if any). Then produce the patch by using the <code>svn diff</code> command as shown below:
Before you create a patch in the subversion tree you should again update it to the latest SVN revision via <code>svn update</code> and resolve all occuring conflicts (if any). Then produce the patch by using the <code>svn diff</code> command as shown below:


<pre>svn diff | bzip2 -9c &gt; your_patch.diff.bz2
svn diff | bzip2 -9c &gt; your_patch.diff.bz2
svn diff src/foo.c data/bflang/foo.bflang2 | bzip2 -9c &gt; your_patch.diff.bz2</pre>
svn diff src/foo.c data/bflang/foo.bflang2 | bzip2 -9c &gt; your_patch.diff.bz2
 


====Special notes for translators====
====Special notes for translators====
Line 90: Line 67:
In case you have updated all <tt>your_lang.po</tt> files in the subversion tree and you want to send us a patch, you can use:
In case you have updated all <tt>your_lang.po</tt> files in the subversion tree and you want to send us a patch, you can use:


<pre>find . -name your_lang.po | xargs svn diff | bzip2 -9c &gt; your_lang.diff.bz2</pre>
find . -name your_lang.po | xargs svn diff | bzip2 -9c &gt; your_lang.diff.bz2


Alternatively you can send us the files too by adding them to a tarball:
Alternatively you can send us the files too by adding them to a tarball:


<pre>find . -name your_lang.po | xargs tar -cjf your_lang.tar.bz2</pre>
find . -name your_lang.po | xargs tar -cjf your_lang.tar.bz2
 


===Create the patch against the tarball===
===Create the patch against the tarball===
Line 108: Line 84:
==Sending the patch==
==Sending the patch==


You can send patches to the development mailinglist or attach them to a bugzilla bugreport.
You can send patches to the [mailto:bluefish-dev@lists.ems.ru development mailinglist]<ref>You can subscribe to the developers' Bluefish mailing list by sending an email containing “subscribe bluefish-dev” to [mailto:bluefish-dev-request@lists.ems.ru bluefish-dev-request@lists.ems.ru].</ref> or attach them to a [http://bugzilla.gnome.org/buglist.cgi?product=bluefish bugzilla bugreport].


simple isn't it?
simple isn't it?
==notes and references==
<references/>

Latest revision as of 20:36, 29 September 2009


This is a short document how you should send your patches.


Getting the code[edit]

To get the bluefish source see Getting Bluefish. If you have checked out the code, then please first update it to retrieve the latest revision:

svn update


Notes for hackers[edit]

The following information is for people wanting to hack on Bluefishs source code.

While coding[edit]

  • for indenting use tabs, not spaces
  • comment all public functions like it is done in bf_lib.c and gtk_easy.c (javadoc style, with some small differences)
  • declare all non-local functions in the .h file
  • for gtk callback functions, use the name of the signal in the name, and append _lcb to the function name if it is local, or _cb for non-local callbacks
  • more to come...

Before creating the patch[edit]

  • run make distclean && ./configure && make and test if it runs successfull
  • if you have the possibility do this even with gcc-2.95 and gcc-3 as compiler
  • more to come later...


Notes for translators[edit]

The following information is for people wanting to translate Bluefish into their language and update an existing language.

Before you start[edit]

Before you start contact our translation coordinator. To get a very last and complete template file run:

LINGUAS="your_lang" make update-po

After this step you can begin to work on these translations. For a list of all .po files for your language use find . -name your_lang.po. If there are no .po file for your language please contact our translaton coordinator. Files for a new translation can also be obtained with:

find . -name "*.pot" -execdir msginit -l your_lang_code --no-translator ";"

Before creating the patch[edit]

The following step is not necessary but it will help you finding issues, which must be fixed, before your changes can be committed to the subversion tree. It requires an installation of the gettext tools.

find . -name lang.po | xargs msgcat --use-first -o - | msgfmt -o /dev/null --statistics - 

This step should report missing or fuzzy translations and even errors in your .po file. It won't report wrong translations though.

Create the patch[edit]

Create the patch against the Subversion tree[edit]

Before you create a patch in the subversion tree you should again update it to the latest SVN revision via svn update and resolve all occuring conflicts (if any). Then produce the patch by using the svn diff command as shown below:

svn diff | bzip2 -9c > your_patch.diff.bz2

svn diff src/foo.c data/bflang/foo.bflang2 | bzip2 -9c > your_patch.diff.bz2

Special notes for translators[edit]

In case you have updated all your_lang.po files in the subversion tree and you want to send us a patch, you can use:

find . -name your_lang.po | xargs svn diff | bzip2 -9c > your_lang.diff.bz2

Alternatively you can send us the files too by adding them to a tarball:

find . -name your_lang.po | xargs tar -cjf your_lang.tar.bz2

Create the patch against the tarball[edit]

Suppose you have two directories, the original tree (e.g. bluefish-unstable-1.3.6.orig) and your working tree (e.g. bluefish-unstable-1.3.6), then use the diff comand to produce a patch. Make sure you

  • run make distclean (or even make maintainer-clean) in both trees
  • cd to the parent dir of the two trees
  • run diff -purN original-tree working-tree | bzip2 -9c > patch.diff.bz2


Sending the patch[edit]

You can send patches to the development mailinglist<ref>You can subscribe to the developers' Bluefish mailing list by sending an email containing “subscribe bluefish-dev” to bluefish-dev-request@lists.ems.ru.</ref> or attach them to a bugzilla bugreport.

simple isn't it?

notes and references[edit]

<references/>