1703N/ASetting up the sample Razor repository

1703N/A======================================

1703N/A

1703N/ARazor is a centralised Source Code Management and Issue Tracking

1703N/ASystem, whose basics are described in more detail in

1703N/ARazorRepository.java (which can be found in

1703N/Aopengrok/src/org/opensolaris/opengrok/history directory).

1703N/A

1703N/AA normal OpenGrok user would extract a read-only checkout of the files

1703N/Aand directories from Razor they wished OpenGrok to process using

1703N/A'threads' or 'versions' into $SRC_ROOT or a subdirectory of $SRC_ROOT.

725N/AThey would then be required to create a symlink to from the base

1703N/Adirectory of the checkout to the relevant group directory inside the

1703N/ARazor repository file structure as documented in RazorRepository.java.

1703N/A

1703N/AWe therefore have two quite separate directory trees required for a

1703N/Asimulation of a Razor repository, the centralised repository and the

1703N/Auser level checkout of the current state of the repository. As such,

1703N/Atwo archives have been provided representing these two directory

1703N/Atrees. (Note: In the OpenGrok source tree, these archives have been

3311N/Aextracted to the subdirectories Repository and UserSandbox, located in

1703N/Athe same directory as this README file.)

725N/A

1741N/AThe repository archive contains the Razor Universe 'OpenGrokSample' and

1741N/Athe Razor Group 'Simple', which itself contains several sub-directories

1741N/Aof user controlled files. These files should be extracted to location

1703N/Aoutside of SRC_ROOT so they are not processed by OpenGrok directly.

1741N/A

1741N/AThe user sandbox archive contains the a read-only checkout of all the

1741N/Ahead revision of the files is in the Razor group 'Simple'. These files

1741N/Ashould be extracted under $SRC_ROOT or a sub-directory of it.

1703N/A

1703N/AThe following example should correctly construct a sample file set that

1703N/Awhen processed by OpenGrok will result in the relevant version and

1703N/Ahistory information being extracted extracted from the Razor repository

1703N/Afile structure. It assumes that the variables REPO_ROOT, SRC_ROOT and

1703N/AARCHIVES are set correctly for your environment and that we wish all

1741N/Athe files in the Razor group 'Simple' to be extracted in a

1703N/Asub-directory of $SRC_ROOT.

1703N/A

1703N/A Examples Variable Values

1741N/A

1703N/A REPO_ROOT=/data

1703N/A SRC_ROOT=/data/opengrok/src

1703N/A ARCHIVES=/src/opengrok/RazorArchives

1703N/A

1703N/A Repository Setup

1703N/A

1703N/A cd ${REPO_ROOT}

1703N/A cp -rp ${ARCHIVES}/Repository .

3311N/A

1703N/A OpenGrok Source Setup

1703N/A

1703N/A cd ${SRC_ROOT}

1703N/A cp -rp ${ARCHIVES}/UserSandbox Razor-Simple

1703N/A

1703N/A Link each top-level directory checkout to its group directory in the

1703N/Acentral repository (as discussed in RazorRepository.java)

1703N/A

1703N/A cd Razor-Simple

1703N/A cd SimpleCProgram

1703N/A ln -s ${REPO_ROOT}/Repository/OpenGrokSample/RAZOR_UNIVERSE/DOMAIN_01/Simple .razor

1703N/A cd ..

1703N/A cd SimpleCProgram-BinaryRelease

1703N/A ln -s ${REPO_ROOT}/Repository/OpenGrokSample/RAZOR_UNIVERSE/DOMAIN_01/Simple .razor

1703N/A cd ${SRC_ROOT}

1703N/A

1703N/A Ask OpenGrok to process the new addition

1703N/A

1703N/A OpenGrok update

1703N/A

1703N/A Verify the files have history and annotation information and can be differenced

1703N/Ain the OpenGrok web interface.

1703N/A

1703N/A

1703N/AAssumptions:

1703N/A - The 'OpenGrok' command from the OpenGrok distribution has been

1703N/A configured for the local OpenGrok installation

1703N/A

1703N/A