[Pkg-octave-devel] Guidelines for the Debian Octave Group

Tue, 8 Feb 2005 10:12:44 +0100

--qDbXVdCdHGoSgWSk
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

I wrote a set of Guidelines for the collaborative work in the Debian Octave
Group, improving the SVN cookbook that Isaac Clerencia posted here some days
ago.  You will the Guidelines at:

    http://svn.debian.org/wsvn/pkg-octave/trunk/README

I am also attaching the file below, just for the record.

Please, read the document and fix any mistake in the text, in particular as
regards the usage of English.  No fear: the file is under Subversion control
:-)

-- 
Rafael

--qDbXVdCdHGoSgWSk
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename=README

Guidelines for maintaining Octave-related Debian packages
=========================================================

1. Coordination
---------------

The development of Octave-related packages in Debian is done as a
collaborative work by the Debian Octave Group at alioth.debian.org.  Any
maintainer/developer, either a DD or not, interested in Octave related
packages is encouraged to join the pkg-octave project at Alioth.

Issues are discussed in the pkg-octave-devel mailing list.  For more
information about subscription and for looking at the archives, please
visit http://lists.alioth.debian.org/mailman/listinfo/pkg-octave-devel

Besides the common development of the Octave-related packages, the Debian
Octave Group will eventually improve the common build infrastructure, which
will result in a better integration of the packages in the Debian
distribution.

2. Building and uploading packages
----------------------------------

The first thing to do when contributing a new package is to set the
maintainer to Debian Octave Group <pkg-octave-devel@lists.alioth.debian.org>
in debian/control.

The debian/changelog entries should look like this:

octave-cool (1.2.3-4) unstable; urgency=low

  +++ Changes made by Dirk Eddelbuettel

  * Rebuilt with cool stuff

  +++ Changes made by Rafael Laboissiere

  * Cool tweaks 

 -- Debian Octave Group <pkg-octave-devel@lists.alioth.debian.org>  Mon,  15 Oct 2012 08:30:00 -0400

At the end of debian/changelog put the following lines:

Local Variables:
debian-changelog-full-name: "Debian Octave Group"
debian-changelog-mailing-address: "pkg-octave-devel@lists.alioth.debian.org"
End:

This is a great help when using (X)Emacs with the debian-changelog-mode and
hitting [(control) c] [(control) c].

3. SVN repository
-----------------

The packages are under Subversion control at svn.debian.org.  For more
information on Subversion, please look at the web site
http://subversion.tigris.org.  The Subversion book is also a valuable
resource.  Install the subversion package and point your browser at 
file::///usr/share/doc/subversion/book/.

Automatic SVN activity is sent to the pkg-octave-commit mailing list.  For
more information, please visit
http://lists.alioth.debian.org/mailman/listinfo/pkg-octave-commit 

The repository is organized as follows

    snv://svn.debian.org/svn/pkg-octave/
      trunk/
        packages/
          octave2.1/
            debian/
          octave-forge/
            debian/
          [...]
      tags/
        packages/
          octave2.1/
            2.1.64-3/
            2.1.64-4/      
            [...]
          octave-forge/
            2004.11.16-3/
            2004.11.16-4/
            [...]
          [...]

Notice that only the debian files are put under Subversion control.  No
upstream files, please.

As regards tag conventions, use the following path:

    svn://svn.debian.org/svn/pkg-octave/tags/packages/<package>/<version>

Here is the cookbook to put a new package under Subversion control:

# Import the pkg-octave repository

svn co svn+ssh://svn.debian.org/svn/pkg-octave

# Create the directory for the new package in trunk and tags

mkdir pkg-octave/trunk/packages/octave-cool
mkdir pkg-octave/tags/packages/octave-cool

# Get the latest released version of the package

apt-get source octave-cool

# Copy the debian directory to trunk

cp -a octave-cool-1.2.3/debian pkg-octave/trunk/packages/octave-cool

# Add the Debian-related files to the repository

cd pkg-octave
svn add trunk/packages/octave-cool
svn add tags/packages/octave-cool
svn commit --message 'Initial import of package octave-cool'

# Tag its current version

svn copy trunk/packages/octave-cool tags/packages/octave-cool/1.2.3-4
svn commit tags/packages/octave-cool --message 'Debian release 1.2.3-4'

# Now you can go back to the package sources and do:

cd ../octave-cool-1.2.3-4
rm -rf debian
svn co svn+ssh://svn.debian.org/svn/pkg-octave/trunk/packages/octave-cool/debian

When committing changes that do not result in a Debian release, keep
debian/changelog in a clearly broken state, such that the other developers
will know that the version is not yet released.  Something like this:

octave-cool (1.2.3-4) unstable; urgency=low

  NOT YET RELEASED!

  +++ Changes made by Rafael Laboissiere

  * First import

 -- 

Notice the absence of signature and release date.  dpkg-buildpackage will
refuse to build a package with such an entry at the top of debian/changelog.

Author
------

Rafael Laboissiere <rafael@debian.org>
in the behalf of the
Debian Octave Group <pkg-octave-devel@lists.alioth.debian.org>

$Id: README 15 2005-02-08 08:57:26Z rafael $

Editor settings
---------------

Local variables:
mode: indented-text
End:

--qDbXVdCdHGoSgWSk--