Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 132 lines (77 sloc) 4.388 kb
102e7de @rhusar fixup readme with markdown after git migration
rhusar authored
1 # HornetQ
5686626 Add a README file.
Francisco Borges authored
2
8e2a617 Document issue with M2Eclipse
Francisco Borges authored
3 If you need information about the HornetQ project please go to
5686626 Add a README file.
Francisco Borges authored
4
5 http://community.jboss.org/wiki/HornetQ
6
102e7de @rhusar fixup readme with markdown after git migration
rhusar authored
7 http://www.jboss.org/hornetq/
5686626 Add a README file.
Francisco Borges authored
8
b53366a @FranciscoBorges update the readme text.
FranciscoBorges authored
9 This file describes some minimum 'stuff one needs to know' to get
10 started coding in this project.
5686626 Add a README file.
Francisco Borges authored
11
b53366a @FranciscoBorges update the readme text.
FranciscoBorges authored
12 ## Source
5686626 Add a README file.
Francisco Borges authored
13
b53366a @FranciscoBorges update the readme text.
FranciscoBorges authored
14 The project's source code is hosted at:
15
16 https://github.com/hornetq
17
456f75c Document the expectation of merging using '--no-ff'.
Francisco Borges authored
18 ### Git usage:
19
20 Pull requests should be merged without fast forwards '--no-ff'. An easy way to achieve that is to use
21
22 ```% git config branch.master.mergeoptions --no-ff```
23
b53366a @FranciscoBorges update the readme text.
FranciscoBorges authored
24 ## Maven
25
26 The minimum required Maven version is 3.0.0.
5686626 Add a README file.
Francisco Borges authored
27
09d5a96 Maven now will configure each sub-project identically.
Francisco Borges authored
28 Do note that there are some compatibility issues with Maven 3.X still
065b864 Update the README file.
Francisco Borges authored
29 unsolved [1]. This is specially true for the 'site' plugin [2].
7f13fa7 Upgrade the site plugin to 3.0-beta-3. It should work with mvn3.
Francisco Borges authored
30
31 [1]: <https://cwiki.apache.org/MAVEN/maven-3x-compatibility-notes.html>
32 [2]: <https://cwiki.apache.org/MAVEN/maven-3x-and-site-plugin.html>
5686626 Add a README file.
Francisco Borges authored
33
b53366a @FranciscoBorges update the readme text.
FranciscoBorges authored
34 ## Tests
5686626 Add a README file.
Francisco Borges authored
35
102e7de @rhusar fixup readme with markdown after git migration
rhusar authored
36 To run the unit tests:
5686626 Add a README file.
Francisco Borges authored
37
b53366a @FranciscoBorges update the readme text.
FranciscoBorges authored
38 ```% mvn -Phudson-tests test```
5686626 Add a README file.
Francisco Borges authored
39
102e7de @rhusar fixup readme with markdown after git migration
rhusar authored
40 Generating reports from unit tests:
5686626 Add a README file.
Francisco Borges authored
41
b53366a @FranciscoBorges update the readme text.
FranciscoBorges authored
42 ```% mvn install site```
5686626 Add a README file.
Francisco Borges authored
43
bf40e4b @clebertsuconic adding how to run individual tests on readme
clebertsuconic authored
44
45 Running tests individually
46
bd10ed9 Readme fixes
Francisco Borges authored
47 ```% mvn -Phudson-tests -DfailIfNoTests=false -Dtest=<test-name> test ```
bf40e4b @clebertsuconic adding how to run individual tests on readme
clebertsuconic authored
48
bd10ed9 Readme fixes
Francisco Borges authored
49 where &lt;test-name> is the name of the Test class without its package name
bf40e4b @clebertsuconic adding how to run individual tests on readme
clebertsuconic authored
50
51
5ad890c @andytaylor added readme info for examples
andytaylor authored
52 ## Examples
53
54 To run an example firstly make sure you have run
55
b5f6ad8 readme: correct running examples instructions
Francisco Borges authored
56 ```% mvn -Prelease install```
5ad890c @andytaylor added readme info for examples
andytaylor authored
57
58 If the project version has already been released then this is unnecessary.
59
60 then you will need to set the following maven options, on Linux by
61
62 ```export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=512m"```
63
64 and the finally run the examples by
65
d6baacf Update readme with comments about Eclipse Juno.
Francisco Borges authored
66 ```% mvn verify```
5ad890c @andytaylor added readme info for examples
andytaylor authored
67
68 You can also run individual examples by running the same command from the directory of which ever example you want to run.
69 NB for this make sure you have installed examples/common.
70
102e7de @rhusar fixup readme with markdown after git migration
rhusar authored
71 ## To build a release artifact
dbf0c64 Document maven 'release' profile.
Francisco Borges authored
72
bd10ed9 Readme fixes
Francisco Borges authored
73 ```% mvn -Prelease install```
74
75 ## To build the release bundle
76
77 ```% mvn -Prelease package```
dbf0c64 Document maven 'release' profile.
Francisco Borges authored
78
102e7de @rhusar fixup readme with markdown after git migration
rhusar authored
79 ## Eclipse
1d6580f Fix a number of issues with existing Eclipse configuration files
Francisco Borges authored
80
1795ac0 readme: note on eclipse working sets.
Francisco Borges authored
81 We recommend using Eclipse Indigo (3.7) or Eclipse Juno (4.2), due to the improved
82 Maven and Git support. Note that there are still some Maven plugins used by
83 sub-projects (e.g. documentation) which are not supported even in Eclipse Juno (4.2).
8e2a617 Document issue with M2Eclipse
Francisco Borges authored
84
1795ac0 readme: note on eclipse working sets.
Francisco Borges authored
85 Eclipse code formatting and (basic) project configuration files can be found at the
86 ```etc/``` folder. You need to manually copy them or use a plugin.
8113cb4 update README file with comments and instructions on the new logging …
Francisco Borges authored
87
88 ### Annotation Pre-Processing
89
1795ac0 readme: note on eclipse working sets.
Francisco Borges authored
90 HornetQ uses [JBoss Logging] and that requires source code generation from Java
8fe7119 tidy up links in the readme
Francisco Borges authored
91 annotations. In order for it to 'just work' in Eclipse you need to install the
92 _Maven Integration for Eclipse JDT Annotation Processor Toolkit_ [m2e-apt]. See
93 this [JBoss blog post] for details.
8113cb4 update README file with comments and instructions on the new logging …
Francisco Borges authored
94
95 [JBoss Logging]: <https://community.jboss.org/wiki/JBossLoggingTooling>
8fe7119 tidy up links in the readme
Francisco Borges authored
96 [m2e-apt]: https://github.com/jbosstools/m2e-apt
97 [JBoss blog post]: https://community.jboss.org/en/tools/blog/2012/05/20/annotation-processing-support-in-m2e-or-m2e-apt-100-is-out
348f54b @clebertsuconic Readme how to make the release
clebertsuconic authored
98
d6baacf Update readme with comments about Eclipse Juno.
Francisco Borges authored
99 ### M2E Connector for Javacc-Maven-Plugin
348f54b @clebertsuconic Readme how to make the release
clebertsuconic authored
100
d6baacf Update readme with comments about Eclipse Juno.
Francisco Borges authored
101 Eclipse Indigo (3.7) has out-of-the-box support for it.
102
1795ac0 readme: note on eclipse working sets.
Francisco Borges authored
103 As of this writing, Eclipse Juno (4.2) still lacks support for Maven's javacc
8fe7119 tidy up links in the readme
Francisco Borges authored
104 plugin. See [this post] on the [m2e connector for javacc-maven-plugin] for
105 manual installation instructions (as of this writing you need to use the
106 development update site).
d6baacf Update readme with comments about Eclipse Juno.
Francisco Borges authored
107
8fe7119 tidy up links in the readme
Francisco Borges authored
108 [this post]: http://dev.eclipse.org/mhonarc/lists/m2e-users/msg02725.html
109 [m2e connector for javacc-maven-plugin]: https://github.com/objectledge/maven-extensions
f8e1a60 @clebertsuconic readme changes
clebertsuconic authored
110
1795ac0 readme: note on eclipse working sets.
Francisco Borges authored
111 ### Use _Project Working Sets_
f8e1a60 @clebertsuconic readme changes
clebertsuconic authored
112
1795ac0 readme: note on eclipse working sets.
Francisco Borges authored
113 Importing all HornetQ subprojects will create _too many_ projects in Eclipse,
114 cluttering your _Package Explorer_ and _Project Explorer_ views. One way to address
115 that is to use [Eclipse's Working Sets] feature. A good introduction to it can be
116 found at a [Dzone article on Eclipse Working Sets].
117
118 [Eclipse's Working Sets]: http://help.eclipse.org/juno/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2Fconcepts%2Fcworkset.htm
119 [Dzone article on Eclipse Working Sets]: http://eclipse.dzone.com/articles/categorise-projects-package
f8e1a60 @clebertsuconic readme changes
clebertsuconic authored
120
121 ## Github procedures
122
1795ac0 readme: note on eclipse working sets.
Francisco Borges authored
123 HornetQ accepts contributions through pull requests on GitHub. After review a pull
124 request should either get merged or be rejected.
f8e1a60 @clebertsuconic readme changes
clebertsuconic authored
125
1795ac0 readme: note on eclipse working sets.
Francisco Borges authored
126 When a pull request needs to be reworked, say you have missed something, the pull
127 request is then closed, at the time you finished the required changes you should
128 reopen your original Pull Request and it will then be re-evaluated. At that point if
129 the request is aproved we will then merge it.
f8e1a60 @clebertsuconic readme changes
clebertsuconic authored
130
131 Make sure you always rebase your branch on master before submitting pull requests.
Something went wrong with that request. Please try again.