734N/ASetting up the sample Razor repository
734N/A======================================
734N/ARazor is a centralised Source Code Management and Issue Tracking
734N/ASystem, whose basics are described in more detail in
734N/AA normal OpenGrok user would extract a read-only checkout of the files
734N/Aand directories from Razor they wished OpenGrok to process using
734N/A'threads' or 'versions' into $SRC_ROOT or a subdirectory of $SRC_ROOT.
734N/AThey would then be required to create a symlink to from the base
734N/Adirectory of the checkout to the relevant group directory inside the
734N/AWe therefore have two quite separate directory trees required for a
734N/Asimulation of a Razor repository, the centralised repository and the
734N/Auser level checkout of the current state of the repository. As such,
734N/Atwo archives have been provided representing these two directory
735N/Atrees. (Note: In the OpenGrok source tree, these archives have been
735N/Aextracted to the subdirectories Repository and UserSandbox, located in
735N/Athe same directory as this README file.)
734N/AThe repository archive contains the Razor Universe 'OpenGrokSample' and
734N/Athe Razor Group 'Simple', which itself contains several sub-directories
734N/Aof user controlled files. These files should be extracted to location
734N/Aoutside of SRC_ROOT so they are not processed by OpenGrok directly.
734N/AThe user sandbox archive contains the a read-only checkout of all the
734N/Ahead revision of the files is in the Razor group 'Simple'. These files
734N/Ashould be extracted under $SRC_ROOT or a sub-directory of it.
734N/AThe following example should correctly construct a sample file set that
734N/Awhen processed by OpenGrok will result in the relevant version and
734N/Ahistory information being extracted extracted from the Razor repository
734N/Afile structure. It assumes that the variables REPO_ROOT, SRC_ROOT and
734N/AARCHIVES are set correctly for your environment and that we wish all
734N/Athe files in the Razor group 'Simple' to be extracted in a
734N/Asub-directory of $SRC_ROOT.
734N/A Examples Variable Values
735N/A cp -rp ${ARCHIVES}/Repository .
735N/A cp -rp ${ARCHIVES}/UserSandbox Razor-Simple
734N/A Link each top-level directory checkout to its group directory in the
734N/A cd SimpleCProgram-BinaryRelease
734N/A Ask OpenGrok to process the new addition
734N/A Verify the files have history and annotation information and can be differenced
734N/Ain the OpenGrok web interface.
734N/A - The 'OpenGrok' command from the OpenGrok distribution has been
734N/A configured for the local OpenGrok installation