You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@creadur.apache.org by rd...@apache.org on 2012/11/05 22:04:05 UTC
svn commit: r1405953 - in /creadur/rat/trunk: apache-rat-core/src/site/apt/
apache-rat-tasks/src/site/apt/ apache-rat-tasks/src/site/apt/examples/
apache-rat/src/site/apt/ src/site/apt/
Author: rdonkin
Date: Mon Nov 5 21:04:04 2012
New Revision: 1405953
URL: http://svn.apache.org/viewvc?rev=1405953&view=rev
Log:
Replace older-style source headers, and Eclipse tidied up some whitespace
Modified:
creadur/rat/trunk/apache-rat-core/src/site/apt/index.apt.vm
creadur/rat/trunk/apache-rat-tasks/src/site/apt/examples/basic.apt.vm
creadur/rat/trunk/apache-rat-tasks/src/site/apt/examples/custom.apt
creadur/rat/trunk/apache-rat-tasks/src/site/apt/index.apt
creadur/rat/trunk/apache-rat-tasks/src/site/apt/report.apt
creadur/rat/trunk/apache-rat-tasks/src/site/apt/types.apt
creadur/rat/trunk/apache-rat/src/site/apt/index.apt.vm
creadur/rat/trunk/src/site/apt/index.apt.vm
creadur/rat/trunk/src/site/apt/site-publish.apt
Modified: creadur/rat/trunk/apache-rat-core/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/site/apt/index.apt.vm?rev=1405953&r1=1405952&r2=1405953&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/site/apt/index.apt.vm (original)
+++ creadur/rat/trunk/apache-rat-core/src/site/apt/index.apt.vm Mon Nov 5 21:04:04 2012
@@ -1,15 +1,18 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-~~ Licensed 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.
+~~ 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.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------
@@ -24,7 +27,7 @@ Release Audit Tool (Rat)
It's reports require interpretation.
* Running from the Command Line
-
+
Run from the command line with:
+------------------------------------------+
@@ -44,7 +47,7 @@ java -jar apache-rat-${project.version}.
+------------------------------------------+
java -jar apache-rat-${project.version}.jar --addLicence
- --copyright "Copyright 2008 Foo"
+ --copyright "Copyright 2008 Foo"
/path/to/project
+------------------------------------------+
Modified: creadur/rat/trunk/apache-rat-tasks/src/site/apt/examples/basic.apt.vm
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-tasks/src/site/apt/examples/basic.apt.vm?rev=1405953&r1=1405952&r2=1405953&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-tasks/src/site/apt/examples/basic.apt.vm (original)
+++ creadur/rat/trunk/apache-rat-tasks/src/site/apt/examples/basic.apt.vm Mon Nov 5 21:04:04 2012
@@ -1,15 +1,18 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-~~ Licensed 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.
+~~ 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.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
----
@@ -57,7 +60,7 @@ java -jar apache-rat-${project.version}.
+------------------------------------------+
java -jar apache-rat-${project.version}.jar --addLicence
- --copyright "Copyright 2008 Foo"
+ --copyright "Copyright 2008 Foo"
/path/to/project
+------------------------------------------+
@@ -96,7 +99,7 @@ java -jar apache-rat-${project.version}.
* Run Rat but make the Apache License Version 2.0 the only one
accepted
----
+---
<rat:report addDefaultLicenseMatchers="false">
<fileset dir="src"/>
<rat:asl20/>
@@ -105,7 +108,7 @@ java -jar apache-rat-${project.version}.
* Run Rat on all files in <<<src>>> that have been modified today
----
+---
<tstamp/>
<rat:report xmlns:rat="antlib:org.apache.rat.anttasks">
<restrict>
Modified: creadur/rat/trunk/apache-rat-tasks/src/site/apt/examples/custom.apt
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-tasks/src/site/apt/examples/custom.apt?rev=1405953&r1=1405952&r2=1405953&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-tasks/src/site/apt/examples/custom.apt (original)
+++ creadur/rat/trunk/apache-rat-tasks/src/site/apt/examples/custom.apt Mon Nov 5 21:04:04 2012
@@ -1,17 +1,19 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-~~ Licensed 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.
+~~ 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.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
---
Custom Types
---
Modified: creadur/rat/trunk/apache-rat-tasks/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-tasks/src/site/apt/index.apt?rev=1405953&r1=1405952&r2=1405953&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-tasks/src/site/apt/index.apt (original)
+++ creadur/rat/trunk/apache-rat-tasks/src/site/apt/index.apt Mon Nov 5 21:04:04 2012
@@ -1,15 +1,18 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-~~ Licensed 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.
+~~ 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.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----
@@ -41,7 +44,7 @@ Installation
* The traditional way:
-------
-<taskdef
+<taskdef
resource="org/apache/rat/anttasks/antlib.xml">
<classpath>
<pathelement location="YOUR-PATH-TO/apache-rat-tasks.jar"/>
@@ -59,7 +62,7 @@ Installation
* Similar, but assigning a namespace URI
-------
-<taskdef
+<taskdef
uri="antlib:org.apache.rat.anttasks"
resource="org/apache/rat/anttasks/antlib.xml">
<classpath>
Modified: creadur/rat/trunk/apache-rat-tasks/src/site/apt/report.apt
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-tasks/src/site/apt/report.apt?rev=1405953&r1=1405952&r2=1405953&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-tasks/src/site/apt/report.apt (original)
+++ creadur/rat/trunk/apache-rat-tasks/src/site/apt/report.apt Mon Nov 5 21:04:04 2012
@@ -1,15 +1,18 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-~~ Licensed 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.
+~~ 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.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----
@@ -42,7 +45,7 @@ Attributes of the Task
| format | The format to use for the report.
| | Choices are <<<xml>>> for Rat's XML format,
| | <<<plain>>> for plain text using Rat's built-in stylesheet,
-| | <<<styled>>> transforms the XML output using the given stylesheet. The stylesheet nested element must be set as well if this attribute is used.
+| | <<<styled>>> transforms the XML output using the given stylesheet. The stylesheet nested element must be set as well if this attribute is used.
| | Defaults to <<<plain>>>|
*-------------------------*-------------------------------+
| addDefaultLicenseMatchers | Whether to use Rat's built-in set of license matchers in addition to those specified as nested elements.
@@ -78,7 +81,7 @@ Nested Elements
If the <<<format>>> attribute has been set to <<<styled>>> the XSLT
stylesheet to apply is specified as a nested resource element. For
example
-
+
---
<rat:report format="styled" reportFile="rat-report.html">
...
@@ -112,7 +115,7 @@ Nested Elements
<<<addDefaultLicenseMatchers>>> to false and then explicitly add the
built-in <<<asl20>>> matcher
----
+---
<rat:report addDefaultLicenseMatchers="false">
<rat:asl20/>
</rat:report>
Modified: creadur/rat/trunk/apache-rat-tasks/src/site/apt/types.apt
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-tasks/src/site/apt/types.apt?rev=1405953&r1=1405952&r2=1405953&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-tasks/src/site/apt/types.apt (original)
+++ creadur/rat/trunk/apache-rat-tasks/src/site/apt/types.apt Mon Nov 5 21:04:04 2012
@@ -1,15 +1,18 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-~~ Licensed 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.
+~~ 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.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----
Modified: creadur/rat/trunk/apache-rat/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat/src/site/apt/index.apt.vm?rev=1405953&r1=1405952&r2=1405953&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat/src/site/apt/index.apt.vm (original)
+++ creadur/rat/trunk/apache-rat/src/site/apt/index.apt.vm Mon Nov 5 21:04:04 2012
@@ -1,15 +1,18 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-~~ Licensed 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.
+~~ 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.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------
@@ -25,7 +28,7 @@ Release Audit Tool (Rat)
* Running from the Command Line
-
+
Run from the command line with:
+------------------------------------------+
Modified: creadur/rat/trunk/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/src/site/apt/index.apt.vm?rev=1405953&r1=1405952&r2=1405953&view=diff
==============================================================================
--- creadur/rat/trunk/src/site/apt/index.apt.vm (original)
+++ creadur/rat/trunk/src/site/apt/index.apt.vm Mon Nov 5 21:04:04 2012
@@ -1,26 +1,29 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-~~ Licensed 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.
+~~ 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.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------
A Release Audit Tool
--------------------------
-
+
Apache Rat
- Apache Rat is a release audit tool. Use Rat to improve accuracy and efficiency
- when checking releases. It is heuristic in nature: making guesses about possible
- problems. It will produce false positives and cannot find every possible issue
+ Apache Rat is a release audit tool. Use Rat to improve accuracy and efficiency
+ when checking releases. It is heuristic in nature: making guesses about possible
+ problems. It will produce false positives and cannot find every possible issue
with a release. It's reports require interpretation.
Rat was developed in response to a need felt in the Apache Incubator to be able to
@@ -28,20 +31,20 @@ Apache Rat
highly tuned to the Apache style of releases.
Rat is intended to be self documenting: reports should include introductory material
- describing their function. Building Rat describes how to run Rat. Running Rat
+ describing their function. Building Rat describes how to run Rat. Running Rat
describes the options available. The release notes describe the current state of
Rat.
-
+
Apache Rat is part of the {{{http://creadur.apache.org}Apache Creadur}}
- language- and build-agnostic suite of tools for auditing and comprehending
- software distributions. Our community develops
+ language- and build-agnostic suite of tools for auditing and comprehending
+ software distributions. Our community develops
{{{http://www.opensource.org/} open source software}} the
- {{{http://www.apache.org/foundation/how-it-works.html} Apache way}}.
+ {{{http://www.apache.org/foundation/how-it-works.html} Apache way}}.
* Running Rat
** Command Line
-
+
Quick start by
+------------------------------------------+
@@ -49,19 +52,19 @@ java -jar apache-rat-${project.version}.
+------------------------------------------+
Read more {{{./apache-rat/index.html}here}}.
-
+
** Apache Ant
-
+
Use the task library for {{{http://ant.apache.org/} Apache Ant 1.7}} or later
-
+
Read more {{{./apache-rat-tasks/index.html} here}}.
-
+
** Apache Maven
Use the plugin for {{{http://maven.apache.org}Apache Maven ${mavenVersion}}} or later.
-
+
Read more {{{./apache-rat-plugin/index.html} here}}.
-
+
* Checking Out Rat
@@ -74,7 +77,7 @@ svn co http://svn.apache.org/repos/asf/c
Read more {{{./source-repository.html}here}}.
* Building Rat
-
+
Build Rat with {{{http://maven.apache.org/} Apache Maven}}
Quick start
@@ -82,4 +85,4 @@ svn co http://svn.apache.org/repos/asf/c
+------------------------------------------+
mvn install
+------------------------------------------+
-
+
Modified: creadur/rat/trunk/src/site/apt/site-publish.apt
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/src/site/apt/site-publish.apt?rev=1405953&r1=1405952&r2=1405953&view=diff
==============================================================================
--- creadur/rat/trunk/src/site/apt/site-publish.apt (original)
+++ creadur/rat/trunk/src/site/apt/site-publish.apt Mon Nov 5 21:04:04 2012
@@ -1,15 +1,18 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-~~ Licensed 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.
+~~ 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.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------
Publishing this site
@@ -27,13 +30,13 @@ How to publish the Rat website
* Happy with changes and ready to go live?
- Do
+ Do
+------------------------------------------+
mvn site
+------------------------------------------+
- then if successful do
+ then if successful do
+------------------------------------------+
mvn site-deploy
@@ -44,8 +47,8 @@ mvn site-deploy
If you have issues with 'mvn site' failing try running 'mvn clean' then 'mvn install package' before going back and running 'mvn site' again.
- If you experience an Out of Memory error <<java.lang.OutOfMemoryError: Java heap space>> when running 'mvn site' try setting 'export MAVEN_OPTS=-Xmx512m'
- or for windows 'set MAVEN_OPTS=-Xmx512m' first on the command line (or in your profile) and then try 'mvn site' again. Only when 'mvn site' is successful
+ If you experience an Out of Memory error <<java.lang.OutOfMemoryError: Java heap space>> when running 'mvn site' try setting 'export MAVEN_OPTS=-Xmx512m'
+ or for windows 'set MAVEN_OPTS=-Xmx512m' first on the command line (or in your profile) and then try 'mvn site' again. Only when 'mvn site' is successful
should you then 'mvn site-deploy'
* Wait for the hourly site sync to our www machines and the updated site will be live.
@@ -62,7 +65,7 @@ Using the CMS
mvn site:site
+------------------------------------------+
- and gets deployed via
+ and gets deployed via
+------------------------------------------+
mvn site:deploy -Pcms