diff options
| author | Christian Lohmaier <lohmaier+github@googlemail.com> | 2012-08-03 14:58:14 +0200 |
|---|---|---|
| committer | Christian Lohmaier <lohmaier+github@googlemail.com> | 2012-08-03 14:58:14 +0200 |
| commit | 9a6825135771e9960015f442c7ec23e3093e085e (patch) | |
| tree | 862e635d4295f119d8c6f16540701cf2b2941c79 | |
| parent | 821f927e6842e8be1d624fad3b21de0f52bb842c (diff) | |
fdo#52320: move opengrok stuff to githubopengrok
56 files changed, 5 insertions, 3612 deletions
diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 080b239..0000000 --- a/.gitignore +++ /dev/null @@ -1 +0,0 @@ -lib/source.war diff --git a/INSTALL b/INSTALL deleted file mode 100644 index bae8479..0000000 --- a/INSTALL +++ /dev/null @@ -1,12 +0,0 @@ -Requirements - * Tomcat - -Install OpenGrok - - * Clone this branch of the website git repository into /usr/local/share/opengrok - * Copy the bin/opengrok into the PATH, eg: /usr/local/bin and adapt the path to - the data and tomcat locations. - * Copy the bin/update-opengrok into the $HOME/bin of the user running opengrok - * Copy the opengrok-config.xml file in the home of the user running opengrok - - diff --git a/MOVED_TO_GITHUB b/MOVED_TO_GITHUB new file mode 100644 index 0000000..fabf6f8 --- /dev/null +++ b/MOVED_TO_GITHUB @@ -0,0 +1,5 @@ +This branch of the repository has been split out/moved to + +https://github.com/tdf/www-opengrok + +See https://bugs.freedesktop.org/show_bug.cgi?id=52320 for details. diff --git a/bin/OpenGrok b/bin/OpenGrok deleted file mode 100755 index 39acbba..0000000 --- a/bin/OpenGrok +++ /dev/null @@ -1,757 +0,0 @@ -#!/bin/sh -# -# OpenGrok Wrapper (initial setup and cron job updating) -# -# Supported Operating Systems: -# - Solaris 10 (SunOS 5.10) -# - OpenSolaris (SunOS 5.11) -# - Debian (Linux) -# -# Supported Deployment Engines: -# - Tomcat 6 -# - Tomcat 5.5 -# - Glassfish -# -# Supported Environment Variables: -# - OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages (*) -# - OPENGROK_STANDARD_ENV Run Time Shell Environment (Shell Script) -# - OPENGROK_CONFIGURATION User Configuration (Shell Script) -# -# Supported Environment Variables for configuring the default setup: -# - OPENGROK_DISTRIBUTION_BASE Base Directory of the OpenGrok Distribution -# - OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area -# - EXUBERANT_CTAGS Full Path to Exuberant CTags -# - JAVA_HOME Full Path to Java Installation Root -# - OPENGROK_APP_SERVER Application Server ("Tomcat" or "Glassfish") -# - OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory -# - OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory -# - OPENGROK_WAR_TARGET Fallback WAR Target Directory -# - OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps) -# - OPENGROK_GLASSFISH_BASE Base Directory for Glassfish (contains domains) -# - OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name -# - OPENGROK_VERBOSE Enable Verbose Mode in opengrok.jar (*) -# - OPENGROK_REMOTE_REPOS Disable History Cache for (remote) Repositories (*) -# - OPENGROK_SCAN_REPOS Disable Scan for repositories (*)_ -# - OPENGROK_SCAN_DEPTH how deep should scanning for repos go (by default 3 directories from SRC_ROOT) -# -# - READ_XML_CONFIGURATION file with read only configuration - a temp workaround for bug # 327 -# -# Notes: -# (*) Any Non-Empty String will enable these options -# - -# -# Usage -# - -Usage() -{ - echo 1>&2 - echo "Usage: ${0} <deploy|update|updateQuietly|usage>" 1>&2 - echo " ${0} index [<directory>]" 1>&2 - echo 1>&2 - echo " Optional environment variables:" 1>&2 - echo " OPENGROK_CONFIGURATION - location of your configuration" 1>&2 - echo " e.g. $ OPENGROK_CONFIGURATION=/var/opengrok/myog.conf ${0} ... " 1>&2 - echo 1>&2 - echo " See the code for more information on configuration options / variables" 1>&2 - echo 1>&2 - exit 1 -} - -# -# Runtime Configuration -# - -OS_NAME="`/bin/uname -s`" -OS_VERSION="`/bin/uname -r`" - -# TODO: Handle symlinks correctly (especially in ${0}) -SCRIPT_DIRECTORY="`dirname ${0}`" -SCRIPT_DIRECTORY="`cd ${SCRIPT_DIRECTORY}; pwd`" - -# -# Default Instance Configuration -# - -DefaultInstanceConfiguration() -{ - # Use the built-in defaults. This section can be copied to its own - # file and tailored to your local requirements. Then simply set - # OPENGROK_CONFIGURATION=/path/to/your/configuration, before using - # this wrapper. It will save you hand editing in your settings - # on each new release. A sample cron(1M) entry might look like: - # 15 0 * * * OPENGROK_CONFIGURATION=/pkgs/etc/OpenGrok.sh /pkgs/sbin/OpenGrok updateQuietly - - # Note: It is not really possible to ever provided defaults for - # these values which will run in every UNIX-like environment. - # So I have provided a set which are functional for a given - # environment on which you can based you own configuration. - - # This has been updated to support more environment variables and - # operating systems, if you have any reasonably generic - # improvements please feel free to submit a patch. - - OPENGROK_INSTANCE_BASE="${OPENGROK_INSTANCE_BASE:-/var/opengrok}" - - LOGGER_CONFIG_FILE="logging.properties" - - if [ -z "${OPENGROK_DISTRIBUTION_BASE}" ] - then - if [ -d "${SCRIPT_DIRECTORY}/dist" -a \ - -f "${SCRIPT_DIRECTORY}/dist/opengrok.jar" -a \ - -f "${SCRIPT_DIRECTORY}/dist/source.war" \ - ] - then - # Handle Developer Build Environments - OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/dist" - LOGGER_CONF_SOURCE="${SCRIPT_DIRECTORY}/${LOGGER_CONFIG_FILE}" - else - # Handle Binary Distributions - OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/../lib" - LOGGER_CONF_SOURCE="${OPENGROK_DISTRIBUTION_BASE}/../doc/${LOGGER_CONFIG_FILE}" - fi - fi - - # REQUIRED: Source Code/Repository Root - # (your source code or the root of all repositories) - SRC_ROOT="${OPENGROK_INSTANCE_BASE}/src" - - # REQUIRED: OpenGrok Generate Data Root - # (for Lucene index and hypertext cross-references) - # This area is rebuilt by "update" / "updateQuietly" - DATA_ROOT="${OPENGROK_INSTANCE_BASE}/data" - - # OPTIONAL: User Provided Source Path to Description Mapping (Tab Separated Value) - # (The user maintained source of the generated EftarFile file) - PATH_DESC="${OPENGROK_INSTANCE_BASE}/etc/paths.tsv" - - # REQUIRED: XML Configuration - # (the configuration used by Web/GUI interfaces) - XML_CONFIGURATION="${OPENGROK_INSTANCE_BASE}/etc/configuration.xml" - - # OPTIONAL: read only XML config, if it exists, it will be read - READ_XML_CONFIGURATION="${READ_XML_CONFIGURATION:-}" - - if [ -f "${READ_XML_CONFIGURATION}" ] ; then - READ_XML_CONF="-R ${READ_XML_CONFIGURATION}" - fi - - # REQUIRED: Logger Configuration - LOGGER_CONFIG_PATH="${OPENGROK_INSTANCE_BASE}/${LOGGER_CONFIG_FILE}" - LOGGER_PROPERTIES="-Djava.util.logging.config.file=${LOGGER_CONFIG_PATH}" - - # REQUIRED: Java Archive of OpenGrok (Installation Location) - OPENGROK_JAR="${OPENGROK_DISTRIBUTION_BASE}/opengrok.jar" - - # REQUIRED(deploy): Web Archive of OpenGrok (Distribution Location) - # (user building from source code will find this and other key - # files in the "dist" directory after the build is completed) - OPENGROK_DIST_WAR="${OPENGROK_DISTRIBUTION_BASE}/source.war" - - # REQUIRED: Exuberant CTags (http://ctags.sf.net) - EXUBERANT_CTAGS="${EXUBERANT_CTAGS:-`FindExuberantCTags`}" - - # REQUIRED: Java Home - JAVA_HOME="${JAVA_HOME:-`FindJavaHome`}" - export JAVA_HOME - - # REQUIRED: Java Virtual Machine - JAVA="${JAVA:-$JAVA_HOME/bin/java}" - - # DEVELOPMENT: Debug option, if enabled current indexer will listen on the port 8010 until a debugger connects - #JAVA_DEBUG="-agentlib:jdwp=transport=dt_socket,server=y,address=8010,suspend=y" - - # OPTIONAL: Ignore these patterns as names of files or directories - #IGNORE_PATTERNS="-i dummy" - - # OPTIONAL: Enable Projects - # (Every directory in SRC_ROOT is considered a separate project) - ENABLE_PROJECTS="-P" - - # OPTIONAL: Scanning Options (for Mercurial repositories) - SCAN_FOR_REPOSITORY="-S" - if [ ! -z "${OPENGROK_SCAN_REPOS}" ] - then - SCAN_FOR_REPOSITORY="" - fi - - # OPTIONAL: Remote Repository Support (CVS or SVN) - # (Can be very time demanding, uncomment if needed) - REMOTE_REPOSITORIES="-r on" - if [ ! -z "${OPENGROK_REMOTE_REPOS}" ] - then - REMOTE_REPOSITORIES="" - fi - - # OPTIONAL: override depth of scanning for repositories - if [ ! -z "${OPENGROK_SCAN_DEPTH}" ] - then - SCAN_DEPTH="-z${OPENGROK_SCAN_DEPTH}" - fi - - # OPTIONAL: Allow Leading Wildcard Searches - # (default: off) - #LEADING_WILDCARD="-a on" - - # OPTIONAL: Web Site Look & Feel - # (Options: default, offwhite and polished. - # Note the quoting requirements) - #SKIN='-L "default"' - - # OPTIONAL: Set Maximum Indexed Words Per File - # Note, that you might run out of memory, then either increase JVM memory - # as noted in JAVA_OPTS, or set this limit(if you don't mind opengrok not - # indexing the rest of the file, once the limit is reached) - # (default: unlimited) - #MAX_INDEXED_WORDS="-m 100000" - - # OPTIONAL: Configuration Address (host:port) - # (conf/web.xml default is localhost:2424) - WEBAPP_CONFIG_ADDRESS="-U localhost:2424" - - # OPTIONAL: JVM Options - #JAVA_OPTS="-server -Xmx2048m" - JAVA_OPTS="-Xmx2048m" - - # OPTIONAL: Full Path to History Utilities - HG="`Which hg`" - CVS="`Which cvs`" - SVN="`Which svn`" - SCCS="`Which sccs`" - CLEARCASE="`Which cleartool`" - GIT="`Which git`" - P4="`Which p4`" - MTN="`Which mtn`" - BZR="`Which bzr`" - - # OPTIONAL: Override Built-in Properties - # Assumption: We should not set properties to the empty string - PROPERTIES="\ -${HG:+-Dorg.opensolaris.opengrok.history.Mercurial=$HG} \ -${CVS:+-Dorg.opensolaris.opengrok.history.cvs=$CVS} \ -${SVN:+-Dorg.opensolaris.opengrok.history.Subversion=$SVN} \ -${SCCS:+-Dorg.opensolaris.opengrok.history.SCCS=$SCCS} \ -${CLEARCASE:+-Dorg.opensolaris.opengrok.history.ClearCase=$CLEARCASE} \ -${GIT:+-Dorg.opensolaris.opengrok.history.git=$GIT} \ -${P4:+-Dorg.opensolaris.opengrok.history.Perforce=$P4} \ -${MTN:+-Dorg.opensolaris.opengrok.history.Monotone=$MTN} \ -${BZR:+-Dorg.opensolaris.opengrok.history.Bazaar=$BZR} \ -" - - # OPTIONAL: Store The History Cache in Java DB (derby), - # instead of file system (in gzipped xml files). - # - # Requirements: - # - derbyclient.jar - See README.txt for more details - # - Running Derby Server - Defaults to localhost:1527 - # - #DERBY_HISTORY_CACHE=-D - - # DELIVERED: An update program for EftarFile - # Usage: <class> inputFile [inputFile ...] outputFile - # EftarFile == An Extremely Fast Tagged Attribute Read-only File System - EFTAR_UPDATE="org.opensolaris.opengrok.web.EftarFile" - - # HARDCODED: Generated EftarFile (See web/*.jsp) - EFTAR_OUTPUT_FILE="${DATA_ROOT}/index/dtags.eftar" - - # Be Quiet? (set indirectly by command line arguments in the main program) - #QUIET="" - - # or alternatively, Be Verbose! - #VERBOSE="-v" - - if [ ! -z "${OPENGROK_VERBOSE}" ] - then - VERBOSE="-v" - QUIET="" - fi -} - -# -# Helper Functions - Logging -# -# In general, non-interactive use like cron jobs and automated -# installation environments should not generate unnecessary -# progress information or warnings, as usage and configuration -# will have generally been debugged prior to automation. -# - -Progress() -{ - if [ -z "${OPENGROK_NON_INTERACTIVE}" ] - then - echo "${@}" - fi -} - -Warning() -{ - if [ -z "${OPENGROK_NON_INTERACTIVE}" ] - then - echo "WARNING: ${@}" 1>&2 - fi -} - -Error() -{ - echo "ERROR: ${@}" 1>&2 -} - -FatalError() -{ - echo 1>&2 - echo "FATAL ERROR: ${@} - Aborting!" 1>&2 - echo 1>&2 - ${DO} exit 2 -} - -# -# Helper Functions - Autodetection of Runtime Environment -# - -Which() -{ - path="`which ${1} 2>/dev/null`" - - if [ -x "${path}" ] - then - echo "${path}" - fi -} - -FindExuberantCTags() -{ - case "${OS_NAME}:${OS_VERSION}" in - SunOS:5.10) commandName="" ;; - SunOS:5.11) commandName="exctags" ;; - Linux:*) commandName="ctags-exubertant";; - *) commandName="" ;; - esac - - if [ -z "${commandName}" ] - then - Error "Unable to determine Exuberant CTags command name" \ - "for ${OS_NAME} ${OS_VERSION}" - return - fi - - Which "${commandName}" -} - -FindJavaHome() -{ - case "${OS_NAME}:${OS_VERSION}" in - SunOS:5.10) javaHome="/usr/jdk/instances/jdk1.6.0" ;; - SunOS:5.11) javaHome="/usr/jdk/latest" ;; - Linux:*) javaHome="/usr/lib/jvm/java-6-sun" ;; - *) javaHome="" ;; - esac - - if [ -z "${javaHome}" ] - then - Error "Unable to determine Java 6 Home" \ - "for ${OS_NAME} ${OS_VERSION}" - return - fi - - if [ ! -d "${javaHome}" ] - then - Error "Missing Java Home ${javaHome}" - return - fi - - echo "${javaHome}" -} - -FindApplicationServerType() -{ - # Use this function to determine which environment the deploy the - # web application function into. Some users (especially - # developers) will have many deployment environments or will wish - # to specify directly the application server to deploy to. - - # Either use the environment variable OPENGROK_APP_SERVER or - # reimplement this function in your configuration file (as - # specified by OPENGROK_CONFIGURATION) - - if [ -n "${OPENGROK_APP_SERVER}" ] - then - echo "${OPENGROK_APP_SERVER}" - return - fi - - # This implementation favours Tomcat, but needs a lot of work, - # especially if Glassfish is perferrerd or it is under the control - # of SMF (Service Management Facility) - - # Maybe a better implementation would be to call Application - # Server specific WAR Directory and see if they exist. - - if [ -d "/var/tomcat6/webapps" \ - -o -d "/var/lib/tomcat6/webapps" \ - -o -d "/var/lib/tomcat5.5/webapps" \ - ] - then - echo "Tomcat" - return - fi - - if [ -x "/etc/init.d/appserv" -a -d "/var/appserver/domains" ] - then - echo "Glassfish" - return - fi - - # Assume Tomcat - echo "Tomcat" -} - -DetermineWarDirectoryTomcat() -{ - if [ -n "${OPENGROK_WAR_TARGET_TOMCAT}" ] - then - echo "${OPENGROK_WAR_TARGET_TOMCAT}" - return - elif [ -n "${OPENGROK_WAR_TARGET}" ] - then - echo "${OPENGROK_WAR_TARGET}" - return - fi - - for prefix in \ - ${OPENGROK_TOMCAT_BASE} \ - /var/tomcat6 \ - /var/lib/tomcat6 \ - /var/lib/tomcat5.5 \ - - do - if [ -d "${prefix}/webapps" ] - then - echo "${prefix}/webapps" - return - fi - done -} - -DetermineWarDirectoryGlassfish() -{ - - if [ -n "${OPENGROK_WAR_TARGET_GLASSFISH}" ] - then - echo "${OPENGROK_WAR_TARGET_GLASSFISH}" - return - elif [ -n "${OPENGROK_WAR_TARGET}" ] - then - echo "${OPENGROK_WAR_TARGET}" - return - fi - - for prefix in \ - ${OPENGROK_GLASSFISH_BASE} \ - /var/appserver \ - - do - if [ -d "${prefix}/domains" ] - then - if [ -z "${domainDirectory}" ] - then - domainDirectory="${prefix}/domains" - fi - fi - done - - if [ -z "${domainDirectory}" ] - then - return - fi - - # User Specified Domain - if [ -n "${OPENGROK_GLASSFISH_DOMAIN}" ] - then - directory="${domainDirectory}/${OPENGROK_GLASSFISH_DOMAIN}/autodeploy" - - if [ ! -d "${directory}" ] - then - FatalError "Missing Specified Glassfish Domain ${OPENGROK_GLASSFISH_DOMAIN}" - fi - - echo "${directory}" - return - fi - - # Arbitrary Domain Selection - firstDomain=`ls -1 ${domainDirectory} | head -1` - - if [ -z "${firstDomain}" ] - then - FatalError "Failed to dynamically determine Glassfish Domain from ${domainDirectory}" - fi - - echo "${domainDirectory}/${firstDomain}/autodeploy" -} - -# -# Implementation -# -# The variable "DO" can usefully be set to "echo" to aid in script debugging -# - -LoadStandardEnvironment() -{ - # Setup a standard execution environment (if required) - - OPENGROK_STANDARD_ENV="${OPENGROK_STANDARD_ENV:-/pkgs/sbin/CronExecutionEnvironment.sh}" - - if [ -f "${OPENGROK_STANDARD_ENV}" ] - then - Progress "Loading ${OPENGROK_STANDARD_ENV} ..." - . "${OPENGROK_STANDARD_ENV}" - fi -} - -LoadInstanceConfiguration() -{ - # Note: As all functions have been defined by the time this routine - # is called, your configuration can, if desired, override functions - # in addition to setting the variables mentioned in the function - # DefaultInstanceConfiguration(), this maybe useful to override - # functionality used to determine the default deployment environment - # find dependencies or validate the configuration, for example. - - if [ -n "${OPENGROK_CONFIGURATION}" -a -f "${OPENGROK_CONFIGURATION}" ] - then - # Load the Local OpenGrok Configuration Environment - Progress "Loading ${OPENGROK_CONFIGURATION} ..." - . "${OPENGROK_CONFIGURATION}" - else - Progress "Loading the default instance configuration ..." - DefaultInstanceConfiguration - fi -} - -ValidateConfiguration() -{ - if [ ! -x "${EXUBERANT_CTAGS}" ] - then - FatalError "Missing Dependent Application - Exuberant CTags" - fi - - if [ ! -d "${SRC_ROOT}" ] - then - FatalError "OpenGrok Source Path ${SRC_ROOT} doesn't exist" - fi - - if [ -n "${QUIET}" -a -n "${VERBOSE}" ] - then - Warning "Both Quiet and Verbose Mode Enabled - Choosing Verbose" - QUIET="" - VERBOSE="-v" - fi -} - -CreateRuntimeRequirements() -{ - if [ ! -d "${DATA_ROOT}" ] - then - Warning "OpenGrok Generated Data Path ${DATA_ROOT} doesn't exist" - Progress " Attempting to create generated data directory ... " - ${DO} mkdir -p "${DATA_ROOT}" - fi - if [ ! -d "${DATA_ROOT}" ] - then - FatalError "OpenGrok Data Path ${DATA_ROOT} doesn't exist" - fi - - if [ ! -d "${OPENGROK_INSTANCE_BASE}/etc" ] - then - Warning "OpenGrok Generated Etc Path ${OPENGROK_INSTANCE_BASE}/etc doesn't exist" - Progress " Attempting to create generated etc directory ... " - ${DO} mkdir -p "${OPENGROK_INSTANCE_BASE}/etc" - fi - if [ ! -d "${OPENGROK_INSTANCE_BASE}/etc" ] - then - FatalError "OpenGrok Etc Path ${OPENGROK_INSTANCE_BASE}/etc doesn't exist" - fi - - if [ -n "${LOGGER_CONFIG_PATH}" -a ! -f "${LOGGER_CONFIG_PATH}" ] - then - Progress " Creating default ${LOGGER_CONFIG_PATH} ... " - if [ ! -f "${LOGGER_CONF_SOURCE}" ] - then - Warning "Can't find distribution logging configuration" \ - "(${LOGGER_CONF_SOURCE}) to install as default" \ - "logging configuration (${LOGGER_CONFIG_PATH})" - else - ${DO} grep -v java.util.logging.FileHandler.pattern "${LOGGER_CONF_SOURCE}" > "${LOGGER_CONFIG_PATH}" - ${DO} grep java.util.logging.FileHandler.pattern "${LOGGER_CONF_SOURCE}" | sed "s|opengrok%g.%u.log|${OPENGROK_INSTANCE_BASE}/log/opengrok%g.%u.log|g" >> "${LOGGER_CONFIG_PATH}" - ${DO} mkdir ${OPENGROK_INSTANCE_BASE}/log - fi - fi -} - -StdInvocation() -{ -echo ${DO} ${JAVA} ${JAVA_OPTS} ${PROPERTIES} \ -echo ${LOGGER_PROPERTIES} \ -echo ${JAVA_DEBUG} \ -echo -jar ${OPENGROK_JAR} \ -echo ${IGNORE_PATTERNS} ${ENABLE_PROJECTS} \ -echo ${DERBY_HISTORY_CACHE} \ -echo ${SCAN_FOR_REPOSITORY} ${REMOTE_REPOSITORIES} \ -echo ${SCAN_DEPTH} \ -echo ${VERBOSE} ${QUIET} \ -echo ${EXUBERANT_CTAGS:+-c} ${EXUBERANT_CTAGS} \ -echo ${MAX_INDEXED_WORDS} ${SKIN} ${LEADING_WILDCARD} \ -echo ${READ_XML_CONF} \ -echo -W ${XML_CONFIGURATION} \ -echo ${WEBAPP_CONFIG_ADDRESS} \ -echo -s ${SRC_ROOT} -d ${DATA_ROOT} \ -echo "${@}" - - ${DO} ${JAVA} ${JAVA_OPTS} ${PROPERTIES} \ - ${LOGGER_PROPERTIES} \ - ${JAVA_DEBUG} \ - -jar ${OPENGROK_JAR} \ - ${IGNORE_PATTERNS} ${ENABLE_PROJECTS} \ - ${DERBY_HISTORY_CACHE} \ - ${SCAN_FOR_REPOSITORY} ${REMOTE_REPOSITORIES} \ - ${SCAN_DEPTH} \ - ${VERBOSE} ${QUIET} \ - ${EXUBERANT_CTAGS:+-c} ${EXUBERANT_CTAGS} \ - ${MAX_INDEXED_WORDS} ${SKIN} ${LEADING_WILDCARD} \ - ${READ_XML_CONF} \ - -W ${XML_CONFIGURATION} \ - ${WEBAPP_CONFIG_ADDRESS} \ - -s ${SRC_ROOT} -d ${DATA_ROOT} \ - "${@}" - -} - -UpdateGeneratedData() -{ - StdInvocation -H -} - -UpdateDescriptionCache() -{ - # OPTIONAL : Update the EftarFile data - - if [ -n "${PATH_DESC}" -a -s "${PATH_DESC}" ] - then - ${DO} ${JAVA} -classpath ${OPENGROK_JAR} \ - ${EFTAR_UPDATE} ${PATH_DESC} ${EFTAR_OUTPUT_FILE} - fi -} - -OpenGrokUsage() -{ - echo "Options for opengrok.jar:" 1>&2 - ${DO} ${JAVA} ${JAVA_OPTS} -jar ${OPENGROK_JAR} '-?' -} - -DeployWar() -{ - applicationServer="`FindApplicationServerType`" - - case "${applicationServer}" in - - Tomcat) warTarget="`DetermineWarDirectoryTomcat`" ;; - Glassfish) warTarget="`DetermineWarDirectoryGlassfish`" ;; - - *) FatalError "Unsupported Application Server ${applicationServer}" ;; - - esac - - if [ -z "${warTarget}" ] - then - FatalError "Unable to determine Deployment Directory for ${applicationServer}" - fi - - if [ ! -f "${OPENGROK_DIST_WAR}" ] - then - FatalError "Missing Web Application Archive ${OPENGROK_DIST_WAR}" - fi - - if [ ! -d "${warTarget}" ] - then - FatalError "Missing Deployment Directory ${warTarget}" - fi - - Progress "Installing ${OPENGROK_DIST_WAR} to ${warTarget} ..." - ${DO} cp "${OPENGROK_DIST_WAR}" "${warTarget}/" - if [ $? != 0 ] - then - FatalError "Web Application Installation FAILED" - fi - - Progress - Progress "Start your application server (${applicationServer}), if it is not already" - Progress "running, or wait until it loads the just installed web application." - Progress - Progress "OpenGrok should be available on <HOST>:<PORT>/source" - Progress " where HOST and PORT are configured in ${applicationServer}." - Progress -} - -# -# Main Program -# - -if [ $# -eq 0 -o $# -gt 2 ] -then - Usage -fi - -LoadStandardEnvironment - -LoadInstanceConfiguration - -case "${1}" in - - deploy) - DeployWar - ;; - - update) - ValidateConfiguration - CreateRuntimeRequirements - UpdateGeneratedData - UpdateDescriptionCache - ;; - - updateQuietly) - ValidateConfiguration - CreateRuntimeRequirements - QUIET="-q" - VERBOSE="" - UpdateGeneratedData - UpdateDescriptionCache - ;; - - index) - if [ -n "${2}" ] - then - SRC_ROOT="${2}" - fi - ValidateConfiguration - CreateRuntimeRequirements - UpdateGeneratedData - UpdateDescriptionCache - ;; - - usage) - OpenGrokUsage - Usage - ;; - - *) - Usage - ;; - -esac - -# -# End of File -# diff --git a/bin/apply-fixes b/bin/apply-fixes deleted file mode 100755 index f8ae7ca..0000000 --- a/bin/apply-fixes +++ /dev/null @@ -1,37 +0,0 @@ -#!/bin/sh - -INSTALL=`pwd`/`dirname $0`/.. - -PATCHES_DIR=$INSTALL/patches -WAR=$INSTALL/lib/source.war - -TMP_DIR=/tmp/opengrok-war - -echo "Uncompressing war..." -mkdir $TMP_DIR -unzip -q $WAR.orig -d $TMP_DIR - -cd $TMP_DIR -for p in `ls $PATCHES_DIR`; do - if [ -f $PATCHES_DIR/$p ]; then - patch -s -p2 -l --fuzz=0 --dry-run <$PATCHES_DIR/$p - if [ "$?" != "0" ]; then - echo "ERROR: patch -p2 -l --fuzz=0 --dry-run <$PATCHES_DIR/$p" - patch -p2 -l --fuzz=0 --dry-run <$PATCHES_DIR/$p - exit 1 - fi - echo "APPLY $p" - patch -p2 -l -s --fuzz=0 <$PATCHES_DIR/$p - fi -done - -#add things inside the toadd folder -cp -r $PATCHES_DIR/toadd/* . - -echo "Updating war..." -if [ -e $WAR ]; then - rm $WAR -fi -zip -q -r $WAR * - -rm -r $TMP_DIR diff --git a/bin/opengrok b/bin/opengrok deleted file mode 100755 index f508670..0000000 --- a/bin/opengrok +++ /dev/null @@ -1,12 +0,0 @@ -#!/bin/sh - -cd /usr/local/share/opengrok/bin -export OPENGROK_TOMCAT_BASE=/srv/tomcat6 -export EXUBERANT_CTAGS=/usr/bin/ctags - -./OpenGrok $@ - -if [ "$1" == "deploy" ]; then - cd $OPENGROK_TOMCAT_BASE/webapps - mv source.war ROOT.war -fi diff --git a/bin/update-opengrok b/bin/update-opengrok deleted file mode 100755 index ae5e459..0000000 --- a/bin/update-opengrok +++ /dev/null @@ -1,29 +0,0 @@ -#!/bin/sh - -SRC_ROOT=/srv/git -REPOS="core - binfilter - help - translations" - -BASE_GIT_URL="git://anongit.freedesktop.org/libreoffice/" - -for REPO in $REPOS -do - if [ ! -d $SRC_ROOT/$REPO ]; then - cd $SRC_ROOT && git clone "$BASE_GIT_URL$REPO" - else - echo "Pulling $REPO" - cd $SRC_ROOT/$REPO && git pull -r - fi -done - -# missing Env when running in cron -export JAVA_HOME=/usr/lib64/jvm/java - -# Run opengrok index -export OPENGROK_INSTANCE_BASE=/var/opengrok -export OPENGROK_REMOTE_REPOS=false -export SKIN="-L libreoffice" -export READ_XML_CONFIGURATION=~/opengrok-config.xml -QUIET="-w /" /usr/local/bin/opengrok index $SRC_ROOT diff --git a/doc/CHANGES.txt b/doc/CHANGES.txt deleted file mode 100644 index 9edcb84..0000000 --- a/doc/CHANGES.txt +++ /dev/null @@ -1,326 +0,0 @@ -May 2010 update 0.9 -------------------------------------------------- -This is a major update. It's advised you cleanup your old DATA_ROOT and run -indexing from fresh. Also the web application should be replaced, since new -indexes are not compatible with old application. -This is also a general rule for most of OpenGrok updates. We don't really -support backwards compatibility, unless it would be a really minor update. - -New Features: - -* Faster Lucene engine (3.0.1) underneath - faster analyzers -* New jQuery (1.4.2) underneath - UI improvements -* Support for xrefs with Unicode characters (not indexed yet, but - finally viewable) -* New SMF service - just pass the source root, the rest is taken care - of by the service (Solaris/OpenSolaris only) - -Bugs fixed: - -Bug #437 (partial): OpenGrok should support source files with multibyte characters -Bug #3435: C functions are not considered as functions -Bug #3900: Unexpected result when clicking a symbol definition -Bug #5042: Author field empty in opengrok after a multiple changeset push -Bug #5848: trimmed diff link results in NULL pointer dereference -Bug #6641: .txx file extension should be included in the list for C++ analyzer -Bug #9407: set limit for directory traversal during search for repositories -Bug #13185: broken focus -Bug #13280: RFE: Configurable tab size for xref -Bug #13330: Wrong URL when search for camel-case identifier has only one match -Bug #13362: plainanalyzer xref writer can never end for a file with long lines -Bug #13364: regression : Jar analyzer doesn't analyze the jars it used to for 0.7 -Bug #13524: Color coding in diffs is confusing -Bug #13529: listing of a file (in xref) might take a LONG time -Bug #13777: Indexer should print "Adding: ..." before it adds a file -Bug #13884: IndexOutOfBoundsException in List2TokenStream.next() -Bug #13949: Missing line numbers in xref for XML file -Bug #13951: Wrong revision in info.properties when not building from head of trunk -Bug #13952: size output not correct -Bug #13961: no quick search box shown on windows (path separator problem in project names/IDs) -Bug #13996: build.xml should provide a version info for generated src.tar.gz so we don't depend on hg -Bug #13997: main logo should take you HOME ;) -Bug #14030: Many lines with same line number (regression) -Bug #14724: Incremental update of Bazaar history broken by instability in revision numbers -Bug #14757: pressing Enter on project select list box takes you to xref instead of submit of the search form -Bug #14953: history index for CVS repos should only include default branch if CVS/Tag is set -Bug #14978: upgrade lucene to 3.0.1 -Bug #15004: Improved handling of UTF Byte Order Marks -Bug #15097: make the search bar in listing stay on top of the page -Bug #15114: AnalyzerGuru:stripBOM should not use String to avoid encoding issues -Bug #15240: radio buttons in history could behave like e.g. on wikipedia -Bug #15391: Executor should log the commands executed -Bug #15394: improve IPS package and SMF for OpenSolaris -Bug #15608: Search field should not be active in file display -Bug #15609: self organizing buttons in history view are confusing -Bug #15632: Strange results when searching for dotted identifier -Bug #15636: wildcard search for definitions does not work -Bug #15637: query constructed only for AND operators -Bug #15643: Simplify CLASSPATH in ogindexd -Bug #15644: Matching lines not shown when using single-character wildcard (?) -Bug #15652: history page shows a stack trace if file doesn't have a history -Bug #15690: css browser caching breaks UI -Bug #15858: String index out of range: -8161 from Summarizer -Bug #15859: html analyzer doesn't escape forms - -For bug details refer to: -http://defect.opensolaris.org/bz/buglist.cgi?bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&target_milestone=0.9&product=opengrok - -Contributors: - -We'd like to thank all the people who report bugs, send us ideas and -improvements. Below are just people that sent patches or pushed code. -That doesn't mean that we don't appreciate your work. On the contrary, -you are the people showing other people (who have the time to write -code) what would be good to fix when you use this software and file -bugs against it! Note that this is just a summary of how many changes -each person made, which doesn't necessarily reflect how significant -each change was. (Inspect the history log with "hg log -v -r 0.8.1:0.9" -to get all details.) - - 45 Knut Anders Hatlen <Knut.Hatlen@sun.com> - 42 Lubos Kosco <Lubos.Kosco@sun.com> - 1 Chris Eldredge <chris.eldredge@gmail.com> - 1 Vitezslav Batrla <Vitezslav.Batrla@Sun.COM> - - -December 2009 update 0.8.1 -------------------------------------------------- -minor changes from OpenGrok 0.8. Most importantly, the 0.8.1 release fixes -the broken Solaris packages. Also OpenGrok script is now improved and 2G of -memory is needed for it to accommodate most deployments. - -November 2009 update 0.8 -------------------------------------------------- -FEATURES - - * Support more source code repository backends: - o Bazaar - o Monotone - * Support for more languages: - o Fortran - o Detect C++ keywords - o Parse C# files with the C analyzer - * Search through multiple projects at the same time - * Possibility to register an opengrok search as a search - * engine(provider) in Firefox(Internet Explorer) - * History cache stored in Java DB - * Simplified installation & setup. Improved user interface. - -BUG FIXES - - * Bug #405: Mercurial history parser may easily get out of sync - * Bug #2243: Show date and time of the last index update - * Bug #3401: C analyzer recognizes C++ keywords - * Bug #3624: History cache should be stored in Java DB - * Bug #4154: History cache should be created automatically for new - * repositories - * Bug #4505: resource leakage of ctags processes if started from the - * agent - * Bug #4580: The agent tries to create the repositories on the client - * side - * Bug #5826: "remote" subversion repositories no longer detected - * Bug #6658: rss.jsp generates ill-formed XML - * Bug #9468: history of renamed files is lost (mercurial) - use -f only - * for files - * Bug #10440: Skip files with no sections or empty section name string - * table - * Bug #10442: zip analyzer fails to parse odps - * Bug #11661: Invalid author link when revision has no author - * Bug #11662: No author not handled by JDBCHistoryCache - * Bug #11663: Failure when commit message exceeds ~32K - * Bug #11664: StringIndexOutOfBoundsException in MercurialHistoryParser - * Bug #11886: set no word limit for indexing of files (can result in out - * of memory errors!) - * Bug #11896: indexer chokes on fifos - * Bug #12029: Check the first 1MB of the file - * Bug #12081: History not returned for uncached repositories when using - * JDBCHistoryCache - * Bug #12324: history view should not contain lists of files - -THE ROAD AHEAD - -A tentative roadmap for OpenGrok can be found here: -http://www.opensolaris.org/os/project/opengrok/Roadmap/ - -As of OpenGrok 0.8 we will change the release model to the train model and -start with quarterly releases. - -CONTRIBUTORS - -The following people contributed to this release since 0.7. - -Note that this is just a summary of how many changes each person made which -doesn't necessarily reflect how significant each change was. (inspect the -history log with "hg log -v -r 0.7:tip" to get all details) - - 121 Knut Anders Hatlen <Knut.Hatlen@sun.com> - 69 Trond Norbye <trond.norbye@sun.com> - 50 Lubos Kosco <Lubos.Kosco@sun.com> - 39 Jorgen Austvik <jorgen.austvik@sun.com> - 4 Jan Berg <jan.berg@sun.com> - 4 Peter Bray <Peter.Darren.Bray@gmail.com> - 1 Scott Halstead <shaltead@bloomberg.net> - -October 2008 update 0.7 -------------------------------------------------- -NEW FEATURES - -* Support more source code repository backends: - o ClearCase (Magnus Lind) - o Git (Jorgen Austvik) - o Razor (Peter Bray) - -* JMX Agent (Jan Stale Berg) - -OpenGrok can now talk JMX with clients. This work is the start of a -project to make it easier to configure OpenGrok. The first proof of -concept is a system tray applet to show OpenGrok status. - -* Use external Subversion binary instead of svn-javahl.jar (Trond) - -A lot of our users had problems installing svn-javahl.jar, now we use -the system provided svn binary. - -* Logging - -OpenGrok is changed to use standard java.util.logging (Jan Stale Berg, -Trond, Lubos Kosco) - -* Store history cache in compressed files to save disk space (Trond) - -* Quality (Trond, Knut Anders, Lubos Kosco, Jorgen Austvik) - - We have incorporated tools like PMD, FindBugs, CheckStyle and -Hudson into our development process, and fixed lots and lots of -potential bugs long before any users experience them. - - We have started to write unit-tests, and use Emma to measure how -good they are. In this release our unit tests cover 61% of our code -(block coverage), for OpenGrok 0.8 we aim for 70%. - -* General code and design cleanup (Peter Bray, Trond, Knut Anders, Lubos -Kosco, Jorgen Austvik) - - -April 2008 update 0.6.1 -------------------------------------------------- -This is a bugfix release. - -Please see http://src.opensolaris.org/source/history/opengrok/trunk/ for -full history information, and for the list of contributors. The following is -just a summary. - -Bug #67: Duplicate magics in the analyzers -Bug #546: IOException when viewing history for xref root in multi-project installation -Bug #785: Indexer don't use the value specified with -m -Bug #779: Add option to disable index optimization upon indexing -Bug #829: create links to account details in annotate mode -Bug #966: fails on directory names that contain a plus (+) character -Bug #989: Can't reindex a subtree -Bug #988: Make it possible to optimize the index without reindexing -Bug #1007: Add URL friendly project handling -Bug #1009: Economical mode generates suggestion database -Bug #1057: double-colon in search pattern throws an error - -March 2008 update 0.6 -------------------------------------------------- -Please see http://src.opensolaris.org/source/history/opengrok/trunk/ for -full history information, and for the list of contributors. The following is -just a summary. - -New Features: - Analyzer-support for Tcl/Tk - Analyzer-support for SQL - Support for TeamWare repositories - Use multiple index databases - -Bug fixes: - A lot.. See http://src.opensolaris.org/source/history/opengrok/trunk/ - -August 2007 update 0.5 -------------------------------------------------- -Please see http://cvs.opensolaris.org/source/history/opengrok/trunk/ for -full history information, and for the list of contributors. The following is -just a summary. - -New Features: - Annotate support for Subversion and Mercurial - Use of a "history cache" for some SCM's to improve performance - Replaced system properties with configuration that may be changed runtime - Added support for Lisp - Updated the Lucene search engine, and allow wildcard search - Implemented glob'ing for IgnoredNames (-i *.bak) - Added a meta robots directive to the page headers to stop robots - Added support for "Projects" - Added support for RCS - Allow user-configurable bug patterns - -Bug fixes: - Fix problems that Tomcat reports IllegalStateException for page redirects - Added more stack traces when errors occurs - -December 2006 update 0.4 -------------------------------------------------- -New Features: - New Java Analyzer - Experimental support for Mercurial - -Bug Fixes: - Fixed image path (alt webroot) provided by Nathan Beyer - Improved JRCS parser provided by Gustav Gunnarsson - Improved error handling for a corrupt web.xml in error.jsp - Fix problem with unterminated <form> tag provided by Chris Elving - Fix problem with how arguments are passed to an editor - (reported by Joachim Deguara) - Added patch for glob'ing files provided by Ben Ravago - Added patch for displaying CVS files not present on HEAD. - Provided by Chris Elving. - -April 2006 update 0.3.1 -------------------------------------------------- -Bug Fixes: - Fix the webapp for custom context option - Many changes contributed by Knut Pape - More easy to understand usage message - tar.bz2 was not getting processed properly - PDF files were getting cross-referenced by mistake - Troff - missing space in xref - -February 2006 update 0.3 -------------------------------------------------- -New Features: - Support for Subversion. - A cscope like GUI for search. - A GUI wizard for creating or updating search index. - New option that supports webapps with different context URLs. - Better display of matched context - A new CSS style sheet with offwhite theme. - - -December 2005 update: 0.2.1 -------------------------------------------------- -New Features: - Now runs on Microsoft Windows - a new CSS theme (polished) - Interim support for PHP and OpenSolaris Assembler code. - Single distributable file to keep things simple - -Bug fixes: - Fixes a XSS security issue (reported by Wez Furlong) - Fixes bug where some CVS revisions could not be retrived - Fixes bug in handling CVS long histories (reported by Wez Furlong) - Handles extra characters in CVS symbol names (reported by Wez Furlong) - More robust EFTAR file handling (reported by Andy Tucker) - Throws more helpful error messages - Tomcat 4.x compatibility fixes - Minor fixes to hypertexting code that handles strings. - Fixed bug that ignored symlinked SRC_ROOT (reported by Michael Allen) - -Compatibility Note: - The DATA_ROOT files generated by 0.2 are compatible - with this release. Changing the source.war parameters - and redeploying should work. - However to get full advantage, it is advisable to - generate the data from scratch (i.e. remove the old - DATA_ROOT and run the run.sh again). - -Initial public release, November 2005 Version 0.2 -------------------------------------------------- diff --git a/doc/EXAMPLE.txt b/doc/EXAMPLE.txt deleted file mode 100644 index 56a9c24..0000000 --- a/doc/EXAMPLE.txt +++ /dev/null @@ -1,178 +0,0 @@ -OpenGrok deployment, step by step ---------------------------------- - -One of the design goals of OpenGrok is that it should be easy to use, so a -user should be able to use OpenGrok with a minimum of configuration. While the -mimimum configuration is suitable for some users, it will not fit all users. -The intent of this document is to offer a "step by step" guide for two -different deployments of OpenGrok. A simple configuration suitable for small -deployments, and a more "advanced" one for sites that want to host multiple -source projects with a single OpenGrok server. - -Note that projects cannot have a "," in their name because of web application -project field separator. - -Simple configuration. ---------------------- - -The first thing you need to do is to create a directory structure to hold the -sources and the database used by OpenGrok. I would suggest something like: - -/opengrok -|-- bin -|-- data -`-- source - -You should copy the OpenGrok binaries into the bin-directory. The following -command should do the trick: - -$ cp -r OpenGrok opengrok.jar lib /opengrok/bin - -Edit OpenGrok, review the configuration section and set at least the -following parameters to reflect your system and requirements: -SRC_ROOT=/opengrok/source -DATA_ROOT=/opengrok/data -EXUB_CTAGS=/absolute/path/to/Exubrant/Ctags - -The last thing we need to do is to configure the web application. To do so, -please execute the following commands: -$ mkdir /opengrok/web/source -$ cd /opengrok/web/source -$ unzip /path/to/opengrok-release/source.war - -edit WEB-INF/web.xml and specify SRC_ROOT and DATA_ROOT. - -You may also want to modify the file index_body.html before you re-create -the war-file with the following commands: - -$ cd /opengrok/web/source -$ zip -r /opengrok/web/source.war - -Deploy OpenGrok to a Tomcat server by copying source.war to the "webapps" -directory in the Tomcat installation. -In case you have Glassfish, you can use web admin UI to deploy the war, or -you can simply put it in your domains directory in the "autodeploy" folder. -If you are using any other web application container servers, please refer to -their documentation on war deployments. - - -Advanced configuration. ------------------------ - -This configuration is suitable for deployments where you would like to host -multiple source projects in the same OpenGrok installation. This configuration -is also suitable if you want to run the index generation on one server, and -the web interface on another server. - -I would recommend that you create a unique user and group named opengrok to -own the files and run the indexing software. - -As with the simple configuration you need to set up a directory structure. -I would suggest something like: - -/opengrok -|-- bin -|-- smf -|-- stage1 -| |-- data -| `-- source -`-- stage2 - |-- data - `-- source - -The reason we need two stage directories is that the web service will use one -while we're updating the other. - -You should then populate the directory with files from the OpenGrok -distribution: -$ cp -r opengrok.jar lib /opengrok/bin -$ cp -r tools/smf /opengrok - -(Please note that you should use the same value for SRC_ROOT and DATA_ROOT for -on all servers if you generate indexes on one server and run the web interface -on another server. On Solaris you could use the automounter to mount /opengrok -on all servers, or you could specify the path by using /net/servername/opengrok) - -The /opengrok/smf subdirectory contains scripts and manifest files that may be -used to run the index generation as a Solaris service. You will find a script -that may be used as a skeleton to create you own startup / shutdown script in -tools/init.d. This should be placed in /etc/init.d and appropriate links -must be creted from the desired rcX.d directory. - -Solaris users should edit /opengrok/smf/opengrok.xml and verify that the -variables specified there are correct. The service is imported by executing -the following command: -# svccfg import /opengrok/smf/opengrok.xml - -For other platforms these variables are specified in /etc/init.d/opengrok.sh - -The next thing to do is to populate the source trees with the sources you want -OpenGrok to serve. E.g. to create your own "mirror" of the OpenGrok sources you -would execute: - -$ cd /opengrok/stage1/source -$ hg clone ssh://anon@opensolaris.org/hg/opengrok/trunk opengrok -$ cp -pr opengrok /opengrok/stage2/source - -If you are going to host source from multiple projects in your OpenGrok server, -you should edit /opengrok/smf/indexer.sh and look for the line: - # ADD_PROJECTS="-P -p /onnv-gate -W ${DATA_ROOT}/../configuration.xml" - -Remove the '#' to activate the line, and replace "/onnv-gate" with the -directory name of the project you would like to be selected as default (to -select the opengrok source we added above, insert "/opengrok"). - -The last step we need to do before we can start generating the indices is to -create the configuration file used by the web interface. You create the -configuration file by executing the following command: - -$ java -jar /opengrok/bin/opengrok.jar -W /opengrok/stage1/configuration.xml \ - -c /path/to/ctags -P -S -v -s /opengrok/stage1/source \ - -d /opengrok/stage1/data - -You can now start generating indices by executing: -Solaris with SMF: -# svcadm enable opengrok -Or if you use scripts in /etc/init.d: -# /etc/init.d/opengrok start - -The last thing we need to do is to configure the web application. To do so, -please execute the following commands: -$ mkdir /opengrok/web/source -$ cd /opengrok/web/source -$ unzip /path/to/opengrok-release/source.war - -edit WEB-INF/web.xml and add the following section (next to all the other -<context-param> entries): - - <context-param> - <param-name>CONFIGURATION</param-name> - <param-value>/opengrok/configuration.xml</param-value> - </context-param> - - <context-param> - <param-name>ConfigAddress</param-name> - <param-value>localhost:2424</param-value> - </context-param> - -The last entry will let the web application listen on port 2424 for -configuration updates. There is currently _no_ authentication implemented here, -so you should not add an ip address reachable from an untrusted source. -If you run the index generation on another server than the web server, you must -add one of the external interfaces of the web server (but it should _NOT_ be -reachable from external hosts). - -You may also want to modify the file index_body.html before you re-create -the jar-file with the following commands: - -$ cd /opengrok/web/source -$ zip -r /opengrok/web/source.war - -Deploy OpenGrok to a Tomcat server by copying source.war to the webapps -directory in the Tomcat installation. -In case you have Glassfish, you can use web admin UI to deploy the war, or -you can simply put it in your domains directory in the "autodeploy" folder. -If you are using any other web application container servers, please refer to -their documentation on war deployments. - - diff --git a/doc/LICENSE.txt b/doc/LICENSE.txt deleted file mode 100644 index a474897..0000000 --- a/doc/LICENSE.txt +++ /dev/null @@ -1,387 +0,0 @@ -Unless otherwise noted, all files in this distribution are released -under the Common Development and Distribution License (CDDL), -Version 1.0 only. Exceptions are noted within the associated -source files. -Where we have dual MIT and GPL license we choose MIT license. -File NOTICE.txt contains all notices from apache licensed software we distribute. - --------------------------------------------------------------------- - - -COMMON DEVELOPMENT AND DISTRIBUTION LICENSE Version 1.0 - -1. Definitions. - - 1.1. "Contributor" means each individual or entity that creates - or contributes to the creation of Modifications. - - 1.2. "Contributor Version" means the combination of the Original - Software, prior Modifications used by a Contributor (if any), - and the Modifications made by that particular Contributor. - - 1.3. "Covered Software" means (a) the Original Software, or (b) - Modifications, or (c) the combination of files containing - Original Software with files containing Modifications, in - each case including portions thereof. - - 1.4. "Executable" means the Covered Software in any form other - than Source Code. - - 1.5. "Initial Developer" means the individual or entity that first - makes Original Software available under this License. - - 1.6. "Larger Work" means a work which combines Covered Software or - portions thereof with code not governed by the terms of this - License. - - 1.7. "License" means this document. - - 1.8. "Licensable" means having the right to grant, to the maximum - extent possible, whether at the time of the initial grant or - subsequently acquired, any and all of the rights conveyed - herein. - - 1.9. "Modifications" means the Source Code and Executable form of - any of the following: - - A. Any file that results from an addition to, deletion from or - modification of the contents of a file containing Original - Software or previous Modifications; - - B. Any new file that contains any part of the Original - Software or previous Modifications; or - - C. Any new file that is contributed or otherwise made - available under the terms of this License. - - 1.10. "Original Software" means the Source Code and Executable - form of computer software code that is originally released - under this License. - - 1.11. "Patent Claims" means any patent claim(s), now owned or - hereafter acquired, including without limitation, method, - process, and apparatus claims, in any patent Licensable by - grantor. - - 1.12. "Source Code" means (a) the common form of computer software - code in which modifications are made and (b) associated - documentation included in or with such code. - - 1.13. "You" (or "Your") means an individual or a legal entity - exercising rights under, and complying with all of the terms - of, this License. For legal entities, "You" includes any - entity which controls, is controlled by, or is under common - control with You. For purposes of this definition, - "control" means (a) the power, direct or indirect, to cause - the direction or management of such entity, whether by - contract or otherwise, or (b) ownership of more than fifty - percent (50%) of the outstanding shares or beneficial - ownership of such entity. - -2. License Grants. - - 2.1. The Initial Developer Grant. - - Conditioned upon Your compliance with Section 3.1 below and - subject to third party intellectual property claims, the Initial - Developer hereby grants You a world-wide, royalty-free, - non-exclusive license: - - (a) under intellectual property rights (other than patent or - trademark) Licensable by Initial Developer, to use, - reproduce, modify, display, perform, sublicense and - distribute the Original Software (or portions thereof), - with or without Modifications, and/or as part of a Larger - Work; and - - (b) under Patent Claims infringed by the making, using or - selling of Original Software, to make, have made, use, - practice, sell, and offer for sale, and/or otherwise - dispose of the Original Software (or portions thereof). - - (c) The licenses granted in Sections 2.1(a) and (b) are - effective on the date Initial Developer first distributes - or otherwise makes the Original Software available to a - third party under the terms of this License. - - (d) Notwithstanding Section 2.1(b) above, no patent license is - granted: (1) for code that You delete from the Original - Software, or (2) for infringements caused by: (i) the - modification of the Original Software, or (ii) the - combination of the Original Software with other software - or devices. - - 2.2. Contributor Grant. - - Conditioned upon Your compliance with Section 3.1 below and - subject to third party intellectual property claims, each - Contributor hereby grants You a world-wide, royalty-free, - non-exclusive license: - - (a) under intellectual property rights (other than patent or - trademark) Licensable by Contributor to use, reproduce, - modify, display, perform, sublicense and distribute the - Modifications created by such Contributor (or portions - thereof), either on an unmodified basis, with other - Modifications, as Covered Software and/or as part of a - Larger Work; and - - (b) under Patent Claims infringed by the making, using, or - selling of Modifications made by that Contributor either - alone and/or in combination with its Contributor Version - (or portions of such combination), to make, use, sell, - offer for sale, have made, and/or otherwise dispose of: - (1) Modifications made by that Contributor (or portions - thereof); and (2) the combination of Modifications made by - that Contributor with its Contributor Version (or portions - of such combination). - - (c) The licenses granted in Sections 2.2(a) and 2.2(b) are - effective on the date Contributor first distributes or - otherwise makes the Modifications available to a third - party. - - (d) Notwithstanding Section 2.2(b) above, no patent license is - granted: (1) for any code that Contributor has deleted - from the Contributor Version; (2) for infringements caused - by: (i) third party modifications of Contributor Version, - or (ii) the combination of Modifications made by that - Contributor with other software (except as part of the - Contributor Version) or other devices; or (3) under Patent - Claims infringed by Covered Software in the absence of - Modifications made by that Contributor. - -3. Distribution Obligations. - - 3.1. Availability of Source Code. - - Any Covered Software that You distribute or otherwise make - available in Executable form must also be made available in Source - Code form and that Source Code form must be distributed only under - the terms of this License. You must include a copy of this - License with every copy of the Source Code form of the Covered - Software You distribute or otherwise make available. You must - inform recipients of any such Covered Software in Executable form - as to how they can obtain such Covered Software in Source Code - form in a reasonable manner on or through a medium customarily - used for software exchange. - - 3.2. Modifications. - - The Modifications that You create or to which You contribute are - governed by the terms of this License. You represent that You - believe Your Modifications are Your original creation(s) and/or - You have sufficient rights to grant the rights conveyed by this - License. - - 3.3. Required Notices. - - You must include a notice in each of Your Modifications that - identifies You as the Contributor of the Modification. You may - not remove or alter any copyright, patent or trademark notices - contained within the Covered Software, or any notices of licensing - or any descriptive text giving attribution to any Contributor or - the Initial Developer. - - 3.4. Application of Additional Terms. - - You may not offer or impose any terms on any Covered Software in - Source Code form that alters or restricts the applicable version - of this License or the recipients' rights hereunder. You may - choose to offer, and to charge a fee for, warranty, support, - indemnity or liability obligations to one or more recipients of - Covered Software. However, you may do so only on Your own behalf, - and not on behalf of the Initial Developer or any Contributor. - You must make it absolutely clear that any such warranty, support, - indemnity or liability obligation is offered by You alone, and You - hereby agree to indemnify the Initial Developer and every - Contributor for any liability incurred by the Initial Developer or - such Contributor as a result of warranty, support, indemnity or - liability terms You offer. - - 3.5. Distribution of Executable Versions. - - You may distribute the Executable form of the Covered Software - under the terms of this License or under the terms of a license of - Your choice, which may contain terms different from this License, - provided that You are in compliance with the terms of this License - and that the license for the Executable form does not attempt to - limit or alter the recipient's rights in the Source Code form from - the rights set forth in this License. If You distribute the - Covered Software in Executable form under a different license, You - must make it absolutely clear that any terms which differ from - this License are offered by You alone, not by the Initial - Developer or Contributor. You hereby agree to indemnify the - Initial Developer and every Contributor for any liability incurred - by the Initial Developer or such Contributor as a result of any - such terms You offer. - - 3.6. Larger Works. - - You may create a Larger Work by combining Covered Software with - other code not governed by the terms of this License and - distribute the Larger Work as a single product. In such a case, - You must make sure the requirements of this License are fulfilled - for the Covered Software. - -4. Versions of the License. - - 4.1. New Versions. - - Sun Microsystems, Inc. is the initial license steward and may - publish revised and/or new versions of this License from time to - time. Each version will be given a distinguishing version number. - Except as provided in Section 4.3, no one other than the license - steward has the right to modify this License. - - 4.2. Effect of New Versions. - - You may always continue to use, distribute or otherwise make the - Covered Software available under the terms of the version of the - License under which You originally received the Covered Software. - If the Initial Developer includes a notice in the Original - Software prohibiting it from being distributed or otherwise made - available under any subsequent version of the License, You must - distribute and make the Covered Software available under the terms - of the version of the License under which You originally received - the Covered Software. Otherwise, You may also choose to use, - distribute or otherwise make the Covered Software available under - the terms of any subsequent version of the License published by - the license steward. - - 4.3. Modified Versions. - - When You are an Initial Developer and You want to create a new - license for Your Original Software, You may create and use a - modified version of this License if You: (a) rename the license - and remove any references to the name of the license steward - (except to note that the license differs from this License); and - (b) otherwise make it clear that the license contains terms which - differ from this License. - -5. DISCLAIMER OF WARRANTY. - - COVERED SOFTWARE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" - BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, - INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED - SOFTWARE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR - PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND - PERFORMANCE OF THE COVERED SOFTWARE IS WITH YOU. SHOULD ANY - COVERED SOFTWARE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE - INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF ANY - NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF - WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF - ANY COVERED SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS - DISCLAIMER. - -6. TERMINATION. - - 6.1. This License and the rights granted hereunder will terminate - automatically if You fail to comply with terms herein and fail to - cure such breach within 30 days of becoming aware of the breach. - Provisions which, by their nature, must remain in effect beyond - the termination of this License shall survive. - - 6.2. If You assert a patent infringement claim (excluding - declaratory judgment actions) against Initial Developer or a - Contributor (the Initial Developer or Contributor against whom You - assert such claim is referred to as "Participant") alleging that - the Participant Software (meaning the Contributor Version where - the Participant is a Contributor or the Original Software where - the Participant is the Initial Developer) directly or indirectly - infringes any patent, then any and all rights granted directly or - indirectly to You by such Participant, the Initial Developer (if - the Initial Developer is not the Participant) and all Contributors - under Sections 2.1 and/or 2.2 of this License shall, upon 60 days - notice from Participant terminate prospectively and automatically - at the expiration of such 60 day notice period, unless if within - such 60 day period You withdraw Your claim with respect to the - Participant Software against such Participant either unilaterally - or pursuant to a written agreement with Participant. - - 6.3. In the event of termination under Sections 6.1 or 6.2 above, - all end user licenses that have been validly granted by You or any - distributor hereunder prior to termination (excluding licenses - granted to You by any distributor) shall survive termination. - -7. LIMITATION OF LIABILITY. - - UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT - (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE - INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF - COVERED SOFTWARE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE - LIABLE TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR - CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT - LIMITATION, DAMAGES FOR LOST PROFITS, LOSS OF GOODWILL, WORK - STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER - COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN - INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF - LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL - INJURY RESULTING FROM SUCH PARTY'S NEGLIGENCE TO THE EXTENT - APPLICABLE LAW PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO - NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR - CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION AND LIMITATION MAY NOT - APPLY TO YOU. - -8. U.S. GOVERNMENT END USERS. - - The Covered Software is a "commercial item," as that term is - defined in 48 C.F.R. 2.101 (Oct. 1995), consisting of "commercial - computer software" (as that term is defined at 48 - C.F.R. 252.227-7014(a)(1)) and "commercial computer software - documentation" as such terms are used in 48 C.F.R. 12.212 - (Sept. 1995). Consistent with 48 C.F.R. 12.212 and 48 - C.F.R. 227.7202-1 through 227.7202-4 (June 1995), all - U.S. Government End Users acquire Covered Software with only those - rights set forth herein. This U.S. Government Rights clause is in - lieu of, and supersedes, any other FAR, DFAR, or other clause or - provision that addresses Government rights in computer software - under this License. - -9. MISCELLANEOUS. - - This License represents the complete agreement concerning subject - matter hereof. If any provision of this License is held to be - unenforceable, such provision shall be reformed only to the extent - necessary to make it enforceable. This License shall be governed - by the law of the jurisdiction specified in a notice contained - within the Original Software (except to the extent applicable law, - if any, provides otherwise), excluding such jurisdiction's - conflict-of-law provisions. Any litigation relating to this - License shall be subject to the jurisdiction of the courts located - in the jurisdiction and venue specified in a notice contained - within the Original Software, with the losing party responsible - for costs, including, without limitation, court costs and - reasonable attorneys' fees and expenses. The application of the - United Nations Convention on Contracts for the International Sale - of Goods is expressly excluded. Any law or regulation which - provides that the language of a contract shall be construed - against the drafter shall not apply to this License. You agree - that You alone are responsible for compliance with the United - States export administration regulations (and the export control - laws and regulation of any other countries) when You use, - distribute or otherwise make available any Covered Software. - -10. RESPONSIBILITY FOR CLAIMS. - - As between Initial Developer and the Contributors, each party is - responsible for claims and damages arising, directly or - indirectly, out of its utilization of rights under this License - and You agree to work with Initial Developer and Contributors to - distribute such responsibility on an equitable basis. Nothing - herein is intended or shall be deemed to constitute any admission - of liability. - --------------------------------------------------------------------- - -NOTICE PURSUANT TO SECTION 9 OF THE COMMON DEVELOPMENT AND -DISTRIBUTION LICENSE (CDDL) - -For Covered Software in this distribution, this License shall -be governed by the laws of the State of California (excluding -conflict-of-law provisions). - -Any litigation relating to this License shall be subject to the -jurisdiction of the Federal Courts of the Northern District of -California and the state courts of the State of California, with -venue lying in Santa Clara County, California. diff --git a/doc/NOTICE.txt b/doc/NOTICE.txt deleted file mode 100644 index e3b818a..0000000 --- a/doc/NOTICE.txt +++ /dev/null @@ -1,32 +0,0 @@ -List of notices from Apache licensed software OpenGrok uses: - -Apache Lucene -Copyright 2006 The Apache Software Foundation - -This product includes software developed by -The Apache Software Foundation (http://www.apache.org/). - -The snowball stemmers in - contrib/snowball/src/java/net/sf/snowball -were developed by Martin Porter and Richard Boulton. -The full snowball package is available from - http://snowball.tartarus.org/ - -The Arabic stemmer (contrib/analyzers) comes with a default -stopword list that is BSD-licensed created by Jacques Savoy. The file resides in -contrib/analyzers/common/src/resources/org/apache/lucene/analysis/ar/stopwords.txt. -See http://members.unine.ch/jacques.savoy/clef/index.html. - -The Persian analyzer (contrib/analyzers) comes with a default -stopword list that is BSD-licensed created by Jacques Savoy. The file resides in -contrib/analyzers/common/src/resources/org/apache/lucene/analysis/fa/stopwords.txt. -See http://members.unine.ch/jacques.savoy/clef/index.html. - -Includes lib/servlet-api-2.4.jar from Apache Tomcat - -The SmartChineseAnalyzer source code (under contrib/analyzers) was -provided by Xiaoping Gao and copyright 2009 by www.imdict.net. - -ICU4J, (under contrib/collation) is licensed under an MIT styles license -(contrib/collation/lib/ICU-LICENSE.txt) and Copyright (c) 1995-2008 -International Business Machines Corporation and others diff --git a/doc/README.txt b/doc/README.txt deleted file mode 100644 index 0d6333c..0000000 --- a/doc/README.txt +++ /dev/null @@ -1,586 +0,0 @@ -OpenGrok - a wicked fast source browser ---------------------------------------- - -OpenGrok is a fast and usable source code search and cross reference -engine, written in Java. It helps you search, cross-reference and navigate -your source tree. It can understand various program file formats and -version control histories like SCCS, RCS, CVS, Subversion and Mercurial. - -OpenGrok is the tool used for the OpenSolaris Source Browser. - -Requirements ------------- - * Latest Java http://java.sun.com/ (At least 1.6) - * A servlet container like Tomcat (5.x or later) - http://tomcat.apache.org/ - supporting Servlet 2.4 and JSP 2.0 - * Exuberant Ctags http://ctags.sourceforge.net/ - * Subversion 1.3.0 or later if SVN support is needed - http://subversion.tigris.org/ - * Mercurial 0.9.3 or later if Mercurial support is needed - http://www.selenic.com/mercurial/wiki/ - * JFlex Ant task (If you want to build OpenGrok) - http://www.jflex.org/ - - -Usage ------ -SRC_ROOT refers to the directory containing your source tree. -OpenGrok analyzes the source tree and builds a search index along with -cross-referenced hypertext versions of the source files. These generated -data files will be stored in DATA_ROOT directory. -Project concept - one project is one directory underneath SRC_ROOT and -usually contains a checkout of a project(or it's branch, version, ...) -sources, it can have several attributes (in its XML description), note that -interface of projects is being stabilized so it can change. Projects -effectively replace need for more web applications with opengrok .war and -leave you with one indexer and one web application serving MORE source code -repositories - projects. A nice concept is to have directories underneath -SRC_ROOT with a naming convention, thereby creating a good overview of -projects (e.g. name-version-branch). Then you have a simple update script & -simple index refresher script in place, which simplifies management of more -repositories. - -OpenGrok setup Step.0 - Setting up the Sources. ----------------------------------------------- -Source base must be available locally for OpenGrok to work efficiently. No -changes are required to your source tree. If the code is under source control -management (SCM) OpenGrok requires the checked out source tree under SRC_ROOT. -It is possible for some SCM systems to use a remote repository (Subversion, -CVS), but this is not recommended due to the performance penalty. Special -option is needed to enable remote repository support(-r on). -Note that OpenGrok ignores symbolic links. - ---------------------------------------------------- -Using Opengrok wrapper script(Solaris and Linux) to create indexes. ---------------------------------------------------- - -Step.1 - Deploy the web application -===================================== - -We provided you with OpenGrok wrapper script, which should aid in deploying -the web application. -Please change to opengrok directory (can vary on your system) -Note that now you might need to change to user which owns the target -directories for data, e.g. on Solaris you'd do # pfexec su - webservd - -$ cd /usr/opengrok/bin - -and run - -$ ./OpenGrok deploy - -This command will do some sanity checks and will deploy the source.war in -its directory to one of detected web application containers. -Please follow the error message it provides. -If it fails to discover your container, please refer to optional steps on -changing web application properties, which has manual steps on how to do -this. - -Note that OpenGrok script expects the directory /var/opengrok to be -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. - - -Step.2 - Populate DATA_ROOT Directory, let the indexer generate the project -XML config file, update configuration.xml to your web app -===================================== - -Second step is to just run the indexing (can take a lot of time). After this -is done, indexer automatically attempts to upload newly generated -configuration to the web application. Most probably you will not be able to -use {Opengrok before this is done. - -Please change to opengrok directory (can vary on your system) - -$ cd /usr/opengrok/bin - -and run, if your SRC_ROOT is prepared under /var/opengrok/src - -$ ./OpenGrok index - -otherwise (if SRC_ROOT is in different directory) run: - -$ ./OpenGrok index <absolute_path_to_your_SRC_ROOT> - -Above command should try to upload latest index status reflected into -configuration.xml to a running source web application. -Once above command finishes without errors(e.g. SEVERE: Failed to send -configuration to localhost:2424 -), you should be able to enjoy your opengrok and search your sources using -latest indexes and setup. - -Congratulations, you should now be able to point your browser to -http://<YOUR_WEBAPP_SERVER>:<WEBAPPSRV_PORT>/source to work with your fresh -opengrok installation! :-) - - -At this time we'd like to point out some customization to OpenGrok script -for advanced users. -A common case would be, that you want the data in some other directory than -/var/opengrok. -This can be easily achieved by using environment variable -OPENGROK_INSTANCE_BASE . -E.g. if my opengrok data directory is /tank/opengrok and my source root is -in /tank/source and I'd like to get more verbosity I'd run the indexer as: - -$ OPENGROK_VERBOSE=true OPENGROK_INSTANCE_BASE=/tank/opengrok \ - ./OpenGrok index /tank/source - -Since above will also change default location of config file, beforehands(or -restart your web container after creating this symlink) I suggest doing -below for our case of having opengrok instance in /tank/opengrok : - -$ ln -s /tank/opengrok/etc/configuration.xml \ - /var/opengrok/etc/configuration.xml - -A lot more customizations can be found inside the script, you just need to -have a look at it, eventually create a configuration out of it and use -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. - - ---------------------------------------------------- -Using smf service(OpenSolaris) to maintain opengrok indexes. ---------------------------------------------------- - -If you installed opengrok from a package, then configure the service like this: - -# svccfg -s opengrok - listprop opengrok - setprop opengrok/srcdir="/absolute/path/to/your/sourcetree" - setprop opengrok/maxmemory="2048" - end - -then make the service start the indexing, at this point it would be nice if -the web application is already running. - -# svcadm enable -rs opengrok -(which will enable tomcat6 as dependency) - -When the service starts indexing for first time, it's already enabled and -depending on tomcat6, so at this point the web application should be -already running. -The indexing is not done when opengrok service is disabled. - -To rebuild the index later (e.g. after source code changed)just run: -# svcadm refresh opengrok - -Note: before removing opengrok package please disable the service. -If you don't do it, it will not be removed automatically. -In such case please remove it manually. - ---------------------------------------------------- -Using command line interface(general pointers) to create indexes. ---------------------------------------------------- - -Step.1 - Populate DATA_ROOT Directory -===================================== -Option 1. OpenGrok: There is a sample shell script OpenGrok that is suitable -for using in a cron job to run regularly. Modify the variables in the script -to point appropriate directories, or as the code suggests factor your local -configuration into a separate file and simplify future upgrades. - -Option 2. opengrok.jar: You can also directly use the Java application. If -the sources are all located in a directory SRC_ROOT and the data and -hypertext files generated by OpenGrok are to be stored in DATA_ROOT, run - - $ java -jar opengrok.jar -s SRC_ROOT -d DATA_ROOT - -See opengrok.jar manual below for more details. - -Step.2 - Configure and Deploy source.war Webapp -=============================================== -To configure the webapp source.war, look into the parameters defined in -web.xml of source.war file and change them (see note1) appropriately. - - * HEADER: is the fragment of HTML that will be used to display title or - logo of your project - * SRC_ROOT: the absolute path name of the root directory of your source tree - * DATA_ROOT: absolute path of the directory where OpenGrok data - files are stored - - -Optional Step.3 - Path Descriptions ------------------------------------ -OpenGrok uses path descriptions in various places (For eg. while showing -directory listings or search results) Example descriptions are in paths.tsv -file. You can list descriptions for directories one per line tab separated -format path tab description. Refer to example 4 below. - -Note 1 - Changing webapp parameters: web.xml is the deployment descriptor -for the web application. It is in a Jar file named source.war, you can -change the : - - * Option 1: Unzip the file to TOMCAT/webapps/source/ directory and - change the source/WEB-INF/web.xml and other static html files like - index.html to customize to your project. - - * Option 2: Extract the web.xml file from source.war file - - $ unzip source.war WEB-INF/web.xml - - edit web.xml and re-package the jar file. - - $ zip -u source.war WEB-INF/web.xml - - Then copy the war files to <i>TOMCAT</i>/webapps directory. - - * Option 3: Edit the Context container element for the webapp - - Copy source.war to TOMCAT/webapps - - When invoking OpenGrok to build the index, use -w <webapp> to set the - context. - - After the index is built, there's a couple different ways to set the - Context for the servlet container: - - Add the Context inside a Host element in TOMCAT/conf/server.xml - - <Context path="/<webapp>" docBase="source.war"> - <Parameter name="DATA_ROOT" value="/path/to/data/root" override="false" /> - <Parameter name="SRC_ROOT" value="/path/to/src/root" override="false" /> - <Parameter name="HEADER" value='...' override="false" /> - </Context> - - - Create a Context file for the webapp - - This file will be named `<webapp>.xml'. - - For Tomcat, the file will be located at: - `TOMCAT/conf/<engine_name>/<hostname>', where <engine_name> - is the Engine that is processing requests and <hostname> is a Host - associated with that Engine. By default, this path is - 'TOMCAT/conf/Catalina/localhost' or 'TOMCAT/conf/Standalone/localhost'. - - This file will contain something like the Context described above. - ---------------------------------------------------- -Using Java DB for history cache -(instead of gzipped xml files) ---------------------------------------------------- - -You need Java DB 10.5.3 or later -(OpenSolaris: # pkg install SUNWjavadb or SUNWj6dev , -Debian/Ubuntu: # apt-get install sun-java6-javadb). -There are two modes, having Java DB embedded, or running a Java DB server. -Java DB server is default option, I will not describe how to set up embedded -option. - -1) Start the server: -$ mkdir -p $DATA_ROOT/derby - -OpenSolaris: -# svcadm enable javadb -OR -$ java -Dderby.system.home=$DATA_ROOT/derby -jar /opt/SUNWjavadb/lib/derbynet.jar start -OR -$ java -Dderby.system.home=$DATA_ROOT/derby -jar /usr/jdk/instances/jdk1.6.0/db/lib/derbynet.jar start - -Debian: -$ java -Dderby.system.home=$DATA_ROOT/derby -jar /usr/lib/jvm/java-6-sun/db/lib/derbynet.jar start - - -2) You need to have the derbyclient.jar in lib directory of opengrok.jar and in source.war WEB-INF/lib -Copy it over from -OpenSolaris: /opt/SUNWjavadb/lib/derbyclient.jar OR /usr/jdk/instances/jdk1.6.0/db/lib/derbyclient.jar -Debian: /usr/lib/jvm/java-6-sun/db/lib/derbyclient.jar - -3) Use these options with indexer when indexing/generating the configuration: - -D -H - -Also the Java DB server has to be running during indexing and for the web application. - -Note: To use a bigger database buffer, which may improve performance of both -indexing and fetching of history, create a file named derby.properties in -$DATA_ROOT/derby and add this line to it: -derby.storage.pageCacheSize=25000 - ---------------------------------------------------- -Optional CLI - Command Line Interface Usage ---------------------------------------------------- - - You need to pass location of project file + the query to Search class, e.g. -for fulltext search for project with above generated configuration.xml you'd -do: - -$ java -cp ./opengrok.jar org.opensolaris.opengrok.search.Search -R \ -/var/opengrok/etc/configuration.xml -f fulltext_search_string - - For quick help run: - -$ java -cp ./opengrok.jar org.opensolaris.opengrok.search.Search - ---------------------------------------------------- -Optional need to change web application properties or name ---------------------------------------------------- - - You might need to modify the web application if you don't store the -configuration file in the default location -(/var/opengrok/etc/configuration.xml). - -To configure the webapp source.war, look into the parameters defined in -WEB-INF/web.xml of source.war (use jar or zip/unzip or your preffered zip -tool to get into it - e.g. extract the web.xml file from source.war ($ unzip -source.war WEB-INF/web.xml) file, edit web.xml and re-package the jar file -(zip -u source.war WEB-INF/web.xml) ) file and change those web.xml -parameters appropriately. These sample parameters need modifying(there are -more options, refer to manual or read param comments). - - * CONFIGURATION - the absolute path to XML file containing project - * configuration (e.g. /var/opengrok/etc/configuration.xml ) - * ConfigAddress - port for remote updates to configuration, optional, - * but advised(since there is no authentification) to be set to - * localhost:<some_port> (e.g. localhost:2424), if you choose some_port - * below 1024 you have to have root privileges - -If you need to change name of the web application from source to something -else you need to use special option -w <new_name> for indexer to create -proper xrefs, besides changing the .war file name. Examples below show just -deploying source.war, but you can use it to deploy your new_name.war too. - -Deploy the modified .war file in glassfish/Sun Java App Server: ------------------------------------ - - * Option 1: Use browser and log into glassfish web administration - * interface - - Common Tasks / Applications / Web Applications , button Deploy and point -it to your source.war webarchive - - * Option 2: Copy the source.war file to - * GLASSFISH/domains/YOURDOMAIN/autodeploy directory, glassfish will try - * to deploy it "automagically". - * Option 3: Use cli from GLASSFISH directory: - -# ./bin/asadmin deploy /path/to/source.war - -Deploy the modified .war file in tomcat: ------------------------------------ - - * just copy the source.war file to TOMCAT_INSTALL/webapps directory. - ---------------------------------------------------- -Optional opengrok indexer setup with agent and systray GUI control application ---------------------------------------------------- - -we provide an example opengrok-agent.properties file, which can be used when -starting special OpenGrok Agent, where you can connect with a systray GUI -application. - -To start the indexer with configuration run: -$ java -cp ./opengrok.jar org.opensolaris.opengrok.management.OGAgent \ ---config opengrok-agent.properties - -then from the remote machine one can run: -$ java -cp ./opengrok.jar \ -org.opensolaris.opengrok.management.client.OpenGrokTrayApp - -assuming configuration permits remote connections(so not listening on -localhost, but rather on a physical network interface) - -This agent is work in progress, so it might not fully work. - ---------------------------------------------------- -Using Findbugs ---------------------------------------------------- -If you want to run Findbugs (http://findbugs.sourceforge.net/) on OpenGrok, -you have to download Findbugs to your machine, and install it where you have -checked out your OpenGrok source code, under the lib/findbugs directory, -like this: - - cd ~/.ant/lib - wget http://..../findbugs-x.y.z.tar.gz - gtar -xf findbugs-x.y.z.tar.gz - mv findbugs-x.y.z findbugs - -You can now run ant with the findbugs target: - - ant findbugs - ... - findbugs: - [findbugs] Executing findbugs from ant task - [findbugs] Running FindBugs... - [findbugs] Warnings generated: nnn - [findbugs] Output saved to findbugs/findbugs.html - -Now, open findbugs/findbugs.html in a web-browser, and start fixing bugs! - -If you want to install findbugs some other place than ~/.ant/lib, you can untar the -.tar.gz file to a directory, and use the findbugs.home property to tell ant where to find -findbugs, like this (if you have installed fundbugs under the lib directory): - - ant findbugs -Dfindbugs.home=lib/findbug - -There is also a findbugs-xml ant target that can be used to generate XML files that can -later be parsed, e.g. by Hudson. - ---------------------------------------------------- -Using Emma ---------------------------------------------------- -If you want to check test coverage on OpenGrok, download Emma from -http://emma.sourceforge.net/. Place emma.jar and emma-ant.jar in the -opengrok/trunk/lib directory, or ~/.ant/lib. - -Now you can instrument your classes, and create a jar file: - - ant emma-instrument - -If you are using NetBeans, select File - "opengrok" Properties -- libraries - Compile tab. Press the "Add JAR/Folder" and select -lib/emma.jar and lib/emma_ant.jar - -If you are not using netbeans, you have to edit the file -nbproject/project.properties, and add "lib/emma.jar" and -"lib/emma_ant.jar" to the javac.classpath inside it. - -Now you can put the classes into jars and generate distributables: - - ant dist - -The classes inside opengrok.jar should now be instrumented. -If you use opengrok.jar for your own set of tests, you need -emma.jar in the classpath.If you want to specify where to store -the run time analysis, use these properties: - - emma.coverage.out.file=path/coverage.ec - emma.coverage.out.merge=true - -The coverage.ec file should be placed in the opengrok/trunk/coverage -directory for easy analyzation. - -If you want to test the coverage of the unit tests, you can -run the tests: - - ant test (Or Alt+F6 in NetBeans) - -Now you should get some output saying that Emma is placing runtime -coverage data into coverage.ec. - -To generate reports, run ant again: - - ant emma-report - -Look at coverage/coverage.txt, coverage/coverage.xml and -coverage/coverage.html to see how complete your tests are. - -Note: For full coverage report your system has to provide proper junit test -environment, that would mean: -- you have to use ant 1.7 and above -- at least junit-4.?.jar has to be in ants classpath (e.g. in ./lib) -- your PATH must contain exuberant ctags binary -- your PATH variable must contain binaries of appropriate SCM SW, so commands -hg, sccs, cvs, git, bzr, svn (svnadmin too) must be available for full report - ---------------------------------------------------- -Using Checkstyle ---------------------------------------------------- - -To check that your code follows the standard coding conventions, -you can use checkstyle from http://checkstyle.sourceforge.net/ - -First you must download checkstyle from http://checkstyle.sourceforge.net/ , -You need Version 5.1 (or newer). Extract the package you have -downloaded, and create a symbolic link to it from ~/.ant/lib/checkstyle, -e.g. like this: - - cd ~/.ant/lib - unzip ~/Desktop/checkstyle-5.1.zip - ln -s checkstyle-5.1 checkstyle - -You also have to create symbolic links to the jar files: - - cd checkstyle - ln -s checkstyle-5.1.jar checkstyle.jar - ln -s checkstyle-all-5.1.jar checkstyle-all.jar - -To run checkstyle on the source code, just run ant checkstyle: - - ant checkstyle - -Output from the command will be stored in the checkstyle directory. - -If you want to install checkstyle some other place than ~/.ant/lib, you can -untar the .tar.gz file to a directory, and use the checkstyle.home property -to tell ant where to find checkstyle, like this (if you have installed -checkstyle under the lib directory): - - ant checkstyle -Dcheckstyle.home=lib/checkstyle - ---------------------------------------------------- -Using PMD and CPD ---------------------------------------------------- - -To check the quality of the OpenGrok code you can also use PMD -from http://pmd.sourceforge.net/. - -How to install: - - cd ~/.ant/lib - unzip ~/Desktop/pmd-bin-4.2.5.zip - ln -s pmd-4.2.5/ pmd - -You also have to make links to the jar files: - - cd ~/.ant/lib/pmd/lib - ln -s pmd-4.2.5.jar pmd.jar - ln -s jaxen-1.1.1.jar jaxen.jar - -To run PMD on the rource code, just run ant pmd: - - ant pmd - -Outout from the command will be stored in the pmd subdirectory. - - % ls pmd - pmd_report.html pmd_report.xml - -If you want to install PMD some other place than ~/.ant/lib, you can -unzip the .zip file to a directory, and use the pmd.home property -to tell ant where to find PMD, like this (if you have installed -PMD under the lib directory): - - ant pmd -Dpmd.home=lib/pmd-4.2.5 - -To run CPD, just use the same as above, but use targets: - - ant cpd cpd-xml - -Which will result in - - % ls pmd - cpd_report.xml cpd_report.txt - ---------------------------------------------------- -Using JDepend ---------------------------------------------------- -To see dependencies in the source code, you can use JDepend from -http://clarkware.com/software/JDepend.html. - -How to install: - - cd ~/.ant/lib - unzip ~/Desktop/jdepend-2.9.zip - ln -s jdepend-2.9/ jdepend - cd jdepend/lib - ln -s jdepend-2.9.jar jdepend.jar - -How to analyze: - - ant jdepend - -Output is stored in the jdepend directory: - - $ ls jdepend/ - report.txt report.xml - -AUTHORS -------- -Chandan B.N, Sun Microsystems. https://blogs.sun.com/chandan -Trond Norbye, norbye.org -Knut Pape, eBriefkasten.de -Martin Englund, Sun Microsystems -Knut Anders Hatlen, Sun Microsystems -Lubos Kosco, Sun Microsystems diff --git a/doc/logging.properties b/doc/logging.properties deleted file mode 100644 index 51e4ef5..0000000 --- a/doc/logging.properties +++ /dev/null @@ -1,61 +0,0 @@ -############################################################ -# Logging Configuration File -# -# You can use a different file by specifying a filename -# with the java.util.logging.config.file system property. -# For example java -Djava.util.logging.config.file=myfile -############################################################ - -############################################################ -# Global properties -############################################################ - -# "handlers" specifies a comma separated list of log Handler -# classes. These handlers will be installed during VM startup. -# Note that these classes must be on the system classpath. -# By default we only configure a ConsoleHandler, which will only -# show messages at the INFO and above levels. -#handlers= java.util.logging.ConsoleHandler - -# To also add the FileHandler, use the following line instead. -handlers= java.util.logging.FileHandler, java.util.logging.ConsoleHandler - -# Default global logging level. -# This specifies which kinds of events are logged across -# all loggers. For any given facility this global level -# can be overriden by a facility specific level -# Note that the ConsoleHandler also has a separate level -# setting to limit messages printed to the console. -# -# Available logging levels: OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, ALL -# OFF will give no output, SEVERE will give very little output, FINEST and ALL will give lots of output. -# -.level= ALL - -############################################################ -# Handler specific properties. -# Describes specific configuration info for Handlers. -############################################################ - -# default file output is in user's home directory. -#java.util.logging.FileHandler.pattern = %hjava%u.log -java.util.logging.FileHandler.pattern = opengrok%g.%u.log -java.util.logging.FileHandler.limit = 52428800 -java.util.logging.FileHandler.count = 3 -java.util.logging.FileHandler.level = ALL -#java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter -java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter - -# Limit the message that are printed on the console to INFO and above. -java.util.logging.ConsoleHandler.level = INFO -java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter - - -############################################################ -# Facility specific properties. -# Provides extra control for each logger. -############################################################ - -# For example, set the com.xyz.foo logger to only log SEVERE -# messages: -#com.xyz.foo.level = SEVERE diff --git a/doc/paths.tsv b/doc/paths.tsv deleted file mode 100644 index 81535af..0000000 --- a/doc/paths.tsv +++ /dev/null @@ -1,3 +0,0 @@ -/some_dir Description of some directory -/some_file Description of some file -/foo/some_other Some Other under Foo diff --git a/doc/run-quiet.sh b/doc/run-quiet.sh deleted file mode 100644 index c577b2f..0000000 --- a/doc/run-quiet.sh +++ /dev/null @@ -1,23 +0,0 @@ -#!/bin/sh - -PROGDIR=`dirname $0` - -# REQUIRED The root of your source tree -SRC_ROOT=/your/src/tree/ - -# REQUIRED The directory where the data files like -# Lucene index and hypertext cross-references are stored -DATA_ROOT=/var/tmp/opengrok_data - -# OPTIONAL A tab separated files that contains small -# descriptions for paths in the source tree -PATH_DESC=${PROGDIR}/paths.tsv - -# A modern Exubrant Ctags program -# from http://ctags.sf.net -EXUB_CTAGS=/usr/local/bin/ctags - -java -jar ${PROGDIR}/opengrok.jar -q -c ${EXUB_CTAGS} -s ${SRC_ROOT} -d ${DATA_ROOT} - -# OPTIONAL -java -classpath ${PROGDIR}/opengrok.jar org.opensolaris.opengrok.web.EftarFile ${PATH_DESC} ${DATA_ROOT}/index/dtags.eftar diff --git a/doc/run.bat b/doc/run.bat deleted file mode 100644 index 2f5dc67..0000000 --- a/doc/run.bat +++ /dev/null @@ -1,27 +0,0 @@ -REM Get the name of the directory this run.bat script is living in.
-set PROGDIR=%~dp0
-
-REM REQUIRED The root of your source tree (upper-case drive
-REM letter matters)
-set SRC_ROOT=C:\your\source\root
-
-REM REQUIRED The directory where the data files like Lucene index and
-REM hypertext cross-references are stored
-set DATA_ROOT=C:\your\data\root
-
-REM REQUIRED if ctags is not in PATH
-REM A modern Exubrant Ctags program
-REM from http://ctags.sf.net
-set EXUB_CTAGS=C:\ctags\ctags.exe
-
-REM OPTIONAL
-REM A tab separated file that contains small
-REM descriptions for paths in the source tree
-set PATH_DESC=%PROGDIR%\paths.tsv
-
-set LOGGER="-Djava.util.logging.config.file=logging.properties"
-
-java %LOGGER% -jar %PROGDIR%opengrok.jar -c %EXUB_CTAGS% -s %SRC_ROOT% -d %DATA_ROOT%
-
-REM OPTIONAL
-java %LOGGER% -classpath %PROGDIR%opengrok.jar org.opensolaris.opengrok.web.EftarFile %PATH_DESC% %DATA_ROOT%\index\dtags.eftar
diff --git a/doc/run.sh b/doc/run.sh deleted file mode 100644 index 8cdc4ba..0000000 --- a/doc/run.sh +++ /dev/null @@ -1,34 +0,0 @@ -#!/bin/sh - -PROGDIR=`dirname $0` - -# REQUIRED The root of your source tree -SRC_ROOT=/your/src/tree/ - -# REQUIRED The directory where the data files like -# Lucene index and hypertext cross-references are stored -DATA_ROOT=/var/tmp/opengrok_data - -# OPTIONAL A tab separated files that contains small -# descriptions for paths in the source tree -PATH_DESC=${PROGDIR}/paths.tsv - -# A modern Exubrant Ctags program -# from http://ctags.sf.net -EXUB_CTAGS=/usr/local/bin/ctags - -# If you need to set properties (Ex. override the mercurial binary) -#PROPERTIES=-Dorg.opensolaris.opengrok.history.Mercurial=/home/trond/bin/hg - -# Uncomment the following line if your source contains Mercurial repositories. -# SCAN_FOR_REPOS="-S" - -# You might want to add more available memory, and perhaps use a server jvm? -#JAVA_OPTS="-server -Xmx1024m" - -LOGGER="-Djava.util.logging.config.file=logging.properties" - -java ${JAVA_OPTS} ${PROPERTIES} ${LOGGER} -jar ${PROGDIR}/opengrok.jar ${SCAN_FOR_REPOS} -c ${EXUB_CTAGS} -s ${SRC_ROOT} -d ${DATA_ROOT} - -# OPTIONAL -java ${LOGGER} -classpath ${PROGDIR}/opengrok.jar org.opensolaris.opengrok.web.EftarFile ${PATH_DESC} ${DATA_ROOT}/index/dtags.eftar diff --git a/lib/lib/ant.jar b/lib/lib/ant.jar Binary files differdeleted file mode 100644 index e84a8cb..0000000 --- a/lib/lib/ant.jar +++ /dev/null diff --git a/lib/lib/bcel-5.2.jar b/lib/lib/bcel-5.2.jar Binary files differdeleted file mode 100644 index 2fa90ce..0000000 --- a/lib/lib/bcel-5.2.jar +++ /dev/null diff --git a/lib/lib/jakarta-oro-2.0.8.jar b/lib/lib/jakarta-oro-2.0.8.jar Binary files differdeleted file mode 100644 index 23488d2..0000000 --- a/lib/lib/jakarta-oro-2.0.8.jar +++ /dev/null diff --git a/lib/lib/jmxremote_optional.jar b/lib/lib/jmxremote_optional.jar Binary files differdeleted file mode 100644 index 2492985..0000000 --- a/lib/lib/jmxremote_optional.jar +++ /dev/null diff --git a/lib/lib/lucene-core-3.0.1.jar b/lib/lib/lucene-core-3.0.1.jar Binary files differdeleted file mode 100644 index 4115246..0000000 --- a/lib/lib/lucene-core-3.0.1.jar +++ /dev/null diff --git a/lib/lib/lucene-spellchecker-3.0.1.jar b/lib/lib/lucene-spellchecker-3.0.1.jar Binary files differdeleted file mode 100644 index 29a4d23..0000000 --- a/lib/lib/lucene-spellchecker-3.0.1.jar +++ /dev/null diff --git a/lib/lib/org.apache.commons.jrcs.diff.jar b/lib/lib/org.apache.commons.jrcs.diff.jar Binary files differdeleted file mode 100644 index b9dc338..0000000 --- a/lib/lib/org.apache.commons.jrcs.diff.jar +++ /dev/null diff --git a/lib/lib/org.apache.commons.jrcs.rcs.jar b/lib/lib/org.apache.commons.jrcs.rcs.jar Binary files differdeleted file mode 100644 index c351001..0000000 --- a/lib/lib/org.apache.commons.jrcs.rcs.jar +++ /dev/null diff --git a/lib/lib/swing-layout-0.9.jar b/lib/lib/swing-layout-0.9.jar Binary files differdeleted file mode 100644 index 046ee00..0000000 --- a/lib/lib/swing-layout-0.9.jar +++ /dev/null diff --git a/lib/opengrok.jar b/lib/opengrok.jar Binary files differdeleted file mode 100644 index 124708a..0000000 --- a/lib/opengrok.jar +++ /dev/null diff --git a/lib/source.war.orig b/lib/source.war.orig Binary files differdeleted file mode 100644 index 9e0437e..0000000 --- a/lib/source.war.orig +++ /dev/null diff --git a/man/man1/opengrok.1 b/man/man1/opengrok.1 deleted file mode 100644 index 301795f..0000000 --- a/man/man1/opengrok.1 +++ /dev/null @@ -1,161 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN"> -<?Pub Inc> -<refentry id="opengrok-1"> -<refmeta> -<refentrytitle>opengrok</refentrytitle> -<manvolnum>1</manvolnum> -<refmiscinfo class="date">May 11, 2010</refmiscinfo> -</refmeta> -<refnamediv> -<refname>opengrok</refname> -<refpurpose>a wicked fast source browser</refpurpose> -</refnamediv> -<refsynopsisdiv> -<cmdsynopsis> -<command>opengrok -<optional><option> -q</option></optional> -<optional><option> -v</option></optional> -<optional><option> -e</option></optional> -<optional><option> -c <replaceable>/path/to/ctags</replaceable></option></optional> -<optional><option> -R <replaceable>/path/to/configuration</replaceable></option></optional> -<optional><option> -W <replaceable>/path/to/configuration</replaceable></option></optional> -<optional><option> -U <replaceable>host:port</replaceable></option></optional> -<optional><option> -P</option></optional> -<optional><option> -p <replaceable>/path/to/default/project</replaceable></option></optional> -<optional><option> -Q <replaceable>on/off</replaceable></option></optional> -<optional><option> -n</option></optional> -<optional><option> -H</option></optional> -<optional><option> -h <replaceable>/path/to/repository</replaceable></option></optional> -<optional><option> -D</option></optional> -<optional><option> -j <replaceable>class</replaceable></option></optional> -<optional><option> -u <replaceable>url</replaceable></option></optional> -<optional><option> -r <replaceable>on/off</replaceable></option></optional> -<optional><option> -L <replaceable>path</replaceable></option></optional> -<optional><option> -l <replaceable>on/off</replaceable></option></optional> -<optional><option> -O <replaceable>on/off</replaceable></option></optional> -<optional><option> -a <replaceable>on/off</replaceable></option></optional> -<optional><option> -w <replaceable>webapp-context</replaceable></option></optional> -<optional><option> -i <replaceable>pattern</replaceable></option></optional> -<optional><option> -A <replaceable>ext:analyzer</replaceable></option></optional> -<optional><option> -m <replaceable>number</replaceable></option></optional> -<optional><option> -S</option></optional> -<optional><option> -z <replaceable>number</replaceable></option></optional> -<optional><option> -s <replaceable>/path/to/source/root</replaceable></option></optional> -<optional><option> -d <replaceable>/path/to/data/root</replaceable></option></optional> -<optional><option> -T <replaceable>number</replaceable></option></optional> -<optional><option> -?</option></optional> -<optional><option> -V</option></optional> -</command> -</cmdsynopsis> -</refsynopsisdiv> - -<refsect1><title>DESCRIPTION</title> -<para> -OpenGrok is a fast and usable source code search and cross reference -engine written in pure Java. It helps you search, cross-referenece -and navigate your source tree. It can understand various program file -formats and version control histories. -</para> -</refsect1> - -<refsect1><title>OPTIONS</title> -<variablelist termlength="medium"> -<varlistentry><term><option>q</option></term><listitem><para>Run as quietly as possible</para></listitem></varlistentry> -<varlistentry><term><option>v</option></term><listitem><para>Print progress information as we go along</para></listitem></varlistentry> -<varlistentry><term><option>e</option></term><listitem><para>Economical - consumes less disk space. It does not generate hyper text cross reference files offline, but will do so on demand - which could be sightly slow.</para></listitem></varlistentry> -<varlistentry><term><option>c</option></term><listitem><para>Path to Exuberant Ctags from http://ctags.sf.net by default takes the Exuberant Ctags in PATH.</para></listitem></varlistentry> -<varlistentry><term><option>R</option></term><listitem><para>Read configuration from the specified file</para></listitem></varlistentry> -<varlistentry><term><option>W</option></term><listitem><para>Write the current configuration to the specified file (so that the web application can use the same configuration</para></listitem></varlistentry> -<varlistentry><term><option>U</option></term><listitem><para>Send the current configuration to the specified address (This is most likely the web-app configured with ConfigAddress)</para></listitem></varlistentry> -<varlistentry><term><option>P</option></term><listitem><para>Generate a project for each of the top-level directories in source root</para></listitem></varlistentry> -<varlistentry><term><option>p</option></term><listitem><para>This is the path to the project that should be selected by default in the web application(when no other project set either in cookie or in parameter). You should strip off the source root.</para></listitem></varlistentry> -<varlistentry><term><option>Q</option></term><listitem><para>Turn on/off quick context scan. By default only the first 32k of a file is scanned, and a '[..all..]' link is inserted if the file is bigger. Activating this may slow the server down (Note: this is setting only affects the web application)</para></listitem></varlistentry> -<varlistentry><term><option>n</option></term><listitem><para>Do not generate indexes, but process all other command line options</para></listitem></varlistentry> -<varlistentry><term><option>H</option></term><listitem><para>Generate history cache for all external repositories</para></listitem></varlistentry> -<varlistentry><term><option>h</option></term><listitem><para>Generate history cache for the specified repos (absolute path from source root)</para></listitem></varlistentry> -<varlistentry><term><option>D</option></term><listitem><para>Store history cache in a database (needs the JDBC driver in the classpath, typically derbyclient.jar or derby.jar)</para></listitem></varlistentry> -<varlistentry><term><option>j</option></term><listitem><para>Name of the JDBC driver class used by the history cache. Can use one of the shorthands "client" (org.apache.derby.jdbc.ClientDriver) or "embedded" (org.apache.derby.jdbc.EmbeddedDriver). Default: "client"</para></listitem></varlistentry> -<varlistentry><term><option>u</option></term><listitem><para>URL to the database that contains the history cache. Default: If -j specifies "embedded", "jdbc:derby:$DATA_ROOT/cachedb;create=true"; otherwise, "jdbc:derby://localhost/cachedb;create=true"</para></listitem></varlistentry> -<varlistentry><term><option>r</option></term><listitem><para>Turn on/off support for remote SCM systems</para></listitem></varlistentry> -<varlistentry><term><option>L</option></term><listitem><para>Path to the subdirectory in the web-application containing the requested stylesheet. The following factory-defaults exist: "default", "offwhite" and "polished"</para></listitem></varlistentry> -<varlistentry><term><option>l</option></term><listitem><para>Turn on/off locking of the Lucene database during index generation</para></listitem></varlistentry> -<varlistentry><term><option>O</option></term><listitem><para>Turn on/off the optimization of the index database as part of the indexing step</para></listitem></varlistentry> -<varlistentry><term><option>a</option></term><listitem><para>Allow or disallow leading wildcards in a search</para></listitem></varlistentry> -<varlistentry><term><option>w</option></term><listitem><para>Context of webapp. Default is /source. If you specify a different name, make sure to rename source.war to that name.</para></listitem></varlistentry> -<varlistentry><term><option>i</option></term><listitem><para>Ignore the named files or directories (supports wildcards, example: -i *.so -i *.dll)</para></listitem></varlistentry> -<varlistentry><term><option>A</option></term><listitem><para>Files with the named extension should be analyzed with the specified class</para></listitem></varlistentry> -<varlistentry><term><option>m</option></term><listitem><para>The maximum words to index in a file</para></listitem></varlistentry> -<varlistentry><term><option>S</option></term><listitem><para>Search for "external" source repositories and add them</para></listitem></varlistentry> -<varlistentry><term><option>z</option></term><listitem><para>depth of scanning for repositories in directory structure relative to source root</para></listitem></varlistentry> -<varlistentry><term><option>s</option></term><listitem><para>The root directory of the source tree</para></listitem></varlistentry> -<varlistentry><term><option>d</option></term><listitem><para>The directory where OpenGrok stores the generated data</para></listitem></varlistentry> -<varlistentry><term><option>T</option></term><listitem><para>The number of threads to use for index generation. By default the number of threads will be set to the number of available CPUs</para></listitem></varlistentry> -<varlistentry><term><option>?</option></term><listitem><para>Help</para></listitem></varlistentry> -<varlistentry><term><option>V</option></term><listitem><para>Print version and quit</para></listitem></varlistentry> -</variablelist> -</refsect1> - -<refsect1><title>FILE FORMATS</title> -<para> -OpenGrok can grok various program file formats like C, C++, Shell -Scripts like ksh, sh, Perl, Java, Java Class files, JAR files, ELF -files, troff man pages, file archives like Zip, Gzip, BZip2, Tar -and meta language files like XML, SGML or HTML. -</para> -<para> -OpenGrok supports various source control systems like Mercurial, CVS, -Subversion, TeamWare, SCCS and Bazaar. -</para> -</refsect1> - -<refsect1><title>EXAMPLE</title> -<example> -<title>Indexing files in /usr/include and storing the output data to -/var/tmp/opengrok_data.</title> -<screen>$ <userinput>opengrok.jar -s /usr/include -d /var/tmp/opengrok_data</userinput> -</screen> -</example> - -</refsect1> - -<refsect1><title>EXIT STATUS</title> -<variablelist termlength="medium"> -<varlistentry><term>0</term><listitem><para>command executed successfully</para></listitem></varlistentry> -<varlistentry><term>1</term><listitem><para>error in executing the command</para></listitem></varlistentry> -</variablelist> -</refsect1> -</refentry> - diff --git a/opengrok-config.xml b/opengrok-config.xml deleted file mode 100644 index 4ca52d4..0000000 --- a/opengrok-config.xml +++ /dev/null @@ -1,134 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<java version="1.6.0" class="java.beans.XMLDecoder"> - <object class="org.opensolaris.opengrok.configuration.Configuration"> - <void property="ctags"> - <string>/usr/bin/ctags</string> - </void> - <void property="dataRoot"> - <string>/var/opengrok/data</string> - </void> - <void property="projects"> - <void method="add"> - <object class="org.opensolaris.opengrok.configuration.Project"> - <void property="description"> - <string>binfilter</string> - </void> - <void property="path"> - <string>/binfilter</string> - </void> - </object> - </void> - <void method="add"> - <object class="org.opensolaris.opengrok.configuration.Project"> - <void property="description"> - <string>help</string> - </void> - <void property="path"> - <string>/help</string> - </void> - </object> - </void> - <void method="add"> - <object class="org.opensolaris.opengrok.configuration.Project"> - <void property="description"> - <string>core</string> - </void> - <void property="path"> - <string>/core</string> - </void> - </object> - </void> - <void method="add"> - <object class="org.opensolaris.opengrok.configuration.Project"> - <void property="description"> - <string>translations</string> - </void> - <void property="path"> - <string>/translations</string> - </void> - </object> - </void> - </void> - <void property="repositories"> - <void method="add"> - <object class="org.opensolaris.opengrok.history.RepositoryInfo"> - <void property="datePattern"> - <string>EEE MMM dd hh:mm:ss yyyy ZZZZ</string> - </void> - <void property="directoryName"> - <string>/srv/git/binfilter</string> - </void> - <void property="type"> - <string>git</string> - </void> - <void property="working"> - <boolean>true</boolean> - </void> - </object> - </void> - <void method="add"> - <object class="org.opensolaris.opengrok.history.RepositoryInfo"> - <void property="datePattern"> - <string>EEE MMM dd hh:mm:ss yyyy ZZZZ</string> - </void> - <void property="directoryName"> - <string>/srv/git/help</string> - </void> - <void property="type"> - <string>git</string> - </void> - <void property="working"> - <boolean>true</boolean> - </void> - </object> - </void> - <void method="add"> - <object class="org.opensolaris.opengrok.history.RepositoryInfo"> - <void property="datePattern"> - <string>EEE MMM dd hh:mm:ss yyyy ZZZZ</string> - </void> - <void property="directoryName"> - <string>/srv/git/core</string> - </void> - <void property="type"> - <string>git</string> - </void> - <void property="working"> - <boolean>true</boolean> - </void> - </object> - </void> - <void method="add"> - <object class="org.opensolaris.opengrok.history.RepositoryInfo"> - <void property="datePattern"> - <string>EEE MMM dd hh:mm:ss yyyy ZZZZ</string> - </void> - <void property="directoryName"> - <string>/srv/git/translations</string> - </void> - <void property="type"> - <string>git</string> - </void> - <void property="working"> - <boolean>true</boolean> - </void> - </object> - </void> - </void> - <void property="sourceRoot"> - <string>/srv/git</string> - </void> - <void property="urlPrefix"> - <string>/s?</string> - </void> - <void property="webappLAF"> - <string>libreoffice</string> - </void> - <void property="bugPage"> - <string>https://bugs.freedesktop.org/show_bug.cgi?id=</string> - </void> - <void property="bugPattern"> - <string>(?:fdo#|#fdo)([123456789][0-9]+)</string> - </void> - </object> -</java> diff --git a/patches/all-code.diff b/patches/all-code.diff deleted file mode 100644 index 82158dc..0000000 --- a/patches/all-code.diff +++ /dev/null @@ -1,29 +0,0 @@ -diff -ur a/web/menu.jspf b/web/menu.jspf ---- a/web/menu.jspf 2010-05-11 10:10:08.000000000 +0200 -+++ b/web/menu.jspf 2011-02-17 13:21:20.000000000 +0100 -@@ -70,10 +70,13 @@ - function selectAllProjects() { - $("#project *").attr("selected","selected"); - } --function invertAllProjects() { -+function codeOnlyProjects() { -+ $("#project *").attr("selected","selected"); - $("#project *").each( function(){ -- if ( $(this).attr("selected") ) { $(this).removeAttr("selected") } -- else { $(this).attr("selected","true"); } -+ var value = $(this).attr("value"); -+ if ( value == 'translations' || value == 'l10n' || value == 'help' ) { -+ $(this).removeAttr("selected") -+ } - } - ); - } -@@ -101,7 +104,7 @@ - <table border="0"> - <tbody> - <tr> -- <td>in project(s): <span style="padding-left:60px;font-size:small"><a tabindex="6" href="#" onclick="javascript:selectAllProjects();return false;">select all</a> | <a href="#" tabindex="7" onclick="javascript:invertAllProjects();return false;">invert selection</a></span></td> -+ <td>in project(s): <span style="padding-left:60px;font-size:small"><a tabindex="6" href="#" onclick="javascript:selectAllProjects();return false;">select all</a> | <a href="#" tabindex="7" onclick="javascript:codeOnlyProjects();return false;">all code</a></span></td> - </tr> - <tr><td> - <select tabindex="8" onkeyup="javascript:checkEnter(event);" class="q" style="width: 300px" id="project" name="project" multiple="multiple" size="<%=Math.min(6, env.getProjects().size())%>"> diff --git a/patches/bug-16692.diff b/patches/bug-16692.diff deleted file mode 100644 index da8101b..0000000 --- a/patches/bug-16692.diff +++ /dev/null @@ -1,70 +0,0 @@ -diff -r 2a27ccb1bba5 -r 3b798fad36ed web/search.jsp ---- a/web/search.jsp Tue Aug 03 14:34:22 2010 +0200 -+++ b/web/search.jsp Tue Aug 03 17:21:43 2010 +0200 -@@ -16,8 +16,7 @@ - - CDDL HEADER END - --Copyright 2010 Sun Microsystems, Inc. All rights reserved. --Use is subject to license terms. -+Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. - - --%><%@ page import = "javax.servlet.*, - java.lang.Integer, -@@ -43,7 +42,6 @@ - org.apache.lucene.store.FSDirectory, - org.apache.lucene.analysis.*, - org.apache.lucene.document.*, --org.apache.lucene.index.*, - org.apache.lucene.search.*, - org.apache.lucene.queryParser.*" - %><%@ page session="false" %><%@ page errorPage="error.jsp" %><% -@@ -104,7 +102,6 @@ - Searcher searcher = null; //the searcher used to open/search the index - TopScoreDocCollector collector=null; // the collector used - ScoreDoc[] hits = null; // list of documents which result from the query -- IndexReader ireader = null; //the reader used to open/search the index - Query query = null; //the Query created by the QueryBuilder - boolean allCollected=false; - int totalHits=0; -@@ -158,8 +155,8 @@ - int ii = 0; - //TODO might need to rewrite to Project instead of String , need changes in projects.jspf too - for (String proj : project) { -- ireader = (IndexReader.open(FSDirectory.open(new File(droot, proj)),true)); -- searchables[ii++] = new IndexSearcher(ireader); -+ FSDirectory dir = FSDirectory.open(new File(droot, proj)); -+ searchables[ii++] = new IndexSearcher(dir); - } - if (Runtime.getRuntime().availableProcessors() > 1) { - searcher = new ParallelMultiSearcher(searchables); -@@ -168,13 +165,13 @@ - } - } else { // just 1 project selected - root = new File(root, project.get(0)); -- ireader = IndexReader.open(FSDirectory.open(root),true); -- searcher = new IndexSearcher(ireader); -+ FSDirectory dir = FSDirectory.open(root); -+ searcher = new IndexSearcher(dir); - } - } - } else { //no project setup -- ireader = IndexReader.open(FSDirectory.open(root),true); -- searcher = new IndexSearcher(ireader); -+ FSDirectory dir = FSDirectory.open(root); -+ searcher = new IndexSearcher(dir); - } - - //TODO check if below is somehow reusing sessions so we don't requery again and again, I guess 2min timeout sessions could be usefull, since you click on the next page within 2mins, if not, then wait ;) -@@ -516,8 +513,9 @@ - } - %><br/></div><%@include file="foot.jspf"%><% - } -- if (ireader != null) -- ireader.close(); -+ if (searcher != null) { -+ searcher.close(); -+ } - } else { // Entry page show the map - response.sendRedirect(context + "/index.jsp"); - } diff --git a/patches/bug-17127.diff b/patches/bug-17127.diff deleted file mode 100644 index 3c0a8d9..0000000 --- a/patches/bug-17127.diff +++ /dev/null @@ -1,11 +0,0 @@ -diff -r aa6f8f87e5f3 -r d48bc6f573d5 web/search.jsp ---- a/web/search.jsp Fri Sep 24 13:05:26 2010 +0200 -+++ b/web/search.jsp Tue Sep 28 10:11:31 2010 +0200 -@@ -399,6 +399,7 @@ - %></p><% - } - spellDirectory.close(); -+ checker.close(); - } - - } diff --git a/patches/empty-context-fix.diff b/patches/empty-context-fix.diff deleted file mode 100644 index 643c255..0000000 --- a/patches/empty-context-fix.diff +++ /dev/null @@ -1,48 +0,0 @@ -diff -u a/web/enoent.jsp b/web/enoent.jsp ---- a/web/enoent.jsp 2010-05-11 10:10:08.000000000 +0200 -+++ b/web/enoent.jsp 2010-10-08 14:58:33.000000000 +0200 -@@ -49,7 +49,7 @@ - <%@ include file="pageheader.jspf" %> - </div> - <div id="Masthead"></div> --<div id="bar"><a id="home" href="<%=context%>">Home</a> | <input id="search" name="q" class="q"/> <input type="submit" value="Search" class="submit"/> </div> -+<div id="bar"><a id="home" href="<%=context%>/">Home</a> | <input id="search" name="q" class="q"/> <input type="submit" value="Search" class="submit"/> </div> - <h3 class="error">Error 404: File not found!</h3> - The requested resource is not available. <%=configError%> - <div style="display:block;height:10em"> </div><%@include file="foot.jspf"%> -diff -u a/web/error.jsp b/web/error.jsp ---- a/web/error.jsp 2010-05-11 10:10:08.000000000 +0200 -+++ b/web/error.jsp 2010-10-08 14:58:56.000000000 +0200 -@@ -45,7 +45,7 @@ - <%@ include file="pageheader.jspf" %> - </div> - <div id="Masthead"></div> --<div id="bar"><a id="home" href="<%=context%>">Home</a> | <input id="search" name="q" class="q"/> <input type="submit" value="Search" class="submit"/> </div> -+<div id="bar"><a id="home" href="<%=context%>/">Home</a> | <input id="search" name="q" class="q"/> <input type="submit" value="Search" class="submit"/> </div> - <h3 class="error">There was an error!</h3> - <p><%=configError%> - </p><pre><% -diff -u a/web/mast.jsp b/web/mast.jsp ---- a/web/mast.jsp 2010-05-11 10:10:08.000000000 +0200 -+++ b/web/mast.jsp 2010-10-08 14:59:53.000000000 +0200 -@@ -167,7 +167,7 @@ - <div id="pagetitle"><b id="filename">Cross Reference: <%=basename%></b><% if (dtag!=null & dtag!="") { %><br/><%=dtag%><% } %></div> - </div> - <div id="Masthead"><tt><a href="<%=context%>/xref/">xref</a>: <%=org.opensolaris.opengrok.web.Util.breadcrumbPath(context + "/xref", path)%></tt></div> -- <div id="bar"><a href="<%=context%>" id="home">Home</a> | -+ <div id="bar"><a href="<%=context%>/" id="home">Home</a> | - <% - - if (noHistory || servlet.startsWith("/hi")) { -diff -u a/web/search.jsp b/web/search.jsp ---- a/web/search.jsp 2010-05-11 10:10:08.000000000 +0200 -+++ b/web/search.jsp 2010-10-08 15:00:13.000000000 +0200 -@@ -274,7 +274,7 @@ - <div id="header"><%@ include file="pageheader.jspf" %></div> - <div id="Masthead"></div> - <div id="bar"> -- <table border="0" width="100%"><tr><td><a href="<%=context%>" id="home">Home</a></td><td align="right"><% -+ <table border="0" width="100%"><tr><td><a href="<%=context%>/" id="home">Home</a></td><td align="right"><% - { - String url = "search?"; - url = url + (q == null ? "" : "&q=" + Util.URIEncode(q)) + diff --git a/patches/header-libreoffice-link.diff b/patches/header-libreoffice-link.diff deleted file mode 100644 index 86fc611..0000000 --- a/patches/header-libreoffice-link.diff +++ /dev/null @@ -1,11 +0,0 @@ -diff -ru a/web/pageheader.jspf b/web/pageheader.jspf ---- a/web/pageheader.jspf 2010-05-11 10:10:08.000000000 +0200 -+++ b/web/pageheader.jspf 2011-02-17 13:09:42.000000000 +0100 -@@ -20,6 +20,4 @@ - Use is subject to license terms. - - --%> --<% String home = request.getContextPath(); --%> --<a href="<%=home%>"><div id="MastheadLogo"><h1> OpenGrok </h1></div></a> -+<a href="http://www.libreoffice.org"><div id="MastheadLogo"><h1> LibreOffice </h1></div></a> diff --git a/patches/index.diff b/patches/index.diff deleted file mode 100644 index 12dee8b..0000000 --- a/patches/index.diff +++ /dev/null @@ -1,27 +0,0 @@ ---- a/web/index_body.html 2010-05-11 10:10:08.000000000 +0200 -+++ b/web/index_body.html 2010-10-08 14:34:33.000000000 +0200 -@@ -1,21 +1,6 @@ - <p> - <b>OpenGrok - a "wicked fast" source browser!</b> - </p> -- <p> -- This is the front page of of your <a href="xref/">browsable and searchable -- source tree</a> (<a href="xref/">xref/</a>).</p> -- <p> -- To setup and configure OpenGrok please refer to -- <a href="http://www.opensolaris.org/os/project/opengrok/">http://www.opensolaris.org/os/project/opengrok/</a> -- or README.txt in the distribution. -- </p> -- <p> -- You can replace this block of text(in index_body.html) with some more useful -- information about your source tree and its organization, with direct -- links to key parts of code base. -- </p> -- <br/> -- <br/> -- <br/> -- <br/> -- <br/> -+ <p>This is a tool to search in the <a href="http://documentfoundation.org">LibreOffice</a> GIT reposities. The source code -+itself can be found at: <a href="http://cgit.freedesktop.org/libreoffice">http://cgit.freedesktop.org/libreoffice</a>.</p> -+ <p>Some hacking hints can be read on the <a href="http://wiki.documentfoundation.org/Development">LibreOffice development wiki pages</a>.</p> diff --git a/patches/remote-attribute.diff b/patches/remote-attribute.diff deleted file mode 100644 index beabf46..0000000 --- a/patches/remote-attribute.diff +++ /dev/null @@ -1,39 +0,0 @@ ---- a/web/search.jsp 2012-04-17 17:18:14.147097100 +0100 -+++ b/web/search.jsp 2012-04-17 17:12:42.679094963 +0100 -@@ -48,11 +48,12 @@ - org.apache.lucene.queryParser.*" - %><%@ page session="false" %><%@ page errorPage="error.jsp" %><% - Date starttime = new Date(); --String q = request.getParameter("q"); --String defs = request.getParameter("defs"); --String refs = request.getParameter("refs"); --String hist = request.getParameter("hist"); --String path = request.getParameter("path"); -+String remote = request.getParameter("remote"); -+String q = request.getParameter("q"); -+String defs = request.getParameter("defs"); -+String refs = request.getParameter("refs"); -+String hist = request.getParameter("hist"); -+String path = request.getParameter("path"); - - %><%@ include file="projects.jspf" %><% - String sort = null; -@@ -269,7 +270,7 @@ - RuntimeEnvironment environment = RuntimeEnvironment.getInstance(); - environment.register(); - %><%@ include file="httpheader.jspf" %> --<body> -+<body <% if( remote != null && remote.equals("true") ) { %> id="remote" <% } %> > - <div id="page"> - <div id="header"><%@ include file="pageheader.jspf" %></div> - <div id="Masthead"></div> -@@ -425,7 +426,8 @@ - (refs == null ? "" : "&refs=" + Util.URIEncode(refs)) + - (path == null ? "" : "&path=" + Util.URIEncode(path)) + - (hist == null ? "" : "&hist=" + Util.URIEncode(hist)) + -- (sort == null ? "" : "&sort=" + Util.URIEncode(sort)); -+ (sort == null ? "" : "&sort=" + Util.URIEncode(sort)) + -+ (remote == null ? "" : "&remote=" + Util.URIEncode(remote)); - if (hasProjects) { - urlp = urlp + "&project="; - for (Iterator it = project.iterator(); it.hasNext();) { diff --git a/patches/select-all.diff b/patches/select-all.diff deleted file mode 100644 index b65244a..0000000 --- a/patches/select-all.diff +++ /dev/null @@ -1,16 +0,0 @@ ---- a/web/projects.jspf 2010-10-08 10:01:07.202553872 +0200 -+++ b/web/projects.jspf 2010-10-08 14:16:37.494001297 +0200 -@@ -70,6 +70,13 @@ - Project defaultProject = env.getDefaultProject(); - if (defaultProject != null && project.isEmpty()) { - project.add(defaultProject.getDescription()); -+ } else if ( project.isEmpty()) { -+ // Make all projects default instead of none -+ for (Project p : projects) { -+ if ( p.getPath().endsWith( "/core" ) ) { -+ project.add(p.getDescription()); -+ } -+ } - } - - //only save found projects into cookies diff --git a/patches/show-entire-bug-text.diff b/patches/show-entire-bug-text.diff deleted file mode 100644 index 6c4d559..0000000 --- a/patches/show-entire-bug-text.diff +++ /dev/null @@ -1,12 +0,0 @@ -diff -ur a/web/history.jsp b/web/history.jsp ---- a/web/history.jsp 2010-05-11 10:10:08.000000000 +0200 -+++ b/web/history.jsp 2011-02-17 16:37:54.000000000 +0100 -@@ -173,7 +173,7 @@ - %> </td><td><% - String cout=Util.htmlize(entry.getMessage()); - if (bugPage != null && ! bugPage.equals("")){ -- cout=bugPattern.matcher(cout).replaceAll("<a href=\"" + bugPage + "$1\">$1</a>"); } -+ cout=bugPattern.matcher(cout).replaceAll("<a href=\"" + bugPage + "$1\">$0</a>"); } - if (reviewPage != null && ! reviewPage.equals("")) { - cout=reviewPattern.matcher(cout).replaceAll("<a href=\"" + reviewPage + "$1\">$1</a>"); } - %><%= cout %> diff --git a/patches/toadd/libreoffice/img/background-page.png b/patches/toadd/libreoffice/img/background-page.png Binary files differdeleted file mode 100644 index f9ff7b0..0000000 --- a/patches/toadd/libreoffice/img/background-page.png +++ /dev/null diff --git a/patches/toadd/libreoffice/img/bg.png b/patches/toadd/libreoffice/img/bg.png Binary files differdeleted file mode 100644 index c4a0a24..0000000 --- a/patches/toadd/libreoffice/img/bg.png +++ /dev/null diff --git a/patches/toadd/libreoffice/img/button1.png b/patches/toadd/libreoffice/img/button1.png Binary files differdeleted file mode 100644 index 720e35c..0000000 --- a/patches/toadd/libreoffice/img/button1.png +++ /dev/null diff --git a/patches/toadd/libreoffice/img/button2.png b/patches/toadd/libreoffice/img/button2.png Binary files differdeleted file mode 100644 index 2b18d4e..0000000 --- a/patches/toadd/libreoffice/img/button2.png +++ /dev/null diff --git a/patches/toadd/libreoffice/img/header.png b/patches/toadd/libreoffice/img/header.png Binary files differdeleted file mode 100644 index f60318d..0000000 --- a/patches/toadd/libreoffice/img/header.png +++ /dev/null diff --git a/patches/toadd/libreoffice/img/heading-green.png b/patches/toadd/libreoffice/img/heading-green.png Binary files differdeleted file mode 100644 index 7adf6e4..0000000 --- a/patches/toadd/libreoffice/img/heading-green.png +++ /dev/null diff --git a/patches/toadd/libreoffice/img/icon.png b/patches/toadd/libreoffice/img/icon.png Binary files differdeleted file mode 100644 index 969eb3b..0000000 --- a/patches/toadd/libreoffice/img/icon.png +++ /dev/null diff --git a/patches/toadd/libreoffice/img/indicator.gif b/patches/toadd/libreoffice/img/indicator.gif Binary files differdeleted file mode 100644 index 085ccae..0000000 --- a/patches/toadd/libreoffice/img/indicator.gif +++ /dev/null diff --git a/patches/toadd/libreoffice/img/libreoffice-logo.png b/patches/toadd/libreoffice/img/libreoffice-logo.png Binary files differdeleted file mode 100644 index cb961b5..0000000 --- a/patches/toadd/libreoffice/img/libreoffice-logo.png +++ /dev/null diff --git a/patches/toadd/libreoffice/img/servedby.png b/patches/toadd/libreoffice/img/servedby.png Binary files differdeleted file mode 100644 index dfe6efc..0000000 --- a/patches/toadd/libreoffice/img/servedby.png +++ /dev/null diff --git a/patches/toadd/libreoffice/img/transparent_pixel.gif b/patches/toadd/libreoffice/img/transparent_pixel.gif Binary files differdeleted file mode 100644 index 0b6452b..0000000 --- a/patches/toadd/libreoffice/img/transparent_pixel.gif +++ /dev/null diff --git a/patches/toadd/libreoffice/jquery.autocomplete.css b/patches/toadd/libreoffice/jquery.autocomplete.css deleted file mode 100644 index f49bfb0..0000000 --- a/patches/toadd/libreoffice/jquery.autocomplete.css +++ /dev/null @@ -1,48 +0,0 @@ -.ac_results { - padding: 0px; - border: 1px solid black; - background-color: white; - overflow: hidden; - z-index: 99999; -} - -.ac_results ul { - width: 100%; - list-style-position: outside; - list-style: none; - padding: 0; - margin: 0; -} - -.ac_results li { - margin: 0px; - padding: 2px 5px; - cursor: default; - display: block; - /* - if width will be 100% horizontal scrollbar will apear - when scroll mode will be used - */ - /*width: 100%;*/ - font: menu; - font-size: 12px; - /* - it is very important, if line-height not setted or setted - in relative units scroll will be broken in firefox - */ - line-height: 16px; - overflow: hidden; -} - -.ac_loading { - background: white url('./img/indicator.gif') right center no-repeat; -} - -.ac_odd { - background-color: #eee; -} - -.ac_over { - background-color: #0A246A; - color: white; -} diff --git a/patches/toadd/libreoffice/jquery.combo.css b/patches/toadd/libreoffice/jquery.combo.css deleted file mode 100644 index fc1f4c0..0000000 --- a/patches/toadd/libreoffice/jquery.combo.css +++ /dev/null @@ -1,68 +0,0 @@ -.combo_td1 { - background: url('./img/bg.png') no-repeat; - width: 158px; -} - -.combo_td1 input { - margin-left: 5px; - margin-right: 5px; - margin-top: 3px; - height: 18px; - width: 274px; - border: 0; - display: block; -} - -.combo_td1 div { - background-color: white; - margin-bottom: 2px; -} - -.combo_td2 { - cursor: pointer; - height: 25px; - width: 22px; - cursor: pointer; -} - -.combo_td2 img { - display: block; - margin: 0; - padding: 0; - border: 0; - height: 25px; -} - -.combo_td2 a { - background: url('./img/button1.png'); - display: block; - height: 25px; - width: 22px; -} - -.combo_td2 a:hover { - background: url('./img/button2.png'); -} - -.combo_input1 { - background: transparent url(./img/transparent_pixel.gif) repeat scroll 0% 0%; -/* color: gray; */ - -moz-background-clip: border; - -moz-background-origin: padding; - -moz-background-inline-policy: continuous; -} - -.combo_div { - padding: 0; - margin: 0; - padding-left: 4px; - background: url('./img/transparent_pixel.gif'); -} - -.combo_div4 { - -moz-background-clip: border; - -moz-background-origin: padding; - -moz-background-inline-policy: continuous; -} - - diff --git a/patches/toadd/libreoffice/jquery.tooltip.css b/patches/toadd/libreoffice/jquery.tooltip.css deleted file mode 100644 index 85fc5c2..0000000 --- a/patches/toadd/libreoffice/jquery.tooltip.css +++ /dev/null @@ -1,9 +0,0 @@ -#tooltip {
- position: absolute;
- z-index: 3000;
- border: 1px solid #111;
- background-color: #eee;
- padding: 5px;
- opacity: 0.90;
-}
-#tooltip h3, #tooltip div { margin: 0; font-size: small; }
diff --git a/patches/toadd/libreoffice/print.css b/patches/toadd/libreoffice/print.css deleted file mode 100644 index 471099e..0000000 --- a/patches/toadd/libreoffice/print.css +++ /dev/null @@ -1,188 +0,0 @@ -body { - background-color: #ffffff; -/* font-size: 100.01%;*/ - color: black; - font-family: arial, sans-serif; -/* padding: 1em; - margin: 0em;*/ -} - -#Masthead { - background: none; - display:block; - border: none; - border-bottom: 1px solid #000; - /*padding-bottom:3px; - margin-bottom: 3px;*/ -} - -#header { -min-height:44px; -} - -#content { - position:absolute; - bottom:0px; - left:0px; - right:0px; - padding-left: 1em; - padding-top:7px; - overflow:auto; - top:6em; - } - -#whole_header { - height:6em; - padding-left: 1em; - padding-right: 1em; - position:absolute; - top:0; - right:0px; - left:0px; - /*width:98%;*/ - overflow:auto; - } - -#MastheadLogo h1 { - display:inline; - font-size:medium; -} - -#MastheadLogo { - background-color: white; - background-image: none; -/* background-image: url(./img/header-bw.png);*/ - background-position: 0px 8px; - background-repeat: no-repeat; - float: left; - height: 48px; - width: 270px; - border: none; - text-decoration: none; -} - -#pagetitle { - float: right; - font-size: large; - text-align:right; - color:#000; -} - -#filename { - font-size: x-large; - text-align:right; - color:#000; -} - -#bar { - padding-left: 0.5em; - margin-bottom:1em; - display: none; -} - -input.q { - color: #000; - border: 1px solid #000; - font-weight: normal; - padding:2px; -} - -input.submit { - background-color: #ccc; - color: #000; - border: 1px solid #000; - padding: 0px; - font-weight: bold; - min-width:4em; - text-align:center; -} - -input.submit:hover, input.submit:active { - background-color: #ddd; - color: #000; - border: 1px solid #000; - padding: 0px; - font-weight: bold; - min-width:4em; - text-align:center; -} - -.thead { -background-color:#ddd; -border-bottom:1px solid #000; -font-weight:bold; -} - -.alt { -background-color:#fff; -} - -a:link {color:#000;text-decoration:none;} -a:visited {color:#000;text-decoration:none;} -a:active, a:hover {color:#000;text-decoration:underline;} -img {border:0;} - -tt {margin:0;} - - -form, pre {padding:0px;margin:0px;} -#src {font-size:75%;} -#src .l {color:#000;border-right: 1px solid #000;background-color:#fff;margin-right:.5em;padding-right:.5em;text-decoration:none;} -#src .hl {color:#000;border-right: 1px solid #000;background-color:#fff;margin-right:.5em;padding-right:.5em;text-decoration:none;font-weight:bold;} -#src .l-hide {display: none} -#src .hl-hide {display: none} -#src tt{padding-left:1em; padding-right:1em;} -.sl {color:#999;text-decoration:underline;} -td.a{color:#000} -.n {color:#000;} -.s {color:#000;} -.c {color:#000; font-style:italic;} -a.d {color:#000; font-weight:bold; font-style:italic;text-decoration:none;} -a.s {color:#000;} /* matched lines */ -a.f {color:#000;} -div.a{color:#000} - -#results .con{font-size:small;color:#000;} -#more .l, #results .l { color:#888; } -#results .m {background-color:#ffb;} -#results i {color: #000; font-weight:bold;} -#results tr.dir{background-color:#fff;border-top:3px solid #000;} -#results td.f{width:3em;padding-left:2em;padding-right:.5em;} - -#more { line-height:1.25em;} -#more b { background-color:transparent;} - -#diffbar {border-bottom: 1px solid #000; padding-left:2em;font-size:medium; margin-top:1em;} -#difftable {border:#000; border-collapse:collapse;font-size:small;} -span.tab { padding: 5px; padding-top:3px; padding-bottom: 0px; margin-left: 2px; margin-right: 2px; margin-bottom:0px ;background-color:#eee; border:1px solid #000;border-bottom:1px none;} -span.tabsel { padding: 6px; padding-top:5px; padding-bottom: 1px; margin-left: 2px; margin-right: 2px; background-color:#fff; border:1px solid #000; border-bottom:2px solid #fff;} -#difftable .d { background-color:#FFCC40;font-weight:bold;} -#difftable .a { background-color:#8BD98B;font-weight:bold;} -tr.k {border-bottom:1px dashed #000;} -#difftable i {color:#666;background-color:#ddd;margin-right:.2em;padding-left:1em;padding-right:.5em;text-decoration:none;} -#difftable i.a {background-color:#FFDD80;color:#666; font-weight:bold;} -strike.d{background-color:#bbddbb; margin-right:.2em;padding-left:1em;padding-right:.5em;} -#difftable td.d { background-color:#eeeeee;} -.grey{background-color:#eee;} - -#badge img { display:none; } - -#Footer { - background-color: white; - color: #000; - font-size: 75%; - margin-top: 1em; -} -#Footer p { - margin: 0.6em 0 1em 0; - text-align:center; -} -#Footer a { - color: #000; -} - -.more {background-color:transparent;border: 1px #ccc solid;padding:.3em;margin:1px;} -.sel {background-color:#ddd;border: 1px #000 solid;padding:.5em;margin:1px;} - -span.blame { } -span.blame-hidden { display: none } diff --git a/patches/toadd/libreoffice/style.css b/patches/toadd/libreoffice/style.css deleted file mode 100644 index a42b7a7..0000000 --- a/patches/toadd/libreoffice/style.css +++ /dev/null @@ -1,233 +0,0 @@ - -body { - background:#FFFFFF url(img/background-page.png) repeat-x scroll 0 0; - color: black; - font-family: arial, sans-serif; - margin: 0; -} - -#page { - margin: auto; - width: 900px; -} - -#Masthead { - background: none; - border: none; - display:block; - background-image: url(img/header.png); - background-position:0 bottom; - padding-left: 5px; - padding-right: 5px; - height: 15px; -} -#header { - background-image: url(img/header.png); - padding-left: 5px; - padding-right: 5px; - height:88px; - display: block; -/*width: 98%;*/ -} - -#content { - position:absolute; - bottom:0px; - left:0px; - right:0px; - padding-left: 1em; - padding-top:7px; - overflow:auto; - top:150px; - } - -#whole_header { - height:6em; - top:0; - right:0px; - left:0px; - } - -#MastheadLogo h1 { - display: none; -} - -#MastheadLogo { - background:transparent url(img/libreoffice-logo.png) no-repeat scroll 18px 20px; - height: 45px; - width: 218px; - padding:18px 20px; -} - -#pagetitle { - font-size: large; - color:#5382a1; - text-align:right; - position: relative; - top: -20px; - right: 0.5em; -} - -#filename { - font-size: x-large; - color:#000; - text-align:right; -} - -#menu { - margin-left: 5em; -} - -#bar { - padding-left: 0.5em; - margin-bottom:0.2em; -} - -input.q { - background-color: #ffffff; - color: #000; - border-left: 1px solid #bbbbff; - border-top: 1px solid #bbbbff; - border-right: 1px solid #93a8bb; - border-bottom: 1px solid #93a8bb; - font-weight: normal; - padding:2px; -} - -input.submit { - background-color: #43c330; - color: #fff; - padding: 0px; - border-left: 1px solid #92e285; - border-top: 1px solid #92e285; - border-right: 1px solid #106802; - border-bottom: 1px solid #106802; - font-weight: bold; - min-width:4em; - text-align:center; -} - -input.submit:hover, input.submit:active { - background-color: #106802; - color: #fff; - padding: 0px; - border-left: 1px solid #92e285; - border-top: 1px solid #92e285; - border-right: 1px solid #106802; - border-bottom: 1px solid #106802; - font-weight: bold; - min-width:4em; - text-align:center; -} - -.thead { - background-color:#C5D5A9; - font-weight:bold; -} - -.alt { - background-color:#e8e8f0; -} - -#results a {color:#1C99E0;text-decoration:none;} -#results a:visited {color:#023f62;text-decoration:none;} -#results a:active, #results a:hover {color:#0369a3;text-decoration:underline;} - -#results tr.dir a {color:#18A303;text-decoration:none;} -#results tr.dir a:visited {color:#106802;text-decoration:none;} -#results tr.dir a:active, #results a:hover {color:#18A303;text-decoration:underline;} - -a {color:#18a303;text-decoration:none;} -a:visited {color:#105802;text-decoration:none;} -a:active, a:hover {color:#106802;text-decoration:underline;} -img {border:0;} -tt {margin:0;} -form, pre {padding:0px;margin:0px;} - -#src .l {color:#888;background-color:#ddd;padding-right:.1em;margin-right:.2em;text-align:right;} -#src .hl {color:#000;background-color:#ddd;padding-right:.1em;margin-right:.2em;text-align:right;} -#src .l-hide {display: none} -#src .hl-hide {display: none} -#src tt{padding-left:1em; padding-right:1em;} - -.sl {color:#999;text-decoration:underline;} -td.a{color:#000} -.n {color:brown;} /* numbers */ -.s {color:green;} /* strings */ -.c {color:#666;} /* comments */ -.b {color:#000; font-weight:bold;} /* comments */ -.k {color:#000; font-family:monospace;} /* comments */ -a.d {color:#909; font-weight:bold; font-style:italic;text-decoration:none;} /* definitions */ -a.s {color:#000;} /* matched lines */ -a.f {color:#909;} /* file locals */ -div.a {color:#000} -a.h {font-size:small; margin-left:2em;} - -#results {margin-top:.5em;} -#results .con{font-size:small;color:#000;} -#more .l, #results .l { color:#666; } -#results .m {background-color:#ffb;} -#results i {color: green; font-weight:bold;} -#results tr.dir td { - background:transparent url(img/heading-green.png) repeat-x scroll 0 bottom; - border-bottom:1px solid #92E285; - font-weight: 600; -} -#results td.f{width:3em;padding-left:2em;padding-right:.5em;} - -#more { line-height:1.25em;} -#more b { background-color:#ffff99;} - -#diffbar {border-bottom: 2px solid #c5d5a9; padding-left:2em;font-size:medium; } -#difftable {border:#C5D5A9; border-collapse:collapse;font-size:small;} -span.tab { padding: 5px; padding-top:3px; padding-bottom: 0px; margin-left: 2px; margin-right: 2px; margin-bottom:0px ;background-color:#eee; border:2px solid #c5d5a9;border-bottom:2px none #eee;} -span.tabsel { padding: 6px ; padding-top:5px; padding-bottom: 1px; margin-left: 2px; margin-right: 2px; background-color:#fff; border:2px solid #c5d5a9; border-bottom:2px solid #fff;} -#difftable .d { background-color:#FFCC40;} -#difftable .a { background-color:#8BD98B;} -tr.k{border-bottom:1px dashed #ccc;} -#difftable i {color:#666;background-color:#ddd;margin-right:.2em;padding-left:1em;padding-right:.5em;text-decoration:none; font-weight:normal;} -#difftable i.a {background-color:#FFDD80;color:#666;} -strike.d{background-color:#bbddbb; margin-right:.2em;padding-left:1em;padding-right:.5em;} -#difftable td.d { background-color:#eeeeee;} -.grey{background-color:#eee;} - -#badge { padding:3px; } - -.rssbadge { padding:3px; text-align:right; border:0px;} - -#Footer { - background-color: white; - color: #777; - font-size: 95%; - margin-top: 1em; -} -#Footer p { - margin: 0.6em 0 1em 0; - text-align:center; -} -#Footer a { - color: #555; -} - -.more {background-color:#fff;border: 1px #ccc solid;padding:.3em;margin:1px;} -.sel {background-color:#63bbee;border: 1px #0369a3 solid; color: #0369a3; padding:.3em;margin:1px;} -.error {color: brown;} - -span.blame { } -span.blame-hidden { display: none } - - -/* Remote Styles */ - -body#remote { - background:transparent !important -} - -body#remote #page { - width:100% !important; - margin-top:8px -} - -body#remote #header, body#remote #Masthead, body#remote #menu, body#remote #Footer { - display:none !important -} diff --git a/patches/toadd/robots.txt b/patches/toadd/robots.txt deleted file mode 100644 index b93e3f5..0000000 --- a/patches/toadd/robots.txt +++ /dev/null @@ -1,3 +0,0 @@ -User-Agent: * -Disallow: / - |
