onami-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From randg...@apache.org
Subject svn commit: r1456591 - in /incubator/onami/trunk/lifecycle/warmup/src/site: ./ apt/ apt/index.apt.vm resources/ resources/images/ resources/images/abc.png site.xml
Date Thu, 14 Mar 2013 18:21:46 GMT
Author: randgalt
Date: Thu Mar 14 18:21:45 2013
New Revision: 1456591

URL: http://svn.apache.org/r1456591
Log:
Added doc

Added:
    incubator/onami/trunk/lifecycle/warmup/src/site/
    incubator/onami/trunk/lifecycle/warmup/src/site/apt/
    incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm   (with props)
    incubator/onami/trunk/lifecycle/warmup/src/site/resources/
    incubator/onami/trunk/lifecycle/warmup/src/site/resources/images/
    incubator/onami/trunk/lifecycle/warmup/src/site/resources/images/abc.png   (with props)
    incubator/onami/trunk/lifecycle/warmup/src/site/site.xml   (with props)

Added: incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm?rev=1456591&view=auto
==============================================================================
--- incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm (added)
+++ incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm Thu Mar 14 18:21:45 2013
@@ -0,0 +1,67 @@
+                                    ------
+                                    Home
+                                    ------
+                                    The Apache Onami developers team
+                                    ------
+                                     2012
+
+~~
+~~ 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.
+~~
+
+Welcome to ${project.name}!
+
+ Methods annotated with @WarmUp will be called in parallel
+ (using the Java Fork-Join framework). Object
+ dependencies are respected – i.e. given:
+
+[./images/abc.png]
+
+ * Object A is dependent on objects B and C and all have warm up methods.
+
+ * Object A’s warm up method will not be executed until both objects B and C’s
warm up methods complete.
+
+ * Objects B and C’s warm up methods will execute in parallel.
+
+Before starting
+
+  ${project.name} is available on the Maven Central repo, you just need to add the dependency
below in your <<<pom.xml>>> file:
+
++--------------------------------------+
+<dependencies>
+  ...
+  <dependency>
+    <groupId>${project.groupId}</groupId>
+    <artifactId>${project.artifactId}</artifactId>
+    <version>${project.version}</version>
+  </dependency>
+  ...
+</dependencies>
++--------------------------------------+
+
+Usage
+
+ To use, install the WarmUpModule in your Guice injector. To initiate the warm up, get the
warm up stager and
+ call the stage() method.
+
++--------------------------------------+
+Injector injector = Guice.createInjector( WarmUpModule().newWarmUpModule() );
+// ...
+Stager<WarmUp> warmUpStager = injector.get( LifeCycleStageModule.key(WarmUp.class)
);
+warmUpStager.stage(); // causes all injected object's @WarmUp methods to get called
++--------------------------------------+

Propchange: incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: incubator/onami/trunk/lifecycle/warmup/src/site/apt/index.apt.vm
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: incubator/onami/trunk/lifecycle/warmup/src/site/resources/images/abc.png
URL: http://svn.apache.org/viewvc/incubator/onami/trunk/lifecycle/warmup/src/site/resources/images/abc.png?rev=1456591&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/onami/trunk/lifecycle/warmup/src/site/resources/images/abc.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: incubator/onami/trunk/lifecycle/warmup/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/onami/trunk/lifecycle/warmup/src/site/site.xml?rev=1456591&view=auto
==============================================================================
--- incubator/onami/trunk/lifecycle/warmup/src/site/site.xml (added)
+++ incubator/onami/trunk/lifecycle/warmup/src/site/site.xml Thu Mar 14 18:21:45 2013
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ | 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.
+-->
+<project xmlns="http://maven.apache.org/DECORATION/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/DECORATION/1.1.0 http://maven.apache.org/xsd/decoration-1.1.0.xsd"
+         name="${project.name}">
+
+  <body>
+    <head>
+      <link rel="meta" title="DOAP" href="${project.url}/doap.rdf" type="application/rdf+xml"
/>
+    </head>
+
+    <menu name="Apache Onami™ Lifecycle Warm Up">
+      <item name="Home" href="index.html" />
+    </menu>
+
+    <menu ref="reports"/>
+
+    <footer>
+      <div class="row span12">
+        Apache Onami, Apache Onami Lifecycle, Apache, the Apache feather logo, and the Apache
Onami project logos are trademarks of The Apache Software Foundation. All other marks mentioned
may be trademarks or registered trademarks of their respective owners.
+      </div>
+    </footer>
+  </body>
+
+</project>

Propchange: incubator/onami/trunk/lifecycle/warmup/src/site/site.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/onami/trunk/lifecycle/warmup/src/site/site.xml
------------------------------------------------------------------------------
    svn:keywords = Date Revision Author HeadURL Id

Propchange: incubator/onami/trunk/lifecycle/warmup/src/site/site.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml



Mime
View raw message