Commit Graph

830 Commits

Author SHA1 Message Date
Arnout Vandecappelle
ef2efaff15 website: add reference to submitting-patches to Contribute tab
In the hope of improving the quality of patches send by newcomers,
add a reference to the submitting-patches section of the manual
to the Contribute tab of the website.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2016-02-01 19:16:45 +01:00
Thomas De Schampheleire
fcddb9dafe manual: minor fixes in the graph-size documentation
Fix some typos and references to a size-stats 'target' (the script is called
'size-stats' but the make target is 'graph-size').

Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2016-02-01 14:25:15 +01:00
Yann E. MORIN
1ad97d1ff1 docs/manual: makedev syntax accepts usernames and group names
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2016-02-01 08:02:38 +01:00
Joao Mano
4fad12598d support/download: alternative access methods to CVS
Allows user to specify other access methods than :pserver:anonymous@
on CVS repositories. This shall be defined in the <pkg>_SITE variable.

[Thomas:
 - as suggested by Yann, quote the variable expansion
 - as suggested by Yann, use a regexp match
 - tweak commit log]

Signed-off-by: Joao Mano <joao@datacom.ind.br>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2016-01-20 23:26:03 +01:00
Yann E. MORIN
cd6153680b docs/manual: add ordering of kconfig options' attributes
We want to ensure all packages follow the same coding style, so we add a
blurb about the order of kconfig options' attributes:

  - first, the type and the prompt
  - the default value if needed
  - then dependencies of the 'depends on' category
  - followed by dependencies of the 'select' form
  - with eventually the help text

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2016-01-19 22:24:34 +01:00
Yann E. MORIN
04d8fee3d7 docs/manual: slightly compactify a paragraph
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2016-01-19 22:24:21 +01:00
Angelo Compagnucci
b6b5f2c481 docs/website: fixing mixing content error
Firefox recently activated mixing content mode protection
(http elements in an https page). This patch changes
the external slides service to https.

Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2016-01-13 23:07:57 +01:00
Arnout Vandecappelle
12825f7af5 Config.in: add symbols for BR2_HOST_GCC_AT_LEAST_X_Y
Some host packages need a recent gcc version. Add symbols to Config.in
to specify the HOSTCC version. The values are passed through the
environment, and this environment is generated in a new support script.

Also update the documentation to mention the new symbols.

[Thomas: simplify by using only make logic instead of an external
shell script.]

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-12-31 10:32:10 +01:00
Angelo Compagnucci
33771d6a2d docs/website: fixing pre block indentation
Pre block should not be indented, this patch fixes wrong
indentation.

Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-12-29 22:06:45 +01:00
Yann E. MORIN
217493eef8 docs/manual: document the new kconfig-package variable
The previous patch introduced the new FOO_KCONFIG_DEFCONFIG variable
to specify a defconfig rule rather than a (def)config file.

Add this to the manual.

Also document the pre-existing FOO_KCONFIG_FILE for which the
explanations were missing altogether.

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Sam Bobroff <sam.bobroff@au1.ibm.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-12-22 22:39:26 +01:00
Arnout Vandecappelle
aafff45965 manual: clarify policy when updating a package patch
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Cc: Renaud AUBIN <root@renaud.io>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-12-16 23:44:03 +01:00
Peter Korsgaard
f8daafddb2 docs: website: update for 2015.11.1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-12-05 23:17:04 +01:00
Peter Korsgaard
2723fa4a50 docs/website/news.html: add 2015.11 announcement link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-12-01 22:15:28 +01:00
Peter Korsgaard
3f90e532ff Update for 2015.11
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-11-30 23:13:41 +01:00
Thomas Petazzoni
e99163a826 docs/website: fix invalid links to the mailing list page
As noticed by Peter Korsgaard, all the links to links.html are broken,
they should point to support.html instead.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-11-28 18:14:45 +01:00
Thomas Petazzoni
15cec18f6c docs/website: fix invalid link
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-11-28 14:54:07 +01:00
Peter Korsgaard
4a8b0c6795 docs: images: re-add github image
This got removed with the addition of the new website, but it is used by the
manual so it no longer builds.

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-11-26 23:25:11 +01:00
Peter Korsgaard
610f3fa03d Update for 2015.11-rc3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-11-26 23:06:02 +01:00
Peter Korsgaard
260fe6c422 news.html: fix typo in 2015.05-rc3 link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-11-26 22:54:41 +01:00
Angelo Compagnucci
97ab48658d docs/website: New website
This patch introduces a new buildroot website based on a modern flat
layout inspired by material design.

Each page of the old website is converted to the new css/layout, the
big bump is in main page which is completely rewritten. Content of
the old website is copied more or less verbatim, planning to add more
content in the future.

Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-11-23 22:56:59 +01:00
Peter Korsgaard
bfaed966af Update for 2015.11-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-11-19 13:31:31 +01:00
Luca Ceresoli
89b7375b0f docs/manual: fix bash export syntax in example code
To export a variable in .bashrc we shouldn't put a '$' at the
beginning of the line, and there must be a '=' between key and value.

Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-11-11 23:12:30 +01:00
Thomas Petazzoni
40c43ee0b7 website/news: update with release date and announcement e-mail link
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-11-08 14:42:46 +01:00
Thomas Petazzoni
e1da0eff54 Update for 2015.11-rc1
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-11-07 22:43:57 +01:00
Arnout Vandecappelle
1daa4c95a4 docs/manual: fix typo in $(FOO_PKGDIR) documentation
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-11-05 13:30:21 +01:00
Yann E. MORIN
7dcd2296b6 docs/manual: document $(FOO_PKGDIR)
In the manual, add a note that packages can use $(FOO_PKGDIR) to get the
path to the directory containg the .mk and Config.in files, if they need
it to e.g. copy files from there, like startup scripts, systemd units or
any other resource.

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>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-11-05 00:01:23 +01:00
Yann E. MORIN
f1856bd0f5 docs/manual: do not override BR2_EXTERNAL
Currently, we forcibly override BR2_EXTERNAL when building the manual,
so as to avoid referring to packages therein from the manual.

However, when generating the lists of packages, we limit ourselves to
scanning for packages in (Buildroot's) TOPDIR and never search in
BR2_EXTERNAL. So, we do not really need to override BR2_EXTERNAL when
generating the manual to achieve the same result.

Furthermore, we're only looking for packages that are defined in the
sub-menu "Target packages", and never anywhere else, and especially not
in the sub-menu "User-provided options".

Finally, we're soon to completely eliminate use of BR2_EXTERNAL in
Kconfig altogether, so that would no longer have any impact anyway.

So, just leave BR2_EXTERNAL alone when generating the manual.

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: Thomas De Schampheleire <patrickdepinguin@gmail.com>
Cc: Arnout Vandecappelle <arnout@mind.be>
Cc: Samuel Martin <s.martin49@gmail.com>
Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-11-03 23:42:24 +01:00
Yann E. MORIN
07e5641339 core/pkg-generic: allow packages to exclude files when extracting
Currently, packages that need to exclude parts of the archives when
extracting (e.g. to gain space), like gcc or toolchain-external, have to
provide custom extract commands, just for the sake of adding a bunch of
--exclude directives when calling tar.

Add a new variable that packages may set, to provide a space-separated
list of patterns to exclude.

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Cc: Vicente Olivert Riera <Vincent.Riera@imgtec.com>
Reviewed-by: Romain Naour <romain.naour@openwide.fr>
Reviewed-by: Vicente Olivert Riera <Vincent.Riera@imgtec.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-11-03 22:20:30 +01:00
Samuel Martin
539acb7500 Revert "manual: Add notes about GitHub and hashes"
This note is no longer needed, so remove it.

Tarballs generated by GitHub are always the same, so hashes can be
checked.

This reverts commit 9474cc2594.

[Thomas: fix other remaining references to not using hashes for
github, as noticed by Maxime Hadjinlian.]

Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-10-18 17:59:40 +02:00
Gustavo Zacarias
3901cb5157 ccache: allow for BR2_CCACHE_DIR environment override
Allow the BR2_CCACHE_DIR .config option to be overriden by the
BR2_CCACHE_DIR env variable.
This is useful for big projects where in some cases the developers home
directory might be a NFS mount (slow) and real production builds aren't.

Update documentation accordingly as well.

Signed-off-by: Gustavo Zacarias <gustavo.zacarias@free-electrons.com>
Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-10-17 16:32:41 +02:00
Thomas Petazzoni
10f7a256a3 docs/manual: add section about size graphing
Document the new graph-size target and its possibilities.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2015-10-17 16:13:09 +02:00
Arnout Vandecappelle
1e97b27873 ccache: support changing the output directory
When building in a different output directory than the original build,
there will currently be a lot of ccache misses because in many cases
there is some -I/... absolute path in the compilation. Ccache has an
option CCACHE_BASEDIR to substitute absolute paths with relative paths,
so they wil be the same in the hash (and in the output).

Since there are some disadvantages to this path rewriting, it is made
optional as BR2_CCACHE_USE_BASEDIR. It defaults to y because the
usefulness of ccache is severely reduced without this option.

In addition to CCACHE_BASEDIR, we also substitute away the occurences
of $(HOST_DIR) in the calculation of the compiler hash. This is done
regardless of the setting of BR2_CCACHE_USE_BASEDIR because it's
quite harmless.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2015-10-04 18:22:21 +02:00
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