Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-5761 - Update source repository links in Envers documentation

This commit is contained in:
Erik-Berndt Scheper 2010-12-02 15:56:30 +01:00
parent b37cd1a8d6
commit fb8ec5e3f9
1 changed files with 64 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
documentation/envers/src/main/docbook/en-US/content/source.xml
View File

@ -30,17 +30,46 @@
<chapter id="source">
<title>Building from source and testing</title>
<section id="source-checkout">
<title>Building from source</title>
<para>
Envers, as a module of Hibernate, uses a standard Maven2 build. So all the usual
Envers, as a module of Hibernate, uses the standard Hibernate build. So all the usual
build targets (compile, test, install) will work.
</para>
<para>
You can check out the source code
<ulink url="http://anonsvn.jboss.org/repos/hibernate/core/trunk/">from SVN</ulink>,
or browse it using
<ulink url="http://fisheye.jboss.org/browse/Hibernate">FishEye</ulink>.
The public Hibernate Git repository is hosted at GitHub and can be browsed using
<ulink url="https://github.com/hibernate/hibernate-core">GitHub</ulink>.
The source can be checked out using either
<programlisting>
git clone https://github.com/hibernate/hibernate-core hibernate-core.git
git clone git://github.com/hibernate/hibernate-core.git
</programlisting>
</para>
</section>
<section id="source-contributing">
<title>Contributing</title>
<para>
If you want to contribute a fix or new feature, either:
<itemizedlist>
<listitem>
use the GitHub fork capability: clone, work on a branch, fork the repo on GitHub (fork button), push the work there and trigger a pull request (pull request button).
</listitem>
<listitem>
use the pure Git approach: clone, work on a branch, push to a public fork repo hosted somewhere, trigger a pull request
(<literal>git pull-request</literal>)
</listitem>
<listitem>
provide a good old patch file: clone the repo, create a patch with git format-patch or diff and attach the patch file to JIRA
</listitem>
</itemizedlist>
</para>
</section>
<section id="source-tests">
<title>Envers integration tests</title>
<para>
The tests use, by default, use a H2 in-memory database. The configuration
@ -69,6 +98,7 @@
entities where modified are correct (the testRevisionCounts method), and if the historic
data is correct (the testHistoryOfXxx methods).
</para>
</section>
</chapter>