86a415df8a
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 <thomas.de.schampheleire@gmail.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
122 lines
3.9 KiB
Plaintext
122 lines
3.9 KiB
Plaintext
// -*- mode:doc; -*-
|
|
// vim: set syntax=asciidoc:
|
|
|
|
= Getting involved
|
|
|
|
Like any open source project, Buildroot has different ways to share
|
|
information in its community and outside.
|
|
|
|
One piece of it is the document you are currently reading ;-).
|
|
|
|
Each of those ways may interest you if you are looking for some help,
|
|
want to understand Buildroot or contribute to the project.
|
|
|
|
== Mailing List
|
|
|
|
Buildroot has a mailing list
|
|
http://lists.busybox.net/pipermail/buildroot[] for discussion and
|
|
development.
|
|
|
|
[[mailing-list-subscribe]]
|
|
|
|
=== Subscribing to the mailing list
|
|
|
|
You can subscribe by visiting
|
|
http://lists.busybox.net/mailman/listinfo/buildroot[].
|
|
Only subscribers to the Buildroot mailing list are allowed to post to
|
|
this list.
|
|
|
|
The list is also available through _Gmane_ http://gmane.org[], at
|
|
+gmane.comp.lib.uclibc.buildroot+
|
|
http://dir.gmane.org/gmane.comp.lib.uclibc.buildroot[].
|
|
|
|
=== Searching the List Archives
|
|
|
|
Please search the mailing list archives before asking questions on the
|
|
mailing list, since there is a good chance someone else has asked the
|
|
same question before. Checking the archives is a great way to avoid
|
|
annoying everyone on the list with frequently asked questions...
|
|
|
|
== IRC
|
|
|
|
The Buildroot IRC is irc://freenode.net/#buildroot[].
|
|
The channel +#buildroot+ is hosted on Freenode
|
|
http://webchat.freenode.net[].
|
|
|
|
When asking for help on IRC, share relevant logs or pieces of code
|
|
using a code sharing website.
|
|
|
|
[[patchwork]]
|
|
== Patchwork
|
|
|
|
Patchwork is a web-based patch tracking system designed to facilitate
|
|
the contribution and management of contributions to an open-source
|
|
project. Patches that have been sent to a mailing list are \'caught' by
|
|
the system, and appear on a web page. Any comments posted that
|
|
reference the patch are appended to the patch page too. For more
|
|
information on Patchwork see
|
|
http://jk.ozlabs.org/projects/patchwork[].
|
|
|
|
Buildroot's Patchwork website is mainly for use by Buildroot's
|
|
maintainer to ensure patches aren't missed. The website however,
|
|
exposes patches and their corresponding review comments in a clean
|
|
and concise web interface.
|
|
|
|
The Buildroot patch management interface is available at
|
|
http://patchwork.buildroot.org[].
|
|
|
|
[[apply-patches-patchwork]]
|
|
=== Applying Patches from Patchwork
|
|
|
|
The main use of Buildroot's Patchwork website for a developer is for
|
|
pulling in patches into their local git repository for testing
|
|
purposes.
|
|
|
|
When browsing patches in the patchwork management interface, an +mbox+
|
|
link is provided at the top of the page. Copy this link address and
|
|
run the following commands:
|
|
|
|
---------------------
|
|
$ git checkout -b <test-branch-name>
|
|
$ wget -O - <mbox-url> | git am
|
|
---------------------
|
|
|
|
Another option for applying patches is to create a bundle. A bundle is
|
|
a set of patches that you can group together using the patchwork
|
|
interface. Once the bundle is created and the bundle is made public,
|
|
you can copy the +mbox+ link for the bundle and apply the bundle
|
|
using the above commands.
|
|
|
|
[[bugtracker]]
|
|
== Bugtracker
|
|
|
|
The Buildroot bugtracker is at https://bugs.busybox.net[].
|
|
|
|
To open a bug, see xref:reporting-bugs[].
|
|
|
|
== Buildroot wikipage
|
|
|
|
After the Buildroot developer day on February 3, 2012,
|
|
a page dedicated to Buildroot has been created on
|
|
http://elinux.org[elinux.org].
|
|
|
|
This page is reachable at http://elinux.org/Buildroot[].
|
|
|
|
Currently, this page is mainly used as a _todo-list_.
|
|
|
|
[[events]]
|
|
== Events
|
|
|
|
=== Buildroot Developer Days aside ELC-E 2012 (November 3-4, 2012 - Barcelona)
|
|
|
|
* Event page: http://elinux.org/Buildroot:DeveloperDaysELCE2012[]
|
|
|
|
=== Buildroot presentation at LSM 2012 (July 12-14, 2012 - Geneva)
|
|
|
|
* Announcement: http://lists.busybox.net/pipermail/buildroot/2012-May/053845.html[]
|
|
|
|
=== Buildroot Developer Days aside FOSDEM 2012 (February 3, 2012 - Brussels)
|
|
|
|
* Announcement & agenda thread: http://lists.busybox.net/pipermail/buildroot/2012-January/049340.html[]
|
|
* Report: http://lists.busybox.net/pipermail/buildroot/2012-February/050371.html[]
|