Skip to content

Commit bba3d41

Browse files
tarzanektarzanek
authored
Merge pull request #2068 from idodeclare/feature/improve_comments
Fix hang-indent for some descriptions, w/ some rewordings
2 parents e498452 + b8cd2a4 commit bba3d41

File tree

1 file changed

+53
-61
lines changed

1 file changed

+53
-61
lines changed

‎OpenGrok‎

Lines changed: 53 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -69,88 +69,85 @@ Supported Environment Variables for configuring the default setup:
6969
generated
7070
- OPENGROK_CTAGS Full path to Exuberant or Universal CTags binary
7171
- OPENGROK_CTAGS_OPTIONS_FILE Full path to file with extra command line
72-
options for CTags program (for its --options
73-
switch), default is DATA_ROOT/etc/ctags.config
72+
options for CTags program (for its --options
73+
switch). Default is DATA_ROOT/etc/ctags.config
7474
- OPENGROK_MANDOC Full path to mandoc(1) binary
7575
- OPENGROK_LOCKING Locking mode on|off|simple|native (default off)
76-
("on" is an alias for "simple")
76+
("on" is an alias for "simple")
7777
- JAVA_HOME Full Path to Java Installation Root
7878
- JAVA Full Path to java binary (to enable 64bit JDK)
7979
- JAVA_OPTS Java options (e.g. for JVM memory increase
80-
or enabling server JDK)
81-
JAVA_OPTS=-Xmx2048m is the default!
80+
or enabling server JDK)
81+
JAVA_OPTS=-Xmx2048m is the default!
8282
- OPENGROK_APP_SERVER Application Server ("Tomcat", "Glassfish" or
83-
"Resin")
83+
"Resin")
8484
- OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory
8585
- OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory
8686
- OPENGROK_WAR_TARGET_RESIN Resin Specific WAR Target Directory
8787
- OPENGROK_WAR_TARGET Fallback WAR Target Directory
8888
- OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps)
89-
- OPENGROK_GLASSFISH_BASE Base Directory for Glassfish
90-
(contains domains)
89+
- OPENGROK_GLASSFISH_BASE Base Directory for Glassfish (contains domains)
9190
- OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name
9291
- OPENGROK_RESIN_BASE Base Directory for Resin (contains webapps)
9392
- OPENGROK_VERBOSE Enable Verbose Mode in opengrok.jar (*)
9493
- OPENGROK_PROGRESS Shows progress in %(percentage) of working
95-
through project, it's good to have Verbose
96-
Mode enabled too, cost of this is one more
97-
traversal of the project before indexing it(*)
98-
- OPENGROK_RENAMED_FILES_HISTORY If set to "on", get full history of
99-
renamed files for SCMs that support it (Git,
100-
Mercurial).
101-
The default is off.
102-
When set to on, the indexing is slower,
103-
especially in the presence of
104-
lots of renamed files in the repository.
94+
through project. It's good to have Verbose
95+
Mode enabled too. (*)
96+
- OPENGROK_RENAMED_FILES_HISTORY Get full history of renamed files for SCMs
97+
that support it (Git, Mercurial). When set to
98+
on, the indexing is slower, especially in the
99+
presence of lots of renamed files in the
100+
repository.
101+
on|off (default off) (^)
105102
- OPENGROK_GENERATE_HISTORY Influence history cache generation
106-
Following values are recognized:
107-
on - enabled (default)
103+
Following values are recognized:
104+
on - enabled (default) (^)
108105
off - disabled for indexing and UI
109106
dirbased - indexing enabled only for
110107
repos which can fetch history
111108
for directory
112109
local - for local repos only
113110
uionly - enabled for UI only
114-
- OPENGROK_ENABLE_PROJECTS Enable projects (set it to true or false)
115-
Every directory in SRC_ROOT is
116-
considered a separate project
111+
- OPENGROK_ENABLE_PROJECTS Enable projects, where every directory in
112+
SRC_ROOT is considered a separate project.
113+
on|off (default on) (^)
117114
- OPENGROK_IGNORE_PATTERNS Set ignored patterns for indexer to skip.
118115
OPENGROK_IGNORE_PATTERNS="-i dummy"
119116
OPENGROK_IGNORE_PATTERNS="-i f:dummy"
120117
OPENGROK_IGNORE_PATTERNS="-i d:dummy"
121118
Multiple entries can be joined together:
122119
"-i dummy -i d:tmp -i f:dummy"
123120
- OPENGROK_SCAN_REPOS Disable Scan for repositories (*)
124-
- OPENGROK_SCAN_DEPTH how deep should scanning for repos go
125-
(by default 3 directories from SRC_ROOT)
121+
- OPENGROK_SCAN_DEPTH How deep should scanning for repos go
122+
(by default 3 directories from SRC_ROOT)
126123
- OPENGROK_WEBAPP_CFGADDR Web app address to send configuration to
127-
(use "none" to avoid sending it to web app)
124+
(use "none" to avoid sending it to web app)
128125
- OPENGROK_WEBAPP_CONTEXT Context URL of the OpenGrok webapp
129-
(by default /source)
130-
- FULL reindex is needed once this is used
131-
(old already indexed files won't be refreshed)
132-
- OPENGROK_WPREFIX Disable wildcard prefix search query
133-
support (*)
126+
(by default /source). FULL reindex is needed
127+
once this is used (old already indexed files
128+
won't be refreshed)
129+
- OPENGROK_WPREFIX Disable wildcard prefix search query support (*)
134130
- OPENGROK_TAG Enable parsing of revision tags into the History
135-
view
131+
view
136132
- OPENGROK_READ_XML_CONFIGURATION file with read only configuration
137133
- temporary workaround for bug # 327
138134
- OPENGROK_FLUSH_RAM_BUFFER_SIZE="-m 16" - set RAM buffer size for flushing,
139-
default is 16MB per thread, you might try to
140-
increase it to 256MB, but do increase JVM to
141-
4/8/16GB ! Lucene defaults to 8 threads.
142-
Increase JVM memory as noted using JAVA_OPTS
135+
default is 16MB per thread, you might try to
136+
increase it to 256MB, but do increase JVM to
137+
4/8/16GB ! Lucene defaults to 8 threads.
138+
Increase JVM memory as noted using JAVA_OPTS
143139
- OPENGROK_PARALLELISM Default is 0, meaning that parallelism is
144140
determined from available processors.
145141
- OPENGROK_LOGGER_CONFIG_PATH Set path to custom logging.properties file.
146-
- OPENGROK_SUBVERSION_USERNAME name of the user that should be used for
147-
fetching the history from subversion
148-
- OPENGROK_SUBVERSION_PASSWORD password of the user that should be used for
149-
fetching the history from subversion
150-
- OPENGROK_PROFILER Pause to await user input for profiling.
142+
- OPENGROK_SUBVERSION_USERNAME Name of the user that should be used for
143+
fetching the history from subversion
144+
- OPENGROK_SUBVERSION_PASSWORD Password of the user that should be used for
145+
fetching the history from subversion
146+
- OPENGROK_PROFILER Pause to await user input for profiling. (*)
151147
152148
Notes:
153149
(*) Any Non-Empty String will enable these options
150+
(^) on|true|1 are synonyms, as are off|false|0
154151
155152
Supported Operating Systems:
156153
- Solaris 11 (SunOS 5.11)
@@ -309,9 +306,8 @@ DefaultInstanceConfiguration()
309306
# OPTIONAL: Enable Projects
310307
# (Every directory in SRC_ROOT is considered a separate project)
311308
OPENGROK_ENABLE_PROJECTS="${OPENGROK_ENABLE_PROJECTS:-true}"
312-
case $OPENGROK_ENABLE_PROJECTS in
313-
true) ENABLE_PROJECTS="-P" ;;
314-
false) ENABLE_PROJECTS="" ;;
309+
case "$OPENGROK_ENABLE_PROJECTS" in
310+
off|false|0) ENABLE_PROJECTS="" ;;
315311
*) ENABLE_PROJECTS="-P" ;;
316312
esac
317313

@@ -322,24 +318,20 @@ DefaultInstanceConfiguration()
322318
SCAN_FOR_REPOSITORY=""
323319
fi
324320

325-
# OPTIONAL: Disable remote repository support (CVS or SVN) [on by default]
326-
GENERATE_HISTORY="-r on"
327-
if [ -n "${OPENGROK_GENERATE_HISTORY}" ]
328-
then
329-
GENERATE_HISTORY="-r ${OPENGROK_GENERATE_HISTORY}"
330-
fi
331-
332-
if [ "$OPENGROK_GENERATE_HISTORY" != "off" ]
333-
then
334-
GENERATE_HISTORY="${GENERATE_HISTORY} -H"
335-
fi
321+
# OPTIONAL: remote repository support (CVS or SVN) [on by default]
322+
OPENGROK_GENERATE_HISTORY="${OPENGROK_GENERATE_HISTORY:-on}"
323+
case "$OPENGROK_GENERATE_HISTORY" in
324+
off|false|0) GENERATE_HISTORY="-r off" ;;
325+
on|true|1) GENERATE_HISTORY="-r on -H" ;;
326+
*) GENERATE_HISTORY="-r $OPENGROK_GENERATE_HISTORY -H" ;;
327+
esac
336328

337-
if [ "$OPENGROK_RENAMED_FILES_HISTORY" != "on" ]
338-
then
339-
RENAMED_FILES_HISTORY="--renamedHistory off"
340-
else
341-
RENAMED_FILES_HISTORY="--renamedHistory on"
342-
fi
329+
# OPTIONAL: Detect historical renamings if supported [off by default]
330+
OPENGROK_RENAMED_FILES_HISTORY="${OPENGROK_RENAMED_FILES_HISTORY:-off}"
331+
case "$OPENGROK_RENAMED_FILES_HISTORY" in
332+
on|true|1) RENAMED_FILES_HISTORY="--renamedHistory on" ;;
333+
*) RENAMED_FILES_HISTORY="--renamedHistory off" ;;
334+
esac
343335

344336
# OPTIONAL: override depth of scanning for repositories
345337
if [ -n "${OPENGROK_SCAN_DEPTH}" ]

0 commit comments

Comments
 (0)