fis...@4525493e-7705-40b1-a816-d608a930855b  committed cd87afd

*** empty log message ***

  • Participants
  • Parent commits 3eb7e32
  • Branches default

Comments (0)

Files changed (1)

File doc/index.html

-<!--last modified on Monday, May 11, 1998 04:22 PM -->
+<!--last modified on Tuesday, May 12, 1998 11:32 AM -->
 	<META HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=iso-8859-1">
-	<!-- Changed by: S M Fisher, 11-May-1998 -->
+<!-- Changed by: S M Fisher, 11-May-1998 -->
 	<META NAME="Author" Content="Steve Fisher">
 	<TITLE>CodeCheck Tools</TITLE>
 <H1 ALIGN="CENTER">CodeCheck Tools</H1>
 <P>Tools have been developed using the facilities provided by the commercial tool <A HREF="">CodeCheck</A></P>
-<P>CodeCheck is available on many platforms including most UNIX platforms and NT, but as my development work has
-been on NT this documentation currently relates mostly to the NT version. <I>This will be rectified</I>.</P>
+<P>CodeCheck is available on many platforms including most UNIX platforms and NT.</P>
 <H2>What is CodeCheck</H2>
 <P>CodeCheck is a parser for C++ which starts by reading in a set of rules which define actions to be performed
 when certain grammatical constructs are detected in the input files (C++) which it will then read. Many rules sets
 <H3>System installation - ATLAS customisations</H3>
 <P>Tcl scripts are installed to the bin directory maintained by SRT, so this side should look after itself.</P>
 <P>The environment variable CCRULES should point to the directory containing the ATLAS rules files. The rules files
-are installed by SRT. Setting CCRULES will be included in an atlas login script, but for now look for the directory
-containing <TT>default.cco</TT> which is below <TT>share.</TT> There may be two such directories - choose the one
-for big-endian or little-endian as appropriate.</P>
+are installed by SRT. The setting of CCRULES will be included in the atlas login script, but for now you need:</P>
+	<PRE>export CCRULES=$ATLAS_ROOT/dist/&lt;release&gt;/installed/$SRT_TARGET/lib/CodeCheck</PRE>
+<P>where release is the release you are currently using.</P>
 <P>The metrics collection makes use of a tcl script, so you must have a copy of tclsh installed. This is on ASIS
-for UNIX and for NT is available prebuilt <A HREF="">from SUN</A> or as part
+for UNIX. For NT, it is available prebuilt <A HREF="">from SUN</A> or as part
 of the <A HREF="">Cygnus distribution</A>. Note that in both cases the executable
 is not called tclsh, so please copy it or rename it to tclsh. The Cygnus distribution is recommended because it
 contains many UNIX utilities to make life with NT bearable.</P>
 directory) and collects a series of facts (e.g. class A uses class B), it eliminates duplicate facts and (optionally)
 writes out the set of facts. The fact file can be used as a supplementary input and merged with facts from other
 C++&nbsp;files. Only one fact file can be read but they can be concatenated together first.</P>
 <P>In addition a results file may be produced with a one line summary for each class with the class metrics and
 for each function with the function metrics. This can then be analysed by some other program. This file is of the
 	<PRE>cxx-metrics -h</PRE>
 <P>will produce output which should be enough to explain how to use it. The output is shown below:</P>
 <P>The default action is to process all the .h and .cxx files in the current directory, and to produce a short
 summary. To understand the summary you should have read about the <A HREF="metrics.html">choice of metrics</A>.</P>
 <P>It is also possible to give it a list of files to process. Each file is processed within the directory containing
 it. This should be noted when considering the effect of relative paths for include directories.</P>
 <P>To analyse more files, the -o option may be used to output the information for one set of files and this may
 be read in in to the program later (using the -i option) for another set of files. This makes it handy to store
 the analysis of a directory inside that directory. For example:</P>
 <P>The first two lines each descend to a subdirectory and write a metrics file there. The third line concatenates
 the files and the last line displays the combined results.</P>
 <P>Note the format of the <TT>-p</TT> flags. They must be followed by a space and then a parameter to CodeCheck.
 The CodeCheck parameters may not contain spaces. For example <TT>-p -I..</TT> to tell CodeCheck to use the parent
 directory of the processed source file as an include directory.</P>