Author: lfryc(a)redhat.com Date: 2011-11-14 17:23:17 -0500 (Mon, 14 Nov 2011) New Revision: 22935 Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-RichFaces_overview.xml Log: RFPL-1818: Remove "Compiling from Source Code" section from Developer's Guide Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml =================================================================== --- modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml 2011-11-14 22:23:00 UTC (rev 22934) +++ modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml 2011-11-14 22:23:17 UTC (rev 22935) @@ -110,14 +110,6 @@ </step> </stepalternatives> --> - <stepalternatives> - <step> - <title>Compiling from source</title> - <para> - Instead of using the pre-compiled binaries, you can compile the source files yourself. Refer to <xref linkend="sect-Component_Reference-RichFaces_overview-Compiling_from_source_code" /> for further instructions. - </para> - </step> - </stepalternatives> </step> <step> <title>Unzip archive</title> Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-RichFaces_overview.xml =================================================================== --- modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-RichFaces_overview.xml 2011-11-14 22:23:00 UTC (rev 22934) +++ modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-RichFaces_overview.xml 2011-11-14 22:23:17 UTC (rev 22935) @@ -357,169 +357,6 @@ </itemizedlist> </para> </section> - - <section id="sect-Component_Reference-RichFaces_overview-Compiling_from_source_code"> - <title>Compiling from source code</title> - <para> - The source code for the RichFaces framework can be compiled manually rather than using the pre-compiled binaries. - </para> - <procedure> - <step> - <title>Acquiring the source code</title> - <stepalternatives> - <step> - <title>JBoss RichFaces Downloads area</title> - <para> - Download the RichFaces distribution as described in <xref linkend="sect-Developer_Guide-Getting_started_with_RichFaces-Setting_up_RichFaces" />. The distribution bundles contain the full RichFaces source code. - </para> - </step> - <step> - <title>Anonymous SVN repository</title> - <para> - Alternatively, the source files can be checked out from the anonymous SVN repository at <ulink url="http://anonsvn.jboss.org/repos/richfaces/branches/4.0.X/"&... using the following command: - </para> - <screen>svn co http://anonsvn.jboss.org/repos/richfaces/branches/4.0.X/</screen> - </step> - </stepalternatives> - </step> - <step> - <title>Unzip archive</title> - <para> - If using the downloaded distribution, create a new directory named <filename>RichFaces</filename>, then unzip the archive containing the source code there. - </para> - </step> - <step> - <title>Configure <productname>Maven</productname> for RichFaces</title> - <para> - To compile the RichFaces source code, <productname>Maven</productname> requires access to the JBoss repositories. Refer to <xref linkend="step-Developer_Guide-Using_RichFaces_with_Maven-Add_required_repositories" /> of the procedure in <xref linkend="sect-Component_Reference-Using_RichFaces_with_Maven-Using_the_RichFaces_project_archetype" /> to configure the required repositories. - </para> - </step> - <step> - <title>Compile using <productname>Maven</productname></title> - <para> - In the root directory of the unzipped source code, enter the following command to compile and build the RichFaces framework: - </para> - <screen>mvn clean install</screen> - <para> - Add any of the following options after the command to customize the build: - </para> - <variablelist> - <varlistentry> - <term><command>-P release,docs</command></term> - <listitem> - <para> - Maven additionally builds the documentation and release artifacts. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><command>-D skipTests=true</command></term> - <listitem> - <para> - Maven skips the unit and functional tests, which completes the build faster. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><command>-D checkstyle.skip=true</command></term> - <listitem> - <para> - Maven skips the scans for checking style, which completes the build faster. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><command>-D skip-source</command></term> - <listitem> - <para> - Maven does not produce any source <filename>jar</filename> files from the build. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><command>-D skip-enforce</command></term> - <listitem> - <para> - Maven does not check for the correct JDK version, Maven version, and <literal>SNAPSHOT</literal> plug-in, and forces the build. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><command>-D jsf-profile=<replaceable>implementation</replaceable></command></term> - <listitem> - <para> - Maven tests builds and tests against the specified JSF implementation. The <replaceable>implementation</replaceable> value can be any of the following: - </para> - <itemizedlist> - <listitem> - <para> - <literal>jsf_ri</literal>: The latest release of <productname>JSF RI (Mojarra)</productname>. This is the default implemenation. - </para> - </listitem> - <listitem> - <para> - <literal>jsf_ri_javax</literal>: The latest release of <productname>javax.faces</productname>. - </para> - </listitem> - <listitem> - <para> - <literal>jsf_ri_snapshot</literal>: The latest snapshot version of <productname>JSF RI (Mojarra)</productname>. - </para> - </listitem> - <listitem> - <para> - <literal>myfaces</literal>: The latest release of <productname>MyFaces</productname>. - </para> - </listitem> - <listitem> - <para> - <literal>myfaces</literal>: The latest snapshot version of <productname>MyFaces</productname>. - </para> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - </variablelist> - </step> - <step> - <title>Access compiled binaries</title> - <para> - The compiled libraries are located in the following sub-directories of the root RichFaces directory: - </para> - <itemizedlist> - <listitem> - <para> - <filename>/ui/dist/richfaces-components-api/target/richfaces-components-api-<replaceable>version</replaceable>-SNAPSHOT.jar</filename> - </para> - </listitem> - <listitem> - <para> - <filename>/ui/dist/richfaces-components-ui/target/richfaces-components-ui-<replaceable>version</replaceable>-SNAPSHOT.jar</filename> - </para> - </listitem> - <listitem> - <para> - <filename>/core/api/target/richfaces-core-api-<replaceable>version</replaceable>-SNAPSHOT.jar</filename> - </para> - </listitem> - <listitem> - <para> - <filename>/core/impl/target/richfaces-core-impl-<replaceable>version</replaceable>-SNAPSHOT.jar</filename> - </para> - </listitem> - </itemizedlist> - <!-- TODO check build location - <para> - If Maven built the framework using the <command>-P release</command> option, the distribution package containing all three compiled libraries and reference documentation is located at <filename>ui/assembly/target/dist/richfaces-ui-<replaceable>version</replaceable>-SNAPSHOT-bin.zip</filename>. - </para> - --> - </step> - </procedure> - <para> - You can now add the compiled libraries to your project as described in <xref linkend="step-Developer_Guide-Creating_a_project-Add_the_RichFaces_libraries_to_the_project" /> of <xref linkend="sect-Developer_Guide-Getting_started_with_RichFaces-Creating_a_project_with_JBoss_Tools" />. - </para> - - </section> </chapter>