search

oracle / opengrok

OpenGrok is a fast and usable source code search and cross reference engine, written in Java
http://oracle.github.io/opengrok/
Other
4.34k stars 745 forks source link

Source control configuration documentation is not adequate (Bugzilla #6082) #603

Closed vladak closed 5 years ago

vladak commented 11 years ago

status INCOMPLETE severity major in component doc for --- Reported in version unspecified on platform Other Assigned to: Vladimir Kotal

On 2009-01-12 15:34:52 +0000, Curt Cox wrote:

I couldn't find any documentation telling how to set up OpenGrok to use a source control system. If such documentation exists, it needs to be easier to find. Ideally a running OpenGrok instance would have some sort of repository configuration screen that allowed authorized users to specify repository URLs.

The documentation for running OpenGrok without using any source control repositories is also outdated and incomplete. However, I was able to get that portion running relatively quickly, so in a certain sense it is good enough.

The easier it is to get started, the more users you will get.

Thanks, Curt

On 2012-01-25 14:11:52 +0000, Vladimir Kotal wrote:

(In reply to comment # 0)

I couldn't find any documentation telling how to set up OpenGrok to use a source control system. If such documentation exists, it needs to be easier to find. Ideally a running OpenGrok instance would have some sort of repository configuration screen that allowed authorized users to specify repository URLs.

By itself OpenGrok does not perform the setup of the source code repositories. This is to be done by the user - both for the initial setup and also for periodic synchronization.

The only point when OpenGrok needs to contact the repository is when the repository is remote (e.g. created by CVS checkout) and history lookup is performed.

The documentation for running OpenGrok without using any source control repositories is also outdated and incomplete. However, I was able to get that portion running relatively quickly, so in a certain sense it is good enough.

Where is this documentation located ?

On 2012-01-25 14:18:59 +0000, Vladimir Kotal wrote:

I just pushed the following change which clarifies some of the SCM repository handling questions:

changeset: 1298:5d1668919fb3 tag: tip user: Vladimir Kotal Vladimir.Kotal@oracle.com date: Wed Jan 25 15:17:01 2012 +0100

description: README needs some hairdresser attention

Please take a look if the README is more helpful now.

tulinkry commented 5 years ago

There was a solution back then. As of now there’s wiki with such info about setting scm repositories.

vladak commented 5 years ago

The first part of the request is not in line with the design - separate the input data management and processing/presentation.

As for the documentation it should be probably noted somewhere that indexer does not require SCM checkouts. Added a note to https://github.com/oracle/opengrok/wiki/How-to-setup-OpenGrok