a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenSetting up the sample Razor repository
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen======================================
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenRazor is a centralised Source Code Management and Issue Tracking
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenSystem, whose basics are described in more detail in
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenRazorRepository.java (which can be found in
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlenopengrok/src/org/opensolaris/opengrok/history directory).
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenA normal OpenGrok user would extract a read-only checkout of the files
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlenand directories from Razor they wished OpenGrok to process using
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen'threads' or 'versions' into $SRC_ROOT or a subdirectory of $SRC_ROOT.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenThey would then be required to create a symlink to from the base
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlendirectory of the checkout to the relevant group directory inside the
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenRazor repository file structure as documented in RazorRepository.java.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenWe therefore have two quite separate directory trees required for a
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlensimulation of a Razor repository, the centralised repository and the
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlenuser level checkout of the current state of the repository. As such,
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlentwo archives have been provided representing these two directory
d719dedd82547362f808e1087c9c53f03567ebd0Knut Anders Hatlentrees. (Note: In the OpenGrok source tree, these archives have been
d719dedd82547362f808e1087c9c53f03567ebd0Knut Anders Hatlenextracted to the subdirectories Repository and UserSandbox, located in
d719dedd82547362f808e1087c9c53f03567ebd0Knut Anders Hatlenthe same directory as this README file.)
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenThe repository archive contains the Razor Universe 'OpenGrokSample' and
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlenthe Razor Group 'Simple', which itself contains several sub-directories
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlenof user controlled files. These files should be extracted to location
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlenoutside of SRC_ROOT so they are not processed by OpenGrok directly.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenThe user sandbox archive contains the a read-only checkout of all the
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlenhead revision of the files is in the Razor group 'Simple'. These files
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlenshould be extracted under $SRC_ROOT or a sub-directory of it.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenThe following example should correctly construct a sample file set that
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlenwhen processed by OpenGrok will result in the relevant version and
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlenhistory information being extracted extracted from the Razor repository
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlenfile structure. It assumes that the variables REPO_ROOT, SRC_ROOT and
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenARCHIVES are set correctly for your environment and that we wish all
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlenthe files in the Razor group 'Simple' to be extracted in a
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlensub-directory of $SRC_ROOT.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen Examples Variable Values
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen REPO_ROOT=/data
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen Repository Setup
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen cd ${REPO_ROOT}
d719dedd82547362f808e1087c9c53f03567ebd0Knut Anders Hatlen cp -rp ${ARCHIVES}/Repository .
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen OpenGrok Source Setup
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen cd ${SRC_ROOT}
d719dedd82547362f808e1087c9c53f03567ebd0Knut Anders Hatlen cp -rp ${ARCHIVES}/UserSandbox Razor-Simple
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen Link each top-level directory checkout to its group directory in the
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlencentral repository (as discussed in RazorRepository.java)
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen cd Razor-Simple
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen cd SimpleCProgram
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen ln -s ${REPO_ROOT}/Repository/OpenGrokSample/RAZOR_UNIVERSE/DOMAIN_01/Simple .razor
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen cd SimpleCProgram-BinaryRelease
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen ln -s ${REPO_ROOT}/Repository/OpenGrokSample/RAZOR_UNIVERSE/DOMAIN_01/Simple .razor
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen cd ${SRC_ROOT}
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen Ask OpenGrok to process the new addition
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen OpenGrok update
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen Verify the files have history and annotation information and can be differenced
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlenin the OpenGrok web interface.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen - The 'OpenGrok' command from the OpenGrok distribution has been
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen configured for the local OpenGrok installation