Sourceforge (and SVN) usage

Version 2 (Severine Gedzelman, 19/10/2015 09:26)

1 1 Severine Gedzelman
h1. Sourceforge SVN Usage
2 1 Severine Gedzelman
3 2 Severine Gedzelman
4 2 Severine Gedzelman
{{>toc}}
5 2 Severine Gedzelman
6 1 Severine Gedzelman
h2. SVN folders structure
7 1 Severine Gedzelman
8 1 Severine Gedzelman
* copyright: contains copyright files
9 1 Severine Gedzelman
* corpora: contains  samples binary corpus (deprecated)
10 1 Severine Gedzelman
* CWB: contains modified CWB sources (fix error logs, jni code)
11 1 Severine Gedzelman
* doc: contains all kind of TXM documentation
12 1 Severine Gedzelman
* groovy-all: contains a RCP dependency project to enable Groovy scripting in TXM
13 1 Severine Gedzelman
* Eclipse : contains the modified Eclipse project (p2 and workbench)
14 1 Severine Gedzelman
* installers : contains a linux environment to build TXM for all supported architectures (Debian, Windows and Mac OS X)
15 1 Severine Gedzelman
* libs: contains dependency projects (mandatory ones) of the TBX (and RCP ?) (groovy-all should be moved here)
16 1 Severine Gedzelman
* plugins: contains plugins for TXM (optional ones)
17 1 Severine Gedzelman
* RCP: contains the TXM RCP project
18 1 Severine Gedzelman
* sdk: contains environment to build TXM SDK
19 1 Severine Gedzelman
* textometry: contains the "textometry" R package sources
20 1 Severine Gedzelman
* Toolbox: contains the Toolbox main dependency of the RCP project
21 1 Severine Gedzelman
* translation: contains tools to translate TXM manual
22 1 Severine Gedzelman
* WEB: contains TXM portal sources
23 1 Severine Gedzelman
24 1 Severine Gedzelman
h2. SVN commit messages
25 1 Severine Gedzelman
26 1 Severine Gedzelman
*content*
27 1 Severine Gedzelman
Each commit message must follow the syntax :
28 1 Severine Gedzelman
* prefix with *SOMETHING: *(space char)
29 1 Severine Gedzelman
* then insert the nature of the commit for example : *add*, *fix*...
30 1 Severine Gedzelman
* then insert the message content and details
31 1 Severine Gedzelman
* if you need more than one line to describe the entry, prefix the following lines with "#"
32 1 Severine Gedzelman
33 1 Severine Gedzelman
*Prefixes*
34 1 Severine Gedzelman
Prefixes are :
35 1 Severine Gedzelman
* *RCP:*  the TXM desktop (RCP) project
36 1 Severine Gedzelman
* *TBX:*  the Toolbox (TBX) project
37 1 Severine Gedzelman
* *WEB:*  the TXM portal project
38 1 Severine Gedzelman
* *DOC:*  the documentation of any project
39 1 Severine Gedzelman
* *SETUP:* the project that contains scripts to build TXM setups
40 1 Severine Gedzelman
* *CWB:* the CQP lib project
41 1 Severine Gedzelman
* *EXT-<PLUGINNAME>:*  The extensions of TXM
42 1 Severine Gedzelman
* *LIB-<TECHNOLOGY>:*  Third party library plugins used by the TBX or the RCP
43 1 Severine Gedzelman
** *LIB-GROOVY:*  the Groovy-all plugin
44 1 Severine Gedzelman
** *LIB-JFC:*  the JFreeChart plugin
45 1 Severine Gedzelman
* *R-<package>:* R Packages
46 1 Severine Gedzelman
** *R-textometry:* the 'textometry' package sources
47 1 Severine Gedzelman
* *PLUGIN-<PLUGINNAME>:*  _obsolete_ (See EXT-<PLUGINNAME>)
48 1 Severine Gedzelman
* *GROOVYALL:* _obsolete_ (See LIB-GROOVY)
49 1 Severine Gedzelman
* *SETUPS:* _obsolete_ (See SETUP)
50 1 Severine Gedzelman
* *LIBS:*  _obsolete_ (See LIB-<TECHNOLOGY>)
51 1 Severine Gedzelman
52 1 Severine Gedzelman
53 1 Severine Gedzelman
*Example*
54 1 Severine Gedzelman
<pre>
55 1 Severine Gedzelman
TBX: add an awesome new functionnality
56 1 Severine Gedzelman
TBX: fix the XXX import module
57 1 Severine Gedzelman
# the flow was not Groovy enough
58 1 Severine Gedzelman
# end of this entry
59 1 Severine Gedzelman
DOC: add documentation of the new functionnality
60 1 Severine Gedzelman
</pre>
61 1 Severine Gedzelman
62 1 Severine Gedzelman
For further details about commit message syntax, follow those principles:
63 1 Severine Gedzelman
64 1 Severine Gedzelman
https://github.com/erlang/otp/wiki/Writing-good-commit-messages