Changeset 85


Ignore:
Timestamp:
Sep 5, 2005, 2:46:18 PM (19 years ago)
Author:
arnault
Message:

Improving documentation

Location:
CMT/HEAD/doc
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • CMT/HEAD/doc/CMTDoc.html

    r83 r85  
    50575057  <li>The minimal Makefile</li>
    50585058</ul>
     5059  <p>A version directory may be created according to the
     5060              structuring style or structuring strategy parameters
     5061            specified using one of the following means:</p>
     5062  <ol>
     5063    <li>Through the environment variable
     5064    <tt>CMTSTRUCTURINGSTYLE</tt>
     5065     taking one of the
     5066                  alternate values:
     5067<pre>
     5068with_version_directory
     5069without_version_directory</pre>
     5070    <p></p>
     5071  </li>
     5072    <li>Through the command line options
     5073    <tt>-with_version_directory</tt>
     5074     or
     5075    <tt>-without_version_directory</tt>
     5076    <p></p>
     5077  </li>
     5078    <li>Through the <tt>structure_strategy</tt>
     5079     specification entered into the project file of the current project, using the alternate values:
     5080<pre>
     5081with_version_directory
     5082without_version_directory</pre>
     5083    <p></p>
     5084  </li>
     5085</ol>
    50595086</blockquote>
    50605087<hr><h4><a name="cmt expand model [-strict] &lt;model-string&gt;"></a><a href="#index"><tt>13.&nbsp;3.10</tt></a> - cmt expand model [-strict] &lt;model-string&gt;</h4>
    … …  
    52125239<hr><h4><a name="cmt lock [ &lt;package&gt; &lt;version&gt; [&lt;area&gt;] ]"></a><a href="#index"><tt>13.&nbsp;3.13</tt></a> - cmt lock [ &lt;package&gt; &lt;version&gt; [&lt;area&gt;] ]</h4>
    52135240<blockquote>
    5214             This command tries to set a lock onto the current package (or onto the
     5241   This command tries to set a lock onto the current package (or onto the
    52155242            specified package). This consists in the following operations:
    52165243<p></p>
    … …  
    55005527                      sub-project definitions and settings. It shows the
    55015528                      project names and their location (ie the corresponding
    5502                       item in <tt>CMTPATH</tt>
     5529               item in <tt>CMTPATH</tt>
    55035530    </p>
    55045531<pre>
    … …  
    61396166use OPACS v3 </pre>
    61406167  <p>This procedure gives the complete benefit of the use
    6141             relationships between packages (a client application
     6168         relationships between packages (a client application
    61426169            transparently inherits all configuration specifications) while
    61436170            keeping unchanged the original referenced package, allowing to
    … …  
    82418268<td>
    82428269<font face="courier new, courier" COLOR="#770000"><i>
     8270<a href="#kwCMTProject-structure_strategy">structure_strategy</a>
     8271</i></font>
     8272</td>
     8273</tr>
     8274<tr>
     8275<td></td>
     8276<td>|</td>
     8277<td>
     8278<font face="courier new, courier" COLOR="#770000"><i>
    82438279<a href="#kwCMTProject-use">use</a>
    82448280</i></font>
    … …  
    83908426<font face="courier new, courier" COLOR="#FF0000">
    83918427no_cleanup
     8428</font>
     8429</td>
     8430</tr>
     8431<tr>
     8432<td class="rule"><font face="courier new, courier" COLOR="#770000"><i><a name="kwCMTProject-structure_strategy"></a>structure_strategy</i></font></td>
     8433<td class="rule">:</td>
     8434<td class="rule">
     8435<font face="courier new, courier" COLOR="#FF0000">
     8436structure_strategy
     8437</font>
     8438<font face="courier new, courier" COLOR="#770000"><i>
     8439structure-strategy-name
     8440</i></font>
     8441</td>
     8442</tr>
     8443<tr>
     8444<td class="rule"><font face="courier new, courier" COLOR="#770000"><i><a name="kwCMTProject-structure-strategy-name"></a>structure-strategy-name</i></font></td>
     8445<td class="rule">:</td>
     8446<td class="rule">
     8447<font face="courier new, courier" COLOR="#FF0000">
     8448with_version_directory
     8449</font>
     8450</td>
     8451</tr>
     8452<tr>
     8453<td></td>
     8454<td>|</td>
     8455<td>
     8456<font face="courier new, courier" COLOR="#FF0000">
     8457without_version_directory
    83928458</font>
    83938459</td>
    … …  
    86338699<td>
    86348700<font face="courier new, courier" COLOR="#770000"><i>
     8701<a href="#kwCMT-structure_strategy">structure_strategy</a>
     8702</i></font>
     8703</td>
     8704</tr>
     8705<tr>
     8706<td></td>
     8707<td>|</td>
     8708<td>
     8709<font face="courier new, courier" COLOR="#770000"><i>
    86358710<a href="#kwCMT-symbol">symbol</a>
    86368711</i></font>
    … …  
    98149889</tr>
    98159890<tr>
     9891<td class="rule"><font face="courier new, courier" COLOR="#770000"><i><a name="kwCMT-structure_strategy"></a>structure_strategy</i></font></td>
     9892<td class="rule">:</td>
     9893<td class="rule">
     9894<font face="courier new, courier" COLOR="#FF0000">
     9895structure_strategy
     9896</font>
     9897<font face="courier new, courier" COLOR="#770000"><i>
     9898structure-strategy-name
     9899</i></font>
     9900</td>
     9901</tr>
     9902<tr>
     9903<td class="rule"><font face="courier new, courier" COLOR="#770000"><i><a name="kwCMT-structure-strategy-name"></a>structure-strategy-name</i></font></td>
     9904<td class="rule">:</td>
     9905<td class="rule">
     9906<font face="courier new, courier" COLOR="#FF0000">
     9907with_version_directory
     9908</font>
     9909</td>
     9910</tr>
     9911<tr>
     9912<td></td>
     9913<td>|</td>
     9914<td>
     9915<font face="courier new, courier" COLOR="#FF0000">
     9916without_version_directory
     9917</font>
     9918</td>
     9919</tr>
     9920<tr>
    98169921<td class="rule"><font face="courier new, courier" COLOR="#770000"><i><a name="kwCMT-symbol"></a>symbol</i></font></td>
    98179922<td class="rule">:</td>
    … …  
    1015210257<pre class="cmt">
    1015310258  build_strategy prototypes | without_installarea
    10154   setup_strategy config | root </pre>
     10259  setup_strategy config | root
     10260  structure_strategy with_version_directory</pre>
    1015510261</blockquote>
    1015610262<hr><h3><a name="The internal mechanism of cmt cvs operations"></a><a href="#index"><tt>18.10</tt></a> - The internal mechanism of cmt cvs operations</h3>

  • CMT/HEAD/doc/CMTDoc.xml

    r83 r85  
    608608&lt;project&gt;_cleanup
    609609&lt;project&gt;_no_cleanup
     610&lt;project&gt;_with_version_directory
     611&lt;project&gt;_without_version_directory
    610612&lt;project&gt;_prototypes
    611613&lt;project&gt;_no_prototypes</cmt:cmtcode>
    … …  
    29392941
    29402942          <cmt:section title="The package structuring style ">
     2943
     2944            <p>Packages are installed in a directory structure that
     2945            can optionnally include a version directory (just after
     2946            the top directory of the package name). This is controlled
     2947            through the <i>structuring style</i> or <i>structuring
     2948            strategy</i> parameters specified using one of the
     2949            following means:</p>
     2950
     2951            <ol>
     2952
     2953              <li>Through the environment variable
     2954              <tt>CMTSTRUCTURINGSTYLE</tt> taking one of the
     2955              alternate values:
     2956<cmt:code>
     2957with_version_directory
     2958without_version_directory</cmt:code>
     2959              <p></p></li>
     2960
     2961              <li>Through the command line options
     2962              <tt>-with_version_directory</tt> or
     2963              <tt>-without_version_directory</tt><p></p></li>
     2964
     2965              <li>Through the <tt>structure_strategy</tt> specification entered into the project file of the current project, using the alternate values:
     2966<cmt:code>
     2967with_version_directory
     2968without_version_directory</cmt:code>
     2969              <p></p></li>
     2970
     2971            </ol>
     2972
     2973            <p>It should be noted that the command line option will
     2974            take precedence over the strategy specification, in case
     2975            of conflict.</p>
    29412976
    29422977          </cmt:section>
    … …  
    51675202
    51685203            </ul>
     5204
     5205            <p>A version directory may be created according to the
     5206            structuring style or structuring strategy parameters
     5207            specified using one of the following means:</p>
     5208
     5209            <ol>
     5210
     5211              <li>Through the environment variable
     5212              <tt>CMTSTRUCTURINGSTYLE</tt> taking one of the
     5213              alternate values:
     5214<cmt:code>
     5215with_version_directory
     5216without_version_directory</cmt:code>
     5217              <p></p></li>
     5218
     5219              <li>Through the command line options
     5220              <tt>-with_version_directory</tt> or
     5221              <tt>-without_version_directory</tt><p></p></li>
     5222
     5223              <li>Through the <tt>structure_strategy</tt> specification entered into the project file of the current project, using the alternate values:
     5224<cmt:code>
     5225with_version_directory
     5226without_version_directory</cmt:code>
     5227              <p></p></li>
     5228
     5229            </ol>
     5230
     5231            <p>It should be noted that the command line option will
     5232            take precedence over the strategy specification, in case
     5233            of conflict.</p>
    51695234
    51705235          </cmt:section>
    … …  
    80648129    <cmt:alt><cmt:ruleref name="project"/></cmt:alt>
    80658130    <cmt:alt><cmt:ruleref name="setup_strategy"/></cmt:alt>
     8131    <cmt:alt><cmt:ruleref name="structure_strategy"/></cmt:alt>
    80668132    <cmt:alt><cmt:ruleref name="use"/></cmt:alt>
    80678133  </cmt:rule>
    … …  
    81098175    <cmt:alt><cmt:kwd name="no_cleanup"/></cmt:alt>
    81108176  </cmt:rule>
     8177  <cmt:rule name="structure_strategy">
     8178    <cmt:alt>
     8179      <cmt:kwd/>
     8180      <cmt:term name="structure-strategy-name"/>
     8181    </cmt:alt>
     8182  </cmt:rule>
     8183  <cmt:rule name="structure-strategy-name">
     8184    <cmt:alt><cmt:kwd name="with_version_directory"/></cmt:alt>
     8185    <cmt:alt><cmt:kwd name="without_version_directory"/></cmt:alt>
     8186  </cmt:rule>
    81118187  <cmt:rule name="use">
    81128188    <cmt:alt>
    … …  
    81538229    <cmt:alt><cmt:ruleref name="setup_script"/></cmt:alt>
    81548230    <cmt:alt><cmt:ruleref name="setup_strategy"/></cmt:alt>
     8231    <cmt:alt><cmt:ruleref name="structure_strategy"/></cmt:alt>
    81558232    <cmt:alt><cmt:ruleref name="symbol"/></cmt:alt>
    81568233    <cmt:alt><cmt:ruleref name="tag"/></cmt:alt>
    … …  
    85898666    <cmt:alt><cmt:kwd name="no_cleanup"/></cmt:alt>
    85908667  </cmt:rule>
     8668  <cmt:rule name="structure_strategy">
     8669    <cmt:alt>
     8670      <cmt:kwd/>
     8671      <cmt:term name="structure-strategy-name"/>
     8672    </cmt:alt>
     8673  </cmt:rule>
     8674  <cmt:rule name="structure-strategy-name">
     8675    <cmt:alt><cmt:kwd name="with_version_directory"/></cmt:alt>
     8676    <cmt:alt><cmt:kwd name="without_version_directory"/></cmt:alt>
     8677  </cmt:rule>
    85918678  <cmt:rule name="symbol">
    85928679    <cmt:alt><cmt:ruleref name="alias"/></cmt:alt>
    … …  
    86848771  <cmt:cmtcode>
    86858772  build_strategy prototypes | without_installarea
    8686   setup_strategy config | root </cmt:cmtcode>
     8773  setup_strategy config | root
     8774  structure_strategy with_version_directory</cmt:cmtcode>
    86878775
    86888776</cmt:section>

  • CMT/HEAD/doc/ReleaseNotes.html

    r83 r85  
    5858          -->
    5959
     60          <li class="new">Package creation (either from the <tt>cmt
     61          create</tt> or the <tt>cmt co</tt> commands is affected by
     62          the specification of the structuring style or of the
     63          structuring strategy.</li>
     64
     65          <li class="new">Introduce a new strategy structure_strategy
     66          with only one value with/out_version_directory. This is
     67          mostly useful when installed in a project file to condition
     68          the behaviour of package creation afterwards</li>
     69
    6070          <li class="new">Support dependency building using external
    6171          tools such as cpp -M. Fix the cmt_build_des.sh wrapper
Note: See TracChangeset for help on using the changeset viewer.