Difference between revisions of "Dev:Source code"

From Synfig Studio :: Documentation
Jump to: navigation, search
(GIT repository at Sorceforge: Update git repository address after recent SF changes)
m
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Code]] [[Category:Permalink]]
+
{{Title|Source code}}
 +
{{Category|Code}}
 +
{{Category|Permalink}}
  
 
Hey you! Do you want access to bleeding-edge Synfig? Well, I have good news. We provide a way to get the code:  
 
Hey you! Do you want access to bleeding-edge Synfig? Well, I have good news. We provide a way to get the code:  
  
 
*Using git (one repository)
 
*Using git (one repository)
*Using svn (three repositories). '''DISCONTINUED'''
 
  
Once you grab the code, you will need to follow the [[Build instructions|build instructions]].
+
Once you grab the code, you will need to follow the {{l|Dev:Build Instructions|build instructions}}.
  
Commit notifications to master branch are sent to [http://cia.vc/stats/project/synfig CIA] and show up in the [[Contact|IRC channel]].
+
Commit notifications to master branch are <strike>sent to [http://cia.vc/stats/project/synfig CIA] and</strike> shown up in the {{l|Contact|IRC channel}}.
  
While you are browsing the code, you may wish to refer to these links:
+
== GIT repository at Github==
 
+
* [http://sourceforge.net/tracker/?atid=757416&group_id=144022&func=browse Bug tracker]
+
* [http://patches.synfig.org/groups/synfig/ Patches review board]
+
* [http://synfig.org/api/ API documentation]
+
* [[Source Outline|source code outline]]
+
* [[Source Glossary|source code glossary]]
+
* [[Source:ETL_make_check|ETL make check failures]]
+
* [[Source:Layers|Mapping between layer types, classes and .cpp files]]
+
* [[Source:class_ValueNode|ValueNode types]]
+
* [[Source:BlendMethods|Blend Method enumeration values]]
+
* [[Interesting Readings]]
+
 
+
== GIT repository at Sorceforge==
+
  
 
Anonymous access:  
 
Anonymous access:  
  
   git clone git://synfig.git.sourceforge.net/gitroot/synfig/synfig  
+
   git clone git://github.com/synfig/synfig.git
 
People with commit access should use this command instead:
 
People with commit access should use this command instead:
  
   git clone ssh://USERNAME@synfig.git.sourceforge.net/gitroot/synfig/synfig
+
   git clone git@github.com:synfig/synfig.git
  
You can also check out the [http://synfig.git.sourceforge.net/git/gitweb.cgi?p=synfig web interface] to that repository.
+
Or this one if you prefer https protocol:
  
Check out [http://sourceforge.net/apps/trac/sourceforge/wiki/Git Sourceforge Git wiki page] for further references.
+
git clone https://github.com/synfig/synfig.git
  
== SVN repository at Sourceforge (THIS REPOSITORY HAS BEEN DISCONTINUED)==
+
You can also check out the [https://github.com/synfig/synfig web interface] to that repository.
  
Anonymous access:
+
Check out [https://help.github.com Github help page] for further references.
* https://synfig.svn.sourceforge.net/svnroot/synfig/ETL/
+
* https://synfig.svn.sourceforge.net/svnroot/synfig/synfig-core/
+
* https://synfig.svn.sourceforge.net/svnroot/synfig/synfig-studio/
+
  
Web interface:
+
=Proposed git workflow=
* http://synfig.svn.sourceforge.net/viewvc/synfig/
+
 
+
To checkout code from the command line:
+
 
+
  svn co https://synfig.svn.sourceforge.net/svnroot/synfig/ETL/trunk/ etl
+
  svn co https://synfig.svn.sourceforge.net/svnroot/synfig/synfig-core/trunk/ synfig-core
+
  svn co https://synfig.svn.sourceforge.net/svnroot/synfig/synfig-studio/trunk/ synfig-studio
+
 
+
You can also download a [http://synfig.org/code/synfig-svn-checkout.tar.gz daily updated svn checkout] that you can update using svn up. This was created using a [[Subversion|procedure]] by [[User:Dooglus|dooglus]].
+
 
+
You can also download daily updated svn exports for [http://synfig.org/code/ETL-svn.tar.gz ETL], [http://synfig.org/code/synfig-svn.tar.gz synfig], [http://synfig.org/code/synfigstudio-svn.tar.gz synfigstudio].
+
 
+
 
+
==Proposed workflow and other repositories ==
+
 
+
Proposed git workflow:
+
  
 
* Consider the '''master''' branch the stable one.  
 
* Consider the '''master''' branch the stable one.  
Line 69: Line 38:
 
* If it is possible, rebase & rework branches to keep history more sane, linear and atomic.
 
* If it is possible, rebase & rework branches to keep history more sane, linear and atomic.
 
* Releases are tagged according to following criteria:
 
* Releases are tagged according to following criteria:
** If the release consist on a few trivial set of features or bug fixes then increase the third numeration level: 0.61.09 -> 0.61.10
+
** If the release consist on a few trivial set of features or bug fixes then increase the third numeration level: 0.64.0 -> 0.64.1
** If the release consist on a set of important features and/or includes non backward compatible file format, then increase the second level numeration: 0.61.09 -> 0.62.00
+
** If the release consist on a set of important features and/or includes non backward compatible file format, then increase the second level numeration: 0.64.1 -> 0.65.0
 +
 
 +
=See Also=
 +
While you are browsing the code, you may wish to refer to these links:
 +
 
 +
* [http://www.synfig.org/issues/thebuggenie/synfig Bug tracker]
 +
* [http://sourceforge.net/p/synfig/mailman/synfig-devl/ Synfig Dev mailing list]
 +
==Code overview==
 +
* [http://download.tuxfamily.org/synfig/api/index.html API documentation]
 +
* {{l|Dev:Source Outline|source code outline}}
 +
* {{l|Dev:Source Glossary|source code glossary}}
 +
* {{l|Dev:Layers|Mapping between layer types, classes and .cpp files}}
 +
* {{l|Dev:class_ValueNode|ValueNode types}}
 +
* {{l|Dev:BlendMethods|Blend Method enumeration values}}
 +
==Others==
 +
* {{l|Dev:ETL_make_check|ETL make check failures}}
 +
* {{l|Interesting Readings}}
  
Proposed set of git repositories:
+
<!--
 +
Proposed set of git repositories (this section is outdated):
  
 
* admin.git - gitosis admin settings - holds groups, repos and users
 
* admin.git - gitosis admin settings - holds groups, repos and users
Line 89: Line 75:
 
* misc/* - various stuff needed
 
* misc/* - various stuff needed
 
** misc/svn2git.git - the scripts used to convert the SVN repo to git
 
** misc/svn2git.git - the scripts used to convert the SVN repo to git
 +
-->

Latest revision as of 11:55, 16 March 2017

Hey you! Do you want access to bleeding-edge Synfig? Well, I have good news. We provide a way to get the code:

  • Using git (one repository)

Once you grab the code, you will need to follow the build instructions.

Commit notifications to master branch are sent to CIA and shown up in the IRC channel.

GIT repository at Github

Anonymous access:

 git clone git://github.com/synfig/synfig.git 

People with commit access should use this command instead:

 git clone git@github.com:synfig/synfig.git

Or this one if you prefer https protocol:

git clone https://github.com/synfig/synfig.git

You can also check out the web interface to that repository.

Check out Github help page for further references.

Proposed git workflow

  • Consider the master branch the stable one.
  • Each coder should have a username_master branch where all the small changes are done.
  • Once the username_master branch is considered stable it can be rebased/merged to master.
  • Work on new non-trivial features/fixes on username_feature branches.
  • Once the username_feature branch is considered stable it can be rebased/merged to master.
  • Obviously commit trivial fixes straight to the master.
  • If it is possible, rebase & rework branches to keep history more sane, linear and atomic.
  • Releases are tagged according to following criteria:
    • If the release consist on a few trivial set of features or bug fixes then increase the third numeration level: 0.64.0 -> 0.64.1
    • If the release consist on a set of important features and/or includes non backward compatible file format, then increase the second level numeration: 0.64.1 -> 0.65.0

See Also

While you are browsing the code, you may wish to refer to these links:

Code overview

Others