From 371a804bb9018ab7e02769dd121338cb7b7e8fac Mon Sep 17 00:00:00 2001 From: Jan Michel Date: Thu, 9 Nov 2017 16:45:02 +0100 Subject: [PATCH] Update git repo description --- trb3/CodeRepository.tex | 43 +++++++++++++++++++++++++++---------- trb3/Trb3GeneralRemarks.tex | 7 +++--- 2 files changed, 36 insertions(+), 14 deletions(-) diff --git a/trb3/CodeRepository.tex b/trb3/CodeRepository.tex index e0657b1..4101c83 100644 --- a/trb3/CodeRepository.tex +++ b/trb3/CodeRepository.tex @@ -1,21 +1,39 @@ + + +All code is available from a server in Frankfurt. There are two ways to access the repositories: +\begin{itemize*} + \item \verb!git://jspc29.x-matter.uni-frankfurt.de/projects/REPONAME.git! - read access is available from everywhere, no password or permission needed + \item \verb!git@jspc29.x-matter.uni-frankfurt.de:REPONAME! - gives full read/write access, but is only available on request when your ssh key is added to the server. + \item \url{http://jspc29.x-matter.uni-frankfurt.de/git} - a web GUI to browse existing repositories. +\end{itemize*} + \subsection{VHDL} +The main VHDL repositories are as follows, there are several more for specific sub-projects. Have a look to the web page to find them. +For most projects, several repositories are needed because they depend on each other. As a general rule, repositories depend on each other from top to bottom in the following list. +All repositories have to be cloned to a common subdirectory to make links between the repos work. + \begin{description*} - \item[Trb3 VHDL]~\\git clone git://jspc29.x-matter.uni-frankfurt.de/projects/trb3.git - \item[TrbNet VHDL]~\\git clone git://jspc29.x-matter.uni-frankfurt.de/projects/trbnet.git + \item[trbnet] - the main TrbNet repository + \item[vhdlbasics] - some generic code fragments + \item[trb3] - code for TRB3 boards + \item[trb3sc] - code for TRB3sc boards + \item[tdc] - the TDC code + \item[dirich] - code for the DiRich board family + \item[padiwa] - code for all Padiwa boards \end{description*} \subsection{Software / Documentation} \label{sec:Repo:Software} \begin{description*} - \item[Trb3 Documentation]~\\git clone git://jspc29.x-matter.uni-frankfurt.de/projects/daqdocu.git - \item[Trb3 SlowControl Software]~\\git clone git://jspc29.x-matter.uni-frankfurt.de/projects/daqtools.git - \item[Trbnet Software Library]~\\git clone git://jspc29.x-matter.uni-frankfurt.de/projects/trbnettools.git - \item[Data Server (Eventbuilder)]~\\git clone git://jspc29.x-matter.uni-frankfurt.de/projects/daqdata.git~\\only needed if DABC is not used. DABC is recommened to use. + \item[daqdocu] - the documentation, including this PDF + \item[trbnettools] - the basic software for any slow control communication + \item[daqtools] - all tools and scripts to control the TrbNet based system + \item[labtools] - controls for various lab equipment like power supplies \end{description*} \subsection{Additional Resources} \begin{description*} - \item[DABC Eventbuilder]~\\http://hades-wiki.gsi.de/cgi-bin/view/DaqSlowControl/EventBuilderDabc + \item[DABC Eventbuilder]~\\\url{http://hades-wiki.gsi.de/cgi-bin/view/DaqSlowControl/EventBuilderDabc} \end{description*} @@ -24,8 +42,6 @@ \begin{itemize*} \item The repositories with software and documentation (daqdocu, daqtools, trbnettools, daqdata) are supposed to reside in a common directory named trbsoft, e.g. in your home directory. \item If users want to put their own scripts to the git (recommended for education of others), there is a directory daqtools/user/. Here you can add a sub-directory with your project name and add all your files (tools, configuration etc.). - \item The git URLs are read-only. Write access is available upon request by providing a ssh-key. For R/W the URL changes to e.g. \verb!git@jspc29...furt.de:daqdocu! - \item The cvs URLs are accessible with password or ssh-key only. \end{itemize*} \subsubsection{Some Hints for git contributors} @@ -46,12 +62,17 @@ tutorial here (this can be googled duckduckgo'ed). you're committing from the hadaq account (or similar group accounts). Then you don't need to mention your name or initials in the commit message. +\item If you find out that somebody changed the repository on the server + when trying to push your changes, try \verb!git pull --rebase!, this + saves you from having to do a merge commit. If you have uncommitted + local changes, you have to do a \verb!git stash! before and a + \verb!git stash pop! afterwards. \end{itemize*} \subsection{FPGA designs} \begin{itemize*} - \item A list of current FPGA design files can be obtained from \\\url{http://www.editgrid.com/user/hadaq/Design_Files} - \item All designs can be downloaded from \\\url{http://jspc22.x-matter.uni-frankfurt.de/bitfiles/FILENAME} + \item A list of current FPGA design files can be obtained from \\\url{http://jspc29.x-matter.uni-frankfurt.de/trbweb/?action=page&url=design-files} + \item All designs can be downloaded from \\\url{http://jspc22.x-matter.uni-frankfurt.de/bitfiles} \item Developers upload their files via scp to \\\verb!hadaq@jspc22.x-matter.uni-frankfurt.de:/srv/www/htdocs/bitfiles/! \end{itemize*} diff --git a/trb3/Trb3GeneralRemarks.tex b/trb3/Trb3GeneralRemarks.tex index a16f64a..c7a473c 100644 --- a/trb3/Trb3GeneralRemarks.tex +++ b/trb3/Trb3GeneralRemarks.tex @@ -54,9 +54,8 @@ TRB3 if something goes wrong in the fever of a beam time. \subsection{Hardware Information} \begin{itemize*} - \item Schematics \href{http://hades-wiki.gsi.de/pub/DaqSlowControl/TDCReadoutBoardV3/trbv3_SCHEMATIC_michael.pdf}{trbv3\_SCHEMATIC\_michael.pdf} - \item Pin-out file for the peripheral FPGAs \href{cvs://:ext:hadaq@lxi001.gsi.de:/misc/hadesprojects/daq/cvsroot/trb3/base/trb3_periph.lpf}{cvsroot/trb3/base/trb3\_periph.lpf} - \item Pin-out file for the central FPGAs \href{cvs://:ext:hadaq@lxi001.gsi.de:/misc/hadesprojects/daq/cvsroot/trb3/base/trb3_central.lpf}{cvsroot/trb3/base/trb3\_central.lpf} + \item TRB3 \href{http://jspc29.x-matter.uni-frankfurt.de/trbweb/?action=page&url=schematics}{Schematics} + \item Pin-out file for all FPGAs vary based on the AddOns in use and can be found \href{http://http://jspc29.x-matter.uni-frankfurt.de/git/?p=trb3.git;a=tree;f=base}{in the git repository} (*.lpf files) \end{itemize*} @@ -148,6 +147,7 @@ register should only be used to describe hardware-related features, like the nee \item[6XXX] use with Nxyter \item[7XXX] use with 32PinAddOn \item[9XXX] use with ADC AddOn + \item[A000] use with SFP AddOn v2 \item[X0nX] {\color{darkgray}contains $2^n$ TDC channels, single edge, n<8} \item[X1nX] {\color{darkgray}contains $2^n$ TDC channels, double edge, n<8} \item[X2XX] {\color{darkgray}contains a network hub} @@ -200,6 +200,7 @@ All boards of a given type are accessible by a broadcast address at the same tim \item 0x51 DiRich Frontend \item 0x52 DiRich Combiner \item 0x60 Trb3sc + \item 0x61 Trb3sc Hub \end{itemize*} The initial address set with \signal{Regio\_Init\_Address} can be chosen from the following set: -- 2.43.0