Commit 734f9532 authored by Jérome Perrin's avatar Jérome Perrin

README: fix rst syntax

parent 249e1c45
...@@ -229,13 +229,13 @@ platform.machine(). ...@@ -229,13 +229,13 @@ platform.machine().
platform could be 'linux', 'cygwin', 'macos', 'sunos', 'freebsd', platform could be 'linux', 'cygwin', 'macos', 'sunos', 'freebsd',
'netbsd', 'unixware' ... which equals a formatted sys.platform. 'netbsd', 'unixware' ... which equals a formatted sys.platform.
For example, For example::
[bzip2] [bzip2]
recipe = slapos.recipe.cmmi recipe = slapos.recipe.cmmi
[bzip2:cygwin] [bzip2:cygwin]
patches = cygwin-bzip2-1.0.6.src.patch patches = cygwin-bzip2-1.0.6.src.patch
All the options in the [part:platform] have high priority level. All the options in the [part:platform] have high priority level.
...@@ -261,7 +261,7 @@ effects, recipe will return all the installed files in the prefix ...@@ -261,7 +261,7 @@ effects, recipe will return all the installed files in the prefix
directory. The own ``prefix`` of part will disable this behaviour. directory. The own ``prefix`` of part will disable this behaviour.
If the ``buildout`` section has a valid ``prefix`` option, the recipe If the ``buildout`` section has a valid ``prefix`` option, the recipe
will add it to environmet variables as the following: will add it to environmet variables as the following::
PATH=${buildout:prefix}/bin:$PATH PATH=${buildout:prefix}/bin:$PATH
CPPFLAGS=-I${buildout:prefix} $CPPFLAGS CPPFLAGS=-I${buildout:prefix} $CPPFLAGS
...@@ -780,7 +780,7 @@ prefix: ...@@ -780,7 +780,7 @@ prefix:
<BLANKLINE> <BLANKLINE>
installing package installing package
<BLANKLINE> <BLANKLINE>
>>> ls('mylocal') >>> ls('mylocal')
- a.txt - a.txt
- b.txt - b.txt
...@@ -818,11 +818,11 @@ make-targets aren't set, if so, string "prefix=xxx" will be appended ...@@ -818,11 +818,11 @@ make-targets aren't set, if so, string "prefix=xxx" will be appended
in the make-targets. xxx is the final prefix of this recipe. We call in the make-targets. xxx is the final prefix of this recipe. We call
it Magic Prefix. it Magic Prefix.
In these options magic prefix can be represented by %(prefix)s: In these options magic prefix can be represented by ``%(prefix)s``:
``onfigure-command`` ``configure-options`` ``configure-command``, ``configure-options``,
``make-binary`` ``make-options`` ``make-targets`` ``make-binary``, ``make-options``, ``make-targets``,
``pre-configure`` ``pre-build`` ``pre-install`` ``post-install`` ``pre-configure``, ``pre-build``, ``pre-install``, ``post-install``
For example:: For example::
...@@ -831,7 +831,7 @@ For example:: ...@@ -831,7 +831,7 @@ For example::
The other part can refer to magic prefix of this part by The other part can refer to magic prefix of this part by
${part:prefix}, it will return the magic prefix, other than literal ${part:prefix}, it will return the magic prefix, other than literal
value in the part section. For example, value in the part section. For example::
>>> write('buildout.cfg', >>> write('buildout.cfg',
... """ ... """
...@@ -861,7 +861,7 @@ value in the part section. For example, ...@@ -861,7 +861,7 @@ value in the part section. For example,
package-2: Executing post-install package-2: Executing post-install
package magic prefix is /mytemp package magic prefix is /mytemp
<BLANKLINE> <BLANKLINE>
Here it's another sample, we change Makefile before installing so it Here it's another sample, we change Makefile before installing so it
can display "prefix" value in the stdout. can display "prefix" value in the stdout.
...@@ -983,7 +983,7 @@ Look, "package" is reinstalled either: ...@@ -983,7 +983,7 @@ Look, "package" is reinstalled either:
installing package installing package
Install shared package Install shared package
===================== ======================
Use option ``shared`` to install a shared pacakge. Use option ``shared`` to install a shared pacakge.
>>> import os >>> import os
...@@ -1004,7 +1004,7 @@ If no shared-parts is set, and shared is True, shared feature is not used: ...@@ -1004,7 +1004,7 @@ If no shared-parts is set, and shared is True, shared feature is not used:
... url = file://%s/package-0.0.0.tar.gz ... url = file://%s/package-0.0.0.tar.gz
... shared = True ... shared = True
... """% src) ... """% src)
>>> print(system(buildout)) #doctest:+ELLIPSIS >>> print(system(buildout)) #doctest:+ELLIPSIS
Uninstalling package. Uninstalling package.
Uninstalling package-2. Uninstalling package-2.
...@@ -1017,6 +1017,7 @@ If shared-parts is set and shared is True, build package failed, the build direc ...@@ -1017,6 +1017,7 @@ If shared-parts is set and shared is True, build package failed, the build direc
a build directory__compile__ is left for debugging. a build directory__compile__ is left for debugging.
Also a shell script with the environment variable is created, so that developer can try same build Also a shell script with the environment variable is created, so that developer can try same build
process as the recipe tried. process as the recipe tried.
>>> _ = system('mv %s/package-0.0.0.tar.gz %s/package-0.0.0.tar.gz.bak' % (src, src)) >>> _ = system('mv %s/package-0.0.0.tar.gz %s/package-0.0.0.tar.gz.bak' % (src, src))
>>> import tarfile >>> import tarfile
>>> from io import BytesIO >>> from io import BytesIO
...@@ -1072,6 +1073,7 @@ If shared-parts is set and shared is True, package will be installed in shared_p ...@@ -1072,6 +1073,7 @@ If shared-parts is set and shared is True, package will be installed in shared_p
installing package installing package
Do nothing if one package has been installed. Do nothing if one package has been installed.
>>> remove('.installed.cfg') >>> remove('.installed.cfg')
>>> write('buildout.cfg', >>> write('buildout.cfg',
... """ ... """
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment