Sending Patches - Revision history

Daniel Leidert: Refer to Getting Bluefish.

2009-09-29T19:36:38Z

Refer to Getting Bluefish.

← Older revision		Revision as of 19:36, 29 September 2009
Line 4:		Line 4:
	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/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:

	~~svn co https://~~bluefish.~~svn.sourceforge.net/svnroot/bluefish/trunk/bluefish/~~
	or
	~~svn co https://bluefish.svn.sourceforge.net/svnroot/bluefish/branches/bluefish_1_0/~~

	If you ~~already~~ have checked out the code, then please first update it to retrieve the latest revision:

	svn update		svn update

	~~Alternatively download the latest [http://bluefish.svn.sourceforge.net/viewvc/bluefish/trunk/bluefish.tar.gz?view=tar snapshot].~~

Daniel Leidert: Change command how to create .po files for a new language.

2009-09-25T12:13:53Z

Change command how to create .po files for a new language.

← Older revision		Revision as of 12:13, 25 September 2009
Line 59:		Line 59:
	LINGUAS="your_lang" make update-po		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:		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 ~~cp "{}" your_lang.po~~ ";"		find . -name "*.pot" -execdir msginit -l your_lang_code --no-translator ";"

	===Before creating the patch===		===Before creating the patch===

Daniel Leidert: Typo fix.

2009-09-21T17:34:14Z

Typo fix.

← Older revision		Revision as of 17:34, 21 September 2009
Line 69:		Line 69:
	find . -name lang.po \| xargs msgcat --use-first -o - \| msgfmt -o /dev/null --statistics -		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==

Daniel Leidert: Snapshot is available via sf.net (viewvc -> create Tarball).

2009-09-21T17:29:50Z

Snapshot is available via sf.net (viewvc -> create Tarball).

← Older revision		Revision as of 17:29, 21 September 2009
Line 26:		Line 26:
	svn update		svn update

	Alternatively download the latest [http://~~www~~.~~bennewitz~~.~~com~~/bluefish/~~devel/source~~/ snapshot].		Alternatively download the latest [http://bluefish.svn.sourceforge.net/viewvc/bluefish/trunk/bluefish.tar.gz?view=tar snapshot].

Fal7i: remove link to cvs

2009-09-19T12:21:34Z

remove link to cvs

← Older revision		Revision as of 12:21, 19 September 2009
Line 18:		Line 18:
	To checkout one of the branches		To checkout one of the branches

	~~<pre>~~svn co https://bluefish.svn.sourceforge.net/svnroot/bluefish/trunk/bluefish/		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>~~		or
			svn co https://bluefish.svn.sourceforge.net/svnroot/bluefish/branches/bluefish_1_0/

	If you already have checked out the code, then please first update it to retrieve the latest revision:		If you already have checked out the code, then please first update it to retrieve the latest revision:

	~~<pre>~~svn update~~</pre>~~		svn update

	Alternatively download the latest snapshot ~~(see also [[Downloading from CVS]~~]). ~~In this case make a copy of the~~		Alternatively download the latest [http://www.bennewitz.com/bluefish/devel/source/ snapshot].


Line 56:		Line 57:
	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:		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:

	~~<pre>~~find . -name "*.pot" -execdir cp "{}" your_lang.po ";"~~</pre>~~		find . -name "*.pot" -execdir cp "{}" your_lang.po ";"

	===Before creating the patch===		===Before creating the patch===
Line 66:		Line 67:
	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 hough.
Line 77:		Line 78:
	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 > your_patch.diff.bz2		svn diff \| bzip2 -9c > your_patch.diff.bz2
	svn diff src/foo.c data/bflang/foo.bflang2 \| bzip2 -9c > your_patch.diff.bz2~~</pre>~~		svn diff src/foo.c data/bflang/foo.bflang2 \| bzip2 -9c > your_patch.diff.bz2

	====Special notes for translators====		====Special notes for translators====
Line 84:		Line 85:
	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 > your_lang.diff.bz2~~</pre>~~		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:		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 101:		Line 102:
	==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/>

Fal7i: link stable 1.0 branch

2009-09-19T11:20:40Z

link stable 1.0 branch

← Older revision		Revision as of 11:20, 19 September 2009
Line 9:		Line 9:
	We have two main branches in our [https://bluefish.svn.sourceforge.net Subversion] tree:		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/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).		* 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.		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==

Daniel Leidert: space fixes

2009-09-18T11:24:00Z

space fixes

← Older revision		Revision as of 11:24, 18 September 2009
Line 32:		Line 32:

	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 41:
	* 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 52:

	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 65:		Line 62:

	<pre>find . -name "*.pot" -execdir cp "{}" your_lang.po ";"</pre>		<pre>find . -name "*.pot" -execdir cp "{}" your_lang.po ";"</pre>


	===Before creating the patch===		===Before creating the patch===
Line 84:		Line 80:
	<pre>svn diff \| bzip2 -9c > your_patch.diff.bz2		<pre>svn diff \| bzip2 -9c > your_patch.diff.bz2
	svn diff src/foo.c data/bflang/foo.bflang2 \| bzip2 -9c > your_patch.diff.bz2</pre>		svn diff src/foo.c data/bflang/foo.bflang2 \| bzip2 -9c > your_patch.diff.bz2</pre>


	====Special notes for translators====		====Special notes for translators====
Line 95:		Line 90:

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


	===Create the patch against the tarball===		===Create the patch against the tarball===

Daniel Leidert: space fix.

2009-09-18T11:23:09Z

space fix.

← Older revision		Revision as of 11:23, 18 September 2009
Line 104:		Line 104:
	* <code>cd</code> to the parent dir of the two trees		* <code>cd</code> to the parent dir of the two trees
	* run <code>diff -purN original-tree working-tree \| bzip2 -9c > patch.diff.bz2</code>		* run <code>diff -purN original-tree working-tree \| bzip2 -9c > patch.diff.bz2</code>


	==Sending the patch==		==Sending the patch==

Daniel Leidert: Update the whole page. First version. Maybe not yet fully complete.

2009-09-18T11:14:39Z

Update the whole page. First version. Maybe not yet fully complete.

← Older revision		Revision as of 11:14, 18 September 2009
Line 1:		Line 1:
			__TOC__


	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==		==Before starting to code==
Line 18:		Line 22:
	svn co https://bluefish.svn.sourceforge.net/svnroot/bluefish/branches/bluefish_1_0/</pre>		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 ~~retreive~~ the latest revision:		If you already have checked out the code, then please first update it to retrieve the latest revision:

	<pre>svn update</pre>		<pre>svn update</pre>

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


	==~~While coding~~==		==Notes for hackers==

	* use tabs, not spaces~~, for indenting, so everybody can use their own preferred tabsize~~		The following information is for people wanting to hack on Bluefishs source code.
	* comment all public functions like it is done in ~~bf''lib~~.c and ~~gtk''easy~~.c (javadoc style, with some small differences)~~, this can be used to create a function reference~~
	~~'''~~ declare all local functions as 'static', 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		===While coding===

			* for indenting use tabs, not spaces
			* comment all public functions like it is done in <tt>bf_lib.c</tt> and <tt>gtk_easy.c</tt> (javadoc style, with some small differences)
			<!-- * declare all local functions as 'static' -->
			* 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...		* more to come...

	==Before creating the patch==
			===Before creating the patch===

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

	~~==Now create the patch==~~

	~~suppose~~ you have two directories, original-tree ~~and my~~-~~tree~~		==Notes for translators==
	* run make distclean in both trees
	* cd to the parent dir of the two trees		The following information is for people wanting to translate Bluefish into their language and update an existing language.
	* run ''diff -~~Naur~~ original-tree my-tree \| bzip2 -9c ~~> patchbla~~.diff.bz2''

			===Before you start===

			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>

			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>


			===Before creating the patch===

			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>

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


			==Create the patch==

			===Create the patch against the Subversion tree===

			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 > your_patch.diff.bz2
			svn diff src/foo.c data/bflang/foo.bflang2 \| bzip2 -9c > your_patch.diff.bz2</pre>


			====Special notes for translators====

			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 > your_lang.diff.bz2</pre>

			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>


			===Create the patch against the tarball===

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

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

	== 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 development mailinglist or attach them to a bugzilla bugreport.

	simple isn't it?		simple isn't it?

Daniel Leidert: Starting to update the document. cvs->svn transition and update.

2009-09-18T10:34:57Z

Starting to update the document. cvs->svn transition and update.

← Older revision		Revision as of 10:34, 18 September 2009
Line 1:		Line 1:
	~~===A~~ short document how you should send your patches~~===~~		This is a short document how you should send your patches.

	====Before starting to code~~:==~~==		==Before starting to code==

	* update your CVS tree, or alternatively download the latest snapshot (see also [[~~Downloading from CVS~~]])		We have two main branches in our [https://bluefish.svn.sourceforge.net Subversion] tree:

	~~we have two development brances~~: ~~the~~ stable 1.0 ~~brach that should only get~~ bugfixes~~, and~~ the ~~CVS HEAD~~ branch, ~~that gets all the~~ new features.		* 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).

	* copy this original tree, so you ~~can make a patch against this tree~~		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==

			To checkout one of the branches

			<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 retreive the latest revision:

			<pre>svn update</pre>

			Alternatively download the latest snapshot (see also [[Downloading from CVS]]).


			==While coding==

	~~====While coding:====~~
	* use tabs, not spaces, for indenting, so everybody can use their own preferred tabsize		* use tabs, not spaces, for indenting, so everybody can use their own preferred tabsize
	* comment all public functions like it is done in bf''lib.c and gtk''easy.c (javadoc style, with some small differences), this can be used to create a function reference		* comment all public functions like it is done in bf''lib.c and gtk''easy.c (javadoc style, with some small differences), this can be used to create a function reference
Line 16:		Line 33:
	* more to come...		* more to come...

	====Before creating the patch~~:==~~==		==Before creating the patch==

	* run ''make distclean && ./configure && make'' and test if it runs successfull		* run ''make distclean && ./configure && make'' and test if it runs successfull
Line 22:		Line 39:
	* more to come later...		* more to come later...

	====Now create the patch====		==Now create the patch==

	suppose you have two directories, original-tree and my-tree		suppose you have two directories, original-tree and my-tree
Line 29:		Line 46:
	* run ''diff -Naur original-tree my-tree \| bzip2 -9c > patchbla.diff.bz2''		* run ''diff -Naur original-tree my-tree \| bzip2 -9c > patchbla.diff.bz2''

	==== 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 development mailinglist, or attach them to a bugzilla bugreport.

	simple isn't it?		simple isn't it?