/usr/share/doc/gnat-gps/html/The-VCS-node.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2002-2010 AdaCore.

This document is free; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This document is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, see http://www.gnu.org/licenses/.

A copy of the license is included in the section entitled
"GNU General Public License". -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Using the GNAT Programming Studio: The VCS node</title>

<meta name="description" content="Using the GNAT Programming Studio: The VCS node">
<meta name="keywords" content="Using the GNAT Programming Studio: The VCS node">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index-table.html#Index-table" rel="index" title="Index table">
<link href="Describing-a-VCS.html#Describing-a-VCS" rel="up" title="Describing a VCS">
<link href="Associating-actions-to-operations.html#Associating-actions-to-operations" rel="next" title="Associating actions to operations">
<link href="Describing-a-VCS.html#Describing-a-VCS" rel="previous" title="Describing a VCS">
<style type="text/css">
<!--
   

a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
pre.smallexample {background-color:rgb(240,240,240);
                     font-family: courier new,courier,fixed;
                     font-size: 14px;
                     margin: 0px 40px 0px 40px;
                     border-width: 1px 2px 2px 1px;
                     border-top-style: dotted;
                     border-left-style: dotted;
                     border-right-style: solid;
                     border-bottom-style: solid;
                     border-color: black;}
   code             {color:black;
                     font-family: courier new,courier,fixed;
                     font-size: 14px;}
   body             {font-family: arial,helvetica,sans-serif;
                     font-size: 16px;
                     max-width: 800px;
                     text-align: justify}
   samp             {font-family: courier new,courier,fixed;
                     font-size: 14px}
                    

-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="The-VCS-node"></a>
<div class="header">
<p>
Next: <a href="Associating-actions-to-operations.html#Associating-actions-to-operations" accesskey="n" rel="next">Associating actions to operations</a>, Up: <a href="Describing-a-VCS.html#Describing-a-VCS" accesskey="u" rel="up">Describing a VCS</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="The-VCS-node-1"></a>
<h4 class="subsubsection">16.9.2.1 The VCS node</h4>

<p>The <code>vcs</code> node is the toplevel node which contains the
description of the general behavior expected from the VCS. It has the
following attributes:
</p>
<dl compact="compact">
<dt><code>name</code></dt>
<dd><p>The attribute <code>name</code> indicates the identifier of the VCS. The
casing of this name is important, and the same casing must be used in
the project files.
</p>
</dd>
<dt><code>absolute_names</code></dt>
<dd><p>The attribute <code>absolute_names</code> indicates the behavior of the
VCS relative to file names, and can take the values <code>TRUE</code> or
<code>FALSE</code>. If it is set to <code>TRUE</code>, it means that all
commands in the VCS will work on absolute file names. If it set to
<code>FALSE</code>, it means that all actions work on base file names, and
that GPS will move to the appropriate directory before executing an
action.
</p>
</dd>
<dt><code>group_queries_by_directory</code></dt>
<dd><p>The attribute <code>group_queries_by_directory</code> indicates that, when querying
status for all the source files in a directory, a query for the directory
should be launched, instead of launching a query for multiple files.
This operation is faster on some Version Control systems. By default, this
is set to <code>FALSE</code>.
</p>
</dd>
<dt><code>ignore_file</code></dt>
<dd><p>The attribute <code>ignore_file</code> specifies the name of the file used
by the VCS Explorer to get the list of files to ignore. By default for
the CVS mode this is set to <samp>.cvsignore</samp>.
</p>
</dd>
<dt><code>atomic_commands</code></dt>
<dd><p>The attribute <code>atomic_commands</code> specifies if the VCS supports
atomicity and can take the values <code>TRUE</code> or <code>FALSE</code>. If it
is set to <code>TRUE</code> it means that the VCS supports atomic
commands. It is <code>FALSE</code> by default. This attribute is important
to trigger the activities group commit feature. See See <a href="The-VCS-Activities.html#The-VCS-Activities">The VCS Activities</a>.
</p>
</dd>
<dt><code>path_style</code></dt>
<dd><p>The attribute <code>path_style</code> specifies which kind of directory separator
is supported by the VCS and can take the values <code>UNIX</code>,
<code>DOS</code>, <code>Cygwin</code> or <code>System_Default</code>. The later value is
the default value. With this attribute it is possible to control the
directory separator to use when specifying files to the VCS. For the
<code>Cygwin</code> case the drive is specified as <code>/cygdrive/&lt;drive&gt;</code>.
</p>
</dd>
<dt><code>dir_sep</code></dt>
<dd><p>Alias for <code>path_style</code>, obsolescent.
</p>
</dd>
<dt><code>commit_directory</code></dt>
<dd><p>The attribute <code>commit_directory</code> specifies if the VCS supports
commit on directories and can take the values <code>TRUE</code> or <code>FALSE</code>.
If it is set to <code>TRUE</code> it means that the VCS supports commit on
directories this is the case for <code>Subversion</code> for example.
</p>
</dd>
<dt><code>administrative_directory</code></dt>
<dd><p>The attribute <code>administrative_directory</code> specifies the name of
the directory where the external VCS stores the local repository
information. For example for Subversion this is <samp>.svn</samp>. This
information is used when the project is setup to select automatically
the external VCS. See <a href="Version-Control-System.html#Version-Control-System">Version Control System</a>.
</p>
</dd>
<dt><code>require_log</code></dt>
<dd><p>The attribute <code>require_log</code> specifies if the VCS require a log
for the commit/add/delete actions. It can take the values <code>TRUE</code>
or <code>FALSE</code>. If it is set to <code>TRUE</code> GPS will ensure that
a log is created for each file. If it is set to <code>FALSE</code> GPS will
not ask for log, it is expected to be handled by the external VCS.
</p></dd>
</dl>

<p>Note that to support group commit with shared log on GPS both
<code>absolute_name</code> and <code>atomic_commands</code> must be true. This is
the case for the Subversion VCS for example.
</p>
<p>Here is an example, adapted to the use of CVS:
</p>
<div class="smallexample">
<pre class="smallexample">   &lt;vcs name=&quot;Custom CVS&quot; absolute_names=&quot;FALSE&quot;&gt;

      (... description of action associations ...)
      (... description of supported status ...)
      (... description of output parsers ...)

   &lt;/vcs&gt;
</pre></div>

<hr>
<div class="header">
<p>
Next: <a href="Associating-actions-to-operations.html#Associating-actions-to-operations" accesskey="n" rel="next">Associating actions to operations</a>, Up: <a href="Describing-a-VCS.html#Describing-a-VCS" accesskey="u" rel="up">Describing a VCS</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
gnat-gps-doc 5.0-16 / usr / share / doc / gnat-gps / html / The-VCS-node.html
