fix reST syntax.

CHANGES.txt

-Changes
-=======
+=========
+ Changes
+=========
 
 0.15 (2014-11-28)
 -----------------
@@ -21,8 +22,7 @@ Changes
 0.12 (2013-09-05)
 -----------------
 
- * gitclone: Do not upload to cache by default. 'use-cache' option replaces
-  'forbid-download-cache' and must be explicitely set in order to use cache.
+ * gitclone: Do not upload to cache by default. 'use-cache' option replaces 'forbid-download-cache' and must be explicitely set in order to use cache.
  * gitclone: Do not cache working copy, which just duplicate `.git` folder.
  * gitclone: do not force to use 'master' branch when not specified.
  * gitclone: add git 'ignore-ssl-certificate' option.

README.rst

-****************************
-slapos.recipe.build:gitclone
-****************************
+=====================
+ slapos.recipe.build
+=====================
+
+.. contents::
+
+Examples
+--------
+
+Recipe to build the software.
+
+Example buildout::
+
+  [buildout]
+  parts =
+    script
+
+  [script]
+  # default way with using script
+  recipe = slapos.recipe.build
+  url_0 = http://host/path/file.tar.gz
+  md5sum = 9631070eac74f92a812d4785a84d1b4e
+  script =
+    import os
+    os.chdir(%(work_directory)s)
+    unpack(%(url_0), strip_path=True)
+    execute('make')
+    execute('make install DEST=%(location)s')
+  slapos_promise =
+    directory:bin
+    dynlib:bin/file linked:libz.so.1,libc.so.6,libmagic.so.1 rpath:${zlib:location}/lib,!/lib
+    directory:include
+    file:include/magic.h
+    directory:lib
+    statlib:lib/libmagic.a
+    statlib:lib/libmagic.la
+    dynlib:lib/libmagic.so linked:libz.so.1,libc.so.6 rpath:${zlib:location}/lib
+    dynlib:lib/libmagic.so.1 linked:libz.so.1,libc.so.6 rpath:${zlib:location}/lib
+    dynlib:lib/libmagic.so.1.0.0 linked:libz.so.1,libc.so.6 rpath:${zlib:location}/lib
+    directory:share
+    directory:share/man
+    directory:share/man/man1
+    file:share/man/man1/file.1
+    directory:share/man/man3
+    file:share/man/man3/libmagic.3
+    directory:share/man/man4
+    file:share/man/man4/magic.4
+    directory:share/man/man5
+    directory:share/misc
+    file:share/misc/magic.mgc
+
+  [multiarchitecture]
+  recipe = slapos.recipe.build
+  slapos_promise =
+    ...
+  x86 = http://host/path/x86.zip [md5sum]
+  x86-64 =  http://host/path/x64.zip [md5sum]
+  script =
+    if not self.options.get('url'): self.options['url'], self.options['md5sum'] = self.options[guessPlatform()].split(' ')
+    extract_dir = self.extract(self.download(self.options['url'], self.options.get('md5sum')))
+    workdir = guessworkdir(extract_dir)
+    self.copyTree(workdir, "%(location)s")
+
+You can remove formatting by using option “format = no” (default is “yes”)
+
+For example::
+
+  [escaping]
+  recipe = slapos.recipe.build
+  example = foobar's one
+  script =
+    print '%%s' %% self.options['example']
+    # will print “foobar's one”
+
+  [no-escaping]
+  recipe = slapos.recipe.build
+  example = foobar's one
+  foo = bar
+  format = no
+  script =
+    print '%s' % self.options['example']
+    # will print “foobar's one”
+    print '%(foo)s'
+    # will print “%(foo)s”
+
+Pure download
+~~~~~~~~~~~~~
+
+Note: deprecated entry-point.
+
+::
+
+  [buildout]
+  parts =
+    download
+
+  [download]
+  recipe = slapos.recipe.build:download
+  url = https://some.url/file
+
+Such profile will download https://some.url/file and put it in
+buildout:parts-directory/download/download
+
+filename parameter can be used to change destination named filename.
+
+destination parameter allows to put explicit destination.
+
+md5sum parameter allows pass md5sum.
+
+mode (octal, so for rw-r--r-- use 0644) allows to set mode
+
+Exposes target attribute which is path to downloaded file.
+
+Notes
+-----
+
+This recipe suffers from buildout download utility issue, which will do not
+try to redownload resource with wrong md5sum.
+
+==============================
+ slapos.recipe.build:gitclone
+==============================
 
 Checkout a git repository.
 Supports slapos.libnetworkcache if present, and if boolean 'use-cache' option
 is true.
 
 Examples
-********
+--------
 
 Those examples use slapos.recipe.build repository as an example.
 
 Simple clone
-------------
+~~~~~~~~~~~~
 
 Only `repository` parameter is required. For each buildout run,
 the recipe will pick up the latest commit on the remote master branch::
@@ -49,7 +168,7 @@ When updating, it will do a "git fetch; git reset @{upstream}"::
   HEAD is now at ...
 
 Specific branch
----------------
+~~~~~~~~~~~~~~~
 
 You can specify a specific branch using `branch` option. For each
 run it will take the latest commit on this remote branch::
@@ -80,6 +199,7 @@ Let's take a look at the buildout parts directory now::
   d git-clone
 
 And let's see that current branch is "build"::
+
   >>> import subprocess
   >>> cd('parts', 'git-clone')
   >>> print subprocess.check_output(['git', 'branch'])
@@ -94,7 +214,7 @@ When updating, it will do a "git fetch; git reset build"::
   HEAD is now at ...
 
 Specific revision
------------------
+~~~~~~~~~~~~~~~~~
 
 You can specify a specific commit hash or tag using `revision` option.
 This option has priority over the "branch" option::
@@ -141,7 +261,7 @@ When updating, it will do a "git fetch; git reset revision"::
   HEAD is now at 2566127 ...
 
 Empty revision/branch
----------------------
+~~~~~~~~~~~~~~~~~~~~~
 
 Specifying an empty revision or an empty branch will make buildout
 ignore those values as if it was not present at all (allowing to easily
@@ -175,7 +295,7 @@ extend an existing section specifying a branch)::
   * master
 
 Revision/branch priority
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 If both revision and branch parameters are set, revision parameters is used
 and branch parameter is ignored::
@@ -206,7 +326,7 @@ and branch parameter is ignored::
   * master
 
 Setup a "develop" repository
-----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If you need to setup a repository that will be manually alterated over time for
 development purposes, you need to make sure buildout will NOT alter it and NOT
@@ -220,9 +340,8 @@ erase your local modifications by specifying the "develop" flag::
   repository = https://example.net/example.git/
   develop = true
 
-
 Specific git binary
--------------------
+~~~~~~~~~~~~~~~~~~~
 
 The default git command is `git`, if for a any reason you don't
 have git in your path, you can specify git binary path with `git-command`
@@ -285,7 +404,7 @@ In case of uninstall, buildout will keep the repository directory::
   destination directory already exists.
 
 Ignore SSL certificate
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~
 
 By default, when remote server use SSL protocol git checks if the SSL
 certificate of the remote server is valid before executing commands.
@@ -318,20 +437,17 @@ Full example
   git-command = ${git-binary:location}/bin/git
   revision = 0123456789abcdef
 
-
-************************
-slapos.recipe.build:cpan
-************************
+==========================
+ slapos.recipe.build:cpan
+==========================
 
 Downloads and installs perl modules using Comprehensive Perl Archive Network (cpan).
 
-
-
 Examples
-********
+--------
 
 Basic example
--------------
+~~~~~~~~~~~~~
 
 Here is example to install one or several modules::
 
@@ -349,13 +465,12 @@ Here is example to install one or several modules::
   perl = perl
 
 Specific version
-----------------
+~~~~~~~~~~~~~~~~
 
 Note that cpan won't allow you to specify version and will always take latest
 version available. To choose a specific version, you will need to specify
 the full path in cpan like in ::
 
-
   [buildout]
   parts = perl-modules
 
@@ -366,23 +481,22 @@ the full path in cpan like in ::
   perl = perl
 
 Notes
-=====
+-----
 
 Currently, the modules will be installed in site-perl directory. Location of this
 directory changes depending on the perl installation.
 
-
-***********************
-slapos.recipe.build:npm
-***********************
+=========================
+ slapos.recipe.build:npm
+=========================
 
 Downloads and installs node.js packages using Node Package Manager (NPM).
 
 Examples
-********
+--------
 
 Basic example
--------------
+~~~~~~~~~~~~~
 
 Here is example to install one or several modules::
 
@@ -401,7 +515,7 @@ Here is example to install one or several modules::
   node = node-0.6
 
 Specific version
-----------------
+~~~~~~~~~~~~~~~~
 ::
 
   [buildout]
@@ -412,124 +526,3 @@ Specific version
   modules =
     express@1.0.2
   node = node-0.6
-
-
-*******************
-slapos.recipe.build
-*******************
-
-.. contents::
-
-Examples
-********
-
-Recipe to build the software.
-
-Example buildout::
-
-  [buildout]
-  parts =
-    script
-
-  [script]
-  # default way with using script
-  recipe = slapos.recipe.build
-  url_0 = http://host/path/file.tar.gz
-  md5sum = 9631070eac74f92a812d4785a84d1b4e
-  script =
-    import os
-    os.chdir(%(work_directory)s)
-    unpack(%(url_0), strip_path=True)
-    execute('make')
-    execute('make install DEST=%(location)s')
-  slapos_promise =
-    directory:bin
-    dynlib:bin/file linked:libz.so.1,libc.so.6,libmagic.so.1 rpath:${zlib:location}/lib,!/lib
-    directory:include
-    file:include/magic.h
-    directory:lib
-    statlib:lib/libmagic.a
-    statlib:lib/libmagic.la
-    dynlib:lib/libmagic.so linked:libz.so.1,libc.so.6 rpath:${zlib:location}/lib
-    dynlib:lib/libmagic.so.1 linked:libz.so.1,libc.so.6 rpath:${zlib:location}/lib
-    dynlib:lib/libmagic.so.1.0.0 linked:libz.so.1,libc.so.6 rpath:${zlib:location}/lib
-    directory:share
-    directory:share/man
-    directory:share/man/man1
-    file:share/man/man1/file.1
-    directory:share/man/man3
-    file:share/man/man3/libmagic.3
-    directory:share/man/man4
-    file:share/man/man4/magic.4
-    directory:share/man/man5
-    directory:share/misc
-    file:share/misc/magic.mgc
-
-  [multiarchitecture]
-  recipe = slapos.recipe.build
-  slapos_promise =
-    ...
-  x86 = http://host/path/x86.zip [md5sum]
-  x86-64 =  http://host/path/x64.zip [md5sum]
-  script =
-    if not self.options.get('url'): self.options['url'], self.options['md5sum'] = self.options[guessPlatform()].split(' ')
-    extract_dir = self.extract(self.download(self.options['url'], self.options.get('md5sum')))
-    workdir = guessworkdir(extract_dir)
-    self.copyTree(workdir, "%(location)s")
-
-You can remove formatting by using option “format = no” (default is “yes”)
-
-For example::
-
-  [escaping]
-  recipe = slapos.recipe.build
-  example = foobar's one
-  script =
-    print '%%s' %% self.options['example']
-    # will print “foobar's one”
-
-  [no-escaping]
-  recipe = slapos.recipe.build
-  example = foobar's one
-  foo = bar
-  format = no
-  script =
-    print '%s' % self.options['example']
-    # will print “foobar's one”
-    print '%(foo)s'
-    # will print “%(foo)s”
-
-
-Pure download
-*************
-
-Note: deprecated entry-point.
-
-::
-
-  [buildout]
-  parts =
-    download
-
-  [download]
-  recipe = slapos.recipe.build:download
-  url = https://some.url/file
-
-Such profile will download https://some.url/file and put it in
-buildout:parts-directory/download/download
-
-filename parameter can be used to change destination named filename.
-
-destination parameter allows to put explicit destination.
-
-md5sum parameter allows pass md5sum.
-
-mode (octal, so for rw-r--r-- use 0644) allows to set mode
-
-Exposes target attribute which is path to downloaded file.
-
-Notes
------
-
-This recipe suffers from buildout download utility issue, which will do not
-try to redownload resource with wrong md5sum.

setup.py

@@ -18,6 +18,7 @@ setup(name=name,
         ],
       keywords='slapos recipe',
       license='GPLv3',
+      url='http://git.erp5.org/gitweb/slapos.recipe.build.git',
       namespace_packages=['slapos', 'slapos.recipe'],
       packages=find_packages(),
       include_package_data=True,