<feed xmlns='http://www.w3.org/2005/Atom'>
<title>buildroot/docs/manual/adding-packages-python.txt, branch 2016.05</title>
<subtitle>OpenPOWER buildroot sources</subtitle>
<id>https://git.raptorcs.com/git/buildroot/atom?h=2016.05</id>
<link rel='self' href='https://git.raptorcs.com/git/buildroot/atom?h=2016.05'/>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/'/>
<updated>2016-02-23T16:25:06+00:00</updated>
<entry>
<title>docs/manual: add "python-package CFFI backend" section</title>
<updated>2016-02-23T16:25:06+00:00</updated>
<author>
<name>Yegor Yefremov</name>
<email>yegorslists@googlemail.com</email>
</author>
<published>2016-02-22T09:20:59+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=0e5c9c2b35c71a3d3180c5829975dba5222b30c9'/>
<id>urn:sha1:0e5c9c2b35c71a3d3180c5829975dba5222b30c9</id>
<content type='text'>
Signed-off-by: Yegor Yefremov &lt;yegorslists@googlemail.com&gt;
[Thomas: formatting/redaction tweaks.]
Signed-off-by: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
</content>
</entry>
<entry>
<title>docs/manual: Fix trivial typo</title>
<updated>2015-07-14T21:56:58+00:00</updated>
<author>
<name>Jan Viktorin</name>
<email>viktorin@rehivetech.com</email>
</author>
<published>2015-07-14T15:17:20+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=c99a0deec78cc0e444332c341ba687b567abd79f'/>
<id>urn:sha1:c99a0deec78cc0e444332c341ba687b567abd79f</id>
<content type='text'>
Signed-off-by: Jan Viktorin &lt;viktorin@rehivetech.com&gt;
Signed-off-by: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
</content>
</entry>
<entry>
<title>manual: remove the extra whitespaces</title>
<updated>2014-12-20T14:55:54+00:00</updated>
<author>
<name>Jerzy Grzegorek</name>
<email>jerzy.grzegorek@trzebnica.net</email>
</author>
<published>2014-12-19T07:12:33+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=3b1df656097b497844b02fdc58711b1a6b35ca8c'/>
<id>urn:sha1:3b1df656097b497844b02fdc58711b1a6b35ca8c</id>
<content type='text'>
Signed-off-by: Jerzy Grzegorek &lt;jerzy.grzegorek@trzebnica.net&gt;
Signed-off-by: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
</content>
</entry>
<entry>
<title>packages: rename FOO_BUILD_OPT into FOO_BUILD_OPTS</title>
<updated>2014-10-04T16:54:30+00:00</updated>
<author>
<name>Thomas De Schampheleire</name>
<email>patrickdepinguin@gmail.com</email>
</author>
<published>2014-09-27T19:32:45+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=a603eb1c470eb0d265368d017640521c4a385e5e'/>
<id>urn:sha1:a603eb1c470eb0d265368d017640521c4a385e5e</id>
<content type='text'>
To be consistent with the recent change of FOO_MAKE_OPT into FOO_MAKE_OPTS,
make the same change for FOO_BUILD_OPT.

Sed command used:
   find * -type f | xargs sed -i 's#_BUILD_OPT\&gt;#&amp;S#g'

Signed-off-by: Thomas De Schampheleire &lt;thomas.de.schampheleire@gmail.com&gt;
Reviewed-by: "Yann E. MORIN" &lt;yann.morin.1998@free.fr&gt;
Signed-off-by: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
</content>
</entry>
<entry>
<title>packages: rename FOO_INSTALL_STAGING_OPT into FOO_INSTALL_STAGING_OPTS</title>
<updated>2014-10-04T16:49:36+00:00</updated>
<author>
<name>Thomas De Schampheleire</name>
<email>patrickdepinguin@gmail.com</email>
</author>
<published>2014-09-27T19:32:41+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=d6c32da8816fb7c520ccf6d5780eca96d0556183'/>
<id>urn:sha1:d6c32da8816fb7c520ccf6d5780eca96d0556183</id>
<content type='text'>
To be consistent with the recent change of FOO_MAKE_OPT into FOO_MAKE_OPTS,
make the same change for FOO_INSTALL_STAGING_OPT.

Sed command used:
   find * -type f | xargs sed -i 's#_INSTALL_STAGING_OPT\&gt;#&amp;S#g'

Signed-off-by: Thomas De Schampheleire &lt;thomas.de.schampheleire@gmail.com&gt;
Reviewed-by: "Yann E. MORIN" &lt;yann.morin.1998@free.fr&gt;
Signed-off-by: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
</content>
</entry>
<entry>
<title>packages: rename FOO_INSTALL_TARGET_OPT into FOO_INSTALL_TARGET_OPTS</title>
<updated>2014-10-04T16:48:33+00:00</updated>
<author>
<name>Thomas De Schampheleire</name>
<email>patrickdepinguin@gmail.com</email>
</author>
<published>2014-09-27T19:32:40+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=57f2b8d2558ca47ffad01f3eadd245dd893e8154'/>
<id>urn:sha1:57f2b8d2558ca47ffad01f3eadd245dd893e8154</id>
<content type='text'>
To be consistent with the recent change of FOO_MAKE_OPT into FOO_MAKE_OPTS,
make the same change for FOO_INSTALL_TARGET_OPT.

Sed command used:
   find * -type f | xargs sed -i 's#_INSTALL_TARGET_OPT\&gt;#&amp;S#g'

Signed-off-by: Thomas De Schampheleire &lt;thomas.de.schampheleire@gmail.com&gt;
Reviewed-by: "Yann E. MORIN" &lt;yann.morin.1998@free.fr&gt;
Signed-off-by: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
</content>
</entry>
<entry>
<title>packages: rename FOO_INSTALL_OPT into FOO_INSTALL_OPTS</title>
<updated>2014-10-04T16:47:37+00:00</updated>
<author>
<name>Thomas De Schampheleire</name>
<email>patrickdepinguin@gmail.com</email>
</author>
<published>2014-09-27T19:32:39+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=b1993430346a8fed4607cfb565104cc33b598ea1'/>
<id>urn:sha1:b1993430346a8fed4607cfb565104cc33b598ea1</id>
<content type='text'>
To be consistent with the recent change of FOO_MAKE_OPT into FOO_MAKE_OPTS,
make the same change for FOO_INSTALL_OPT.

Sed command used:
   find * -type f | xargs sed -i 's#_INSTALL_OPT\&gt;#&amp;S#g'

Signed-off-by: Thomas De Schampheleire &lt;thomas.de.schampheleire@gmail.com&gt;
Reviewed-by: "Yann E. MORIN" &lt;yann.morin.1998@free.fr&gt;
Signed-off-by: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
</content>
</entry>
<entry>
<title>manual: fix copy/paste error in python package example</title>
<updated>2014-08-06T17:51:27+00:00</updated>
<author>
<name>Danomi Manchego</name>
<email>danomimanchego123@gmail.com</email>
</author>
<published>2014-08-06T02:41:52+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=dffb833cbc3dc76d91f00d81d00b3e153fb8267b'/>
<id>urn:sha1:dffb833cbc3dc76d91f00d81d00b3e153fb8267b</id>
<content type='text'>
The SOURCE references "LIBFOO_VERSION", should be "PYTHON_FOO_VERSION".

Signed-off-by: Danomi Manchego &lt;danomimanchego123@gmail.com&gt;
Acked-by: Thomas De Schampheleire &lt; thomas.de.schampheleire@gmail.com&gt;
Signed-off-by: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
</content>
</entry>
<entry>
<title>pkg-python: add staging installation support</title>
<updated>2014-07-16T20:27:34+00:00</updated>
<author>
<name>Thomas Petazzoni</name>
<email>thomas.petazzoni@free-electrons.com</email>
</author>
<published>2014-07-16T20:23:59+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=643627fc43abf0f2dff248992219ad56e27a21c9'/>
<id>urn:sha1:643627fc43abf0f2dff248992219ad56e27a21c9</id>
<content type='text'>
python-numpy needs to be installed to the staging directory, since it
also installs some header files. Therefore, this commit extends the
Python package infrastructure to support staging installation.

Signed-off-by: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
</content>
</entry>
<entry>
<title>manual: use one-line titles instead of two-line titles (trivial)</title>
<updated>2014-05-02T08:27:59+00:00</updated>
<author>
<name>Thomas De Schampheleire</name>
<email>patrickdepinguin@gmail.com</email>
</author>
<published>2014-05-02T05:47:30+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=86a415df8a26c0a13af964097ea0a46060a33cb1'/>
<id>urn:sha1:86a415df8a26c0a13af964097ea0a46060a33cb1</id>
<content type='text'>
Asciidoc supports two syntaxes for section titles: two-line titles (title
plus underline consisting of a particular symbol), and one-line titles
(title prefixed with a specific number of = signs).

The two-line title underlines are:
Level 0 (top level):     ======================
Level 1:                 ----------------------
Level 2:                 ~~~~~~~~~~~~~~~~~~~~~~
Level 3:                 ^^^^^^^^^^^^^^^^^^^^^^
Level 4 (bottom level):  ++++++++++++++++++++++

and the one-line title prefixes:
= Document Title (level 0) =
== Section title (level 1) ==

=== Section title (level 2) ===
==== Section title (level 3) ====
===== Section title (level 4) =====

The buildroot manual is currenly using the two-line titles, but this has
multiple disadvantages:

- asciidoc also uses some of the underline symbols for other purposes (like
  preformatted code, example blocks, ...), which makes it difficult to do
  mass replacements, such as a planned follow-up patch that needs to move
  all sections one level down.

- it is difficult to remember which level a given underline symbol (=-~^+)
  corresponds to, while counting = signs is easy.

This patch changes all two-level titles to one-level titles in the manual.
The bulk of the change was done with the following Python script, except for
the level 1 titles (-----) as these underlines are also used for literal
code blocks.
This patch only changes the titles, no other changes. In
adding-packages-directory.txt, I did add missing newlines between some
titles and their content.

----------------------------------------------------------------------------
#!/usr/bin/env python

import sys
import mmap
import re

for input in sys.argv[1:]:

    f = open(input, 'r+')
    f.flush()
    s = mmap.mmap(f.fileno(), 0)

    # Level 0 (top level):     ======================   =
    # Level 1:                 ----------------------   ==
    # Level 2:                 ~~~~~~~~~~~~~~~~~~~~~~   ===
    # Level 3:                 ^^^^^^^^^^^^^^^^^^^^^^   ====
    # Level 4 (bottom level):  ++++++++++++++++++++++   =====

    def replace_title(s, symbol, replacement):
        pattern = re.compile(r'(.+\n)\%s{2,}\n' % symbol, re.MULTILINE)
        return pattern.sub(r'%s \1' % replacement, s)

    new = s
    new = replace_title(new, '=', '=')
    new = replace_title(new, '+', '=====')
    new = replace_title(new, '^', '====')
    new = replace_title(new, '~', '===')
    #new = replace_title(new, '-', '==')

    s.seek(0)
    s.write(new)
    s.resize(s.tell())
    s.close()
    f.close()

----------------------------------------------------------------------------

Signed-off-by: Thomas De Schampheleire &lt;thomas.de.schampheleire@gmail.com&gt;
Signed-off-by: Peter Korsgaard &lt;peter@korsgaard.com&gt;
</content>
</entry>
</feed>
