/protocols/asn/docs/sources/src/main/resources/en-US/Chapter-Setup.xml

http://mobicents.googlecode.com/ · XML · 60 lines · 38 code · 9 blank · 13 comment · 0 complexity · bc8dd20d5f7eb6f146cbc6cdcaf5b72c MD5 · raw file

  1. <?xml version='1.0'?>
  2. <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "SS7_Stack_User_Guide.ent"> %BOOK_ENTITIES; ]>
  3. <chapter id="setup">
  4. <title>Setup</title>
  5. <!-- <section id="preinstall_requirements_and_prerequisites">
  6. <title>Pre-Install Requirements and Prerequisites</title>
  7. <para>Ensure that the following requirements have been met before continuing with the install.</para>
  8. <section id="hardware_requirements">
  9. <title>Hardware Requirements</title>
  10. <para>The Library doesn't change the &THIS.PLATFORM; Hardware Requirements.</para>
  11. </section>
  12. <section id="software_prerequisites">
  13. <title>Software Prerequisites</title>
  14. <para>There are no specific software requirements.</para>
  15. </section>
  16. </section>--><!--Note: The preinstall requirements section is not needed, as the Library doesn't change any of the standard requirements.-->
  17. <section id="source_code">
  18. <title>&THIS.PLATFORM; &THIS.APPLICATION; Source Code</title>
  19. <para></para>
  20. <section id="release_source_building">
  21. <title>Release Source Code Building</title>
  22. <procedure>
  23. <step>
  24. <title>Downloading the source code</title>
  25. <important>
  26. <para>Subversion is used to manage its source code. Instructions for using Subversion, including install, can be found at <ulink url="http://svnbook.red-bean.com" /></para>
  27. </important>
  28. <para>Use SVN to checkout a specific release source, the base URL is &THIS.RELEASE_SOURCE_CODE_URL;, then add the specific release version, lets consider &THIS.VERSION;.</para>
  29. <programlisting>[usr]$ svn co &THIS.RELEASE_SOURCE_CODE_URL;/&THIS.VERSION; &THIS.APPLICATION.DIRNAME;-&THIS.VERSION;</programlisting>
  30. </step>
  31. <step>
  32. <title>Building the source code</title>
  33. <important>
  34. <para>Maven 2.0.9 (or higher) is used to build the release. Instructions for using Maven2, including install, can be found at <ulink url="http://maven.apache.org" /></para>
  35. </important>
  36. <para>Use Maven to build the binaries.</para>
  37. <programlisting>
  38. [usr]$ cd &THIS.APPLICATION.DIRNAME;-&THIS.VERSION;
  39. [usr]$ mvn install
  40. </programlisting>
  41. <para>Once the process finishes you should have the <literal>binary</literal> jar files in the <filename>target</filename> directory of <literal>module</literal>. </para>
  42. </step>
  43. </procedure>
  44. </section>
  45. <section id="trunk_source_building">
  46. <title>Development Trunk Source Building</title>
  47. <para>Similar process as for <xref linkend="release_source_building"/>, the only change is the SVN source code URL, which is &THIS.TRUNK_SOURCE_CODE_URL;.</para>
  48. </section>
  49. </section>
  50. </chapter>