summaryrefslogtreecommitdiffstats
path: root/docs/manual/adding-packages-directory.txt
Commit message (Collapse)AuthorAgeFilesLines
* docs/manual: document location of hash files for multi-versions packagesYann E. MORIN2018-10-201-0/+7
| | | | | | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com> Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Luca Ceresoli <luca@lucaceresoli.net> Cc: Baruch Siach <baruch@tkos.co.il> Reviewed-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* manual: add expected order of 'depends on'Arnout Vandecappelle (Essensium/Mind)2018-10-081-3/+5
| | | | | | | | | | As discussed in [1], our guideline for the ordering of 'depends on' lines is not written down. Fix that. [1] http://lists.busybox.net/pipermail/buildroot/2018-October/232413.html Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* toolchain: merge toolchain-common.in to Config.inRicardo Martincoski2018-04-011-2/+2
| | | | | | | | | | | | | | | | | | toolchain-common.in is a Config.in file with an uncommon name. It is just included by toolchain/Config.in, and toolchain/Config.in is not that long, so instead of renaming the file, merge it to toolchain/Config.in. Move the raw contents from the file to the exact location it is currently included in order to not change the order in the menu. Update the references in the manual as well. Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* manual: clarify license file hash check during legal-info targetPeter Seiderer2017-10-171-1/+2
| | | | | | Signed-off-by: Peter Seiderer <ps.report@gmx.net> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* core/legal-info: use hash file from version sub-dirYann E. MORIN2017-07-291-1/+3
| | | | | | | | | | | | | | | | | | | | | | When we have multiple versions for a package, and the licensing terms depend on the version actually selected (e.g. like Qt5), storing the hashes for those license files in the .hash file is broken: the infra will ensure that all hashes for a file do match, which would not be the case here. We fix that by first looking for a hash file in the version sub-dir first, and if that does not exist, then we use the main hash file. Drop the useless intermediate variable 'ret'. Update the documentation accordingly. Reported-by: Joshua Henderson <joshua.henderson@microchip.com> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Joshua Henderson <joshua.henderson@microchip.com> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document hashes for license filesYann E. MORIN2017-07-031-2/+13
| | | | | | | | | | [Peter: use sha256 in example] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Luca Ceresoli <luca@lucaceresoli.net> Cc: Peter Korsgaard <peter@korsgaard.com> Cc: Rahul Bedarkar <rahulbedarkar89@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: update details about hashesThomas Petazzoni2017-07-031-7/+16
| | | | | | | | | | | | | | | | | | | | | This commit updates the manual about hashes, fixing a number of issues: - Adding the .hash file should no longer be optional: it *must* be added. Therefore the wording "You can add ..." is changed to "When possible, you must add ...". - We are now checking hashes for Git downloaded packages, so fix this as well, and indicate more clearly which download methods have hash checking. - We no longer want to have auto-generated patches be downloaded through <pkg>_PATCH because such patches are not stable over time, and their hash can change. For example, downloading patches from github.com should no longer be done. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: size of tab in package descriptionRicardo Martincoski2017-04-081-3/+5
| | | | | | | | | | | | | | | | | | | | | | Explicitly state that one tab counts for 8 columns in package description, leaving 62 characters to the text itself. Update the text and the example in the two places where the Config.in format is described. Also mention a newline is expected between the help text itself and the upstream URL. This blob can help developers to understand the expected formatting. Also, it can be referenced by reviewers. http://patchwork.ozlabs.org/patch/611289/ http://patchwork.ozlabs.org/patch/606866/ http://patchwork.ozlabs.org/patch/459960/ Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Romain Naour <romain.naour@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: fix typoLucile Quirion2016-11-291-3/+0
| | | | | | | Also remove dangling reference to virtual package lists. Signed-off-by: Lucile Quirion <lucile.quirion@savoirfairelinux.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: fix packages having a subdirectoryThomas Petazzoni2016-09-211-1/+1
| | | | | | | | | efl and matchbox no longer have a subdirectory containing multiple packages, so they are no longer good examples of that. Mention qt5 and gstreamer instead. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: document dependency on fortranSamuel Martin2016-07-031-0/+4
| | | | | | Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Replace (e)glibc by glibcThomas Petazzoni2016-06-281-1/+1
| | | | | | | | | | | | | | | | Following the removal of eglibc support, this commit replaces all occurences of "(e)glibc" by just "glibc". Most of the occurences are in package Config.in comments. In addition, when the form "an (e)glibc ..." was used, it is replaced by "a glibc ...". [Peter: add new efi* packages, s/uclibc/uClibc as suggested by Romain, systemd / liquid-dsp tweaks as suggested by Yann] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: Romain Naour <romain.naour@gmail.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* arch: remove BR2_ARCH_HAS_ATOMICS optionThomas Petazzoni2016-02-061-5/+0
| | | | | | | | Now that BR2_ARCH_HAS_ATOMICS is no longer used anywhere, we can remove it from arch/Config.in*, as well as from the documentation. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
* docs/manual: document usage of BR2_TOOLCHAIN_HAS_SYNC_xThomas Petazzoni2016-02-061-0/+14
| | | | | | | | | | This commit updates the documentation to detail when and how to use the BR2_TOOLCHAIN_HAS_SYNC_x dependency. Note that we chose to not add a comment about this dependency, because it is mainly tied to architecture capabilities (except in very specific cases, which would be way too complicated to explain in a Config.in comment). Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add ordering of kconfig options' attributesYann E. MORIN2016-01-191-0/+9
| | | | | | | | | | | | | | | We want to ensure all packages follow the same coding style, so we add a blurb about the order of kconfig options' attributes: - first, the type and the prompt - the default value if needed - then dependencies of the 'depends on' category - followed by dependencies of the 'select' form - with eventually the help text Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: slightly compactify a paragraphYann E. MORIN2016-01-191-6/+5
| | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Config.in: add symbols for BR2_HOST_GCC_AT_LEAST_X_YArnout Vandecappelle2015-12-311-0/+7
| | | | | | | | | | | | | | Some host packages need a recent gcc version. Add symbols to Config.in to specify the HOSTCC version. The values are passed through the environment, and this environment is generated in a new support script. Also update the documentation to mention the new symbols. [Thomas: simplify by using only make logic instead of an external shell script.] Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Revert "manual: Add notes about GitHub and hashes"Samuel Martin2015-10-181-10/+2
| | | | | | | | | | | | | | | | This note is no longer needed, so remove it. Tarballs generated by GitHub are always the same, so hashes can be checked. This reverts commit 9474cc2594c8643301164500ce6eb62546da2b8f. [Thomas: fix other remaining references to not using hashes for github, as noticed by Maxime Hadjinlian.] Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document gcc version dependenciesThomas Petazzoni2015-08-051-0/+6
| | | | | | | | | This commit updates the Buildroot manual to document how to detail the gcc version dependencies in Config.in comments of packages, like we do for kernel headers version. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
* Document the 72 char limit on package description.Julien Viard de Galbert2015-07-131-2/+3
| | | | | | | | | | | | | While describing a package I though that the tab and 2 spaces was already doing the margin for wrapping the help test (ie 70 char when wrapping to 80) but apparently the full text need to fit 72 columns. So this patch propose to document that fact in the two places where the Config.in format is described. Signed-off-by: Julien Viard de Galbert <julien@vdg.name> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: Add notes about GitHub and hashesMaxime Hadjinlian2015-05-041-0/+7
| | | | | | | | | | | | | | We can't take hashes from GitHub, unless the tarball has been uploaded by the maintainer, otherwise it is generated and may change over time, which renders hash files useless. [Peter: slightly reword] Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: also document md5 hashYann E. MORIN2015-05-041-11/+18
| | | | | | | | | | | We accept an md5 hash, but only if coming from upstream, and if also accompanied with a stronger hash. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: remove references to IPv6Gustavo Zacarias2015-04-221-8/+3
| | | | | | | | It's no longer an option so remove all references to it. Signed-off-by: Gustavo Zacarias <gustavo@zacarias.com.ar> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* support/download: always fail when there's no hashYann E. MORIN2015-04-031-4/+4
| | | | | | | | | | | | | | | | | | At the time we introduced hashes, we did not want to be too harsh in the beginning, and give people some time to adapt and accept the hashes. So we so far only whined^Wwarned about a missing hash (when the .hash file exists). Some time has passed now, and people are still missing updating hashes when bumping packages. Let's make that warning a little bit more annoying... Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Arnout Vandecappelle <arnout@mind.be> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* support/download: add explicit no-hash supportYann E. MORIN2015-04-031-2/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | Add support to explicitly state that an archive has no hash. This can be used for archives downloaded from a repository, like a git-clone or a subversion checkout, or using the github helper. This will come in handy when we'll eventually make hashes mandatory as soon as a .hash file exists: for some packages, like gcc, some versions are downloaded as archives from upstream, while other versions may come from a GitHub repository (via the github herlper). In this case, a .hash file would exist, that contains hashes for the downloaded tarballs, but archives downloaded from the repository would not have a hash (since it is currently not possible to have reproducible such archives). So, we'd need a way to explicitly state there is no hash, on purpose, for those archives. So, add 'none' as a new type of hash. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Arnout Vandecappelle <arnout@mind.be> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* package infra: do not check hashes when downloading from a repositoryYann E. MORIN2015-04-031-0/+6
| | | | | | | | | | | | | When downloading from a repository, we have no way to ensure the reproducibility of the generated archives, so we can't check the hashes. Do not specifiy a hash file in those cases. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: remove references to largefileGustavo Zacarias2015-04-011-20/+17
| | | | | | | | | | Switch from the ACL package example to RRDTOOL since ACL has no dual (depends + select) dependencies any more and doesn't fit the example scenario. Signed-off-by: Gustavo Zacarias <gustavo@zacarias.com.ar> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add documentation on Config.in.hostJan Heylen2015-03-161-4/+46
| | | | | | | | | | | | + rearrange the structure a bit by adding a new paragraph for the Config files Signed-off-by: Jan Heylen <heyleke@gmail.com> [ThomasDS: - clarify commit title - add list continuations to fix indentation of Config.in.host details] Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: remove the extra whitespacesJerzy Grzegorek2014-12-201-2/+2
| | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Rename BR2_PREFER_STATIC_LIB to BR2_STATIC_LIBSThomas Petazzoni2014-12-111-1/+1
| | | | | | | | | | | | | | | | | | | | | | | Since a while, the semantic of BR2_PREFER_STATIC_LIB has been changed from "prefer static libraries when possible" to "use only static libraries". The former semantic didn't make much sense, since the user had absolutely no control/idea of which package would use static libraries, and which packages would not. Therefore, for quite some time, we have been starting to enforce that BR2_PREFER_STATIC_LIB should really build everything with static libraries. As a consequence, this patch renames BR2_PREFER_STATIC_LIB to BR2_STATIC_LIBS, and adjust the Config.in option accordingly. This also helps preparing the addition of other options to select shared, shared+static or just static. Note that we have verified that this commit can be reproduced by simply doing a global rename of BR2_PREFER_STATIC_LIB to BR2_STATIC_LIBS plus adding BR2_PREFER_STATIC_LIB to Config.in.legacy. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
* manual: Add newline before block codeMaxime Hadjinlian2014-11-221-0/+5
| | | | | | | | This won't change the output, it's only a style issue. Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add musl to toolchain dependency optionsYann E. MORIN2014-09-281-1/+1
| | | | | | | | | | | | | Currently, we only document (e)glibc and uClibc as C libraries on which we can depend. However, we've supported musl for quite some time now. So, also refference it in the manual, when dealing with toolchain options a package may have to depend on. [Peter: order musl before uClibc] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: document dependencies on atomic operationsAnton Kolesov2014-08-181-0/+5
| | | | | | | | | | | | Add atomic operations to the list of generic dependencies. Since this is an architecture option, there is no comment string to be added. Signed-off-by: Anton Kolesov <Anton.Kolesov@synopsys.com> [yann.morin.1998@free.fr: use the new arch-option; remove comment string] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: enhance doc for BR2_TOOLCHAIN_HEADERS_AT_LEAST_X_YYann E. MORIN2014-07-271-2/+2
| | | | | | | | | | | | | | The BR2_TOOLCHAIN_HEADERS_AT_LEAST_X_Y symbols can be used to denote the lowest required kernel headers version, but also the highest supported version. Document that. Use the `...` construct instead of +...+ used eveywhere else, otherwise asciidoc would render +<=+ to the ⇐ arrow, while `...` does no rendering at all. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: add documentation about packages' hashesYann E. MORIN2014-07-041-0/+66
| | | | | | | | | | | | | | Although md5 is, for legacy reasons, a supported hash type, it is not documented on purpose, since it is now known to be weak. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Baruch Siach <baruch@tkos.co.il> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: add the virtual packages listYann E. MORIN2014-06-081-0/+10
| | | | | | | | | | | | | | | | | | | | Add the list of virtual packages as an appendix to the manual. Also reference this list from appropriate locations elsewhere in the manual: - in section 7.2.2. "Config.in file", after the existing explanations on dependencies on target and toolchain options, on a linux kernel, and on udev /dev management, - in section 7.2.10. "Infrastructure for virtual packages", in the provider Config.in and .mk explanations, to have the list of existing symbols to select (in Config.in) and packages to provide (in .mk). Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: make consistent references to package metadata informationSimon Dawson2014-06-041-1/+1
| | | | | | | | | The de facto standard terminology in the manual appears to be "package metadata information"; fix a couple of inconsistent references to package "meta-information" and "meta information". Signed-off-by: Simon Dawson <spdawson@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: fix spelling mistakesSimon Dawson2014-06-011-1/+1
| | | | | Signed-off-by: Simon Dawson <spdawson@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: fix C++ support in libc case, fix indentationYann E. MORIN2014-05-021-2/+2
| | | | | | | | | | | | | | | | | | | The manual has this sentence for the dependency on a C library *and* a toolchain feature: foo needs an (e)glibc toolchain, or foo needs an (e)glibc toolchain w/ C++ support And then, just below, the comment text for C++ is just 'C++', not 'C++ support'. Fix that, and add a bit of indentation too. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: use one-line titles instead of two-line titles (trivial)Thomas De Schampheleire2014-05-021-14/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* manual: Add singular example for dependency commentMaxime Hadjinlian2014-03-291-0/+4
| | | | | | | | | | The manual always uses the format with multiple dependencies. This only add an example where is a single dependency to show that this format is applicable regardless of the number of dependencies. Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: document minimal kernel headers dependencyYann E. MORIN2014-03-011-0/+6
| | | | | | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Merge branch 'next'Peter Korsgaard2014-02-281-3/+7
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: Makefile package/dmraid/Config.in package/gdb/Config.in.host package/linux-headers/linux-headers.mk package/python/python.mk package/python3/python3.mk package/rt-tests/Config.in package/sdl/sdl.mk package/systemd/systemd-01-fix-getty-unit.patch package/systemd/systemd-02-fix-page-size.patch package/systemd/systemd-03-uclibc-fix.patch package/udev/Config.in package/udisks/Config.in package/vlc/vlc.mk system/Config.in Quite some merge conflicts, hopefully I didn't screw up anything. Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
| * docs/manual: indicate how to handle BR2_TOOLCHAIN_HAS_THREADS_NPTLThomas Petazzoni2014-02-221-1/+6
| | | | | | | | | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
| * udev: convert to virtual packageeric.le.bihan.dev@free.fr2014-02-121-2/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch converts udev to a virtual package. For the moment, there is only one provider for the udev features: eudev. Packages meant to provide udev-like features must select the symbol BR2_PACKAGE_HAS_UDEV. Packages depending on BR2_ROOTFS_DEVICE_CREATION_DYNAMIC_UDEV or BR2_PACKAGE_UDEV have been converted to use the new symbol. [Peter: move legacy symbols under 2014.05] Signed-off-by: Eric Le Bihan <eric.le.bihan.dev@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: reference Python and Lua infras from the list of package ↵Thomas Petazzoni2014-02-231-0/+11
|/ | | | | | | | infrastructures [Peter: adjust wording as suggested by Yann] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: explain format of comment about udev /dev management dependencyThomas De Schampheleire2013-12-191-0/+17
| | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: clarify format of comments about dependency on Linux kernelThomas De Schampheleire2013-12-151-0/+16
| | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: remove package clean commandsThomas De Schampheleire2013-12-081-1/+1
| | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: clarify that Config.in comments should have correct dependenciesThomas De Schampheleire2013-11-101-2/+15
| | | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: "Samuel Martin" <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
OpenPOWER on IntegriCloud