summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs/manual: fix typoLuca Ceresoli2015-07-131-1/+1
| | | | | Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Document the 72 char limit on package description.Julien Viard de Galbert2015-07-132-2/+5
| | | | | | | | | | | | | 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>
* docs/manual: add kernel-moduleYann E. MORIN2015-07-122-0/+144
| | | | | | | | | 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: Arnout Vandecappelle <arnout@mind.be> Cc: Jeremy Rosen <jeremy.rosen@openwide.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document <PKG>_STRIP_COMPONENTSLuca Ceresoli2015-07-121-0/+9
| | | | | | | Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Cc: Arnout Vandecappelle <arnout@mind.be> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual/beyond-buildroot: additional minor fixesThomas Petazzoni2015-07-101-2/+2
| | | | | | | Those issues were noticed by Thomas De Schampheleire during the review, but they were forgotten when applying the patch. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual/beyond-buildroot: building and testing live-CDsNoé Rubinstein2015-07-101-0/+29
| | | | | | | | [Thomas: reworked a bit the phrasing, plus mention that Grub 2 is supported.] Signed-off-by: Noé Rubinstein <nrubinstein@aldebaran.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: cvs: document that a branch or a date can be usedFabio Porcedda2015-07-101-1/+3
| | | | | | | Also instead of using the generic word "timestamp" use the word "tag". Signed-off-by: Fabio Porcedda <fabio.porcedda@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* scripts/mkusers: allow users with no password value setJames Knight2015-06-091-1/+2
| | | | | | | | | | | | | | | | | | The following allows a user definition to specify that a created user entry should not have a password value set. Original implementation allowed a user definition to provide a password value of "=" (no quotes) to generate a crypt-encoded empty string value. In some cases, it may be desired to have no value specified for a user's password. By using a value "-" for a password, no value will be set in the shadow value. An example when this can be used is when logging into a terminal. Logging into a session with an encoded empty password will prompt a user to enter a password since it does not know the password is empty. If the password field blank, a login session will not prompt for a password. Signed-off-by: James Knight <james.knight@rockwellcollins.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/website: link to the Free Electrons training materialsThomas Petazzoni2015-06-041-1/+19
| | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Merge branch 'next'Peter Korsgaard2015-06-011-2/+13
|\ | | | | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
| * kconfig-package: add support for config fragmentsFloris Bos2015-05-211-2/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Adds functionality to the kconfig infrastructure to merge additional configuration fragment files to the main configuration file of kconfig packages, using support/kconfig/merge_config.sh Typical use-case is when you want your configuration to be kept in sync with an upstream (def)config file, but do require some minor local modifications. Disables -update-config and -update-defconfig targets when fragment files are set. [Thomas: take into account comments made by Arnout: - Minor fixes in the documentation changes - Add @ before the tests done in the $(1)-update-config and $(1)-update-defconfig targets.] Signed-off-by: Floris Bos <bos@je-eigen-domein.nl> Tested-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Tested-by: Gergely Imreh <imrehg@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* | docs/website/news.html: add 2015.05 announcement linkPeter Korsgaard2015-06-011-1/+2
| | | | | | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | Update for 2015.05Peter Korsgaard2015-05-312-7/+17
| | | | | | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual/br2-external: use proper .Note sectionsYann E. MORIN2015-05-251-2/+6
| | | | | | | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual/br2-external: remove superfluous leading space in code blocksYann E. MORIN2015-05-251-5/+5
| | | | | | | | | | | | | | | | | | | | | | They are not needed, and other code blocks in the same file are not indented either. Remove those leading spaces, so all our code blocks look the same. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | Update for 2015.05-rc3Peter Korsgaard2015-05-222-5/+17
| | | | | | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | Update for 2015.05-rc2Peter Korsgaard2015-05-112-5/+18
| | | | | | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: add list of instrumentation stepsYann E. MORIN2015-05-051-3/+14
| | | | | | | | | | | | | | | | | | | | | | The names of steps are not obvious, so add this list to the manual. Small formatting fix at the same time. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> 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>
* | website/sponsors: fix typoYann E. MORIN2015-05-051-1/+1
| | | | | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/website/news.html: add 2015.05-rc1 announcement linkPeter Korsgaard2015-05-041-1/+2
|/ | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2015.05-rc1Peter Korsgaard2015-05-042-7/+20
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.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>
* doc/manual: fix generating manual after legacy overhaulYann E. MORIN2015-05-021-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | Commit 53903a15 (*config: improve handling of BR2_LEGACY) added an option to entirely skip legacy entries, by passing a variable in the environment. However, it missed one location where that variable is also needed, which is generating the list of packages and deprecated features for inclusion in the manual. Fix that by re-using the global $(COMMON_CONFIG_ENV) variable, overriding just what we don't want (i.e. br2-external location and defconfig path). Also, slightly re-order variables so the ones we override come right after the common settings, moving the specific ones at the end, one variable per line. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Arnout Vandecappelle <arnout@mind.be> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Tested-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: don't use a comment at the end of the version variable assignmentFabio Porcedda2015-04-271-1/+2
| | | | | | | | | The comment at the end of the version string assigment could lead to a download failure so don't use it as a example. Signed-off-by: Fabio Porcedda <fabio.porcedda@gmail.com> Reported-by: Yann E. MORIN <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: remove references to IPv6Gustavo Zacarias2015-04-222-13/+8
| | | | | | | | 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>
* docs/manual: documentation for recursive makedevs syntaxAngelo Compagnucci2015-04-111-1/+9
| | | | | | | | | | | This patch adds the documentation for the new makedevs recursive syntax. [Thomas: s/folder/directory/ as suggested by Yann.] Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add _PATCH_DEPENDENCIESYann E. MORIN2015-04-091-0/+9
| | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: Romain Naour <romain.naour@openwide.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: update documentation about applying patchesThomas Petazzoni2015-04-062-7/+6
| | | | | | | | | | | The Buildroot manual is currently wrong when describing how patches are applied: it says that <packagename>-*.patch is applied, and that <packagename>-<seq>-*.patch is the recommended name for patches. This is incorrect, since we're now using just <seq>-*.patch. This commit adjusts the documentation accordingly. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
* Makefile: split off 'list-defconfigs' from 'help'Arnout Vandecappelle2015-04-042-3/+9
| | | | | | | | | | | | | As discussed in the FOSDEM2015 BR developer meeting, the output of 'make help' is too long for comfortable reading. To shorten it, split off the list of defconfigs in a new target, 'list-defconfigs'. Declare the new target as phony. Add 'list-defconfigs' to the documentation. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> 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: add links to the rest of the licensesYegor Yefremov2015-04-021-4/+12
| | | | | | Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: remove references to largefileGustavo Zacarias2015-04-012-36/+32
| | | | | | | | | | 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: document new graph-depends optionsYann E. MORIN2015-04-011-0/+8
| | | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Francois Perrad <fperrad@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: update documentation about <pkg>_SOURCE, <pkg>_PATCH and ↵Thomas Petazzoni2015-03-301-13/+17
| | | | | | | | | | | | | | | | | | | | | | | <pkg>_EXTRA_DOWNLOADS This commit updates the Buildroot manual for the variables used to indicate where to download the source code from: - It updates the description of <pkg>_SOURCE to make it clear that Buildroot assume that the tarball is hosted at <pkg>_SITE. - It updates the description of <pkg>_PATCH to indicate that not only file names (assumed to be hosted at <pkg>_SITE) can be used, but also full URLs. This allows to match with what the current code is doing. - It updates the description of <pkg>_EXTRA_DOWNLOADS to also indicate that full URLs are now accepted, following the change made in the previous commit. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: Romain Naour <romain.naour@openwide.fr> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
* 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>
* pkg-cmake: allow to build package in a subdirectoryGwenhael Goavec-Merou2015-03-131-0/+4
| | | | | | | | | | | | | | | For some cmake based packages, like GNURadio, it's forbidden to do the compilation directly in the sources directory. This patch add a new variable to specify, if needed, the name of a sub-directory used to compile. [Thomas: put the documentation at the right place in the manual, not in the middle of the <pkg>_CONF_OPTS description.] Signed-off-by: Gwenhael Goavec-Merou <gwenhael.goavec-merou@trabucayre.com> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Tested-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* website: add link to the release archiveLuca Ceresoli2015-03-111-0/+3
| | | | | | | | We have them, let them be reachable. [Peter: use relative URL like elsewhere] Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: download: remove trailing slash from package FOO_SITELuca Ceresoli2015-03-101-1/+1
| | | | | | | | The recommended form is without the trailing slash. Buildroot will add a slash between FOO_SITE and FOO_SOURCE as appropriate. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* website/news.html: add 2015.02 announcement linkPeter Korsgaard2015-03-021-1/+2
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2015.02Peter Korsgaard2015-03-012-8/+17
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2015.02-rc3Peter Korsgaard2015-02-242-5/+17
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2015.02-rc2Peter Korsgaard2015-02-152-5/+18
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website/news.html: add 2015.02-rc1 announcement linkPeter Korsgaard2015-02-081-1/+2
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2015.02-rc1Peter Korsgaard2015-02-082-7/+19
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: reinstall targetDoug Kehn2015-02-031-0/+2
| | | | | | | | | | Add reinstall target information to package-make-target.txt. [Thomas: update to take into account the fact that we now have a single <pkg>-reinstall target.] Signed-off-by: Doug Kehn <rdkehn@yahoo.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add FAQ entry about speeding up the build processThomas Petazzoni2015-02-031-0/+34
| | | | | | | | | | | | This is a very frequently asked question, so let's add a FAQ entry about it, that we can progressively extend with more advices for our users. [Thomas: remove the part about your boss buying new hardware, as suggested by reviewers.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
* docs/manual: add documentation for the pkg-rebar infrastructureYann E. MORIN2015-02-032-0/+104
| | | | | | | Signed-off-by: Johan Oudinet <johan.oudinet@gmail.com> [yann.morin.1998@free.fr: split the doc into its own patch] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
OpenPOWER on IntegriCloud