Merge pull request #804 from tulinkry/master

create.sh fix

Author: Vladimir Kotal

README.txt

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006, 2013, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2006, 2014, Oracle and/or its affiliates. All rights reserved.
 #
 
 
@@ -9,14 +9,15 @@ OpenGrok - a wicked fast source browser
 1.  Introduction
 2.  Requirements
 3.  Usage
-4.  OpenGrok setup
-5.  Optional Command Line Interface Usage
-6.  Change web application properties or name
-7.  OpenGrok systray
-8.  Information for developers
-9.  Tuning OpenGrok for large code bases
-10.  Authors
-11. Contact us
+4.  OpenGrok install
+5.  OpenGrok setup
+6.  Optional Command Line Interface Usage
+7.  Change web application properties or name
+8.  OpenGrok systray
+9.  Information for developers
+10.  Tuning OpenGrok for large code bases
+11.  Authors
+12. Contact us
 
 
 1. Introduction
@@ -89,13 +90,36 @@ Each of these directories was created with 'cvs checkout' command (with
 appropriate arguments to get given branch) and will be treated by OpenGrok
 as a project.
 
-4. OpenGrok setup
+
+4. OpenGrok install
+-----------------
+
+4.1 Installing on Solaris from *.p5p file
+-----------------
+
+4.1.0 Install
+-----------------
+
+The file <package_name>.p5p you can easily use as a new publisher for the pkg command.
+
+  # pkg install --no-refresh -g /path/to/file/<package_name>.p5p opengrok
+
+
+4.1.1 Update
+-----------------
+
+You can also update OpenGrok software with the *.p5p file by running a command
+
+  # pkg update --no-refresh -g /path/to/file/<package_name>.p5p 'pkg://<publisher>/*'
+
+
+5. OpenGrok setup
 -----------------
 
 To setup OpenGrok it is needed to prepare the source code, let OpenGrok index
 it and start the web application.
 
-4.1 Setting up the sources
+5.1 Setting up the sources
 --------------------------
 
 Source base should be available locally for OpenGrok to work efficiently.
@@ -123,13 +147,13 @@ If you want to skip indexing the history of a particular directory
 at the root of that directory.
 
 
-4.2 Using Opengrok wrapper script to create indexes
+5.2 Using Opengrok wrapper script to create indexes
 ---------------------------------------------------
 
 For *nix systems there is a shell script called OpenGrok which simplifies most
 of the tasks. It has been tested on Solaris and Linux distributions.
 
-4.2.1 - Deploy the web application
+5.2.1 - Deploy the web application
 ----------------------------------
 
 First please change to opengrok directory where the OpenGrok shell script is
@@ -157,7 +181,7 @@ available to user running opengrok with all permissions. In root user case
 it will create all the directories needed, otherwise you have to manually
 create the directory and grant all permissions to the user used.
 
-4.2.2 - Populate DATA_ROOT Directory
+5.2.2 - Populate DATA_ROOT Directory
 ------------------------------------
 
 During this process the indexer will generate OpenGrok XML configuration file
@@ -221,7 +245,7 @@ OPENGROK_CONFIGURATION environment variable to point to it. Obviously such
 setups can be used for nightly cron job updates of index or other automated
 purposes.
 
-4.3 Using SMF service (Solaris) to maintain OpenGrok indexes
+5.3 Using SMF service (Solaris) to maintain OpenGrok indexes
 ------------------------------------------------------------
 
 If you installed OpenGrok from the OSOLopengrok package, it will work out of
@@ -260,12 +284,12 @@ Note: before removing the package please disable the service.
 If you don't do it, it will not be removed automatically.
 In such case please remove it manually.
 
-4.4 Using command line interface to create indexes
+5.4 Using command line interface to create indexes
 --------------------------------------------------
 
 There are 2 (or 3) steps needed for this task.
 
-4.4.1 - Populate DATA_ROOT Directory
+5.4.1 - Populate DATA_ROOT Directory
 ------------------------------------
 
 Option 1. OpenGrok: There is a sample shell script OpenGrok that is suitable
@@ -281,7 +305,7 @@ hypertext files generated by OpenGrok are to be stored in DATA_ROOT, run
 
 See opengrok.jar manual below for more details.
 
-4.4.2 - Configure and Deploy source.war Webapp
+5.4.2 - Configure and Deploy source.war Webapp
 ----------------------------------------------
 
 To configure the webapp source.war, look into the parameters defined in
@@ -299,7 +323,7 @@ web.xml of source.war file and change them (see note1) appropriately.
 	 The contents of this file file will be appended to the footer of each
 	 web page after the information about last index update.
 
-4.4.3 - Path Descriptions (optional)
+5.4.3 - Path Descriptions (optional)
 ------------------------------------
 
 OpenGrok can use path descriptions in various places (e.g. while showing
@@ -330,7 +354,7 @@ then the paths.tsv file contents can look like this:
 
 Note that only some paths can have a description.
 
-4.4.4 - Changing webapp parameters (optional)
+5.4.4 - Changing webapp parameters (optional)
 ---------------------------------------------
 
 web.xml is the deployment descriptor for the web application. It is in a Jar
@@ -379,7 +403,7 @@ file named source.war, you can change it as follows:
 
      This file will contain something like the Context described above.
 
-4.4.5 Custom ctags configuration
+5.4.5 Custom ctags configuration
 --------------------------------
 
 To make ctags recognize additional symbols/definitions/etc. it is possible to
@@ -394,7 +418,7 @@ the full path to the file will be /var/opengrok/etc/ctags.config).
 Sample configuration file for Solaris code base is delivered in the doc/
 directory.
 
-4.5 Using Java DB for history cache
+5.5 Using Java DB for history cache
 -----------------------------------
 
 By default OpenGrok stores history indexes in gzipped xml files. An alternative
@@ -486,7 +510,7 @@ the JavaDB data directory and add this line to it:
           /var/lib/javadb/data/derby.properties
 
 
-5. Optional Command Line Interface Usage
+6. Optional Command Line Interface Usage
 ----------------------------------------
 
 You need to pass location of project file + the query to Search class, e.g.
@@ -500,7 +524,7 @@ do:
 
   $ java -cp ./opengrok.jar org.opensolaris.opengrok.search.Search
 
-6. Change web application properties or name
+7. Change web application properties or name
 --------------------------------------------
 
 You might need to modify the web application if you don't store the
@@ -546,7 +570,7 @@ Deploy the modified .war file in tomcat:
 
   * just copy the source.war file to TOMCAT_INSTALL/webapps directory.
 
-7. OpenGrok systray
+8. OpenGrok systray
 -------------------
 
 The indexer can be setup with agent and systray GUI control application.
@@ -572,10 +596,10 @@ localhost, but rather on a physical network interface).
 
 This agent is work in progress, so it might not fully work.
 
-8. Information for developers
+9. Information for developers
 -----------------------------
 
-8.0 Building
+9.0 Building
 ------------
 
 Just run 'ant' from command line in the top-level directory or use build
@@ -585,13 +609,13 @@ Note: in case you are behind http proxy, use ANT_OPTS to download jflex, lucene
 E.g. $ ANT_OPTS="-Dhttp.proxyHost=?.? -Dhttp.proxyPort=80" ant
 
 
-8.0.1 Package build
+9.0.1 Package build
 -------------------
 
 Run 'ant package' to create package (specific for the operating system this is
 being executed on) under the dist/ directory.
 
-8.1 Unit testing
+9.1 Unit testing
 ----------------
 
 Note: For full coverage report your system has to provide proper junit test 
@@ -620,7 +644,7 @@ The tests are then run as follows:
 To check if the test completed without error look for AssertionFailedError
 occurences in the TESTS-TestSuites.xml file produced by the test run.
 
-8.2 Using Findbugs
+9.2 Using Findbugs
 ------------------
 
 If you want to run Findbugs (http://findbugs.sourceforge.net/) on OpenGrok,
@@ -655,7 +679,7 @@ under the lib directory):
 There is also a findbugs-xml ant target that can be used to generate XML files
 that can later be parsed, e.g. by Jenkins.
 
-8.3 Using Emma
+9.3 Using Emma
 --------------
 
 If you want to check test coverage on OpenGrok, download Emma from
@@ -706,7 +730,7 @@ To generate reports, run ant again:
 Look at coverage/coverage.txt, coverage/coverage.xml and 
 coverage/coverage.html to see how complete your tests are.
 
-8.4 Using Checkstyle
+9.4 Using Checkstyle
 --------------------
 
 To check that your code follows the standard coding conventions,
@@ -740,7 +764,7 @@ checkstyle under the lib directory):
 
   $ ant checkstyle -Dcheckstyle.home=lib/checkstyle
 
-8.5 Using PMD and CPD
+9.5 Using PMD and CPD
 ---------------------
 
 To check the quality of the OpenGrok code you can also use PMD
@@ -784,7 +808,7 @@ Which will result in:
   $ ls pmd
   cpd_report.xml cpd_report.txt
 
-8.6 Using JDepend
+9.6 Using JDepend
 -----------------
 
 To see dependencies in the source code, you can use JDepend from
@@ -807,7 +831,7 @@ Output is stored in the jdepend directory:
   $ ls jdepend/
   report.txt  report.xml
 
-8.7 Using SonarQube
+9.7 Using SonarQube
 -------------------
 
 Use a sonar runner with included sonar-project.properties properties, 
@@ -820,15 +844,15 @@ e.g. using bash:
     -Dsonar.host.url=http://${SERVERIP}:9000 
     -Dsonar.jdbc.url=jdbc:h2:tcp://${SERVERIP}:9092/sonar
 
-8.8 Using Travis CI
+9.8 Using Travis CI
 -------------------
 
 Please see .travis.yml, if your branch has this file,
 you should be able to connect your Github to Travis CI.
 OpenGroks Travis is here: https://travis-ci.org/OpenGrok/OpenGrok
 
 
-9. Tuning OpenGrok for large code bases
+10. Tuning OpenGrok for large code bases
 ---------------------------------------
 
 While indexing big source repos you might consider using ZFS filesystem to give 
@@ -886,7 +910,7 @@ the project list when requesting search results):
 Refer to docs of other containers for more info on how to achieve the same.
 
 
-10. Authors
+11. Authors
 -----------
 
 The project has been originally conceived in Sun Microsystems by Chandan B.N.
@@ -899,7 +923,7 @@ Knut Anders Hatlen, Oracle. http://blogs.oracle.com/kah/
 Lubos Kosco, Oracle. http://blogs.oracle.com/taz/
 Vladimir Kotal, Oracle. http://blogs.oracle.com/vlad/
 
-11. Contact us
+12. Contact us
 --------------
 
 Feel free to participate in discussion on [email protected].

build.xml

@@ -394,6 +394,9 @@ Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
         <exec os="SunOS" executable="/usr/bin/pkgtrans" failonerror="true">
             <arg line="-s build ../dist/OSOLopengrok-${version}.pkg OSOLopengrok"/>
         </exec>
+	<exec os="SunOS" executable="platform/solaris/ips/create.sh" failonerror="true">
+	    <arg line="-v ${version}"/>
+	</exec>
     </target>
 
     <target name="dist" depends="jar">

doc/release.txt

@@ -41,6 +41,29 @@ to produce the archive
 
   ant dist
   ant package
+	
+The command above creates both formats of package .pkg and .p5p into the directory dist
+
+
+Note that for the IPS package *.p5p the version names are translated this way:
+0.12          ~       0.12.0.1.0
+0.<n>         ~       0.<n>.0.1.0
+...
+
+0.12-rc1      ~       0.12.0.0.1
+0.12-rc<i>    ~       0.12.0.0.<i>
+...
+
+(Note that the release candidate must follow imediately after the basic version number (0.12))
+
+
+0.12.1        ~       0.12.1.0.0
+0.12.<j>      ~       0.12.<j>.0.0
+...
+
+0.12.0.1      ~       0.12.0.1.1
+0.12.0.<k>    ~       0.12.0.1.<k>
+...
 
 5) Upload them using https://github.com/OpenGrok/OpenGrok/releases