Skip to content

Commit c375d8c

Browse files
jeis2497052Vladimir Kotal
authored andcommitted
Propose fix some typos (#2025)
1 parent 76951cb commit c375d8c

File tree

12 files changed

+138
-138
lines changed

12 files changed

+138
-138
lines changed

README.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -23,24 +23,24 @@ engine, written in Java. It helps you search, cross-reference and navigate
2323
your source tree. It can understand various program file formats and
2424
version control histories of many source code management systems.
2525

26-
Official page of the project is on:
26+
Official page of the project is on:
2727
<http://opengrok.github.com/OpenGrok/>
2828

2929
## 2. Requirements
30-
* Latest Java (at least 1.8)
30+
* Latest Java (at least 1.8)
3131
<http://www.oracle.com/technetwork/java/>
32-
* A servlet container like Tomcat (8.x or later) supporting Servlet 2.5 and JSP 2.1
32+
* A servlet container like Tomcat (8.x or later) supporting Servlet 2.5 and JSP 2.1
3333
<http://tomcat.apache.org/>
34-
* Exuberant Ctags or Universal Ctags
35-
<http://ctags.sourceforge.net/>
34+
* Exuberant Ctags or Universal Ctags
35+
<http://ctags.sourceforge.net/>
3636
<https://ctags.io/>
3737
* Source Code Management installation depending on type of repositories indexed
3838
* If you want to build OpenGrok:
39-
* Ant (1.9.4 and later)
39+
* Ant (1.9.4 and later)
4040
<http://ant.apache.org/>
41-
* JFlex
41+
* JFlex
4242
<http://www.jflex.de/>
43-
* Netbeans (optional, at least 8.2, will need Ant 1.9.4)
43+
* Netbeans (optional, at least 8.2, will need Ant 1.9.4)
4444
<http://netbeans.org/>
4545

4646
## 3. Usage
@@ -114,7 +114,7 @@ Currently supported message types:
114114
3. **StatsMessage (stats)** – this message is designed to retrieve some information from the web application.
115115

116116
The purpose of the message is specified in the text field as one of:
117-
117+
118118
* **reload** – the application reloads the statistics file
119119
and returns the loaded statistics
120120
* **clean** – the application cleans its current statistics
@@ -132,7 +132,7 @@ Currently supported message types:
132132
5. **RefreshMesssage (refresh)** – sent at the end of partial reindex to trigger refresh of `SearcherManagers`.
133133

134134
6. **ProjectMessage** – used for adding/deleting projects and partial (per-project) reindex.
135-
135+
136136
* **add** – adds project(s) and its repositories to the configuration.
137137
If the project already exists, refresh list of its repositories.
138138
* **delete** – removes project(s) and its repositores from the configuration.
@@ -211,7 +211,7 @@ stored (can vary on your system).
211211
Note that now you might need to change to user which owns the target
212212
directories for data, e.g. on Solaris you'd do:
213213

214-
```bash
214+
```bash
215215
pfexec su - webservd
216216
cd /usr/opengrok/bin
217217
```
@@ -328,7 +328,7 @@ them and index them.
328328
It basically works like this:
329329

330330
1. bootstrap initial configuration: OpenGrok bootstrap
331-
331+
332332
* this will create `/var/opengrok/etc/configuration.xml` with basic set of
333333
properties. If more is needed use:
334334

@@ -443,13 +443,13 @@ There are 2 (or 3) steps needed for this task.
443443

444444
#### 5.4.1 Populate DATA_ROOT Directory
445445

446-
* **Option 1. OpenGrok**:
446+
* **Option 1. OpenGrok**:
447447
There is a sample shell script `OpenGrok` that is suitable
448448
for using in a cron job to run regularly. Modify the variables in the script
449449
to point appropriate directories, or as the code suggests factor your local
450450
configuration into a separate file and simplify future upgrades.
451451

452-
* **Option 2. opengrok.jar**:
452+
* **Option 2. opengrok.jar**:
453453
You can also directly use the Java application. If
454454
the sources are all located in a directory `SRC_ROOT` and the data and
455455
hypertext files generated by OpenGrok are to be stored in `DATA_ROOT`, run
@@ -523,12 +523,12 @@ Note that only some paths can have a description.
523523
`web.xml` is the deployment descriptor for the web application. It is in a Jar
524524
file named `source.war`, you can change it as follows:
525525

526-
* **Option 1**:
526+
* **Option 1**:
527527
Unzip the file to `TOMCAT/webapps/source/` directory and
528528
change the `source/WEB-INF/web.xml` and other static html files like
529529
`index.html` to customize to your project.
530530

531-
* **Option 2**:
531+
* **Option 2**:
532532
Extract the `web.xml` file from `source.war` file
533533

534534
```bash
@@ -543,7 +543,7 @@ file named `source.war`, you can change it as follows:
543543

544544
Then copy the war files to `TOMCAT/webapps` directory.
545545

546-
* **Option 3**:
546+
* **Option 3**:
547547
Edit the Context container element for the webapp
548548

549549
Copy `source.war` to `TOMCAT/webapps`
@@ -554,7 +554,7 @@ file named `source.war`, you can change it as follows:
554554

555555
After the index is built, there's a couple different ways to set the
556556
Context for the servlet container:
557-
557+
558558
* Add the Context inside a Host element in `TOMCAT/conf/server.xml`
559559

560560
```xml
@@ -649,10 +649,10 @@ source.war WEB-INF/web.xml`) file, edit `web.xml` and re-package the jar file
649649
parameters appropriately. These sample parameters need modifying(there are
650650
more options, refer to manual or read param comments).
651651

652-
* **CONFIGURATION** – the absolute path to XML file containing project configuration
652+
* **CONFIGURATION** – the absolute path to XML file containing project configuration
653653
(e.g. `/var/opengrok/etc/configuration.xml`)
654654
* **ConfigAddress** – port for remote updates to configuration, optional, but advised(since there is no authentication)
655-
to be set to `localhost:<some_port>` (e.g. `localhost:2424`), if you choose `some_port` below 1024 you have to have
655+
to be set to `localhost:<some_port>` (e.g. `localhost:2424`), if you choose `some_port` below 1024 you have to have
656656
root privileges
657657

658658
If you need to change name of the web application from source to something
@@ -663,16 +663,16 @@ deploying `source.war`, but you can use it to deploy your `new_name.war` too.
663663

664664
Deploy the modified `.war` file in glassfish/Sun Java App Server:
665665

666-
* **Option 1**:
667-
Use browser and log into glassfish web administration interface: Common Tasks / Applications / Web Applications
666+
* **Option 1**:
667+
Use browser and log into glassfish web administration interface: Common Tasks / Applications / Web Applications
668668
, button Deploy and point it to your `source.war` webarchive
669669

670-
* **Option 2**:
670+
* **Option 2**:
671671
Copy the `source.war` file to
672672
`GLASSFISH/domains/YOURDOMAIN/autodeploy` directory, glassfish will try
673673
to deploy it "auto magically".
674674

675-
* **Option 3**:
675+
* **Option 3**:
676676
Use cli from GLASSFISH directory:
677677

678678
```bash
@@ -690,7 +690,7 @@ Just run `ant` from command line in the top-level directory or use build
690690
process driven by graphical developer environment such as Netbeans.
691691

692692
Note: in case you are behind http proxy, use `ANT_OPTS` to download jflex, lucene.
693-
E.g.
693+
E.g.
694694
```bash
695695
ANT_OPTS="-Dhttp.proxyHost=?.? -Dhttp.proxyPort=80" ant
696696
```
@@ -722,7 +722,7 @@ ant -lib ./lib test
722722
```
723723

724724
To check if the test completed without error look for `AssertionFailedError`
725-
occurences in the `TESTS-TestSuites.xml` file produced by the test run.
725+
occurrences in the `TESTS-TestSuites.xml` file produced by the test run.
726726

727727
### 8.2 Using Findbugs
728728

@@ -1001,9 +1001,9 @@ export JAVA_OPTS
10011001
For tomcat you might also hit a limit for http header size (we use it to send
10021002
the project list when requesting search results):
10031003

1004-
* increase(add) in `conf/server.xml`
1005-
1006-
```xml
1004+
* increase(add) in `conf/server.xml`
1005+
1006+
```xml
10071007
maxHttpHeaderSize
10081008
connectionTimeout="20000"
10091009
maxHttpHeaderSize="65536"
@@ -1057,7 +1057,7 @@ The project has been originally conceived in Sun Microsystems by Chandan B.N.
10571057
Feel free to participate in discussion on the mailing lists:
10581058

10591059
`[email protected]` (user topics)
1060-
1060+
10611061
`[email protected]` (developers' discussion)
10621062

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

plugins/LdapPlugin/src/opengrok/auth/plugin/ldap/LdapFacade.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ public class LdapFacade extends AbstractLdapProvider {
7878
* server waiting.
7979
*/
8080
private int interval = 10 * 1000;
81-
81+
8282
/**
8383
* LDAP search base
8484
*/
@@ -224,11 +224,11 @@ public void setInterval(int interval) {
224224
public String getSearchBase() {
225225
return searchBase;
226226
}
227-
227+
228228
public void setSearchBase(String base) {
229229
this.searchBase = base;
230230
}
231-
231+
232232
@Override
233233
public boolean isConfigured() {
234234
return servers != null && servers.size() > 0 && LDAP_FILTER != null && searchBase != null;
@@ -340,7 +340,7 @@ private <T> T lookup(String dn, String filter, String[] attributes, AttributeMap
340340
actualServer = getNextServer();
341341
return lookup(dn, filter, attributes, mapper, fail + 1);
342342
} catch (NamingException ex) {
343-
LOGGER.log(Level.SEVERE, "An arbitrary LDAP error occured.", ex);
343+
LOGGER.log(Level.SEVERE, "An arbitrary LDAP error occurred.", ex);
344344
closeActualServer();
345345
actualServer = getNextServer();
346346
return lookup(dn, filter, attributes, mapper, fail + 1);

src/org/opensolaris/opengrok/configuration/Groups.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public static void main(String[] argv) {
9696
try {
9797
cfg = Configuration.read(f);
9898
} catch (ArrayIndexOutOfBoundsException ex) {
99-
System.err.println("An error occured - this may mean that the input file is not well-formated.");
99+
System.err.println("An error occurred - this may mean that the input file is not well-formated.");
100100
System.err.println();
101101
ex.printStackTrace(System.err);
102102
System.exit(3);
@@ -132,11 +132,11 @@ public static void main(String[] argv) {
132132
}
133133
}
134134
} catch (FileNotFoundException ex) {
135-
System.err.println("An error occured - file does not exist");
135+
System.err.println("An error occurred - file does not exist");
136136
ex.printStackTrace(System.err);
137137
System.exit(3);
138138
} catch (IOException ex) {
139-
System.err.println("An unknown error occured - the input file may be corrupted");
139+
System.err.println("An unknown error occurred - the input file may be corrupted");
140140
ex.printStackTrace(System.err);
141141
System.exit(3);
142142
}
@@ -225,11 +225,11 @@ private static PrintStream prepareOutput(File outFile) {
225225
try {
226226
out = new PrintStream(outFile, "utf-8");
227227
} catch (FileNotFoundException ex) {
228-
System.err.println("An error occured - file does not exist");
228+
System.err.println("An error occurred - file does not exist");
229229
ex.printStackTrace(System.err);
230230
System.exit(3);
231231
} catch (UnsupportedEncodingException ex) {
232-
System.err.println("An error occured - file contains unsupported charset");
232+
System.err.println("An error occurred - file contains unsupported charset");
233233
ex.printStackTrace(System.err);
234234
System.exit(3);
235235
}

src/org/opensolaris/opengrok/history/DirectoryHistoryReader.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ public class DirectoryHistoryReader {
8080
List<String> icomment;
8181
HistoryEntry currentEntry; // set in next()
8282
History history; // set in the constructor
83-
83+
8484
private static final int MAX_RESULTS=40;
8585

8686
/**
@@ -121,7 +121,7 @@ public DirectoryHistoryReader(String path) throws IOException {
121121
hits = fdocs.scoreDocs;
122122
} catch (ParseException e) {
123123
LOGGER.log(Level.WARNING,
124-
"An error occured while parsing search query", e);
124+
"An error occurred while parsing search query", e);
125125
}
126126
if (hits != null) {
127127
// Get maximum MAX_RESULTS (why ? XXX) files which were changed recently.
@@ -150,7 +150,7 @@ public DirectoryHistoryReader(String path) throws IOException {
150150
hist = HistoryGuru.getInstance().getHistory(f);
151151
} catch (HistoryException e) {
152152
LOGGER.log(Level.WARNING,
153-
"An error occured while getting history reader", e);
153+
"An error occurred while getting history reader", e);
154154
}
155155
if (hist == null) {
156156
put(cdate, "", "-", "", rpath);
@@ -177,7 +177,7 @@ public DirectoryHistoryReader(String path) throws IOException {
177177
ireader.close();
178178
} catch (Exception ex) {
179179
LOGGER.log(Level.WARNING,
180-
"An error occured while closing reader", ex);
180+
"An error occurred while closing reader", ex);
181181
}
182182
}
183183
}

0 commit comments

Comments
 (0)