summaryrefslogtreecommitdiffstats
path: root/docs/manual
Commit message (Collapse)AuthorAgeFilesLines
* tools: rename to 'utils'Thomas Petazzoni2017-07-013-6/+6
| | | | | | | | | | | After some discussion, we found out that "tools" has the four first letters identical to the "toolchain" subfolder, which makes it a bit unpractical with tab-completion. So, this commit renames "tools" to "utils", which is more tab-completion-friendly. This has been discussed with Arnout and Yann. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* tools: new tool to filter the output of makeYann E. MORIN2017-07-011-2/+3
| | | | | | | | | | | | | | | | | Add brmake, a small script that redirects the build output log to a file, keeping just Buildroot's own messages, with the date+time added at the start of the line. We need to unbuffer the output of make so that, when the script is interrupted (SIGINT, ^C), there is no lingering output not yet digested by the logger loop. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Ricardo Martincoski <ricardo.martincoski@gmail.com> Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* tools: move get-developers out of support/scripts/Yann E. MORIN2017-07-011-1/+1
| | | | | | | | | | Move it to the top-level tools/ directory, so that it is easier to find for users. 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> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* tools: move test-pkg out of support/scriptsYann E. MORIN2017-07-011-6/+6
| | | | | | | | | | Move it to the top-level tools/ directory, so that it is easier to find for users. 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> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs: known issues no longer validWaldemar Brodkorb2017-07-011-20/+0
| | | | | Signed-off-by: Waldemar Brodkorb <wbx@openadk.org> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: drop mention of removed external toolchainsBaruch Siach2017-06-201-8/+6
| | | | | | | | | The CodeSourcery x86 and sh, the ADI Blackfin, and the Xilinx Mircoblaze external toolchain profiles have all been removed. Update the manual. Signed-off-by: Baruch Siach <baruch@tkos.co.il> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: update external toolchain advantages listBaruch Siach2017-06-201-2/+0
| | | | | | | | | Buildroot can build non-uClibc toolchains internally for quite some time now. Update the manual text. Signed-off-by: Baruch Siach <baruch@tkos.co.il> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: PEP8 coding style for Python scriptsRicardo Martincoski2017-04-271-0/+5
| | | | | | | | | | | | | | | | The advantages of using a pre-existing coding style instead of creating our own are: - documenting on the manual takes a single sentence; - there are automatic tools to help during development/review. So document that PEP8 recommendation should be followed. Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com> Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* support/test-pkg: run legal-infoYann E. MORIN2017-04-171-2/+3
| | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: contribute: fix license string for Buildroot licenseRahul Bedarkar2017-04-151-1/+1
| | | | | | | | | | | As per section 12.2 "Complying with the Buildroot license", Buildroot is released under GPL version 2 or (at your option) any later version. But SPDX license string for Buildroot license in section 21.5 "Submitting patches" refers to only GPL version 2. Fix this inconsistency by using correct SPDX identifier. Signed-off-by: Rahul Bedarkar <rahulbedarkar89@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: size of tab in package descriptionRicardo Martincoski2017-04-082-5/+9
| | | | | | | | | | | | | | | | | | | | | | 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>
* support/test-pkg: print number of toolchains and progressYann E. MORIN2017-04-061-11/+11
| | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document the test-pkg scriptYann E. MORIN2017-04-062-0/+96
| | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: refer to SPDX License ListRahul Bedarkar2017-04-016-86/+11
| | | | | | | | | | | | | We want to use SPDX short identifier for license string as much as possible. So refer to SPDX license list and use SPDX short identifier for license strings in documentation. Also remove License abbreviations that we have. Signed-off-by: Rahul Bedarkar <rahulbedarkar89@gmail.com> [Thomas: take into account suggestions from Arnout.] Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* core: enhance printvarsYann E. MORIN2017-03-291-0/+54
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Currently, the output of printvars copntains the name of the variable, its expanded value and its un-expanded value. However, most of the time, we need the actual, expanded value, so it can be re-used from a (non-Buildroot) infrastructure script, like a post-build script, or a build-farm driver (e.g. a Jenkins job...) Add two options that a user may set to change the output of printvars: - QUOTED_VARS, if set, will quote the value - RAW_VARS, if set, will print the unexpanded value The new output by default only prints the expanded value now. So that it can be used as such: $ make -s printvars VARS=BUSYBOX_VERSION BUSYBOX_VERSION=1.26.2 $ make -s printvars VARS=BUSYBOX_RDEPENDENCIES QUOTED_VARS=YES BUSYBOX_RDEPENDENCIES='ncurses util-linux' $ make -s printvars VARS=BUSYBOX_FINAL_PATCH_DEPENDENCIES RAW_VARS=YES BUSYBOX_FINAL_PATCH_DEPENDENCIES=$(sort $(BUSYBOX_PATCH_DEPENDENCIES)) And it is even possible to directly evaluate it in a shell script: eval $(make -s printvars VARS=BUSYBOX_VERSION QUOTED_VARS=YES) Backward compatibility of the output is not maintained. It is believed that scripts that depended on the previous output were very fragile to begin with, because they had to filter the non-formatted output (splitting on spaces or braces was not really possible, because values could contain either). Document printvars and its options in the manual; list it in the output of 'make help'. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document MPL licensesRahul Bedarkar2017-03-161-0/+6
| | | | | | | | | Many packages are provided under MPL v1.1 and v2.0. Document it under License abbreviations section. Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com> Signed-off-by: Rahul Bedarkar <rahul.bedarkar@imgtec.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: document ISC licenseRahul Bedarkar2017-03-161-0/+3
| | | | | | | | | Many packages are provided under ISC license. Document it under License abbreviations section. Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com> Signed-off-by: Rahul Bedarkar <rahul.bedarkar@imgtec.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* luarocks-package: lowercase the upstream name for LuaRocksArnout Vandecappelle2017-03-051-2/+3
| | | | | | | | | | LuaRocks has a policy that the rockspec and rock filenames are lower case. However, the upstream name may contain uppercase characters. We have several packages like that in Buildroot. To simplify the package .mk files, apply the lowercase from within the infra. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* luarocks-package: introduce PKG_NAME_UPSTREAMArnout Vandecappelle2017-03-021-22/+32
| | | | | | | | | | | | | | | | | Since we now require Lua package names to start with "lua", it is likely that the Buildroot name is different from the upstream LuaRocks name. Add a feature to the luarocks-package infra that makes it easier to handle this situation: the package can explicitly specify the upstream name in PKG_NAME_UPSTREAM, and that name will be used in PKG_ROCKSPEC, PKG_SOURCE and PKG_SUBDIR. Add an explanation of this feature to the manual. To make the example relevant, it is changed to lua-foo, where the upstream name is plain foo. To avoid confusion with the dependency on a native library, that dependency is renamed to bar. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: luarocks: improve tutorial exampleArnout Vandecappelle2017-03-021-1/+1
| | | | | | | | The license file in a luarocks package is always inside the subdir, so the example should reflect this. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: centralize recommendations about BR2_DL_DIRLuca Ceresoli2017-02-072-2/+5
| | | | | | | | | | | | | | | | We currently have two places where we recommend where BR2_DL_DIR should be set: "Environment variables" and "Location of downloaded packages". The former recommends setting BR2_DL_DIR in the .config, the latter kind of endorses using ~/.bashrc. We prefer suggesting the ~/.bashrc way since it avoids downloading the same file multiple times, and anyway it's wise to have all the details in a unique place. So remove the .config suggestion from "Environment variables" and let it just point to "Location of downloaded packages". Cc: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: suggest 'YES' as the value for LIBFOO_GIT_SUBMODULESLuca Ceresoli2017-02-071-5/+6
| | | | | | | | | | | | The manual mentions LIBFOO_GIT_SUBMODULES but does not tell what value it should have. The implementation only checks whether the variable is non-empty, but we should suggest a specific value to avoid people wondering what they have to set, and to try setting weird values. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Cc: Baruch Siach <baruch@tkos.co.il> Cc: Ricardo Herrero <ricardo.herrero@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* pkg-perl: add PREFER_INSTALLER variableFrancois Perrad2017-01-291-2/+9
| | | | | | Signed-off-by: Francois Perrad <francois.perrad@gadz.org> [Thomas: tweak documentation.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Makefile, manual: Bump copyright yearPeter Korsgaard2017-01-271-1/+1
| | | | | | Happy 2017! Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs: Add bc to required toolsMarcus Hoffmann2017-01-061-0/+1
| | | | | | | | | We check for bc under required packages. It should be listed as such in the docs. Signed-off-by: Marcus Hoffmann <m.hoffmann@cartelsol.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* support/dependencies: ensure we have 'file' on the hostYann E. MORIN2016-12-271-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Recently, the autoconf macros for libtool started using '/usr/bin/file' to determine the type of library that is generated by the toolchain. Packages that use this recent version of the libtool autoconf macros will fail in a rather dramatic way when /usr/bin/file is not present on the host: the package will still build but no shared library is generated, which in turn may cause build failures in other packages that link with it. For example, libpng's configure determines that it is not possible to build a shared library on MIPS64 because the expected output from 'file' is not present. Therefore, only a static libpng.a is built. Later, bandwithd links with -lpng but it doesn't use the pkg-config's Private-Libs (because it's not linking statically) and it doesn't have access to the NEEDED reference from the shared library. Therefore, it doesn't link with zlib and fails with pngrutil.c:(.text+0x55c): undefined reference to `inflate' We cant use host-file because it is itself an autotools package and is itself using libtool, so this would be a chicken-n-egg problem. Besides, the libtool script really wants to call /usr/bin/file, so it would not even find our host-file anyway. So, just require that '/usr/bin/file' is present on the host. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Baruch Siach <baruch@tkos.co.il> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* doc/manual: document the new waf-package infra variablesRomain Naour2016-12-111-0/+18
| | | | | | | | | | | | Document LIBFOO_WAF_OPTS, LIBFOO_BUILD_OPTS, LIBFOO_INSTALL_STAGING_OPTS and LIBFOO_INSTALL_TARGET_OPTS. Also document LIBFOO_CONF_OPTS which was missing in waf-package reference. Signed-off-by: Romain Naour <romain.naour@gmail.com> Cc: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* 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>
OpenPOWER on IntegriCloud