logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bode...@apache.org
Subject svn commit: r1172543 - in /logging/log4net/trunk: log4net.build pom.xml src/site/xdoc/release/building.xml
Date Mon, 19 Sep 2011 09:46:37 GMT
Author: bodewig
Date: Mon Sep 19 09:46:37 2011
New Revision: 1172543

URL: http://svn.apache.org/viewvc?rev=1172543&view=rev
Log:
Generate SDK docs for the website

Modified:
    logging/log4net/trunk/log4net.build
    logging/log4net/trunk/pom.xml
    logging/log4net/trunk/src/site/xdoc/release/building.xml

Modified: logging/log4net/trunk/log4net.build
URL: http://svn.apache.org/viewvc/logging/log4net/trunk/log4net.build?rev=1172543&r1=1172542&r2=1172543&view=diff
==============================================================================
--- logging/log4net/trunk/log4net.build (original)
+++ logging/log4net/trunk/log4net.build Mon Sep 19 09:46:37 2011
@@ -1370,7 +1370,7 @@ limitations under the License.
     <!-- SSCLI 1.0 does not support extracting xml documentation -->
   </target>
   <!-- Target for generating docs for build configurations -->
-  <target name="generate-sdkdoc" depends="compile, check-htmlhelp-compiler, check-current-sdkdoc-dir,
check-current-sdkdoc-debug, clean-current-sdkdoc-dir">
+  <target name="generate-sdkdoc-step1" depends="compile, check-htmlhelp-compiler, check-current-sdkdoc-dir,
check-current-sdkdoc-debug, clean-current-sdkdoc-dir">
     <ndoc>
       <assemblies basedir="${current.bin.dir}">
         <include name="log4net.dll" />
@@ -1410,7 +1410,9 @@ limitations under the License.
         </documenter>
       </documenters>
     </ndoc>
-    <!-- Remove everything except the help file itself from the current SDK documentation
directory -->
+  </target>
+  <!-- Remove everything except the help file itself from the current SDK documentation
directory -->
+  <target name="generate-sdkdoc" depends="generate-sdkdoc-step1">
     <delete>
       <fileset basedir="${current.sdkdoc.dir}">
         <include name="**/*" />
@@ -1418,6 +1420,19 @@ limitations under the License.
       </fileset>
     </delete>
   </target>
+  <!-- Build the SDK documentation for the website -->
+  <target name="generate-sdkdoc-for-site"
+          depends="set-release-build-configuration,generate-sdkdoc-step1">
+    <mkdir dir="target/site/release/sdk"/>
+    <copy todir="target/site/release/sdk">
+      <fileset basedir="${current.sdkdoc.dir}">
+        <include name="**/*" />
+        <exclude name="**/*.chm" />
+        <exclude name="**/*.hh?" />
+        <exclude name="**/*.log" />
+      </fileset>
+    </copy>
+  </target>
   <target name="package" depends="set-package-configuration" description="Build and Package
distribution">
     <!-- set flag to indicating that this is a package build -->
     <property name="project.build.package" value="true" />

Modified: logging/log4net/trunk/pom.xml
URL: http://svn.apache.org/viewvc/logging/log4net/trunk/pom.xml?rev=1172543&r1=1172542&r2=1172543&view=diff
==============================================================================
--- logging/log4net/trunk/pom.xml (original)
+++ logging/log4net/trunk/pom.xml Mon Sep 19 09:46:37 2011
@@ -152,16 +152,17 @@
         <configuration>
           <excludes>
             <!-- generated files -->
+            <exclude>**/*.suo</exclude>
+            <exclude>**/*.user</exclude>
+            <exclude>**/obj/**</exclude>
             <exclude>bin/**</exclude>
-            <exclude>tests/bin/**</exclude>
             <exclude>build/**</exclude>
+            <exclude>doc/sdk/**</exclude>
             <exclude>src/log4net.xml</exclude>
-            <exclude>**/obj/**</exclude>
-            <exclude>**/*.user</exclude>
-            <exclude>**/*.suo</exclude>
+            <exclude>tests/bin/**</exclude>
 
             <!-- really README files -->
-            <exclude>*.snk.*</exclude>
+            <exclude>*.snk*</exclude>
             <exclude>tests/lib/prerequisites.txt</exclude>
           </excludes>
         </configuration>

Modified: logging/log4net/trunk/src/site/xdoc/release/building.xml
URL: http://svn.apache.org/viewvc/logging/log4net/trunk/src/site/xdoc/release/building.xml?rev=1172543&r1=1172542&r2=1172543&view=diff
==============================================================================
--- logging/log4net/trunk/src/site/xdoc/release/building.xml (original)
+++ logging/log4net/trunk/src/site/xdoc/release/building.xml Mon Sep 19 09:46:37 2011
@@ -164,7 +164,11 @@ sn -k log4net.snk</pre></div>
 
             <section id="sdk" name="SDK Reference">
                 <p>
-                    NDoc 1.3 is used to build the log4net SDK documentation.
+                    NDoc 1.3 is used to build the log4net SDK
+                    documentation using the <span
+                    class="code">generate-sdkdoc</span> target in
+                    log4net's Nant build file.
+
                     NDoc is available from <a href="http://ndoc.sourceforge.net">ndoc.sourceforge.net</a>.
                 </p>
             </section>
@@ -176,6 +180,13 @@ sn -k log4net.snk</pre></div>
                     Building the documentation requires Java 5 or newer and Maven 2.2.1 or
newer.
                     Run mvn from within the root directory.
                 </p>
+                <p>SDK documentation for the site is built using the
+                <span class="code">generate-sdkdoc-for-site</span> target in
+                log4net's NAnt build file.</p>
+                <p>It is not recommended to use mvn's <span
+                class="code">site:deploy</span> goal but rather to
+                deploy the site generated to <span
+                class="code">target/site</span> manually.</p>
             </section>
 
         </section>



Mime
View raw message