<feed xmlns='http://www.w3.org/2005/Atom'>
<title>buildroot/docs/manual/adding-packages.txt, branch 2016.02</title>
<subtitle>OpenPOWER buildroot sources</subtitle>
<id>https://git.raptorcs.com/git/buildroot/atom?h=2016.02</id>
<link rel='self' href='https://git.raptorcs.com/git/buildroot/atom?h=2016.02'/>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/'/>
<updated>2015-07-14T21:35:58+00:00</updated>
<entry>
<title>docs/manual: add documentation for linux-ext and linux-tools.</title>
<updated>2015-07-14T21:35:58+00:00</updated>
<author>
<name>Romain Naour</name>
<email>romain.naour@openwide.fr</email>
</author>
<published>2015-07-14T17:35:15+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=509a8368c332ce73af24544d970974deb1a13778'/>
<id>urn:sha1:509a8368c332ce73af24544d970974deb1a13778</id>
<content type='text'>
[Thomas: misc improvements.]

Signed-off-by: Romain Naour &lt;romain.naour@openwide.fr&gt;
Signed-off-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>docs/manual: add kernel-module</title>
<updated>2015-07-12T09:56:18+00:00</updated>
<author>
<name>Yann E. MORIN</name>
<email>yann.morin.1998@free.fr</email>
</author>
<published>2015-07-12T00:21:32+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=9e8857d05ae7ac8074e90ec690ed080601ca9ae5'/>
<id>urn:sha1:9e8857d05ae7ac8074e90ec690ed080601ca9ae5</id>
<content type='text'>
Signed-off-by: "Yann E. MORIN" &lt;yann.morin.1998@free.fr&gt;
Cc: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
Cc: Samuel Martin &lt;s.martin49@gmail.com&gt;
Cc: Arnout Vandecappelle &lt;arnout@mind.be&gt;
Cc: Jeremy Rosen &lt;jeremy.rosen@openwide.fr&gt;
Signed-off-by: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
</content>
</entry>
<entry>
<title>docs/manual: add documentation for the pkg-rebar infrastructure</title>
<updated>2015-02-03T09:23:03+00:00</updated>
<author>
<name>Yann E. MORIN</name>
<email>yann.morin.1998@free.fr</email>
</author>
<published>2015-01-12T09:32:07+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=0fe05ff3e16113f2c558ba1f8a7bc2836842a08e'/>
<id>urn:sha1:0fe05ff3e16113f2c558ba1f8a7bc2836842a08e</id>
<content type='text'>
Signed-off-by: Johan Oudinet &lt;johan.oudinet@gmail.com&gt;
[yann.morin.1998@free.fr: split the doc into its own patch]
Signed-off-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>docs/manual: document the asciidoc infra</title>
<updated>2014-10-12T05:46:28+00:00</updated>
<author>
<name>Yann E. MORIN</name>
<email>yann.morin.1998@free.fr</email>
</author>
<published>2014-10-03T17:01:59+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=25b1d130f4178820c222f9f176ef60a1591aad8a'/>
<id>urn:sha1:25b1d130f4178820c222f9f176ef60a1591aad8a</id>
<content type='text'>
[Peter: move periods outside paranthesis as suggested by Thomas De Schampheleire]
Signed-off-by: "Yann E. MORIN" &lt;yann.morin.1998@free.fr&gt;
Cc: Samuel Martin &lt;s.martin49@gmail.com&gt;
Cc: Thomas De Schampheleire &lt;patrickdepinguin@gmail.com&gt;
Reviewed-by: Samuel Martin &lt;s.martin49@gmail.com&gt;
Reviewed-by: Thomas De Schampheleire &lt;thomas.de.schampheleire@gmail.com&gt;
Signed-off-by: Peter Korsgaard &lt;peter@korsgaard.com&gt;
</content>
</entry>
<entry>
<title>manual: add documentation for kconfig-package</title>
<updated>2014-08-04T07:54:04+00:00</updated>
<author>
<name>Thomas De Schampheleire</name>
<email>patrickdepinguin@gmail.com</email>
</author>
<published>2014-08-03T15:32:41+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=e91cd2902d3e66ef9f94358e57c9a55ed1e7e202'/>
<id>urn:sha1:e91cd2902d3e66ef9f94358e57c9a55ed1e7e202</id>
<content type='text'>
This patch adds documentation for the new kconfig-package infrastructure to
the manual.

Note that due to the simplicity of the infrastructure, the documentation
is not split in a 'tutorial' and a 'reference', like for the other
infrastructures. Instead, the usage is described in one section.

Signed-off-by: Thomas De Schampheleire &lt;thomas.de.schampheleire@gmail.com&gt;
[me: slight grammar fix 'copy -back- the configuration +back+ to...']
Signed-off-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: 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>
<entry>
<title>manual: add virtual package tutorial</title>
<updated>2014-04-05T17:20:58+00:00</updated>
<author>
<name>eric.le.bihan.dev@free.fr</name>
<email>eric.le.bihan.dev@free.fr</email>
</author>
<published>2014-04-05T15:21:44+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=7862abad78934ed2a75cea6305163b4ae092b966'/>
<id>urn:sha1:7862abad78934ed2a75cea6305163b4ae092b966</id>
<content type='text'>
The manual now features a new section with instructions about how to add a
virtual package.

Signed-off-by: Eric Le Bihan &lt;eric.le.bihan.dev@free.fr&gt;
[yann.morin.1998@free.fr: move down statement about provider's .mk]
Signed-off-by: "Yann E. MORIN" &lt;yann.morin.1998@free.fr&gt;
Reviewed-by: Samuel Martin &lt;s.martin49@gmail.com&gt;
Acked-by: Arnout Vandecappelle (Essensium/Mind) &lt;arnout@mind.be&gt;
Signed-off-by: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
</content>
</entry>
<entry>
<title>manual: adding packages perl</title>
<updated>2014-02-23T21:38:02+00:00</updated>
<author>
<name>Francois Perrad</name>
<email>fperrad@gmail.com</email>
</author>
<published>2014-02-23T14:17:19+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=d8fab8c5ee7a1b3a1236754a4a59e0630c0cf592'/>
<id>urn:sha1:d8fab8c5ee7a1b3a1236754a4a59e0630c0cf592</id>
<content type='text'>
Signed-off-by: Francois Perrad &lt;francois.perrad@gadz.org&gt;
Signed-off-by: Peter Korsgaard &lt;peter@korsgaard.com&gt;
</content>
</entry>
<entry>
<title>manual: adding packages luarocks</title>
<updated>2014-01-13T22:18:48+00:00</updated>
<author>
<name>Francois Perrad</name>
<email>fperrad@gmail.com</email>
</author>
<published>2014-01-11T15:42:11+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=89d738dd5eb8e1fd545356031cf241673721752c'/>
<id>urn:sha1:89d738dd5eb8e1fd545356031cf241673721752c</id>
<content type='text'>
Signed-off-by: Francois Perrad &lt;francois.perrad@gadz.org&gt;
[yann.morin.1998@free.fr: some cleanups and rephrasing]
Signed-off-by: Yann E. MORIN &lt;yann.morin.1998@free.fr&gt;
Cc: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
Signed-off-by: Peter Korsgaard &lt;peter@korsgaard.com&gt;
</content>
</entry>
<entry>
<title>package: introduce Python package infrastructure</title>
<updated>2013-12-15T12:32:12+00:00</updated>
<author>
<name>Thomas Petazzoni</name>
<email>thomas.petazzoni@free-electrons.com</email>
</author>
<published>2013-12-11T20:26:36+00:00</published>
<link rel='alternate' type='text/html' href='https://git.raptorcs.com/git/buildroot/commit/?id=a6bba674a257f291c51a3859381f653e711bd354'/>
<id>urn:sha1:a6bba674a257f291c51a3859381f653e711bd354</id>
<content type='text'>
[Peter: fix s/BUILD_TYPE/SETUP_TYPE/ typo in manual as noted by Samuel]
Signed-off-by: Thomas Petazzoni &lt;thomas.petazzoni@free-electrons.com&gt;
Signed-off-by: Peter Korsgaard &lt;peter@korsgaard.com&gt;
</content>
</entry>
</feed>
