| Name | Date | Size | |
|---|---|---|---|
| .. | 2011-04-08 05:30:26 | 4 | |
| README-ArchiveCreation | 2011-04-08 05:30:26 | 2.5 KiB | |
| README-Disclaimer | 2011-04-08 05:30:26 | 1.1 KiB | |
| README-Usage | 2011-04-08 05:30:26 | 3 KiB | |
| Repository | 2011-04-08 05:30:26 | 3 | |
| UserSandbox | 2011-04-08 05:30:26 | 4 |
README-ArchiveCreation
HOW THE ARCHIVES WERE CREATED
=============================
Create an area to build the final sample repository for OpenGrok Distribution
mkdir -p Extracted/Repository
Extract a copy of the actual Razor repository. The archive was made by
using GNU tar from the razor_db directory of the whole OpenGrokSample
Universe, with a few local symlinks to customised configuration dereferenced
and stored as files in the archive
gtar fxv ../../ActualRazorRepository-OpenGrokSample.tar.gz
Remove Bulky Non-Essential (for OpenGrok) Files and Executables.
Also remove any vendor supplied files in the repository which they
may be able to claim copyright or moral ownership of.
rm OpenGrokSample/RAZOR_UNIVERSE/DOMAIN_01/Simple##Threads/Tables/Thread_script_after_remote_template.sh
Edit files to remove site specific usernames and data to protect privacy.
I have left my username and a few generic pieces of data to ensure the
validity of the repository.
vi OpenGrokSample/RAZOR_UNIVERSE/DOMAIN_01/++ISSUES++/Tables/Roles
Create the repository archive
cd ..
gtar fcv ../SampleRazorRepository.tar Repository
gzip -9v ../SampleRazorRepository.tar
Create the User Sandbox
mkdir UserSandbox
Use Razor's versions GUI, to extract all sample files into the directory UserSandbox.
cd UserSandbox
versions &
Create the user sandbox archive
cd ..
gtar fcv ../SampleRazorUserSandbox.tar UserSandbox
gzip -9v ../SampleRazorUserSandbox.tar
README-Disclaimer
DISCLAIMER
==========
This submission is supplied without any WARRANTY (EXPRESSED or IMPLIED)
and is intended in good faith to provide the OpenGrok community with a
way to test the functionality of the Razor Repository support, which I
have previously contributed to the OpenGrok project.
THIS REPOSITORY IS IN NO WAY INTENDED FOR ANY RAZOR USER OR
ADMINISTRATOR TO IMPORT OR IN ANY WAY ADD INTO ANY RAZOR SYSTEM. IT IS
PROVIDED FOR THE SOLE PURPOSE OF TESTING RAZOR SUPPORT IN OPENGROK.
As stated in the current implementation of Razor Repository support in
OpenGrok, the Razor product is not required to allow the implementation
to function correctly, only read-only access to the file structure of
the repository.
As documented in README-ArchiveCreation, the sample repository has
been cleansed on vendor binaries and other files to reduce the size of
the contribution and so as to not provided any files the vendor
(Visible Systems Corporation) would reasonably consider their property.
The files used to populate the sample Razor repository were extracted
from the sample Mercurial repository (opengrok/testdata/repositories/mercurial)
in the OpenGrok Repository.
README-Usage
Setting up the sample Razor repository
======================================
Razor is a centralised Source Code Management and Issue Tracking
System, whose basics are described in more detail in
RazorRepository.java (which can be found in
opengrok/src/org/opensolaris/opengrok/history directory).
A normal OpenGrok user would extract a read-only checkout of the files
and directories from Razor they wished OpenGrok to process using
'threads' or 'versions' into $SRC_ROOT or a subdirectory of $SRC_ROOT.
They would then be required to create a symlink to from the base
directory of the checkout to the relevant group directory inside the
Razor repository file structure as documented in RazorRepository.java.
We therefore have two quite separate directory trees required for a
simulation of a Razor repository, the centralised repository and the
user level checkout of the current state of the repository. As such,
two archives have been provided representing these two directory
trees. (Note: In the OpenGrok source tree, these archives have been
extracted to the subdirectories Repository and UserSandbox, located in
the same directory as this README file.)
The repository archive contains the Razor Universe 'OpenGrokSample' and
the Razor Group 'Simple', which itself contains several sub-directories
of user controlled files. These files should be extracted to location
outside of SRC_ROOT so they are not processed by OpenGrok directly.
The user sandbox archive contains the a read-only checkout of all the
head revision of the files is in the Razor group 'Simple'. These files
should be extracted under $SRC_ROOT or a sub-directory of it.
The following example should correctly construct a sample file set that
when processed by OpenGrok will result in the relevant version and
history information being extracted extracted from the Razor repository
file structure. It assumes that the variables REPO_ROOT, SRC_ROOT and
ARCHIVES are set correctly for your environment and that we wish all
the files in the Razor group 'Simple' to be extracted in a
sub-directory of $SRC_ROOT.
Examples Variable Values
REPO_ROOT=/data
SRC_ROOT=/data/opengrok/src
ARCHIVES=/src/opengrok/RazorArchives
Repository Setup
cd ${REPO_ROOT}
cp -rp ${ARCHIVES}/Repository .
OpenGrok Source Setup
cd ${SRC_ROOT}
cp -rp ${ARCHIVES}/UserSandbox Razor-Simple
Link each top-level directory checkout to its group directory in the
central repository (as discussed in RazorRepository.java)
cd Razor-Simple
cd SimpleCProgram
ln -s ${REPO_ROOT}/Repository/OpenGrokSample/RAZOR_UNIVERSE/DOMAIN_01/Simple .razor
cd ..
cd SimpleCProgram-BinaryRelease
ln -s ${REPO_ROOT}/Repository/OpenGrokSample/RAZOR_UNIVERSE/DOMAIN_01/Simple .razor
cd ${SRC_ROOT}
Ask OpenGrok to process the new addition
OpenGrok update
Verify the files have history and annotation information and can be differenced
in the OpenGrok web interface.
Assumptions:
- The 'OpenGrok' command from the OpenGrok distribution has been
configured for the local OpenGrok installation