Commit Graph

1097 Commits

Author SHA1 Message Date
Philipp Wagner
a6479d6058 docs/manual: add external.desc to list of files needed for BR2_EXTERNAL
external.desc must be present when using a br2-external tree. The
documentation notes this later in the text, but the file is missing
from the initial overview of files.

Fixes bug #11481.

Signed-off-by: Philipp Wagner <mail@philipp-wagner.com>
Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-11-02 21:30:13 +01:00
Peter Korsgaard
a02a82aa3f docs/website: update for 2018.02.7
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-10-25 21:10:20 +02:00
Peter Korsgaard
99275417a5 docs/website: update for 2018.08.2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-10-25 20:13:58 +02:00
Francois Perrad
fe12a66bde scancpan: add PERL_FOO_DISTNAME in perl-foo.mk
This variable is needed for upgrading packages with scancpan.

Signed-off-by: Francois Perrad <francois.perrad@gadz.org>
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2018-10-24 00:22:13 +01:00
Yann E. MORIN
8e293a6386 docs/manual: document location of hash files for multi-versions packages
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Cc: Arnout Vandecappelle <arnout@mind.be>
Cc: Luca Ceresoli <luca@lucaceresoli.net>
Cc: Baruch Siach <baruch@tkos.co.il>
Reviewed-by: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-10-20 20:04:06 +02:00
Romain Naour
76fdc787cc docs/website/sponsors: credit Smile for the LLVM/Clang internship
Update Smile url and logo.

Signed-off-by: Romain Naour <romain.naour@smile.fr>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-10-20 17:21:47 +02:00
Thomas Petazzoni
6c1d0f6dbb docs/website: add TkOS to the sponsors
Tk Open Systems has sponsored the Buildroot Association to organize
the Buildroot Developers Meeting.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-10-17 21:27:14 +02:00
Peter Korsgaard
507d56a6be docs/manual: document the new get-developers -e option
Explain how this can be used with git send-email, and how git can be
configured to use it automatically.

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-10-09 14:48:07 +02:00
Arnout Vandecappelle (Essensium/Mind)
e1759f0634 manual: add expected order of 'depends on'
As discussed in [1], our guideline for the ordering of 'depends on'
lines is not written down. Fix that.

[1] http://lists.busybox.net/pipermail/buildroot/2018-October/232413.html

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-10-08 17:43:12 +02:00
Thomas Petazzoni
4b2ac1226a docs/website/sponsors: add sponsors of the Buildroot Developers Meeting @ ELCE 2018
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-10-08 10:00:16 +02:00
Thomas Petazzoni
28912be4f2 docs/website/sponsors: credit Scaleway for the Hackathon
Better late than never: let's thank Scaleway who provided some
excellent hosting conditions for our March 2018 Hackathon in Paris.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-10-08 09:59:17 +02:00
Thomas Petazzoni
458d10f2da docs/website/sponsors: remove "current sponsors", update "past sponsors"
This commit removes Google and Mind as "Current sponsors" and credits
them as "Past sponsors" for the FOSDEM 2018 Buildroot Developers
Meeting.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-10-08 09:54:31 +02:00
Peter Korsgaard
d522be6e0b docs/website: update for 2018.08.1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-10-07 11:46:29 +02:00
Peter Korsgaard
5cb3528738 docs/website: update for 2018.02.6
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-10-07 09:57:11 +02:00
Peter Korsgaard
3e6deea6bd docs/website: update for 2018.05.3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-10-07 08:40:57 +02:00
Thomas Petazzoni
8062700e2d docs/website: add paragraph about the IRC channel restrictions
Due to excessive spamming on Freenode, the IRC channel is currently
restricted to registered users. Since this may not be obvious for
people not familiar with IRC, let's mention it on our website, with a
link to the relevant documentation.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-09-11 15:47:06 +02:00
Thomas Petazzoni
26c28eb55a docs/website: use https:// link for patchwork
Suggested-by: 'popsulfr' on IRC
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-09-11 10:40:18 +02:00
Peter Korsgaard
721e4cbb52 Merge branch 'next'
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-09-07 13:13:17 +02:00
Peter Korsgaard
619d4214a0 website/news.html: add 2018.08 announcement link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-09-06 22:51:35 +02:00
Peter Korsgaard
339d550e92 Update for 2018.08
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-09-06 22:11:06 +02:00
Peter Korsgaard
24b5ff16ae Update for 2018.08-rc3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-09-01 00:28:13 +02:00
Peter Korsgaard
e058075189 docs/website: update for 2018.02.5
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-08-29 18:26:35 +02:00
Peter Korsgaard
511309cdbf docs/website: update for 2018.05.2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-08-28 17:06:55 +02:00
Yann E. MORIN
a2e0003141 docs/manual: expand on why using a branch name is not supported
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-08-25 00:04:40 +02:00
Peter Korsgaard
a907ab7db5 Update for 2018.08-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-08-20 10:55:03 +02:00
Yann E. MORIN
e0e089acc4 core/pkg-kconfig: allow dependencies before configurators
Some users of kconfig need some packages to be built before their
kconfig infra be used.

For example, the linux kernel, starting with 4.16, needs flex and bison
to generate the parser code. Furthermore, starting with 4.18, it will
also need the cross-compiler before parsing the kconfig stuff, because
that calls the compiler to check its features.

Currently, this is broken, even the flex/bison ones, even though they
are listed, because there is no way to define dependencie that are
guaranteed before the (visual) configurators. For example:

    $ make distclean
    $ make menuconfig
      --> enable the linux kernel, choose a defconfig, save, exit
    $ make linux-menuconfig
    [...]
      HOSTCC  scripts/basic/fixdep
      HOSTCC  scripts/kconfig/conf.o
      YACC    scripts/kconfig/zconf.tab.c
    /bin/sh: bison: command not found
      LEX     scripts/kconfig/zconf.lex.c
    scripts/Makefile.lib:196: recipe for target 'scripts/kconfig/zconf.tab.c' failed
    make[3]: *** [scripts/kconfig/zconf.tab.c] Error 127
    make[3]: *** Waiting for unfinished jobs....
    /bin/sh: flex: command not found
    scripts/Makefile.lib:188: recipe for target 'scripts/kconfig/zconf.lex.c' failed
    make[3]: *** [scripts/kconfig/zconf.lex.c] Error 127
    Makefile:528: recipe for target 'rpc_defconfig' failed
    make[2]: *** [rpc_defconfig] Error 2
    linux/linux.mk:511: recipe for target '/home/ymorin/dev/buildroot/buildroot/output/build/linux-4.17.11/.config' failed
    make[1]: *** [/home/ymorin/dev/buildroot/buildroot/output/build/linux-4.17.11/.config] Error 2
    Makefile:79: recipe for target '_all' failed
    make: *** [_all] Error 2

So, we introduce a new type of dependencies for kconfig-based packages,
that are guaranteed to be built and installed before the (visual)
configurators are called.

Since those dependencies are phony targets and therefore always out of
date, a normal dependency would cause the .config target to be rebuilt
on each invocation of make. So we use an order-only pre-requisite, like
is done for the patch dependency.

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Arnout Vandecappelle <arnout@mind.be>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Cc: Jan Kundrát <jan.kundrat@cesnet.cz>
Tested-by: Jan Kundrát <jan.kundrat@cesnet.cz>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-08-18 23:21:03 +02:00
Yann E. MORIN
c32ad51cbf core/sdk: generate the SDK tarball ourselves
Currently, the wording in the manual instructs the user to generate a
tarball from "the contents of the +output/host+ directory".

This is pretty confusing, because taken literally, this would amount to
running a command like:

    tar cf my-sdk.tar -C output/host/ .

This creates a tarbomb [0], which is very bad practice, because when
extracted, it creates multiple files in the current directory.

What one really wants to do, is create a tarball of the host/ directory,
with something like:

    tar cf my-sdk.tar -C output host/

However, this is not much better, because the top-most directory would
have a very common name, host/, which is pretty easy to get conflict
with when it gets extracted.

So, we fix that mess by giving the top-most directory a recognisable
name, based on the target tuple, which we also use as the name of the
archive (suffixed with the usual +.tar.gz+.) We offer the user the
possibility to override that default by specifying the +BR2_SDK_PREFIX+
variable on the command line.

Since this is an output file, we place it in the images/ directory.

As some users expressed a very strong feeling that they do not want to
generate a tarball at all, and that doing so would badly hurt their
workflows [1], we actually prepare the SDK as was previously done, but
under the new, intermediate rule 'prepare-sdk'. The existing 'sdk' rule
obviously depend on that before generating the tarball.

We choose to make the existing rule to generate the tarball, and
introduce a new rule to just prepare the SDK, rather than keep the
existing rule as-is and introduce a new one to generate the tarball,
because it makes sense to have the simplest rule do the correct thing,
leaving advanced, power users use the longest command. If someone
already had a wrapper that called 'sdk' and expected just the host
directory to be prepared, then this is not broken; it just takes a bit
longer (gzip is pretty fast).

Update the manual accordingly.

[0] https://en.wikipedia.org/wiki/Tar_(computing)#Tarbomb
[1] http://lists.busybox.net/pipermail/buildroot/2018-June/thread.html#223377
    and some messages in the ensuing thread...

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Wolfgang Grandegger <wg@grandegger.com>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Cc: Arnout Vandecappelle <arnout@mind.be>
Cc: Stefan Becker <chemobejk@gmail.com>
Cc: Trent Piepho <tpiepho@impinj.com>
Signed-off-by: &quot;Yann E. MORIN&quot; &lt;<a href="mailto:yann.morin.1998@free.fr" target="_blank">yann.morin.1998@free.fr</a>&gt;<br>
Reviewed-by: Stefan Becker <chemobejk@gmail.com>
Signed-off-by: &quot;Yann E. MORIN&quot; &lt;<a href="mailto:yann.morin.1998@free.fr" target="_blank">yann.morin.1998@free.fr</a>&gt;<br>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-08-14 16:03:48 +02:00
Thomas Petazzoni
4094342e2a docs/website: update news.html with 2018.08-rc1 announcement link
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-08-05 16:09:43 +02:00
Thomas Petazzoni
71d8148e59 Update for 2018.08-rc1
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-08-05 15:40:05 +02:00
Baruch Siach
27797caf76 docs/manual: update host gcc minimum required version
The oldest gcc that is known to work with current Buildroot is that of
RHEL 6, version 4.4.

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@bootlin.com>
2018-08-05 14:13:41 +02:00
Peter Korsgaard
bbdedace95 docs/website: update for 2018.02.4
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-07-21 00:36:14 +02:00
Peter Korsgaard
73722908f2 docs/website: update for 2018.05.1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-07-20 10:43:03 +02:00
Peter Korsgaard
8733193e6b docs/website/download.html: fix latest LTS version number
Latest is naturally .3, not .1

Reported-by: Thomas De Schampheleire <patrickdepinguin@gmail.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-06-19 13:45:20 +02:00
Peter Korsgaard
e44fa57a30 docs/website: update for 2018.02.3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-06-18 20:19:39 +02:00
Fabrice Fontaine
f4b4f77e84 docs/manual: fix scancpan path
scancpan is now in utils not in supports/scripts

Signed-off-by: Fabrice Fontaine <fontaine.fabrice@gmail.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-06-15 10:04:45 +02:00
Yann E. MORIN
529219ba96 docs/manual: always point to the correct license file
The manual is GPL-2, and points to the COPYING file in the repository.
When we do a rendering of the manual for a specific version, that URL
is currently always poitning to the latest version of the COPYING file.

If we ever have to change the content of that file (e.g. to add a new
exception, more clarifications, a license change, or whatever), then
an old manual would point to that newer version, which would then be
incorrect.

Include the sha1 of the commit in the URL, so that the manual always
point to the tree at the time the manual was rendered, not the time
it is consulted. Contrary to the informative text above, use the full
sha1, not the shortened one.

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com>
Cc: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-06-10 16:33:44 +02:00
Peter Korsgaard
8b0fd3cb49 Merge branch 'next'
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-06-02 11:21:20 +02:00
Peter Korsgaard
67009fd269 docs/website/news.html: add 2018.05 announcement link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-06-01 22:53:36 +02:00
Peter Korsgaard
f3d114a1ef Update for 2018.05
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-06-01 22:22:57 +02:00
Eric Le Bihan
12e56136e2 docs/manual: document pkg-meson infra
Update documentation about adding meson-based packages with instructions for
using pkg-meson infrastructure.

Signed-off-by: Eric Le Bihan <eric.le.bihan.dev@free.fr>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-05-30 21:59:05 +02:00
Peter Korsgaard
30d52c67a7 docs/website/news.html: fix s/2018.05/2018.02/ typos
Reported-by: Andreas Naumann <dev@andin.de>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-05-30 17:55:28 +02:00
Peter Korsgaard
bea6b866ef Update for 2018.05-rc3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-05-28 23:02:21 +02:00
Peter Korsgaard
c11ed3a4d9 Update for 2018.05-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-05-22 23:26:26 +02:00
Yann E. MORIN
970cb26ec2 docs/manual: using a branch name as FOO_VERSION does not work
For various reasons, we've always suggested users to avoid using a
branch as version string for their packages, because it does not work
as a they would expect:

  - it is not reproducible, because the branch may change between two
    builds that are done at different times;

  - it does not even follow the branch, as Buildroot anyway generates
    a local tarball, which it will reuse on subsequent builds.
    Furthermore, since we fetch and not pull, any existing local branch
    is not updated.

Yet, until recently, using a branch name would just work (with the
above limitations): the git tree was cloned, the branch checked out,
and the tarball created.

But with the advent of the git caching, using a branch name does not
work anymore. Indeed, we now do a git-fetch, and that does not create
a local master branch. So we can't check out master, because it does
not exist locally. And for other branches, as noticed above, the local
branch does not get udpated to the remote one.

Furthermore, the local branches are only created by chance, again as a
side-effect of trying to fetch the "special refs".

So, we can't say that we reliably support the use of a branch name.

Update the manual to state that using a branch does not work. Remove
the 'stable' example, as it looked like the name of a stable branch;
instead, replace it with a version string that ressemble a tag.

Fix the layout of the manual by making the version examples an actual
bulleted list.

Note: the above is only entirely true for git. For Mercurial, CVS and
subversion, the status may be mixed, but nonetheless, using branches is
still a bad idea, if at least because it is not reproducible, and
because Buildroot does not even follow the branch. So, we do not
differentiate between the various SCMs, and just flatly state that using
a branch name is not supported.

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>
Cc: Peter Korsgaard <peter@korsgaard.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-05-11 23:03:21 +02:00
Thomas Petazzoni
b73e9e3d21 docs/website: update news.html for 2018.05-rc1
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-05-09 23:18:26 +02:00
Thomas Petazzoni
b19e24b9f7 Update for 2018.05-rc1
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-05-09 23:00:18 +02:00
Peter Korsgaard
77e0ec697a docs/website: update for 2018.02.2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-05-04 19:15:31 +02:00
Thomas Petazzoni
38860fb21f package/pkg-generic: add check that target variant is defined before host variant
Update the documentation accordingly.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
[yann.morin.1998@free.fr: slight rephrasing in error message, update manual]
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2018-04-30 17:43:49 +02:00
Peter Korsgaard
476243ac3d website: footer.html: really use version 1.7.1 of clipboard.js
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-04-28 10:44:09 +02:00
Peter Korsgaard
f26e61319f docs/website: add favicon.png
The website advertises a favicon in PNG format, but we don't actually
provide one. From docs/website/header.html:

<link rel="shortcut icon" href="images/favicon.png">

So add one. Generated by:

convert -geometry 32x32!  docs/website/images/logo_small.png \
  docs/website/favicon.png

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2018-04-28 09:31:33 +02:00