Skip to content

Commit 6c6e76d

Browse files
authored
Merge pull request #1343 from vladak/management_eol
Management eol of the systray
2 parents 0baa2c8 + dc0b0b0 commit 6c6e76d

35 files changed

+27
-5590
lines changed

README.txt

Lines changed: 26 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#
2-
# Copyright (c) 2006, 2016, Oracle and/or its affiliates. All rights reserved.
2+
# Copyright (c) 2006, 2017, Oracle and/or its affiliates. All rights reserved.
33
#
44

55

@@ -13,11 +13,10 @@ OpenGrok - a wicked fast source browser
1313
5. OpenGrok setup
1414
6. Optional Command Line Interface Usage
1515
7. Change web application properties or name
16-
8. OpenGrok systray
17-
9. Information for developers
18-
10. Tuning OpenGrok for large code bases
19-
11. Authors
20-
12. Contact us
16+
8. Information for developers
17+
9. Tuning OpenGrok for large code bases
18+
10. Authors
19+
11. Contact us
2120

2221

2322
1. Introduction
@@ -694,36 +693,11 @@ Deploy the modified .war file in tomcat:
694693

695694
* just copy the source.war file to TOMCAT_INSTALL/webapps directory.
696695

697-
8. OpenGrok systray
698-
-------------------
699-
700-
The indexer can be setup with agent and systray GUI control application.
701-
This is optional step for those who wish to monitor and configure OpenGrok
702-
from their desktop using systray application.
703-
704-
An example opengrok-agent.properties file is provided, which can be used when
705-
starting special OpenGrok Agent, where you can connect with a systray GUI
706-
application.
707-
708-
To start the indexer with configuration run:
709-
710-
$ java -cp ./opengrok.jar org.opensolaris.opengrok.management.OGAgent \
711-
--config opengrok-agent.properties
712-
713-
Then from the remote machine one can run:
714-
715-
$ java -cp ./opengrok.jar \
716-
org.opensolaris.opengrok.management.client.OpenGrokTrayApp
717-
718-
assuming configuration permits remote connections (i.e. not listening on
719-
localhost, but rather on a physical network interface).
720-
721-
This agent is work in progress, so it might not fully work.
722696

723-
9. Information for developers
697+
8. Information for developers
724698
-----------------------------
725699

726-
9.0 Building
700+
8.0 Building
727701
------------
728702

729703
Just run 'ant' from command line in the top-level directory or use build
@@ -733,13 +707,13 @@ Note: in case you are behind http proxy, use ANT_OPTS to download jflex, lucene
733707
E.g. $ ANT_OPTS="-Dhttp.proxyHost=?.? -Dhttp.proxyPort=80" ant
734708

735709

736-
9.0.1 Package build
710+
8.0.1 Package build
737711
-------------------
738712

739713
Run 'ant package' to create package (specific for the operating system this is
740714
being executed on) under the dist/ directory.
741715

742-
9.1 Unit testing
716+
8.1 Unit testing
743717
----------------
744718

745719
Note: For full coverage report your system has to provide proper junit test
@@ -763,7 +737,7 @@ The tests are then run as follows:
763737
To check if the test completed without error look for AssertionFailedError
764738
occurences in the TESTS-TestSuites.xml file produced by the test run.
765739

766-
9.2 Using Findbugs
740+
8.2 Using Findbugs
767741
------------------
768742

769743
If you want to run Findbugs (http://findbugs.sourceforge.net/) on OpenGrok,
@@ -798,7 +772,7 @@ under the lib directory):
798772
There is also a findbugs-xml ant target that can be used to generate XML files
799773
that can later be parsed, e.g. by Jenkins.
800774

801-
9.3 Using Jacoco
775+
8.3 Using Jacoco
802776
--------------
803777

804778
If you want to check test coverage on OpenGrok, download jacoco from
@@ -813,7 +787,7 @@ Now you should get output data in jacoco.exec
813787

814788
Look at jacoco/index.html to see how complete your tests are.
815789

816-
9.4 Using Checkstyle
790+
8.4 Using Checkstyle
817791
--------------------
818792

819793
To check that your code follows the standard coding conventions,
@@ -846,7 +820,7 @@ checkstyle under the lib directory):
846820

847821
$ ant checkstyle -Dcheckstyle.home=lib/checkstyle
848822

849-
9.5 Using PMD and CPD
823+
8.5 Using PMD and CPD
850824
---------------------
851825

852826
To check the quality of the OpenGrok code you can also use PMD
@@ -883,7 +857,7 @@ Which will result in:
883857
$ ls pmd
884858
cpd_report.xml cpd_report.txt
885859

886-
9.6 Using JDepend
860+
8.6 Using JDepend
887861
-----------------
888862

889863
To see dependencies in the source code, you can use JDepend from
@@ -906,7 +880,7 @@ Output is stored in the jdepend directory:
906880
$ ls jdepend/
907881
report.txt report.xml
908882

909-
9.7 Using SonarQube
883+
8.7 Using SonarQube
910884
-------------------
911885

912886
Use a sonar runner with included sonar-project.properties properties,
@@ -919,7 +893,7 @@ e.g. using bash:
919893
-Dsonar.host.url=http://${SERVERIP}:9000
920894
-Dsonar.jdbc.url=jdbc:h2:tcp://${SERVERIP}:9092/sonar
921895

922-
9.8 Using Travis CI
896+
8.8 Using Travis CI
923897
-------------------
924898

925899
Travis depends on updated and working maven build.
@@ -928,13 +902,13 @@ you should be able to connect your Github to Travis CI.
928902
OpenGroks Travis is here: https://travis-ci.org/OpenGrok/OpenGrok
929903

930904

931-
9.9 Maven
905+
8.9 Maven
932906
------------------
933907
The build can now be done through Maven (https://maven.apache.org/) which takes care of the dependency management
934908
and setup (calls Ant for certain actions).
935909

936910

937-
9.9.1 Unit Testing
911+
8.9.1 Unit Testing
938912
-------------------------
939913
You can test the code at the moment by running `./mvn test` which will execute *all* tests.
940914
Conditionally, if you don't have every type of repository installed, you can set it to unit-test only those which are
@@ -946,10 +920,10 @@ You can also force a specific repository test from running through the following
946920

947921
> ./mvnw test -Djunit-force-all=false -Djunit-force-git=true
948922

949-
10. Tuning OpenGrok for large code bases
923+
9. Tuning OpenGrok for large code bases
950924
---------------------------------------
951925

952-
10.1 Almost atomic index flip using ZFS
926+
9.1 Almost atomic index flip using ZFS
953927
---------------------------------------
954928

955929
While indexing big source repos you might consider using ZFS filesystem to give
@@ -960,7 +934,7 @@ incrementally index in parallel to having the current sources and index in sync.
960934
the ones that were updated by SCM/index and start tomcat again - outage is
961935
minimal, sources+indexes are ALWAYS in sync, users see the truth)
962936

963-
10.2 JVM tuning
937+
9.2 JVM tuning
964938
---------------
965939

966940
OpenGrok script by default uses 2G of heap and 16MB per thread for flush size of
@@ -1001,7 +975,7 @@ For tomcat you can easily get this done by creating conf/setenv.sh:
1001975

1002976
export JAVA_OPTS
1003977

1004-
10.3 Tomcat/Apache tuning
978+
9.3 Tomcat/Apache tuning
1005979
-------------------------
1006980

1007981
For tomcat you might also hit a limit for http header size (we use it to send
@@ -1018,7 +992,7 @@ The same tuning to Apache can be done with the LimitRequestLine directive:
1018992
LimitRequestLine 65536
1019993
LimitRequestFieldSize 65536
1020994

1021-
10.4 Open File hard and soft limits
995+
9.4 Open File hard and soft limits
1022996
-----------------------------------
1023997

1024998
The initial index creation process is resource intensive and often the error
@@ -1028,15 +1002,15 @@ avoid this increase the ulimit value to a higher number.
10281002
It is noted that the hard and soft limit for open files of 10240 works for mid
10291003
sized repositores and so the recommendation is to start with 10240.
10301004

1031-
10.5 Multi-project search speed tip
1005+
9.5 Multi-project search speed tip
10321006
-----------------------------------
10331007

10341008
If multi-project search is performed frequently, it might be good to warm
10351009
up file system cache after each reindex. This can be done e.g. with
10361010
https://github.com/hoytech/vmtouch
10371011

10381012

1039-
11. Authors
1013+
10. Authors
10401014
-----------
10411015

10421016
The project has been originally conceived in Sun Microsystems by Chandan B.N.
@@ -1049,7 +1023,7 @@ Knut Anders Hatlen, Oracle. http://blogs.oracle.com/kah/
10491023
Lubos Kosco, Oracle. http://blogs.oracle.com/taz/
10501024
Vladimir Kotal, Oracle. http://blogs.oracle.com/vlad/
10511025

1052-
12. Contact us
1026+
11. Contact us
10531027
--------------
10541028

10551029
Feel free to participate in discussion on the mailing lists:

build.xml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -114,13 +114,6 @@ Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
114114

115115
<property name="mvn.repository" value="http://repo1.maven.org/maven2"/>
116116

117-
<available property="compileSystrayClient" classname="java.awt.TrayIcon"/>
118-
119-
<target name="-exclude-client" unless="compileSystrayClient">
120-
<echo>JDK doesn't have java.awt.TrayIcon, excluding building of systray client ... </echo>
121-
<property name="excludes" value="org/opensolaris/opengrok/management/client/**"/>
122-
</target>
123-
124117
<property name="jflex-version" value="1.6.1"/>
125118

126119
<path id="lib.search.path">
@@ -325,7 +318,7 @@ Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
325318
</target>
326319

327320
<!-- injecting jacoco, too -->
328-
<target name="-pre-init" depends="-touch-manifest, -exclude-client, -set-jacocoagent"/>
321+
<target name="-pre-init" depends="-touch-manifest, -set-jacocoagent"/>
329322

330323
<!--
331324
Initialize a property holding a list of jar files on which

nbproject/configs/Agent.properties

Lines changed: 0 additions & 1 deletion
This file was deleted.

nbproject/configs/Tray.properties

Lines changed: 0 additions & 1 deletion
This file was deleted.

opengrok-indexer/pom.xml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,6 @@ Copyright (c) 2010, 2011, Oracle and/or its affiliates. All rights reserved.
6060
<directory>../src/org/opensolaris/opengrok/index/</directory>
6161
<excludes><exclude>*.java</exclude></excludes>
6262
</resource>
63-
<resource>
64-
<targetPath>org/opensolaris/opengrok/management/</targetPath>
65-
<directory>../src/org/opensolaris/opengrok/management/</directory>
66-
<includes>
67-
<include>*.properties</include>
68-
<include>**/*.gif</include>
69-
</includes>
70-
</resource>
7163
<resource>
7264
<targetPath>org/opensolaris/opengrok/history/</targetPath>
7365
<directory>../src/org/opensolaris/opengrok/history/</directory>

0 commit comments

Comments
 (0)