Git

Introduction

The primary source code management system for the Mu2e Offline software is a git repository that is hosted on the Fermilab Redmine site. Git is a popular open-source software version control system and Redmine is a software project management system which contains, for each project, a wiki, gantt charts, and a bug tracking along with the git respositories.

Biased on the git repository's url, you can check out code, and, if you are a code developer, check in modifications. NB, when committing code, please follow these mu2e conventions only. Git also has capabilities for tagging code, tracking history and supports splitting off and merging development branches, among many other features.

Some older parts of Mu2e software is managed using other source code management systems. Some code, both critical and specialized, is in other, smaller repositories. See Repositories below for more details on repositories.

See the references for more details on Redmine and git.

Quick Start

Please also see the basic code recipe for an introduction to setting up the environment, checking out code and building.

If you are going to commit anything, you must understand and follow the mu2e commit instructions

If this is the first time you are using git in the mu2e environment, please follow the few steps listed here under "Configure git" in order to set up your ~.gitconfig.

A more detailed introduction to mu2e repositories is mu2e here.

• checkout the main repository
  • readonly:

    git clone http://cdcvs.fnal.gov/projects/mu2eofflinesoftwaremu2eoffline/Offline.git

  • with kerberos authentication for committing code

    git clone ssh://p-mu2eofflinesoftwaremu2eoffline@cdcvs.fnal.gov/cvs/projects/mu2eofflinesoftwaremu2eoffline/Offline.git

• checkout the head to a local working branch (recommended)

git checkout -b work

• see the history of a file

git log fileSpec

• list tags

git tag -l

• checkout a tag or branch into the working area

git checkout tagOrBranchName 

• update the local repository

git fetch

• update the local repository and checkout the head into the working area

git pull

• see what the status is

git status

• command line help

git status help

• git browser (to see a graphical history of commits)

gitk --all

Please see the references below or many web resources for details on git concepts, commands and features. If you are going to commit anything, you must understand and follow the mu2e commit instructions

Repositories

Almost all of the mu2e Offline code is currently in one Redmine repository. One important piece, the BTrk UPS product, which contains our Kalman track fit code, is stored in the BTrk github repo.

A git repository is accessed through a url. For example this is the read/write url for the main offline code respository

ssh://p-mu2eofflinesoftwaremu2eoffline@cdcvs.fnal.gov/cvs/projects/mu2eofflinesoftwaremu2eoffline/Offline.git

There exist several other mu2e Redmine repositories for various standalone tools not tightly coupled to compiled Offline code. You can browse all Redmine projects and mu2e Redmine. The mu2e Redmine has subprojects (and sub-subprojects) and each has a repository associated with them. For example in the Standalone subproject, there is a sub-subproject Mu2eCCFC with repo url:

ssh://p-mu2eccfc@cdcvs.fnal.gov/cvs/projects/mu2eccfc-mu2eccfc/mu2eccfc.git

In addition, the main mu2e Offline repository has sub-repositories which can be seen on the right sidebar menu on the repository main page. An example is the dhtools sub-repo, which has url:

ssh://p-mu2eofflinesoftwaremu2eoffline@cdcvs.fnal.gov/cvs/projects/mu2eofflinesoftwaremu2eoffline-dhtools/dhtools.git

Here is a (possibly incomplete) list of the smaller repositories.

Name	Content	url
BTrk	Kalman code	https://github.com/KFTrack/BTrk
mu2egrid	mu2eprodsys	ssh://p-mu2eccfc@cdcvs.fnal.gov/cvs/projects/mu2eccfc-mu2egrid/mu2egrid.git
Mu2eCCFC	F-C limit setting	ssh://p-mu2eccfc@cdcvs.fnal.gov/cvs/projects/mu2eccfc-mu2eccfc/mu2eccfc.git
Tools	generate_fcl	ssh://p-mu2e-tools@cdcvs.fnal.gov/cvs/projects/mu2e-tools-tools/mu2etools.git
dhtools	Data Handling	ssh://p-mu2eofflinesoftwaremu2eoffline@cdcvs.fnal.gov/cvs/projects/mu2eofflinesoftwaremu2eoffline-dhtools/dhtools.git
codetools	Jenkins scripts	ssh://p-mu2eofflinesoftwaremu2eoffline@cdcvs.fnal.gov/cvs/projects/mu2eofflinesoftwaremu2eoffline-codetools/codetools.git
geomdisplay	Tutorial	ssh://p-mu2eofflinesoftwaremu2eoffline@cdcvs.fnal.gov/cvs/projects/mu2eofflinesoftwaremu2eoffline-geomdisplay/geomdisplay.git
satellite	Satellite builds	ssh://p-mu2eofflinesoftwaremu2eoffline@cdcvs.fnal.gov/cvs/projects/mu2eofflinesoftwaremu2eoffline-satellite/satellite.git

Creating a Redmine subproject is done by the "add subproject" button on the Redmine project web page. Creating a sub-repository associated to the main offline repo is explained in the mu2e instructions and SCD instructions.

References

• mu2e git and CVS
• mu2e git commit instructions
• git home Documentation reference
• redmine repository browser
• Fermilab redmine
• talk at the Software and Simulation Meeting, Sept 17, 2014.
• Marc P's suggested git workflow for simple git projects
• Fermilab git workshop and related materials
• managing and creating new redmine repositories