Skip to content

Commit 2e3bfc1

Browse files
committed
Merge remote-tracking branch 'upstream/master' into mavenize
# Conflicts: # README.md # debian/copyright # doc/authorization_howto.txt # doc/groups_howto.txt # jrcs/pom.xml # opengrok-indexer/pom.xml # opengrok-indexer/src/main/java/org/opengrok/indexer/search/Search.java # opengrok-indexer/src/test/java/org/opengrok/indexer/search/SearchTest.java # opengrok-web/pom.xml # plugins/pom.xml # pom.xml
2 parents 8a9833b + 4f98942 commit 2e3bfc1

37 files changed

+74
-1956
lines changed

README.md

Lines changed: 22 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,12 @@ Copyright (c) 2006, 2018 Oracle and/or its affiliates. All rights reserved.
1212
3. [Usage](#3-usage)
1313
4. [OpenGrok install](#4-opengrok-install)
1414
5. [OpenGrok setup](#5-opengrok-setup)
15-
6. [Optional Command Line Interface Usage](#6-optional-command-line-interface-usage)
16-
7. [Change web application properties or name](#7-change-web-application-properties-or-name)
17-
8. [Information for developers](#8-information-for-developers)
18-
9. [Tuning OpenGrok for large code bases](#9-tuning-opengrok-for-large-code-bases)
19-
10. [Authors](#10-authors)
20-
11. [Contact us](#11-contact-us)
21-
12. [Demo](#12-demo)
15+
6. [Change web application properties or name](#7-change-web-application-properties-or-name)
16+
7. [Information for developers](#8-information-for-developers)
17+
8. [Tuning OpenGrok for large code bases](#9-tuning-opengrok-for-large-code-bases)
18+
9. [Authors](#10-authors)
19+
10. [Contact us](#11-contact-us)
20+
11. [Demo](#12-demo)
2221

2322
## 1. Introduction
2423

@@ -254,7 +253,9 @@ them and index them.
254253

255254
It basically works like this:
256255

257-
1. bootstrap initial configuration: OpenGrok bootstrap
256+
1. create initial configuration:
257+
258+
`OpenGrok bootstrap`
258259

259260
* this will create `/var/opengrok/etc/configuration.xml` with basic set of
260261
properties. If more is needed use:
@@ -266,7 +267,7 @@ It basically works like this:
266267
2. add a new project **foo**:
267268

268269
```
269-
Messages -t foo -n project add
270+
curl -d "foo" -H "Content-Type: text/plain" -X POST "${webapp_uri}/api/v1/projects"
270271
```
271272
272273
* the project **foo** is now visible in the configuration however is not yet
@@ -280,8 +281,8 @@ It basically works like this:
280281
3. index the project. It will become searchable after that.
281282
282283
```
283-
OPENGROK_READ_XML_CONFIGURATION=/var/opengrok/etc/configuration.xml
284-
OpenGrok indexpart /foo
284+
OPENGROK_READ_XML_CONFIGURATION=/var/opengrok/etc/configuration.xml \
285+
OpenGrok indexpart /foo
285286
```
286287
287288
4. make the project `indexed` status of the project persistent so that if
@@ -314,9 +315,9 @@ project to this directory. The creation of the per-project directory and the
314315
The command used in step 2 can thus look like this:
315316

316317
```bash
317-
OPENGROK_LOGGER_CONFIG_PATH=/var/opengrok/myproj.logging
318-
OPENGROK_READ_XML_CONFIGURATION=/var/opengrok/etc/configuration.xml
319-
OpenGrok indexpart /myproj
318+
OPENGROK_LOGGER_CONFIG_PATH=/var/opengrok/myproj.logging \
319+
OPENGROK_READ_XML_CONFIGURATION=/var/opengrok/etc/configuration.xml \
320+
OpenGrok indexpart /myproj
320321
```
321322

322323
The last argument is path relative to `SRC_ROOT`.
@@ -344,33 +345,6 @@ configuration into a separate file and simplify future upgrades.
344345

345346
See `opengrok.jar` manual below for more details.
346347

347-
#### 5.4.5 Custom ctags configuration
348-
349-
To make ctags recognize additional symbols/definitions/etc. it is possible to
350-
specify configuration file with extra configuration options for ctags.
351-
352-
This can be done by setting `OPENGROK_CTAGS_OPTIONS_FILE` environment variable
353-
when running the OpenGrok shell script (or directly with the `-o` option for
354-
`opengrok.jar`). Default location for the configuration file in the OpenGrok
355-
shell script is `etc/ctags.config` under the OpenGrok base directory (by default
356-
the full path to the file will be `/var/opengrok/etc/ctags.config`).
357-
358-
Sample configuration file for Solaris code base is delivered in the `doc/`
359-
directory.
360-
361-
### 5.6 Introduce own mapping for an extension to analyzer
362-
363-
OpenGrok script doesn't support this out of box, so you'd need to add it there.
364-
Usually to `StdInvocation()` function after line `-jar ${OPENGROK_JAR}`.
365-
It would look like this:
366-
367-
```
368-
-A cs:org.opengrok.indexer.analysis.PlainAnalyzer
369-
```
370-
371-
(this will map extension `.cs` to `PlainAnalyzer`)
372-
You should even be able to override OpenGroks analyzers using this option.
373-
374348
### 5.7 Logging
375349

376350
Both indexer and web app emit extensive log messages.
@@ -386,43 +360,25 @@ If not using the shell script, the path to the configuration file can be
386360
set using the `-Djava.util.logging.config.file=/PATH/TO/MY/logging.properties`
387361
java parameter.
388362

389-
390-
## 6. Optional Command Line Interface Usage
391-
392-
You need to pass location of project file + the query to `Search` class, e.g.
393-
for fulltext search for project with above generated `configuration.xml` you'd
394-
do:
395-
396-
```bash
397-
java -cp ./opengrok.jar org.opengrok.indexer.search.Search -R \
398-
/var/opengrok/etc/configuration.xml -f fulltext_search_string
399-
```
400-
For quick help run:
401-
402-
```bash
403-
java -cp ./opengrok.jar org.opengrok.indexer.search.Search
404-
```
405-
406-
## 7. Change web application properties or name
363+
## 6. Change web application properties or name
407364

408365
See https://github.com/oracle/opengrok/wiki/Webapp-configuration
409366

410-
411-
## 8. Information for developers
367+
## 7. Information for developers
412368

413369
See https://github.com/oracle/opengrok/wiki/Developer-intro and https://github.com/oracle/opengrok/wiki/Developers
414370

415-
## 9. Tuning OpenGrok for large code bases
371+
## 8. Tuning OpenGrok for large code bases
416372

417373
See https://github.com/oracle/opengrok/wiki/Tuning-for-large-code-bases
418374

419-
## 10. Authors
375+
## 9. Authors
420376

421377
The project has been originally conceived in Sun Microsystems by Chandan B.N.
422378

423379
For full list of contributors see https://github.com/oracle/opengrok/graphs/contributors
424380

425-
## 11. Contact us
381+
## 10. Contact us
426382

427383
Feel free to participate in discussion on the mailing lists:
428384

@@ -432,5 +388,6 @@ Feel free to participate in discussion on the mailing lists:
432388

433389
To subscribe, send email to `<mailing_list_name>[email protected]`
434390

435-
## 12. Demo
391+
## 11. Demo
392+
436393
Visit <http://demo.opengrok.org>

debian/README.Debian

Lines changed: 0 additions & 34 deletions
This file was deleted.

debian/ant.properties

Lines changed: 0 additions & 21 deletions
This file was deleted.

debian/changelog

Lines changed: 0 additions & 6 deletions
This file was deleted.

debian/compat

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

debian/control

Lines changed: 0 additions & 21 deletions
This file was deleted.

debian/control.in

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)