Cleanups in packaging.

carrotsearch · Apr 26, 2011 · d60b0ec · d60b0ec
1 parent 3dca44c
commit d60b0ec
Show file tree

Hide file tree

Showing 9 changed files with 101 additions and 180 deletions.
diff --git a/hppc-core/CHANGES.txt → CHANGES b/hppc-core/CHANGES.txt → CHANGES
@@ -16,6 +16,8 @@ HPPC-52: Dropped custom hash functions and comparators from associative containe
 
 ** New features
 
+HPPC-61: Cleaned up Maven structure: parent aggregator and submodules.
+
 HPPC-57: Added a view of values to associative containers (values() method).
 
 HPPC-49: Added support for XorShift random.

diff --git a/hppc-core/hppc.LICENSE → LICENSE b/hppc-core/hppc.LICENSE → LICENSE
diff --git a/README b/README
@@ -14,4 +14,56 @@ mvn clean
 # Generate Eclipse project files (the setup is a bit complex, so use this!)
 mvn compile eclipse:eclipse
 
+# All unit tests
+mvn clean test
 
+# Install packages in a local repository.
+mvn clean install
+
+# Create a distribution package
+mvn clean package -Prelease
+
+
+hppc-core only targets
+----------------------
+
+# Run tests with clover
+mvn -Pclover
+
+# Generate code quality reports
+mvn -Pclover site 
+
+# Creates a release directory for rsyncing to labs.carrotsearch.com:
+# rsync -azv -e "ssh -p 2222" --chmod=u=rwX,g=rX,o=rX target/site-labs/ carrot2@hostgator.carrot2.org:./public_html/com.carrotsearch.labs/download/hppc/
+mvn -Psite-labs
+
+
+
+Deployment
+----------
+
+# Deploy a snapshot of artefacts to SonaType's snapshots repo
+mvn clean deploy
+
+
+Clover
+------
+
+A local license is required for Clover support. Edit your ~/.m2/settings.xml and 
+add an active profile definiting these settings:
+
+...
+  <profiles>
+          <profile>
+            <id>clover-license</id>
+            <properties>
+              <clover.license.path>[...]\clover.license</clover.license.path>
+              <maven.clover.licenseLocation>[...]\clover.license</maven.clover.licenseLocation>
+            </properties>
+          </profile>
+  </profiles>
+
+  <activeProfiles>
+    <activeProfile>clover-license</activeProfile>
+  </activeProfiles>
+...
diff --git a/hppc-benchmarks/lib/install-deps b/hppc-benchmarks/lib/install-deps
diff --git a/hppc-core/README.txt b/hppc-core/README.txt
diff --git a/hppc-core/pom.xml b/hppc-core/pom.xml
@@ -260,7 +260,7 @@
             </configuration>
             <executions>
               <execution>
-                <id>make-assembly</id>
+                <id>make-labs-assembly</id>
                 <phase>package</phase>
                 <goals>
                   <goal>single</goal>
@@ -277,14 +277,13 @@
       <id>release</id>
 
       <build>
-        <defaultGoal>install</defaultGoal>
+        <defaultGoal>package</defaultGoal>
 
         <plugins>
           <!-- Attach and modify JavaDocs. -->
           <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-javadoc-plugin</artifactId>
-            <version>2.6.1</version>
             <configuration>
               <encoding>${project.build.sourceEncoding}</encoding>
               <stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile>
@@ -316,7 +315,6 @@
           <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-source-plugin</artifactId>
-            <version>2.1.2</version>
             <executions>
               <execution>
                 <id>attach-sources</id>
@@ -341,34 +339,14 @@
             </configuration>
             <executions>
               <execution>
-                <id>make-assembly</id>
+                <id>make-release-assembly</id>
                 <phase>package</phase>
                 <goals>
                   <goal>single</goal>
                 </goals>
               </execution>
             </executions>
           </plugin>
-
-          <!-- GPG sign artefacts. -->
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-gpg-plugin</artifactId>
-            <version>1.1</version>
-            <configuration>
-              <excludes>
-                <exclude>**/*.gz</exclude>
-                <exclude>**/*.zip</exclude>
-              </excludes>
-            </configuration>
-            <executions>
-              <execution>
-                <goals>
-                  <goal>sign</goal>
-                </goals>
-              </execution>
-            </executions>
-          </plugin>
         </plugins>
       </build>
     </profile>

diff --git a/hppc-core/src/main/assembly/bin.xml b/hppc-core/src/main/assembly/bin.xml
@@ -12,12 +12,15 @@
 
   <fileSets>
     <fileSet>
-      <directory></directory>
+      <directory>../</directory>
       <outputDirectory />
       <includes>
-        <include>*.LICENSE</include>
+        <include>LICENSE</include>
+        <include>README</include>
+        <include>CHANGES</include>
       </includes>
     </fileSet>
+
     <fileSet>
       <directory>${project.build.directory}</directory>
       <outputDirectory />

diff --git a/hppc-core/src/main/java/com/carrotsearch/hppc/package.html b/hppc-core/src/main/java/com/carrotsearch/hppc/package.html
@@ -181,102 +181,6 @@ <h2>Interfaces and container inheritance</h2>
         implement a given interface. The interface hierarchy is loosely inspired by STL.</p>
 
         <p>An overview of interfaces and their relationship to data structures implemented
-        in HPPC is depicted graphically in {@link com.carrotsearch.hppc.ObjectContainer}. Functional method-outline
-        is shown in the table below.</p>
-
-        <!--  At some point, it'd be nice to convert it to a real table... -->
-<pre>
-Method name                 sets        lists      deque
----------------------------------------------------------
-
-[ObjectContainer]
-
-contains(KType)               +            +         +
-isEmpty()                     +            +         +
-size()                        +            +         +
-clear()                       +            +         +
-KType [] toArray              +            +         +
-iterable [KType]              +            +         +
-
-forEach(Procedure)            +            +         +
-forEach(Predicate)            +            +         +
-apply(Function)               +            +         +
-
-
-[ObjectCollection: ObjectContainer]
-
-retainAll(Predicate)          +            +         +
-retainAll(LookupContainer)    +            +         +
-removeAll(Predicate)          +            +         +
-removeAll(LookupContainer)    +            +         +
-removeAllOccurrences(KType)   +            +         +
-
-
-[ObjectIndexedContainer: ObjectCollection, RandomAccess]
-
-removeFirstOccurrence(KType)               +         +
-removeLastOccurrence(KType)                +         +
-indexOf(KType)                             +
-lastIndexOf(KType)                         +
-add(KType)                    +            +
-insert(index, KType)                       +
-get(index)                                 +
-remove(index)                              +
-removeRange(...)                           +
-
-
-[ObjectDeque: ObjectCollection]
-
-removeFirstOccurrence(KType)               +         +
-removeLastOccurrence(KType)                +         +
-addFirst(KType)                                      +
-addLast(KType)                                       +
-removeFirst()                                        +
-removeLast()                                         +
-getFirst()                                           +
-getLast()                                            +
-descendingIterator()                                 +
-descendingForEach(Procedure)                         +
-descendingForEach(Predicate)                         +
-
-
-[ObjectSet: ObjectCollection]
-
-add(KType)                    +            +
-
-
-[ObjectLookupContainer: ObjectContainer], {guaranteed constant-time object lookup}
-
-contains(KType)               +
-</pre>
-
-
-        <p>And a similar overview of associative containers.</p>
-
-<pre>
-Method name                  map       [?multimap]         
----------------------------------------------------------
-
-[ObjectObjectAssociativeContainer]
-
-iterable [KType, VType]       +
-containsKey                   +
-size                          +
-isEmpty                       +
-removeAll(ObjectContainer)    +
-removeAll(predicate)          +
-forEach(procedure)            +
-clear                         +
-keySet                        +
-
-
-[ObjectObjectMap : ObjectObjectAssociativeContainer]
-
-put                           +
-get                           +
-putAll                        +
-remove                        +
-</pre>
-
+        in HPPC is depicted graphically in {@link com.carrotsearch.hppc.ObjectContainer}.</p>
     </body>
 </html>
diff --git a/pom.xml b/pom.xml
@@ -180,6 +180,18 @@
           <version>1.5</version>
         </plugin>
 
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-javadoc-plugin</artifactId>
+          <version>2.6.1</version>
+        </plugin>
+
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-source-plugin</artifactId>
+          <version>2.1.2</version>
+        </plugin>
+
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-eclipse-plugin</artifactId>
@@ -202,6 +214,32 @@
         <defaultGoal>eclipse:eclipse</defaultGoal>
       </build>
     </profile>
+
+    <profile>
+      <id>sign</id>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-gpg-plugin</artifactId>
+            <version>1.1</version>
+            <configuration>
+              <excludes>
+                <exclude>**/*.gz</exclude>
+                <exclude>**/*.zip</exclude>
+              </excludes>
+            </configuration>
+            <executions>
+              <execution>
+                <goals>
+                  <goal>sign</goal>
+                </goals>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
   </profiles>
 </project>