File: dbp.getstart.html

package info (click to toggle)
darcs-buildpackage 0.5.12.2
links: PTS
area: main
in suites: squeeze
size: 716 kB
ctags: 2
sloc: haskell: 452; sh: 62; makefile: 56
file content (343 lines) | stat: -rw-r--r-- 6,735 bytes
parent folder | download | duplicates (2)
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Getting Started</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="Building Debian Packages with darcs-buildpackage"
HREF="dbp.html"><LINK
REL="PREVIOUS"
TITLE="Introduction"
HREF="dbp.intro.html"><LINK
REL="NEXT"
TITLE="Importing Packages"
HREF="dbp.import.html"><STYLE
TYPE="text/css"
>.synopsis, .classsynopsis {
    background: #eeeeee;
    border: solid 1px #aaaaaa;
    padding: 0.5em;
}
.programlisting {
    background: #eeeeff;
    border: solid 1px #aaaaff;
    padding: 0.5em;
}
.variablelist {
    padding: 4px;
    margin-left: 3em;
}
.navigation {
    background: #ffeeee;
    border: solid 1px #ffaaaa;
    margin-top: 0.5em;
    margin-bottom: 0.5em;
}
.navigation a {
    color: #770000;
}
.navigation a:visited {
    color: #550000;
}
.navigation .title {
    font-size: 200%;
}</STYLE
></HEAD
><BODY
CLASS="CHAPTER"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><TABLE
WIDTH="100%"
CLASS="navigation"
SUMMARY="Navigation header"
CELLPADDING="2"
CELLSPACING="2"
><TR
VALIGN="middle"
><TD
><A
ACCESSKEY="p"
HREF="dbp.intro.html"
><IMG
SRC="left.png"
WIDTH="24"
HEIGHT="24"
BORDER="0"
ALT="Prev"></A
></TD
><TD
><A
ACCESSKEY="h"
HREF="dbp.html"
><IMG
SRC="home.png"
WIDTH="24"
HEIGHT="24"
BORDER="0"
ALT="Home"></A
></TD
><TH
WIDTH="100%"
align="center"
>Building Debian Packages with darcs-buildpackage</TH
><TD
><A
ACCESSKEY="n"
HREF="dbp.import.html"
><IMG
SRC="right.png"
WIDTH="24"
HEIGHT="24"
BORDER="0"
ALT="Next"></A
></TD
></TR
></TABLE
><DIV
CLASS="CHAPTER"
><H1
><A
NAME="DBP.GETSTART"
></A
>Getting Started</H1
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="dbp.getstart.html#DBP.LAYOUT"
>The <SPAN
CLASS="APPLICATION"
>darcs-buildpackage</SPAN
> Repository Layout</A
></DT
><DT
><A
HREF="dbp.getstart.html#DBP.CONFIGFILE"
>The Configuration File</A
></DT
></DL
></DIV
><P
>      Getting started with <SPAN
CLASS="APPLICATION"
>darcs-buildpackage</SPAN
> is pretty simple.  This chapter shows
      you how.
    </P
><BR
CLEAR="all"><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="DBP.LAYOUT"
>The <SPAN
CLASS="APPLICATION"
>darcs-buildpackage</SPAN
> Repository Layout</A
></H1
><P
>        <SPAN
CLASS="APPLICATION"
>darcs-buildpackage</SPAN
> assumes that you have two "canonical" repositories for
        every Debian package.  These repositories correspond to the
        upstream and the Debian versions of the package's source.  The
        upstream repository tracks unmodified upstream versions.  The
        Debian repository pulls in upstream patches, and also has the
        Debian-specific patches for your package.  (Debian-native
        packages have no upstream version and thus no upstream repository.)
      </P
><P
>        Normally, you would not work directly in the canonical
        repository storage area.  Rather, you would use <B
CLASS="COMMAND"
>darcs
        get</B
> or dbp-get to make a copy of the sources, and
        <B
CLASS="COMMAND"
>darcs push</B
> to push changes back to your
        storage area when done.
      </P
><P
>        The canonical repository need not be on your local machine.
        It could be any repository area that Darcs has access to.
      </P
><BR
CLEAR="all"><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN91"
>Upstream Repository</A
></H2
><P
>          The upstream repository tracks changes to the upstream
          program.  You can use dbp-importorig or dbp-importdsc to
          import upstream sources from tarballs, or you can use Darcs
          to track a Darcs-based upstream with <B
CLASS="COMMAND"
>darcs
          get</B
> and <B
CLASS="COMMAND"
>darcs pull</B
>.
        </P
><P
>          Each upstream version should be tagged with
          a tag nammed
          <SPAN
CLASS="PROPERTY"
>UPSTREAM_<TT
CLASS="REPLACEABLE"
><I
>packagename</I
></TT
>_<TT
CLASS="REPLACEABLE"
><I
>version</I
></TT
></SPAN
>.
          Note that the Debian revision doesn't appear in this tag.
          An example would be
          <SPAN
CLASS="PROPERTY"
>UPSTREAM_mypackage_1.0.5</SPAN
>.
          If you use dbp-importorig or dbp-importdsc, this tag will be
          created for you automatically.  If you manage your upstream
          repository manually, you should create the tag yourself
          using <B
CLASS="COMMAND"
>darcs tag</B
>
        </P
></DIV
><BR
CLEAR="all"><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN102"
>Debian Repository</A
></H2
><P
>          The Debian repository tracks the Debian-specific package.
          The Debian package is represented as the upstream source
          plus a set of Debian patches.  Upstream patches are normally
          pulled into the Debian repository before beginning on the
          Debian package.
        </P
><P
>          Each Debian version carries a tag similar to the upstream
          version, but the Debian version tags begin with
          <SPAN
CLASS="PROPERTY"
>DEBIAN_</SPAN
> and contain a full Debian revision.  
          An example is <SPAN
CLASS="PROPERTY"
>DEBIAN_mypackage_1.0.5-3</SPAN
>.
        </P
></DIV
></DIV
><BR
CLEAR="all"><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="DBP.CONFIGFILE"
>The Configuration File</A
></H1
><P
>        The first thing you must do is create your <SPAN
CLASS="APPLICATION"
>darcs-buildpackage</SPAN
> configuration
        file.  It is called <TT
CLASS="FILENAME"
>.darcs-buildpackage</TT
>
        and stored in your home directory.  The main purpose of the
        configuration file is to specify the location and naming of
        your repositories.
      </P
><P
>        There are two items required in the configuration file:
        <SPAN
CLASS="PROPERTY"
>upstreamrepo</SPAN
> and
        <SPAN
CLASS="PROPERTY"
>debianrepo</SPAN
>.  The special token
        <TT
CLASS="FILENAME"
>%(package)s</TT
> represents the name of a
        specific package.  Thus, a sample file could look like this:
      </P
><PRE
CLASS="SCREEN"
>upstreamrepo = /home/jgoerzen/debdarcs/%(package)s.upstream
debianrepo = /home/jgoerzen/debdarcs/%(package)s
      </PRE
><P
>        More sophisticated configurations are possible.  (FIXME: write
        about them)
      </P
></DIV
></DIV
><TABLE
CLASS="navigation"
WIDTH="100%"
SUMMARY="Navigation footer"
CELLPADDING="2"
CELLSPACING="2"
><TR
VALIGN="middle"
><TD
ALIGN="left"
><A
ACCESSKEY="p"
HREF="dbp.intro.html"
><B
>&lt;&lt;&lt;&nbsp;Introduction</B
></A
></TD
><TD
ALIGN="right"
><A
ACCESSKEY="n"
HREF="dbp.import.html"
><B
>Importing Packages&nbsp;&gt;&gt;&gt;</B
></A
></TD
></TR
></TABLE
></BODY
></HTML
>