summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs/manual: FOO_SITE must not have a trailing slashLuca Ceresoli2015-10-021-2/+4
| | | | | | | | | This has been the best practice since a long time, but it was not clearly stated in the manual. Now it is mandatory, so mention it explicitly. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add useful tips on patch versioning and patch submissionFrancesco Nwokeka2015-09-191-0/+14
| | | | | | | | | | | Added an alternative on patch versioning (the -v option) and added a tip on how to automatically mark a previous commit as superseded. [Thomas: minor tweaks.] Signed-off-by: Francesco Nwokeka <francesco.nwokeka@gmail.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs: use lists.buildroot.org to refer to the mailman archivesPeter Korsgaard2015-09-144-50/+50
| | | | | | | Now that mailman handles lists.buildroot.org lets use that everywhere in the documentation as well. Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: use bugs.buildroot.org for bugtrackerPeter Korsgaard2015-09-142-2/+2
| | | | | | | Now that we have a bugs.buildroot.org CNAME for bugzilla lets use that in the manual as well. Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: add a space between attributesVicente Olivert Riera2015-09-071-1/+1
| | | | | | | | | | | Error highlighted by the W3 HTML validator: Error: No space between attributes. At line 71, column 64 e="width:100%;"href="/download Signed-off-by: Vicente Olivert Riera <Vincent.Riera@imgtec.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: add the "mark as superseded" hintVicente Olivert Riera2015-09-071-0/+8
| | | | | | Signed-off-by: Vicente Olivert Riera <Vincent.Riera@imgtec.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs: website: update for 2015.08.1Peter Korsgaard2015-09-062-5/+15
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website/news.html: add 2015.08 announcement linkPeter Korsgaard2015-09-011-1/+2
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2015.08Peter Korsgaard2015-08-312-7/+16
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: remove broken symlink for top-level manualYann E. MORIN2015-08-291-1/+0
| | | | | | | | | | | | | | | Recently, we've tried to have the manual lie at the top-level of the site, to get a shorter URL. However, that is broken: we do not need only a link the the HTML, but also to the CSS and to any resource linked from the html (images...). The server configuration has now been updated to add a redirect, so we no longer need that symlink anyway. Remove it. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Peter Korsgaard <jacmet@uclibc.org> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: makedevs only accepts numerical valuesYann E. MORIN2015-08-291-4/+7
| | | | | | | | | | | | | | | | | | | | | | | | | Because of a limitation in how makedevs resolves names [0], usernames and groupnames would be resolved with UIDs and GIDs from the host, not the target. Fixing makedevs would involve us rewriting a /etc/passwd and /etc/group parser (not too complex, still not trivial). Document that the user and group fields should only be numbers, not names. Also, the manual is currently misleading, as an example indeed uses names for the user and group fields. Fix that and expand the explanations. The mode field should also be numbers, not a rwx combo. Slight typographical eye-candy about major/minor fields. [0] it uses getpwnma(3) and getgrnam(3) to resolve names to IDs, and those only resolve names on the host (i.e. there is no way to specify a chroot-like feature) Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/website: fix manual symlinkYann E. MORIN2015-08-261-1/+1
| | | | | | | It should point to the filesystem path on the server, not the HTTP virtual path. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* website: make a symlink for the manual at the root of the websiteYann E. MORIN2015-08-263-2/+3
| | | | | | | | | | | | This will give us a shorter URL, that we can more easily refer to in the documetation itself, in help texts, on IRC... [Peter: Use buildroot.org everywhere] Suggested-by: Arnout Vandecappelle <arnout@mind.be> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Peter Korsgaard <jacmet@uclibc.org> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Add link to 2015.08-rc2 announcement e-mailThomas Petazzoni2015-08-241-1/+3
| | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Update for 2015.08-rc2Thomas Petazzoni2015-08-242-5/+18
| | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/website: add announcement e-mail link for 2015.08-rc1Thomas Petazzoni2015-08-051-3/+4
| | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Update for 2015.08-rc1Thomas Petazzoni2015-08-052-7/+18
| | | | 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>
* docs/manual: Modify GitHub FOO_SITE explanationMaxime Hadjinlian2015-07-282-8/+10
| | | | | | | | | | | GitHub has changed its layout, there is no longer any green nor grey button, it's a link with a tiny icon that indicates if it's uploaded by the maintainer or not. In order to not confuse anyone, adding an image should make it clear. Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Reviewed-by: Lionel Orry <lionel.orry@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add U-Boot configurationJörg Krause2015-07-194-2/+16
| | | | | Signed-off-by: Jörg Krause <joerg.krause@embedded.rocks> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: Fix trivial typoJan Viktorin2015-07-141-1/+1
| | | | | Signed-off-by: Jan Viktorin <viktorin@rehivetech.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: relax python version requirementBaruch Siach2015-07-141-1/+1
| | | | | | | | Buildroot should now work with host installed python version 3. Update the manual accordingly. Signed-off-by: Baruch Siach <baruch@tkos.co.il> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add documentation for linux-ext and linux-tools.Romain Naour2015-07-143-0/+152
| | | | | | | | [Thomas: misc improvements.] Signed-off-by: Romain Naour <romain.naour@openwide.fr> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* 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>
OpenPOWER on IntegriCloud