Commit Graph

798 Commits

Author SHA1 Message Date
Luca Ceresoli
ad9c7ee554 docs/manual: document new actual source package variables
Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com>
Cc: Arnout Vandecappelle <arnout@mind.be>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-10-04 17:04:16 +01:00
Luca Ceresoli
571552c468 system: clarify /dev management using devtmpfs + {mdev, eudev}
The "Dynamic using mdev" and "Dynamic using eudev" /dev management
methods are using devtmpfs, just like "Dynamic using devtmpfs only",
on top of which they add either mdev or eudev. But their names might
suggest they use mdev only or eudev only.

Clarify their descriptions by adding "devtmpfs +" to make it
unambiguous.

[Thomas: rewrap the paragraphs in the manual. It makes the diff a lot
less readable, but we actually want the result to be wrapped.]

Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-10-04 11:23:14 +01:00
Luca Ceresoli
c7ed1243a5 docs/manual: FOO_SITE must not have a trailing slash
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>
2015-10-02 21:12:18 +01:00
Francesco Nwokeka
59fa7b7f7c docs/manual: add useful tips on patch versioning and patch submission
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>
2015-09-19 15:57:15 +02:00
Peter Korsgaard
e77d6c60b9 docs: use lists.buildroot.org to refer to the mailman archives
Now that mailman handles lists.buildroot.org lets use that everywhere in the
documentation as well.

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-09-14 14:50:40 +02:00
Peter Korsgaard
162b30bcc3 docs/manual: use bugs.buildroot.org for bugtracker
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>
2015-09-14 14:46:33 +02:00
Vicente Olivert Riera
476b674824 docs/website: add a space between attributes
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>
2015-09-07 23:53:19 +02:00
Vicente Olivert Riera
76bcbae365 docs/manual: add the "mark as superseded" hint
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>
2015-09-07 23:52:35 +02:00
Peter Korsgaard
3cd209bfaf docs: website: update for 2015.08.1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-09-06 23:09:12 +02:00
Peter Korsgaard
b6beb1d503 docs/website/news.html: add 2015.08 announcement link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-09-01 09:56:56 +02:00
Peter Korsgaard
20a36cd877 Update for 2015.08
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-08-31 23:06:58 +02:00
Yann E. MORIN
c7bd65e1d4 docs/website: remove broken symlink for top-level manual
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>
2015-08-29 10:36:15 +02:00
Yann E. MORIN
dc1ba281a5 docs/manual: makedevs only accepts numerical values
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>
2015-08-29 10:35:28 +02:00
Yann E. MORIN
551971984c docs/website: fix manual symlink
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>
2015-08-26 22:26:55 +02:00
Yann E. MORIN
0af33406a7 website: make a symlink for the manual at the root of the website
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>
2015-08-26 17:36:59 +02:00
Thomas Petazzoni
a123e7ed8e Add link to 2015.08-rc2 announcement e-mail
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-08-24 23:01:11 +02:00
Thomas Petazzoni
985b46be0c Update for 2015.08-rc2
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-08-24 22:20:16 +02:00
Thomas Petazzoni
6b804f75eb docs/website: add announcement e-mail link for 2015.08-rc1
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-08-05 23:13:36 +02:00
Thomas Petazzoni
7b1e9d5244 Update for 2015.08-rc1
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-08-05 15:50:27 +02:00
Thomas Petazzoni
45aaa372b0 docs/manual: document gcc version dependencies
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>
2015-08-05 12:11:20 +02:00
Maxime Hadjinlian
f8d281d816 docs/manual: Modify GitHub FOO_SITE explanation
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>
2015-07-28 23:37:39 +02:00
Jörg Krause
61f1578503 docs/manual: add U-Boot configuration
Signed-off-by: Jörg Krause <joerg.krause@embedded.rocks>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-07-19 14:47:11 +02:00
Jan Viktorin
c99a0deec7 docs/manual: Fix trivial typo
Signed-off-by: Jan Viktorin <viktorin@rehivetech.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-07-14 23:56:58 +02:00
Baruch Siach
fe3f30d9a7 docs/manual: relax python version requirement
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>
2015-07-14 23:56:35 +02:00
Romain Naour
509a8368c3 docs/manual: add documentation for linux-ext and linux-tools.
[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>
2015-07-14 23:35:58 +02:00
Luca Ceresoli
7701e2bf75 docs/manual: fix typo
Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-07-13 17:08:23 +02:00
Julien Viard de Galbert
5284dcf7de Document the 72 char limit on package description.
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>
2015-07-13 12:16:45 +02:00
Yann E. MORIN
9e8857d05a docs/manual: add kernel-module
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>
2015-07-12 11:56:18 +02:00
Luca Ceresoli
62803be844 docs/manual: document <PKG>_STRIP_COMPONENTS
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>
2015-07-12 00:51:14 +02:00
Thomas Petazzoni
821f30c82c docs/manual/beyond-buildroot: additional minor fixes
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>
2015-07-10 19:17:02 +02:00
Noé Rubinstein
618346836e docs/manual/beyond-buildroot: building and testing live-CDs
[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>
2015-07-10 19:15:40 +02:00
Fabio Porcedda
21036a58a2 manual: cvs: document that a branch or a date can be used
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>
2015-07-10 11:09:30 +02:00
James Knight
8d972df185 scripts/mkusers: allow users with no password value set
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>
2015-06-09 23:13:41 +02:00
Thomas Petazzoni
97f6d7dcb5 docs/website: link to the Free Electrons training materials
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-06-04 15:32:31 +02:00
Peter Korsgaard
cddaae8229 Merge branch 'next'
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-06-01 23:52:57 +02:00
Peter Korsgaard
7919b0ec55 docs/website/news.html: add 2015.05 announcement link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-06-01 23:51:45 +02:00
Peter Korsgaard
6d73615f0c Update for 2015.05
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-05-31 23:15:34 +02:00
Yann E. MORIN
162290e1f3 docs/manual/br2-external: use proper .Note sections
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>
2015-05-25 22:35:10 +02:00
Yann E. MORIN
188025e691 docs/manual/br2-external: remove superfluous leading space in code blocks
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>
2015-05-25 22:34:07 +02:00
Peter Korsgaard
c6ce119cb0 Update for 2015.05-rc3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-05-22 11:53:58 +02:00
Floris Bos
0cfb5549b3 kconfig-package: add support for config fragments
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>
2015-05-21 23:41:46 +02:00
Peter Korsgaard
f2435f6ddb Update for 2015.05-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-05-11 13:28:26 +02:00
Yann E. MORIN
8548238e95 docs/manual: add list of instrumentation steps
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>
2015-05-05 22:47:32 +02:00
Yann E. MORIN
cb3d3bb8a6 website/sponsors: fix typo
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-05-05 17:09:20 +02:00
Peter Korsgaard
4ccb5ad27a docs/website/news.html: add 2015.05-rc1 announcement link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-05-04 22:39:48 +02:00
Peter Korsgaard
5628a15a69 Update for 2015.05-rc1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-05-04 21:28:31 +02:00
Maxime Hadjinlian
9474cc2594 manual: Add notes about GitHub and hashes
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>
2015-05-04 15:40:14 +02:00
Yann E. MORIN
74ce748dc9 docs/manual: also document md5 hash
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>
2015-05-04 15:37:02 +02:00
Yann E. MORIN
9776b9cc70 doc/manual: fix generating manual after legacy overhaul
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>
2015-05-02 09:00:44 +02:00
Fabio Porcedda
375728d051 manual: don't use a comment at the end of the version variable assignment
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>
2015-04-27 23:31:28 +02:00