<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>src/Darcs/Commands/Init.lhs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
% Copyright (C) 2002-2003 David Roundy
%
% This program is free software; 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, or (at your option)
% any later version.
%
% This program 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; see the file COPYING. If not, write to
% the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
% Boston, MA 02110-1301, USA.
\darcsCommand{initialize}
\begin{code}
<pre><a name="line-1"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Commands</span><span class='hs-varop'>.</span><span class='hs-conid'>Init</span> <span class='hs-layout'>(</span> <span class='hs-varid'>initialize</span><span class='hs-layout'>,</span> <span class='hs-varid'>initializeCmd</span> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-2"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Commands</span> <span class='hs-layout'>(</span> <span class='hs-conid'>DarcsCommand</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>nodefaults</span> <span class='hs-layout'>)</span>
<a name="line-3"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Arguments</span> <span class='hs-layout'>(</span> <span class='hs-conid'>DarcsFlag</span><span class='hs-layout'>,</span> <span class='hs-varid'>workingRepoDir</span><span class='hs-layout'>,</span>
<a name="line-4"></a> <span class='hs-varid'>inventoryChoices</span> <span class='hs-layout'>)</span>
<a name="line-5"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Repository</span> <span class='hs-layout'>(</span> <span class='hs-varid'>amNotInRepository</span><span class='hs-layout'>,</span> <span class='hs-varid'>createRepository</span> <span class='hs-layout'>)</span>
<a name="line-6"></a>
<a name="line-7"></a><a name="initializeDescription"></a><span class='hs-definition'>initializeDescription</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span>
<a name="line-8"></a><span class='hs-definition'>initializeDescription</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"Make the current directory a repository."</span>
<a name="line-9"></a>
<a name="line-10"></a><a name="initializeHelp"></a><span class='hs-definition'>initializeHelp</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span>
<a name="line-11"></a><span class='hs-definition'>initializeHelp</span> <span class='hs-keyglyph'>=</span>
<a name="line-12"></a> <span class='hs-str'>"The `darcs initialize' command turns the current directory into a\n"</span> <span class='hs-varop'>++</span>
<a name="line-13"></a> <span class='hs-str'>"Darcs repository. Any existing files and subdirectories become\n"</span> <span class='hs-varop'>++</span>
<a name="line-14"></a> <span class='hs-str'>"UNSAVED changes in the working tree: record them with `darcs add -r'\n"</span> <span class='hs-varop'>++</span>
<a name="line-15"></a> <span class='hs-str'>"and `darcs record'.\n"</span> <span class='hs-varop'>++</span>
<a name="line-16"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-17"></a> <span class='hs-comment'>-- FIXME: confirm my assertion re conversion is true. --twb, 2008-12-14</span>
<a name="line-18"></a> <span class='hs-str'>"When converting a project to Darcs from some other VCS, translating\n"</span> <span class='hs-varop'>++</span>
<a name="line-19"></a> <span class='hs-str'>"the full revision history to native Darcs patches is recommended.\n"</span> <span class='hs-varop'>++</span>
<a name="line-20"></a> <span class='hs-str'>"(The Darcs wiki lists utilities for this.) Because Darcs is optimized\n"</span> <span class='hs-varop'>++</span>
<a name="line-21"></a> <span class='hs-str'>"for small patches, simply importing the latest revision as a single\n"</span> <span class='hs-varop'>++</span>
<a name="line-22"></a> <span class='hs-str'>"large patch can PERMANENTLY degrade Darcs performance in your\n"</span> <span class='hs-varop'>++</span>
<a name="line-23"></a> <span class='hs-str'>"repository by an order of magnitude.\n"</span> <span class='hs-varop'>++</span>
<a name="line-24"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-25"></a> <span class='hs-str'>"This command creates the `_darcs' directory, which stores version\n"</span> <span class='hs-varop'>++</span>
<a name="line-26"></a> <span class='hs-str'>"control metadata. It also contains per-repository settings in\n"</span> <span class='hs-varop'>++</span>
<a name="line-27"></a> <span class='hs-str'>"_darcs/prefs/, which you can read about in the user manual.\n"</span> <span class='hs-varop'>++</span>
<a name="line-28"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-29"></a> <span class='hs-str'>"In addition to the default `darcs-2' format, there are two backward\n"</span> <span class='hs-varop'>++</span>
<a name="line-30"></a> <span class='hs-str'>"compatibility formats for the _darcs directory. These formats are\n"</span> <span class='hs-varop'>++</span>
<a name="line-31"></a> <span class='hs-str'>"only useful if some of your contributors do not have access to Darcs\n"</span> <span class='hs-varop'>++</span>
<a name="line-32"></a> <span class='hs-str'>"2.0 or higher. In that case, you need to use the original format\n"</span> <span class='hs-varop'>++</span>
<a name="line-33"></a> <span class='hs-str'>"(called `old-fashioned inventory' or `darcs-1') for any repositories\n"</span> <span class='hs-varop'>++</span>
<a name="line-34"></a> <span class='hs-str'>"those contributors access.\n"</span> <span class='hs-varop'>++</span>
<a name="line-35"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-36"></a> <span class='hs-str'>"As patches cannot be shared between darcs-2 and darcs-1 repositories,\n"</span> <span class='hs-varop'>++</span>
<a name="line-37"></a> <span class='hs-str'>"you cannot use the darcs-2 format for private branches of such a\n"</span> <span class='hs-varop'>++</span>
<a name="line-38"></a> <span class='hs-str'>"project. Instead, you should use the `hashed' format, which provides\n"</span> <span class='hs-varop'>++</span>
<a name="line-39"></a> <span class='hs-str'>"most of the features of the darcs-2 format, while retaining the\n"</span> <span class='hs-varop'>++</span>
<a name="line-40"></a> <span class='hs-str'>"ability to share patches with darcs-1 repositories. The `darcs get'\n"</span> <span class='hs-varop'>++</span>
<a name="line-41"></a> <span class='hs-str'>"command will do this by default.\n"</span> <span class='hs-varop'>++</span>
<a name="line-42"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-43"></a> <span class='hs-str'>"Once all contributors have access to Darcs 2.0 or higher, a darcs-1\n"</span> <span class='hs-varop'>++</span>
<a name="line-44"></a> <span class='hs-str'>"project can be migrated to darcs-2 using the `darcs convert' command.\n"</span> <span class='hs-varop'>++</span>
<a name="line-45"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-46"></a> <span class='hs-str'>"Darcs will create a hashed repository by default when you `darcs get'\n"</span> <span class='hs-varop'>++</span>
<a name="line-47"></a> <span class='hs-str'>"a repository in old-fashioned inventory format. Once all contributors\n"</span> <span class='hs-varop'>++</span>
<a name="line-48"></a> <span class='hs-str'>"have upgraded to Darcs 2.0 or later, use `darcs convert' to convert\n"</span> <span class='hs-varop'>++</span>
<a name="line-49"></a> <span class='hs-str'>"the project to the darcs-2 format.\n"</span> <span class='hs-varop'>++</span>
<a name="line-50"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-51"></a> <span class='hs-str'>"Initialize is commonly abbreviated to `init'.\n"</span>
<a name="line-52"></a>
<a name="line-53"></a><a name="initialize"></a><span class='hs-definition'>initialize</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>DarcsCommand</span>
<a name="line-54"></a><span class='hs-definition'>initialize</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DarcsCommand</span> <span class='hs-layout'>{</span><span class='hs-varid'>commandName</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"initialize"</span><span class='hs-layout'>,</span>
<a name="line-55"></a> <span class='hs-varid'>commandHelp</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>initializeHelp</span><span class='hs-layout'>,</span>
<a name="line-56"></a> <span class='hs-varid'>commandDescription</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>initializeDescription</span><span class='hs-layout'>,</span>
<a name="line-57"></a> <span class='hs-varid'>commandExtraArgs</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>0</span><span class='hs-layout'>,</span>
<a name="line-58"></a> <span class='hs-varid'>commandExtraArgHelp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span><span class='hs-layout'>,</span>
<a name="line-59"></a> <span class='hs-varid'>commandPrereq</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>amNotInRepository</span><span class='hs-layout'>,</span>
<a name="line-60"></a> <span class='hs-varid'>commandCommand</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>initializeCmd</span><span class='hs-layout'>,</span>
<a name="line-61"></a> <span class='hs-varid'>commandGetArgPossibilities</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span><span class='hs-layout'>,</span>
<a name="line-62"></a> <span class='hs-varid'>commandArgdefaults</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>nodefaults</span><span class='hs-layout'>,</span>
<a name="line-63"></a> <span class='hs-varid'>commandAdvancedOptions</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span><span class='hs-layout'>,</span>
<a name="line-64"></a> <span class='hs-varid'>commandBasicOptions</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>inventoryChoices</span><span class='hs-layout'>,</span>
<a name="line-65"></a> <span class='hs-varid'>workingRepoDir</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>}</span>
<a name="line-66"></a>
<a name="line-67"></a><a name="initializeCmd"></a><span class='hs-definition'>initializeCmd</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>DarcsFlag</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-68"></a><span class='hs-definition'>initializeCmd</span> <span class='hs-varid'>opts</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>createRepository</span> <span class='hs-varid'>opts</span>
</pre>\end{code}
</body>
</html>
