Author: elserj
Date: Sun Aug 5 04:37:13 2012
New Revision: 1369523
URL: http://svn.apache.org/viewvc?rev=1369523&view=rev
Log:
ACCUMULO-704 Moving TeX compilation to its own maven profile not active by
default
- Rename the developer manual filename to match user manual filename
- Add developer manual to new maven profile and add output pdf to svn:ignore
Added:
accumulo/trunk/docs/src/developer_manual/accumulo_developer_manual.tex
- copied, changed from r1369512,
accumulo/trunk/docs/src/developer_manual/developer_manual.tex
accumulo/trunk/docs/src/developer_manual/build.sh (with props)
Removed:
accumulo/trunk/docs/src/developer_manual/developer_manual.tex
Modified:
accumulo/trunk/README
accumulo/trunk/assemble/pom.xml
accumulo/trunk/docs/ (props changed)
accumulo/trunk/docs/src/user_manual/chapters/shell.tex
accumulo/trunk/pom.xml
Modified: accumulo/trunk/README
URL:
http://svn.apache.org/viewvc/accumulo/trunk/README?rev=1369523&r1=1369522&r2=1369523&view=diff
==============================================================================
--- accumulo/trunk/README (original)
+++ accumulo/trunk/README Sun Aug 5 04:37:13 2012
@@ -15,9 +15,11 @@ ready to go on x86 GNU/Linux: there is n
However, if you only have source code, or you wish to make changes, you need to
have maven configured to get Accumulo prerequisites from repositories. See
-the pom.xml file for the necessary components.
+the pom.xml file for the necessary components. Activate the 'docs' profile to
build
+the Accumulo developer and user manual.
-Run "mvn package -P assemble"
+Run "mvn package -P assemble" to build a distribution, or run "mvn package -P
assemble,docs"
+to also build the documentation.
If you are running on another Unix-like operating system (OSX, etc) then
you may wish to build the native libraries. They are not strictly necessary
Modified: accumulo/trunk/assemble/pom.xml
URL:
http://svn.apache.org/viewvc/accumulo/trunk/assemble/pom.xml?rev=1369523&r1=1369522&r2=1369523&view=diff
==============================================================================
--- accumulo/trunk/assemble/pom.xml (original)
+++ accumulo/trunk/assemble/pom.xml Sun Aug 5 04:37:13 2012
@@ -61,19 +61,6 @@
<artifactId>exec-maven-plugin</artifactId>
<executions>
<execution>
- <id>user-manual</id>
- <phase>prepare-package</phase>
- <goals>
- <goal>exec</goal>
- </goals>
- <configuration>
- <executable>bash</executable>
- <arguments>
- <argument>../docs/src/user_manual/build.sh</argument>
- </arguments>
- </configuration>
- </execution>
- <execution>
<id>config webpage</id>
<phase>package</phase>
<goals>
@@ -412,5 +399,44 @@
</plugins>
</build>
</profile>
+ <profile>
+ <id>docs</id>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>exec-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>developer-manual</id>
+ <phase>prepare-package</phase>
+ <goals>
+ <goal>exec</goal>
+ </goals>
+ <configuration>
+ <executable>bash</executable>
+ <arguments>
+ <argument>../docs/src/developer_manual/build.sh</argument>
+ </arguments>
+ </configuration>
+ </execution>
+ <execution>
+ <id>user-manual</id>
+ <phase>prepare-package</phase>
+ <goals>
+ <goal>exec</goal>
+ </goals>
+ <configuration>
+ <executable>bash</executable>
+ <arguments>
+ <argument>../docs/src/user_manual/build.sh</argument>
+ </arguments>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
</profiles>
</project>
Propchange: accumulo/trunk/docs/
------------------------------------------------------------------------------
--- svn:ignore (original)
+++ svn:ignore Sun Aug 5 04:37:13 2012
@@ -1,3 +1,4 @@
config.html
+accumulo_developer_manual.pdf
accumulo_user_manual.pdf
apidocs
Copied: accumulo/trunk/docs/src/developer_manual/accumulo_developer_manual.tex
(from r1369512, accumulo/trunk/docs/src/developer_manual/developer_manual.tex)
URL:
http://svn.apache.org/viewvc/accumulo/trunk/docs/src/developer_manual/accumulo_developer_manual.tex?p2=accumulo/trunk/docs/src/developer_manual/accumulo_developer_manual.tex&p1=accumulo/trunk/docs/src/developer_manual/developer_manual.tex&r1=1369512&r2=1369523&rev=1369523&view=diff
==============================================================================
--- accumulo/trunk/docs/src/developer_manual/developer_manual.tex (original)
+++ accumulo/trunk/docs/src/developer_manual/accumulo_developer_manual.tex Sun
Aug 5 04:37:13 2012
@@ -27,16 +27,9 @@
\usepackage{amssymb}
\usepackage[pdftex]{graphicx}
\usepackage{subfigure}
-\usepackage{fancyhdr}
\usepackage[T1]{fontenc}
\title{Apache Accumulo Developer's Manual - Version 1.3}
\author{}
-%\usepackage{fancyhdr}
-%\pagestyle{fancy}
-%\chead{UNCLASSIFIED//FOR OFFICIAL USE ONLY}
-%\cfoot{UNCLASSIFIED//FOR OFFICIAL USE ONLY}
-%\lhead{}
-%\rhead{}
\begin{document}
\maketitle
\newpage
Added: accumulo/trunk/docs/src/developer_manual/build.sh
URL:
http://svn.apache.org/viewvc/accumulo/trunk/docs/src/developer_manual/build.sh?rev=1369523&view=auto
==============================================================================
--- accumulo/trunk/docs/src/developer_manual/build.sh (added)
+++ accumulo/trunk/docs/src/developer_manual/build.sh Sun Aug 5 04:37:13 2012
@@ -0,0 +1,48 @@
+#! /bin/bash
+
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+bin=`dirname "$0"`
+bin=`cd "$bin"; pwd`
+cd $bin
+
+if [ `which pdflatex | wc -l` -eq 0 ]; then
+ echo "*********************************************" 1>&2
+ echo '* Missing pdflatex command. Please install. *' 1>&2
+ echo "*********************************************" 1>&2
+ exit 0;
+fi
+
+if [ -f ../../accumulo_developer_manual.pdf ]
+then
+ if [ `find . -name '*.tex' -newer ../../accumulo_developer_manual.pdf | wc
-l` -eq 0 ]
+ then
+ echo "***********************************************" 1>&2
+ echo "* Developer manual is up-to-date. *" 1>&2
+ echo "***********************************************" 1>&2
+ exit 0
+ fi
+fi
+
+pdflatex accumulo_developer_manual.tex
+pdflatex accumulo_developer_manual.tex
+pdflatex accumulo_developer_manual.tex
+pdflatex accumulo_developer_manual.tex && (
+find . -name '*.aux' -print | xargs rm -f
+rm -f *.log *.toc *.out
+mv accumulo_developer_manual.pdf ../..
+)
Propchange: accumulo/trunk/docs/src/developer_manual/build.sh
------------------------------------------------------------------------------
svn:executable = *
Modified: accumulo/trunk/docs/src/user_manual/chapters/shell.tex
URL:
http://svn.apache.org/viewvc/accumulo/trunk/docs/src/user_manual/chapters/shell.tex?rev=1369523&r1=1369522&r2=1369523&view=diff
==============================================================================
--- accumulo/trunk/docs/src/user_manual/chapters/shell.tex (original)
+++ accumulo/trunk/docs/src/user_manual/chapters/shell.tex Sun Aug 5 04:37:13
2012
@@ -25,7 +25,6 @@ The shell can be started by the followin
\begin{verbatim}
$ACCUMULO_HOME/bin/accumulo shell -u [username]
\end{verbatim}
-% stupid emacs is confused by $ACCUMULO
\normalsize
Modified: accumulo/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/accumulo/trunk/pom.xml?rev=1369523&r1=1369522&r2=1369523&view=diff
==============================================================================
--- accumulo/trunk/pom.xml (original)
+++ accumulo/trunk/pom.xml Sun Aug 5 04:37:13 2012
@@ -189,27 +189,6 @@
</environmentVariables>
</configuration>
</plugin>
-
- <plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>exec-maven-plugin</artifactId>
- <inherited>false</inherited>
- <configuration>
- <executable>bash</executable>
- <arguments>
- <argument>docs/src/user_manual/build.sh</argument>
- </arguments>
- </configuration>
- <executions>
- <execution>
- <id>user-manual</id>
- <phase>prepare-package</phase>
- <goals>
- <goal>exec</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
</plugins>
