/usr/share/doc/gnat-gps/html/Implementing-VCS-actions.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: Implementing VCS actions</title>

<meta name="description" content="Using the GNAT Programming Studio: Implementing VCS actions">
<meta name="keywords" content="Using the GNAT Programming Studio: Implementing VCS actions">
<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="Adding-support-for-new-Version-Control-Systems.html#Adding-support-for-new-Version-Control-Systems" rel="up" title="Adding support for new Version Control Systems">
<link href="The-Server-Mode.html#The-Server-Mode" rel="next" title="The Server Mode">
<link href="Output-parsers.html#Output-parsers" rel="previous" title="Output parsers">
<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="Implementing-VCS-actions"></a>
<div class="header">
<p>
Previous: <a href="Describing-a-VCS.html#Describing-a-VCS" accesskey="p" rel="previous">Describing a VCS</a>, Up: <a href="Adding-support-for-new-Version-Control-Systems.html#Adding-support-for-new-Version-Control-Systems" accesskey="u" rel="up">Adding support for new Version Control Systems</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Implementing-VCS-actions-1"></a>
<h4 class="subsection">16.9.3 Implementing VCS actions</h4>

<p>A number of &ldquo;standard&rdquo; VCS operations are known to GPS. Each of
these operations can be implemented, using Actions. See <a href="Defining-Actions.html#Defining-Actions">Defining Actions</a>) for a complete description of how to implement actions.
</p>
<p>Here is a list of all the defined VCS operations, and their
parameters:
</p>
<dl compact="compact">
<dt><code>status_files</code></dt>
<dd><dl compact="compact">
<dt><code>$1  = whether the log files should be cleared when obtaining up-to-date status</code></dt>
<dt><code>$2- = the list of files to query status for.</code></dt>
</dl>
<p>Query the status for a list of files. This should perform a complete
  VCS query and return results as complete as possible.
</p>
</dd>
<dt><code>status_dir</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = the directory.</code></dt>
</dl>
<p>Same as above, but works on all the files in one directory.
</p>
</dd>
<dt><code>status_dir_recursive</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = the directory.</code></dt>
</dl>
<p>Same as above, but works on all the files in one directory and all
  subdirectories, recursively.
</p>
</dd>
<dt><code>local_status_files</code></dt>
<dd><dl compact="compact">
<dt><code>$* = list of files</code></dt>
</dl>
<p>Query the local status for specified files. This query should be as
  fast as possible, not connecting to any remote VCS. The results need
  not be complete, but it is not useful to implement this command if
  the output does not contain at least the working revision.
</p>
</dd>
<dt><code>open</code></dt>
<dd><dl compact="compact">
<dt><code>$* = list of files</code></dt>
</dl>
<p>Open files or directories for editing. This command should be
  implemented on any VCS that require an explicit check-out/open/edit
  action before being able to edit a file.
</p>
</dd>
<dt><code>update</code></dt>
<dd><dl compact="compact">
<dt><code>$* = list of files</code></dt>
</dl>
<p>Bring the specified files in sync with the latest repository revision.
</p>
</dd>
<dt><code>resolved</code></dt>
<dd><dl compact="compact">
<dt><code>$* = list of files</code></dt>
</dl>
<p>Mark files&rsquo; merge conflics as resolved. Some version control systems
  (like Subversion) will block any commit until this action is called.
</p>
</dd>
<dt><code>commit</code></dt>
<dd><dl compact="compact">
<dt><code>$1  = log file</code></dt>
<dt><code>$2- = list of files</code></dt>
</dl>
<p>Commit/submit/check-in files or directories with provided log. The log is
  passed in a file.
</p>
</dd>
<dt><code>commit_dir</code></dt>
<dd><dl compact="compact">
<dt><code>$1  = log</code></dt>
<dt><code>$2  = directory</code></dt>
</dl>
<p>Commit/submit one directory with provided log. The log is passed in
  a file.
</p>
</dd>
<dt><code>history_text</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = file</code></dt>
</dl>
<p>Query the entire changelog history for the specified file. The result
  is expected to be placed into an editor as plain text.
</p>
</dd>
<dt><code>history</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = file</code></dt>
</dl>
<p>Query the entire changelog history for the specified file. The result
  is expected to be placed into a Revision View.
</p>
</dd>
<dt><code>history_revision</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = revision</code></dt>
<dt><code>$2 = file</code></dt>
</dl>
<p>Query the history for corresponding revision of the specified file.
</p>
</dd>
<dt><code>annotate</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = file</code></dt>
</dl>
<p>Query the annotations for a file.
</p>
</dd>
<dt><code>add</code></dt>
<dd><dl compact="compact">
<dt><code>$1  = log</code></dt>
<dt><code>$2- = list of files or dirs</code></dt>
</dl>
<p>Add files/dirs to the repository, with the provided revision log. The
  added files/dirs are commited.
</p>
</dd>
<dt><code>add_no_commit</code></dt>
<dd><dl compact="compact">
<dt><code>$1  = log</code></dt>
<dt><code>$2- = list of files or dirs</code></dt>
</dl>
<p>Add files/dirs to the repository, with the provided revision log. The
  added files/dirs are not commited.
</p>
</dd>
<dt><code>remove</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = log</code></dt>
<dt><code>$2 = file or dir</code></dt>
</dl>
<p>Remove file/dir from the repository, with the provided revision log.
</p>
</dd>
<dt><code>remove_no_commit</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = log</code></dt>
<dt><code>$2 = file or dir</code></dt>
</dl>
<p>Remove file/dir from the repository, with the provided revision log.
  The removed files/dirs are not commited.
</p>
</dd>
<dt><code>revert</code></dt>
<dd><dl compact="compact">
<dt><code>$* = files</code></dt>
</dl>
<p>Revert the local file to repository revision, cancelling all local
  changes, and close the file for editing if it was open.
</p>
</dd>
<dt><code>diff_patch</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = file</code></dt>
</dl>
<p>Create a textual diff for the given file. This command is used to
  build the activity patch file.
</p>
</dd>
<dt><code>diff_head</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = file</code></dt>
</dl>
<p>Display a visual comparison between the local file and the latest
  repository revision. The diff command must report a <i>normal</i> diff
  as opposed to <i>context</i> or <i>unified</i> ones.
</p>
</dd>
<dt><code>diff_base_head</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = file</code></dt>
</dl>
<p>Display a visual comparison between the revision from which the file
  has been checked-out and the latest revision. The diff command must
  report a <i>normal</i> diff as opposed to <i>context</i> or <i>unified</i> ones.
</p>
</dd>
<dt><code>diff_working</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = file</code></dt>
</dl>
<p>Display a visual comparison between the local file and the revision
  from which it was obtained. The diff command must report a <i>normal</i> diff
  as opposed to <i>context</i> or <i>unified</i> ones.
</p>
</dd>
<dt><code>diff</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = rev</code></dt>
<dt><code>$2 = file</code></dt>
</dl>
<p>Display a visual comparison between the local file and the specified
  revision. The diff command must report a <i>normal</i> diff
  as opposed to <i>context</i> or <i>unified</i> ones.
</p>
</dd>
<dt><code>diff2</code></dt>
<dd><dl compact="compact">
<dt><code>$1 = revision 1</code></dt>
<dt><code>$2 = revision 2</code></dt>
<dt><code>$3 = file</code></dt>
</dl>
<p>Display a visual comparison between the two specified revisions of
  the file. The diff command must report a <i>normal</i> diff
  as opposed to <i>context</i> or <i>unified</i> ones.
</p>
</dd>
</dl>

<hr>
<div class="header">
<p>
Previous: <a href="Describing-a-VCS.html#Describing-a-VCS" accesskey="p" rel="previous">Describing a VCS</a>, Up: <a href="Adding-support-for-new-Version-Control-Systems.html#Adding-support-for-new-Version-Control-Systems" accesskey="u" rel="up">Adding support for new Version Control Systems</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 / Implementing-VCS-actions.html
