summaryrefslogtreecommitdiffstats
path: root/docs/manual
Commit message (Collapse)AuthorAgeFilesLines
* docs/manual: document the waf-package infraYann E. MORIN2016-12-022-0/+69
| | | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Romain Naour <romain.naour@openwide.fr> Reviewed-by: Romain Naour <romain.naour@gmail.com> [Thomas: adjust to the changes in the infra, fix typos.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: fix FOO_PKGDIR name and definitionDanomi Manchego2016-12-021-2/+2
| | | | | | | | Change "foo" references to "libfoo" in section that defines variables explicitly stated to relate to a "libfoo" package. Signed-off-by: Danomi Manchego <danomimanchego123@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: fix typoLucile Quirion2016-11-292-4/+1
| | | | | | | 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 documentation about BR2_EXTERNAL_<name>_PATH variableJerry Evans2016-11-201-3/+3
| | | | | | | | | | | | | | The BR2_EXTERNAL documentation improperly tells to use the BR2_EXTERNAL_<name>_DIR variable to reference the location of the BR2_EXTERNAL directory. But in fact the variable is named BR2_EXTERNAL_<name>_PATH. In addition, some closing double quotes were missing. This commit fixes both of those issues. Signed-off-by: Jerry Evans <g4@novadsp.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: fix scanpypi path typosDanomi Manchego2016-10-191-3/+3
| | | | | | | Signed-off-by: Danomi Manchego <danomimanchego123@gmail.com> Reviewed-by: Yegor Yefremov <yegorslists@googlemail.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document both user-facing br2-external variablesYann E. MORIN2016-10-191-1/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | While BR2_EXTERNAL_<NAME>_PATH was already documented, it was not made obvious that it could be reused in post-biuld, post-image and in-fakeroot scripts. The BR2_EXTERNAL_<NAME>_DESC variable was not documented at all. Update the manual to fix this. Note: a2x chokes on this: .Note: Both +BR2_EXTERNAL_$(NAME)_PATH+ and +BR2_EXTERNAL_$(NAME)_DESC+ are available [...] and spits out a totally useless error message: a2x: ERROR: "xsltproc" --stringparam toc.section.depth 1 --stringparam callout.graphics 0 --stringparam navig.graphics 0 --stringparam admon.textlabel 1 --stringparam admon.graphic 0 --stringparam chunk.section.depth 0 --output "/home/ymorin/dev/buildroot/O/docs/manual/manual.html" "/etc/asciidoc/docbook-xsl/xhtml.xsl" "/home/ymorin/dev/buildroot/O/docs/manual/manual.xml" returned non-zero exit status 6 So, we had to resort to using different quoting styles for each variables. They are not semantically equivalent, but the rendering is the same with the default CSS (which we are using). That's gonna be good-enough for now... Reported-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Benoît Allard <benoit.allard@greenbone.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document the br2-external desc: fieldYann E. MORIN2016-10-161-74/+206
| | | | | | | | | | Docuement the new, optional desc: field for an external.desc file. That part of the manual was starting to be a bit of a mess, so reorganise it. Provide a complete br2-external tree example. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* core: allow a br2-external tree to override a defconfigYann E. MORIN2016-10-161-2/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Currently, it is not possible for a br2-external tree to override a defconfig bundled in Buildroot, nor is it possible to override one from a previous br2-external tree in the stack. However, it is interesting that a latter br2-external tree be able to override a defconfig: - the ones bundled in Buildroot are minimalist, and almost always build a toolchain, so a br2-external tree may want to provide a "better" defconfig (better, in the sense "suited for the project"); - similarly for a defconfig from a previous br2-external tree. But we can't do that, as the rules for the defconfigs are generated in the order the br2-external trees are specified, all after the bundled defconfigs. Those rule are patten-matching rules, which means that the first one to match is used, and the following ones are ignored. Add a new utility macro, 'reverse', inspired from GMSL, that does what it says: reverse a list of words. Use that macro to reverse the list of br2-external trees, so that the latters win over the formers, and even over bundled ones. 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> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Romain Naour <romain.naour@openwide.fr> Cc: Julien CORJON <corjon.j@ecagroup.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: document multi br2-externalYann E. MORIN2016-10-162-16/+42
| | | | | | | | | | 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> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Romain Naour <romain.naour@openwide.fr> Cc: Julien CORJON <corjon.j@ecagroup.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: add appendix to convert old br2-external treesYann E. MORIN2016-10-163-0/+42
| | | | | | | | | | | 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> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Romain Naour <romain.naour@openwide.fr> Cc: Julien CORJON <corjon.j@ecagroup.com> [Peter: slightly reword] Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: document the br2-external NAMEYann E. MORIN2016-10-166-83/+105
| | | | | | | | | | | | | | | | | | | | | | Update the manual with the new external.desc mandatory file. Take the opportunity to add a section listing all mandatory files, Config.in, external.mk and the new external.desc, instead of just hinting about them in the external package recipes section. Change the examples to use the NAME-suffixed variable instead of the raw BR2_EXTERNAL variable. Change all references to BR2_EXTERNAL elsewhere in the manual to now use the 'br2-external tree' terminology. 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> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Romain Naour <romain.naour@openwide.fr> Cc: Julien CORJON <corjon.j@ecagroup.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs: update URL to uClibc-ng homepageWaldemar Brodkorb2016-10-141-2/+2
| | | | | | | | | | It is not necessary to update all mentioning of uClibc, but at least we should point to the right homepage of the used project. Signed-off-by: Waldemar Brodkorb <wbx@openadk.org> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: no warranty on output of legal-infoYann E. MORIN2016-10-031-0/+10
| | | | | | | | | | | | Explicitly state that there is no warranty about the accuracy of the content of the output of 'make legal-info'. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Luca Ceresoli <luca@lucaceresoli.net> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Acked-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: update the linux tools sectionYann E. MORIN2016-09-221-23/+26
| | | | | | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Romain Naour <romain.naour@openwide.fr> [Thomas: - Adjust the Config.in example to show that we now need to "select BR2_PACKAGE_LINUX_TOOLS" - Adjust the .mk file example to use $(LINUX_DIR) instead of $(@D)] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: fix typoLuca Ceresoli2016-09-221-2/+2
| | | | | Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> 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: add new section about the DEVELOPERS file and get-developerThomas Petazzoni2016-09-213-2/+57
| | | | | | [Peter: tweak wording and add xref as suggested by Arnout] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: update contribute.txt to cover get-developersThomas Petazzoni2016-09-211-2/+10
| | | | | | | | | | | This commit updates the contribute.txt part of the manual to tell people to use get-developers to get the appropriate "git send-email" command when sending patches. [Peter: use --cc instead of --to as suggested by Yann/Arnout] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: get rid of the lists of packagesYann E. MORIN2016-09-193-67/+0
| | | | | | | | | | | | | | | | | | | | | | | | | We currently have four lists of packages in the manual: - the non-virtual target packages, - the virtual target packages, - the host packages, - the deprecated features. Those list take more than half of the manual. They do not serve much purpose except to show off. After the recent discussion on the list [0], remove them all. We can now get rid of our biggish and complex generating script (and its companion library kconfiglib). [0] http://lists.busybox.net/pipermail/buildroot/2016-September/171199.html Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Peter Korsgaard <peter@korsgaard.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: update pkg-kconfig doc about <pkg>_KCONFIG_DOTCONFIGThomas Petazzoni2016-09-171-0/+6
| | | | | | Content provided by Yann E. Morin. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Merge branch 'next'Peter Korsgaard2016-09-023-0/+15
|\ | | | | | | | | | | Quite some conflicts, so here goes .. Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
| * docs/manual: prepare-kconfig can be used as a dependency of documentsYann E. MORIN2016-08-271-0/+2
| | | | | | | | | | | | | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Romain Naour <romain.naour@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
| * doc/asciidoc: add possibility to define document dependenciesYann E. MORIN2016-08-271-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Currently, a document can not have dependencies, except for the purely internal ones (like checking asciidoc version, and presence of dblatex). For our own manual, this will come in handy when we introduce a generated kconfig snippet, so we can actually make the manual depend on that snippet being generated first. For external documents, it can be used to depend on host-packages if need be (e.g. a custom host packages that generates specific media files included in the manual). Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Romain Naour <romain.naour@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
| * core: introduce a generated kconfig snippetYann E. MORIN2016-08-271-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add the infrastructure for adding generated kconfig snippet in the menuconfig. For now, the kconfig snippet is generated empty, the recipe for filling it in will be introduced in sub-sequent patches. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Peter Korsgaard <jacmet@uclibc.org> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Cc: Samuel Martin <s.martin49@gmail.com> Reviewed-by: Romain Naour <romain.naour@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
| * docs/manual: Document the variable $(PKG)_DL_OPTSRomain Perier2016-08-231-0/+7
| | | | | | | | | | | | | | | | | | This adds a description of the optional variable $(PKG)_DL_OPTS. When it is set, this option passes additional options to the downloader. Signed-off-by: Romain Perier <romain.perier@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* | docs: libtool patches are not handled by legal-info infrastructure.Romain Naour2016-08-191-0/+5
| | | | | | | | | | | | | | | | | | | | Signed-off-by: Romain Naour <romain.naour@gmail.com> Cc: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Arnout Vandecappelle <arnout@mind.be> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> [Thomas: slightly reword with Yann's suggestion.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* | docs: update legal-notice.txtRomain Naour2016-08-191-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | Since 1273636fc686cd788b6de87be75dd0726cf8676c applied patches are also saved. Signed-off-by: Romain Naour <romain.naour@gmail.com> Cc: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Arnout Vandecappelle <arnout@mind.be> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* | manual: fix typoRodrigo Rebello2016-08-191-1/+1
| | | | | | | | | | Signed-off-by: Rodrigo Rebello <rprebello@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* | docs/manual: fix patch naming conventionGary Bisson2016-08-091-4/+4
|/ | | | | | | Otherwise conflicts with the naming convention from previous section. Signed-off-by: Gary Bisson <gary.bisson@boundarydevices.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: use TARGET_CONFIGURE_OPTS in generic-package tutorialSergio Prado2016-07-251-1/+1
| | | | | | | TARGET_CONFIGURE_OPTS is preferred over manually using CC and LD. Signed-off-by: Sergio Prado <sergio.prado@e-labworks.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* core/pkg-generic: allow packages to declare target-finalize hooksYann E. MORIN2016-07-051-0/+7
| | | | | | | | | | | | | | | | | Currently, packages using target finalize hooks must remember that they need to register their hook in TARGET_FINALIZE_HOOKS conditionally (otherwise their hook will be triggered even if the package is disabled). In order to avoid this potential mistake, this commit introduces a per-package target-finalize hook variable, in which packages can register their target-finalize hooks, with the guarantee that they will only be triggered if the package is enabled. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Reviewed-by: Romain Naour <romain.naour@gmail.com> [Thomas: rework commit log.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document BR2_ROOTFS_POST_FAKEROOT_SCRIPTYann E. MORIN2016-07-041-1/+32
| | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Peter Korsgaard <peter@korsgaard.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>
* docs/manual: document FOO_GIT_SUBMODULEYann E. MORIN2016-07-031-0/+6
| | | | | | | [Peter: fix typo as noticed by Samuel] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Peter Korsgaard <peter@korsgaard.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* makedevs: add capability supportPhilippe Reynes2016-06-301-0/+30
| | | | | | | | | | | | Add the support of capability to makedevs as extended attribute. Now, it's possible to add a line "|xattr <capability>" after a file description to also add a capability to this file. It's possible to add severals capabilities with severals lines. [Peter: extend doc, reword Config.in, extend error message, use HOST_MAKEDEVS_CFLAGS/LDFLAGS for all flags] Signed-off-by: Philippe Reynes <philippe.reynes@sagemcom.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual/known-issues: remove occurrences of eglibcThomas Petazzoni2016-06-281-6/+6
| | | | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: Romain Naour <romain.naour@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: don't mention eglibc, mention muslThomas Petazzoni2016-06-281-2/+2
| | | | | | | | | | | | Following the removal of eglibc, it no longer makes sense to talk about it in the Buildroot manual as one of the supported C libraries. However, it does make sense to indicate that we support musl. [Peter: remove extra 'the' 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>
* 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>
* scanpypi: new utilityDenis THULIN2016-06-111-0/+49
| | | | | | | | | | | | A utility for creating python package from the python package index. It fetches packages info from http://pypi.python.org and generates corresponding packages files. Signed-off-by: Denis THULIN <denis.thulin@openwide.fr> Tested-by: Carlos Santos <casantos@datacom.ind.br> Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com> [Thomas: minor tweaks.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* core/pkg-generic: add support for package-defined helpYann E. MORIN2016-06-071-0/+6
| | | | | | | | | | | | | | Add a package-variable to store the package-specific make rules. Although this variable would be seldom used, we still document it. However, we make sure the documentation explicitly states that this variable should not be used (if it needs to be, the submitter of a package will be told so during reviews). Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs: Fixed syntax error in makedev-syntax example.Alan Yaniger2016-05-231-1/+1
| | | | | | | | | In the makedev syntax documentation, one of the examples lacks the "mode" value. This patch fixes that example. Signed-off-by: Alan Yaniger <alan@tkos.co.il> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Revert "core: add the possibility to provide help for custom rules"Yann E. MORIN2016-04-171-14/+0
| | | | | | | | | | | | | | | | | | | This reverts commit 84c825f8e893bfb56847ab4a880c46066a41744f. Turns out that the custom help is not available when the $(O) directory has not been configure yet (i.e. when there is no .config already filled). Rather than trying to work around this limitation with dirty hacks, just revert this feature. After all, this will not prevent an external.mk from providing custom help anyway; it's just not gonna be advertised nor displayed with the main help. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Peter Korsgaard <peter@korsgaard.com> Cc: Jérôme Pouiller <jezz@sysmic.org> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* core: add the possibility to provide help for custom rulesYann E. MORIN2016-03-191-0/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When using a br2-external tree, it is possible (as stated in our manual) to implement whatever arbitrary extra make rules (such as flashing a board, or extracting the rootfs in an NFS export...). Some of those extra rules might be exposed to the user as new entry points that the user can call by itself. However, there is no way for the br2-external to advertise those new rules in the help text. We add the possibility to do so, by adding a new make rule, called help-custom, advertised in our own help info. It is up to the br2-external tree to provide whatever help text is deemed necessary. The format of the help is completely free-form. Note that we need to provide an empty, dummy help-custom rule, since it is always advertised (making it .PHONY does not work). Since this rule is empty, make gently reports that there is "Nothing to be done for `help-local'", which is pretty well fitting when help-local was not provided (either because there's no br2-external tree, or when the br2-external tree does not provide it. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Jérôme Pouiller <jezz@sysmic.org> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document format for specifying licensesRahul Bedarkar2016-03-061-1/+10
| | | | | | Signed-off-by: Rahul Bedarkar <rahul.bedarkar@imgtec.com> [Thomas: minor tweaks for clarity.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Merge branch 'next'Peter Korsgaard2016-03-021-0/+40
|\ | | | | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
| * docs/manual: add "python-package CFFI backend" sectionYegor Yefremov2016-02-231-0/+40
| | | | | | | | | | | | Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com> [Thomas: formatting/redaction tweaks.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* | docs/manual: add section about patch licensingLuca Ceresoli2016-03-012-3/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | Use the same text that is used in COPYING. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Cc: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Cc: Peter Korsgaard <peter@korsgaard.com> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Steve Calfee <stevecalfee@gmail.com> Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: slightly clarify patch licensingLuca Ceresoli2016-02-251-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Adding a patch is a modification to Buildroot. Thus this sentence might be interpreted as "Patches are released under the Buildroot license". Being a legal matter, the last thing we want is to be ambiguous. Reword the sentence to avoid any misunderstandings. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual/contribute.txt: add formatting patches sectionArnout Vandecappelle2016-02-241-0/+74
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Thomas P. has sent a few big feedback mails recently that explain how a patch should be formatted. Indeed, this was not explained much in the manual, so add a section that explains how patches should be formatted. This is based heavily on the feedback that Thomas P. gave. Also, specific examples for new packages and version bumps are added. This will allow us to refer to https://buildroot.org/manual.html#submitting-patches in the future instead of composing long mails. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Reviewed-by: Yegor Yefremov <yegorslists@googlemail.com> [Thomas: rewrap to our normal formatting practice.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* | docs/manual/contribute.txt: add section for preparing patch seriesArnout Vandecappelle2016-02-241-4/+7
| | | | | | | | | | | | | | | | | | | | | | In subsequent patches, we will add more explanation about how to prepare patches, so it will be worthwhile to have a separate section for the series preparation. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Reviewed-by: Yegor Yefremov <yegorslists@googlemail.com> [Thomas: rewrap to our normal formatting practice.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
OpenPOWER on IntegriCloud