From fb36f336e7b679d5b103d29f88e8c6d5d384f4d1 Mon Sep 17 00:00:00 2001 From: hinder Date: Sat, 22 Oct 2011 11:00:22 +0000 Subject: UserGuide: Document current TRAC system instead of GNATS for problem reports git-svn-id: http://svn.cactuscode.org/flesh/trunk@4749 17b73243-c579-4c4c-a9d2-2d5706c11dac --- doc/UsersGuide/Appendices.tex | 104 +++++++++++++++++++++----------------- doc/UsersGuide/GettingStarted.tex | 24 +++------ 2 files changed, 63 insertions(+), 65 deletions(-) diff --git a/doc/UsersGuide/Appendices.tex b/doc/UsersGuide/Appendices.tex index 0d844704..518fb9ba 100644 --- a/doc/UsersGuide/Appendices.tex +++ b/doc/UsersGuide/Appendices.tex @@ -1925,59 +1925,69 @@ Terminate on next iteration ? [{\tt no}] %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\chapter{Using GNATS} -\label{sec:Appendix.gnats} -GNATS is a freely redistributable set of tools for tracking bug -reports. It allows users to categorize their problem report and submit -them to the GNATS. The bug tracker will assign appropriate maintainers -to analyze and solve the problem. -We are currently supporting a web-based interface at -\url{http://www.cactuscode.org}, which lets you -interactively file a bug report. Here, we briefly -describe the main categories when creating a Cactus -problem report. -\begin{Lentry} -\item[{\bf Reporters email}] Your email address, so we can get in -contact with you. -\item[{\bf Category}] There is currently a category for each of the -Cactus thorns and arrangements, also a category for the old Cactus3.x and -some general subjects like Web, etc. Select whatever category fits -best. -\item[{\bf Synopsis}] A brief and informative subject line. - -\item[{\bf Confidential}] Unused, all PRs are public. - -\item[{\bf Severity}] Pick one of three levels. - -\item[{\bf Class}] In the selected category, specify what kind of -problem you are dealing with. - -\item[{\bf submitter ID}] Unused - -\item[{\bf Originator}] Your name. Anonymous is OK, but you real name - would be best. +\chapter{Using TRAC} +\label{sec:Appendix.trac} -\item[{\bf Release}] The Cactus release you are using. You can find this - out, for example, from an executable by typing {\tt cactus\_ -v}. +TRAC is a web-based tool for tracking bug reports and feature +requests. Cactus bugs and feature requests are handled using the TRAC +system hosted by the Einstein Toolkit consortium at +\url{http://trac.einsteintoolkit.org}. Click on {\em New Ticket} to +create a new ticket in the system. -\item[{\bf Environment}] Very important: specify the environment, -e.g.\ {\tt uname -a}, MPI/non-MPI, etc. +Here, we briefly describe the main categories when creating a Cactus +problem report. +\begin{Lentry} +\item[{\bf Summary}] A brief and informative subject line. \item[{\bf Description}] Describe your problem precisely, if you get a -core dump, include the stack trace, give the minimal number of thorns, -this problems occurs with. - -\item[{\bf How-To-Repeat}] Tell us how to repeat the problem if it is -software related. - -\item[{\bf Fix}] If you can provide a fix, let us know. + core dump, include the stack trace, and if possible give the minimal + number of thorns, this problems occurs with. Describe how to + reproduce the problem if it is not clear. Note that the description + field (and the comments) allow a wiki-style syntax. This means that + blocks of code or error messages should be surrounded by \{\{\{ + ... \}\}\} in order to avoid the text being interpreted as wiki + markup. Click on the WikiFormatting link to learn more about the + available markup. + +\item[{\bf Type}] Choose {\em defect} for cases where there is clearly +something wrong and {\em enhancement} for a feature request. + +\item[{\bf Priority}] Pick whichever level is appropriate. {\em + Blocker} for issues that stop you using the code, {\em critical} for + very serious problems, {\em major} for things which should + definitely be addressed, {\em minor} for things which would be good + to fix but not essential, and {\em optional} for very low priority + items. If in doubt, choose either {\em major} or {\em minor}. + +\item[{\bf Milestone}] This is used by the maintainers to indicate an + intention to fix the problem before a particular release of Cactus. + +\item[{\bf Component}] Use {\em Cactus} for problems related to the + Cactus flesh or one of the thorns in one of the Cactus arrangements + (those in arrangements with names starting ``Cactus''). + +\item[{\bf Version}] The Cactus release you are using. You can find + this out, for example, from an executable by typing {\tt + cactus\_ -v}. % FIXME: We don't list Cactus versions in + % TRAC, only ET versions. + +\item[{\bf Keywords}] Here you can enter a space-separated list of + keywords which might be useful for people searching for specific + types of tickets. For example, you could enter the thorn name if + the problem is with a specific thorn, the keyword {\em testsuite} if + the ticket is related to a test failure, or the keyword {\em + documentation} if the problem is related to the documentation. + +\item[{\bf CC}] Email addresses of people who should be emailed on any + change to the ticket, such as a comment being added. + +\item[{\bf Email or username}] Your email address, so we can get in + contact with you. \end{Lentry} -We also provide the customized {\tt send-pr} and {\tt send-pr.el} programs at -our website. These commands are compiled to submit Cactus problem -reports in your shell and from within Emacs, respectively. - - +If you have an account on the computer systems at CCT, you can log in +to the TRAC system in order to be recognised. Otherwise, your +comments will appear as ``anonymous''. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% diff --git a/doc/UsersGuide/GettingStarted.tex b/doc/UsersGuide/GettingStarted.tex index 2c8558a1..71b7a9fa 100644 --- a/doc/UsersGuide/GettingStarted.tex +++ b/doc/UsersGuide/GettingStarted.tex @@ -355,24 +355,12 @@ your own checkpointing and recovery methods. \chapter{Reporting bugs} \label{sec:gehe} -For tracking problem reports and bugs, we use GNATS, which is a bug tracking -system published under the GNU license. We have set up a web interface at -\url{http://www.cactuscode.org/BugReporting}, which allows easy submission and browsing -of problem reports. - -A description of the GNATS categories we use is provided in the Appendix -\ref{sec:Appendix.gnats}. - -% OK, there is NO emacs at the moment, because the GNATS setup is really stupid -% and sendpr handles like c.... besides the fact, that the user has to go -% through a make process which installs stuff somewhere on his HD. gerd. -% BUT, we could distribute our own, either copy cvsbug, or write a perl -% version. Tom -% \begin{itemize} -% \item \texttt{A web interface} -% \item \texttt{SendPR} -% {FIXME: Mention the emacs thing here too...} -% \end{itemize} +For tracking problem reports and bugs, we use the TRAC bug tracking +system located at \url{http://trac.einsteintoolkit.org} which allows +easy submission and browsing of problem tickets. + +A description of the TRAC categories we use is provided in the Appendix +\ref{sec:Appendix.trac}. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -- cgit v1.2.3