[Pkg-octave-commit] rev 216 - trunk/www
Rafael Laboissiere
pkg-octave-devel@lists.alioth.debian.org
Wed, 08 Jun 2005 16:18:59 +0000
Author: rafael
Date: 2005-06-08 16:18:58 +0000 (Wed, 08 Jun 2005)
New Revision: 216
Modified:
trunk/www/DOG-Guidelines.txt
Log:
* Ported to the reStruturedText markup
* Added table of contents and links to the source document and its CVS history
Modified: trunk/www/DOG-Guidelines.txt
===================================================================
--- trunk/www/DOG-Guidelines.txt 2005-06-07 08:38:27 UTC (rev 215)
+++ trunk/www/DOG-Guidelines.txt 2005-06-08 16:18:58 UTC (rev 216)
@@ -1,6 +1,7 @@
Guidelines for maintaining Octave-related Debian packages
=========================================================
+.. contents::
1. Coordination
---------------
@@ -27,27 +28,27 @@
maintainer to Debian Octave Group <pkg-octave-devel@lists.alioth.debian.org>
in debian/control.
-The debian/changelog entries should look like this:
+The debian/changelog entries should look like this::
-octave-cool (1.2.3-4) unstable; urgency=low
+ octave-cool (1.2.3-4) unstable; urgency=low
- +++ Changes by Dirk Eddelbuettel:
+ +++ Changes by Dirk Eddelbuettel:
- * Rebuilt with cool stuff
+ * Rebuilt with cool stuff
- +++ Changes by Rafael Laboissiere:
+ +++ Changes by Rafael Laboissiere:
- * Cool tweaks
+ * Cool tweaks
- -- Debian Octave Group <pkg-octave-devel@lists.alioth.debian.org> Mon, 15 Oct 2012 08:30:00 -0400
+ -- 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:
+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:
+ 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].
@@ -66,7 +67,7 @@
more information, please visit
http://lists.alioth.debian.org/mailman/listinfo/pkg-octave-commit
-The repository is organized as follows
+The repository is organized as follows::
snv://svn.debian.org/svn/pkg-octave/
trunk/
@@ -109,71 +110,70 @@
Here is the cookbook to put a new package under Subversion control:
-# Import the pkg-octave repository
+* Import the pkg-octave repository::
-svn co svn+ssh://svn.debian.org/svn/pkg-octave
+ svn co svn+ssh://svn.debian.org/svn/pkg-octave
-[N.B.: This only works if your user name in the system you are working is
- the same as your user name in Alioth. If this is not the case, you
- will need to set the SVN_SSH environment variable, like this:
+ :note: This only works if your user name in the system you are working is
+ the same as your user name in Alioth. If this is not the case, you
+ will need to set the SVN_SSH environment variable, like this::
- export SVN_SSH="ssh -l my-alioth-username"
+ export SVN_SSH="ssh -l my-alioth-username"
- Otherwise, you can add your Alioth user name directly in the URL:
+ Otherwise, you can add your Alioth user name directly in the URL::
- svn co svn+ssh://my-alioth-username@svn.debian.org/svn/pkg-octave
+ svn co svn+ssh://my-alioth-username@svn.debian.org/svn/pkg-octave
- Yet another solution, probably the best one, is adding to your
- personal configuration file ~/.ssh/config something like:
+ Yet another solution, probably the best one, is adding to your
+ personal configuration file ~/.ssh/config something like::
- Host svn.debian.org
- User my-alioth-username
-]
+ Host svn.debian.org
+ User my-alioth-username
-# Create the directory for the new package in trunk and tags
+* 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
+ mkdir pkg-octave/trunk/packages/octave-cool
+ mkdir pkg-octave/tags/packages/octave-cool
-# Get the latest released version of the package
+* Get the latest released version of the package::
-apt-get source octave-cool
+ apt-get source octave-cool
-# Copy the debian directory to trunk
+* Copy the debian directory to trunk::
-cp -a octave-cool-1.2.3/debian pkg-octave/trunk/packages/octave-cool
+ cp -a octave-cool-1.2.3/debian pkg-octave/trunk/packages/octave-cool
-# Add the Debian-related files to the repository
+* 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'
+ 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
+* 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'
+ 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:
+* 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
+ 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:
+will know that the version is not yet released. Something like this::
-octave-cool (1.2.3-4) unstable; urgency=low
+ octave-cool (1.2.3-4) unstable; urgency=low
- NOT YET RELEASED!
+ NOT YET RELEASED!
- +++ Changes made by Rafael Laboissiere
+ +++ Changes made by Rafael Laboissiere
- * First import
+ * 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.
@@ -192,36 +192,36 @@
1) Build-Depends on octave2.1-headers (>= 2.1.65). This is necessary to get
access to files defs.make and octave-depends (attached below).
-2) At the top of debian/rules put the following:
+2) At the top of debian/rules put the following::
- include /usr/share/octave/debian/defs.make
+ include /usr/share/octave/debian/defs.make
This defines the Makefile variables MDIR and OCTDIR containing the
installation paths for .m scripts and .oct loadable modules. Use these
variables to install files in the package.
- For instance, the following examples:
+ For instance, the following examples::
- ##########################################
- include /usr/share/octave/debian/defs.make
- all:
- @echo MDIR: $(MDIR)
- @echo OCTDIR: $(OCTDIR)
- ##########################################
+ ##########################################
+ include /usr/share/octave/debian/defs.make
+ all:
+ @echo MDIR: $(MDIR)
+ @echo OCTDIR: $(OCTDIR)
+ ##########################################
- would give something like:
+ would give something like::
- $ make
- MDIR: /usr/share/octave/site/m
- OCTDIR: /usr/lib/octave/site/oct/api-v13/i386-pc-linux-gnu
+ $ make
+ MDIR: /usr/share/octave/site/m
+ OCTDIR: /usr/lib/octave/site/oct/api-v13/i386-pc-linux-gnu
3) In the install rule of debian/rules, call 'octave-depends' (typically
near dh_shlibdeps). This is a debhelper-like program that calculates the
- right Octave dependency. If you have in debian/control:
+ right Octave dependency. If you have in debian/control::
Depends: ${octave:Depends}
- then octave-depends would give something like:
+ then octave-depends would give something like::
Depends: octave2.1 (>= 2.1.65)
@@ -239,12 +239,14 @@
in the behalf of the
Debian Octave Group <pkg-octave-devel@lists.alioth.debian.org>
-$Id$
+| $Id$
+| `(view source)`_
+| `(view history)`_
+.. _(view source): DOG-Guidelines.txt
+.. _(view history): http://svn.debian.org/wsvn/pkg-octave/trunk/www/DOG-Guidelines.txt?op=log&rev=0&sc=0&isdir=0
-Editor settings
----------------
-Local variables:
-mode: indented-text
-End:
+.. Local variables:
+.. mode: rst
+.. End: