Commit Graph

1497 Commits

Author SHA1 Message Date
Brandon Maier
69f4ee8c5a docs/website: fix favicon
When the favicon image was added in f26e61319f (docs/website: add
favicon.png), it was added to a different directory then where the header's
icon link points. This causes the favicon to fail to load with 404.

While we are here, remove the "shortcut" rel attribute as it is non-standard
and it's recommended not to use it[1].

[1] https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel#sect4

Signed-off-by: Brandon Maier <brandon.maier@collins.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
(cherry picked from commit 8ad1a2eaa5fa6c5eaa6614b007b968223e49448e)
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-11-30 23:41:46 +01:00
Peter Korsgaard
83b09400dd utils/add-custom-hashes: add script to manage global patch dir hashes
Add a script to manage the .hash files in the BR2_GLOBAL_PATCH_DIR for
packages using custom versions.

To use it, run in a configured Buildroot directory, E.G.

  make foo_defconfig; ./utils/add-custom-hashes

We support multiple patch directories in BR2_GLOBAL_PATCH_DIR.  If multiple
directories are specified then use the last one as that is likely to be the
most specific one.

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
[Peter: silence command -v invocation]
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
(cherry picked from commit 4984d0f230d0962270beb195966603f1d5a56300)
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-11-13 19:52:52 +01:00
Yann E. MORIN
106a8d940f package/pkg-download: lookup hash files in global-patch-dir
Currently, we expect and only use hash files that lie within the package
directory, alongside the .mk file. Those hash files are thus bundled
with Buildroot.

This implies that only what's known to Buildroot can ever get into those
hash files. For packages where the version is fixed (or a static
choice), then we can carry hashes for those known versions.

However, we do have a few packages for which the version is a free-form
entry, where the user can provide a custom location and/or version.  like
a custom VCS tree and revision, or a custom tarball URL. This means that
Buildroot has no way to be able to cary hashes for such custom versions.

This means that there is no integrity check that what was downloaded is
what was expected. For a sha1 in a git tree, this is a minor issue,
because the sha1 by itself is already a hash of the expected content.
But for custom tarballs URLs, or for a tag in a VCS, there is indeed no
integrity check.

Buildroot can't provide such hashes, but interested users may want to
provide those, and currently there is no (easy) way to do so.

We leverage the existing global-patch-dir mechanism to look for extra
hash files. We use the same heuristic that is used for bundled hash
files, and for each global patch directory <dir>, we use the first file
to exist among:
 1. look into <dir>/<package>/<version>/<package>.hash
 2. look into <dir>/<package>/<package>.hash

Reported-by: "Martin Zeiser (mzeiser)" <mzeiser@cisco.com>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
(cherry picked from commit 5d36710e36fc4698c8fae71675bcff7395246006)
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-11-10 14:30:00 +01:00
Yann E. MORIN
cf635737ed docs/manual: svn downloads can be hash-checked
Since commit 89f5e98932 (support/download/svn: generate reproducible
svn archives), we've been able to generate reproducible archives, and
thus we have been able to verify the hashes for those archives.

However, the manual was not changed, and still falsely hinted that this
was not the cae.

Fix that.

Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
(cherry picked from commit 6898781f03140e301196a533953a202751be2f59)
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-11-09 18:22:10 +01:00
Giulio Benetti
175260e1e7 docs/manual: add section to explain how to give credits to a sponsor
Sometimes it happens that a Company or a Physical Person sponsors the
creation and/or the upstreaming process of a patch, but at the moment
there is no way to give credits to it. In Linux they prepend '+sponsor'
to the e-mail of the contributor in both authorship and commit log tag as
discussed here[0]. So let's describe in the manual how to do that as a
standard.

[0]: https://lore.kernel.org/linux-doc/20230817220957.41582-1-giulio.benetti@benettiengineering.com/

Signed-off-by: Giulio Benetti <giulio.benetti@benettiengineering.com>
[yann.morin.1998@free.fr:
  - reword to reference sub-addressing and the RFC
  - move to the "submitting patches" section, that already deals with
    SoB tags
  - differentiate between Your/Their names
]
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
(cherry picked from commit de349df08c653a822166f94dbe01295a5a3cfa6e)
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-09-26 09:55:16 +02:00
Peter Korsgaard
d8ce1deff9 Update for 2023.08
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-09-06 21:54:35 +02:00
Peter Korsgaard
fbcc1bf533 docs/website: Update for 2023.02.4
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-08-31 21:30:47 +02:00
Peter Korsgaard
1f137a03ea docs/website: Update for 2023.05.2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-08-31 20:28:40 +02:00
Peter Korsgaard
04bc804630 Update for 2023.08-rc3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-08-29 15:00:27 +02:00
Peter Korsgaard
bdd80863cf Update for 2023.08-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-08-20 23:37:21 +02:00
Thomas Petazzoni
0473a9b521 Update for 2023.08-rc1
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2023-08-05 23:03:28 +02:00
Peter Korsgaard
a89a632833 docs/website: Update for 2023.02.3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-07-17 23:41:31 +02:00
Peter Korsgaard
6c8abbf72f docs/website: Update for 2023.05.1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-07-17 18:14:13 +02:00
Peter Korsgaard
ba9de70c28 docs/website: update for 2023.02.2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-06-16 17:50:29 +02:00
Peter Korsgaard
35b1ddbe63 docs/website/news.html: add 2023.05 announcement link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-06-07 23:32:45 +02:00
Peter Korsgaard
dbb0b4274c Update for 2023.05
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-06-07 23:07:39 +02:00
Peter Korsgaard
25e485f462 Update for 2023.05-rc3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-06-04 13:10:30 +02:00
Peter Korsgaard
c765ac9c02 Update for 2023.05-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-05-28 22:17:33 +02:00
Peter Korsgaard
fb6fe5ddf6 Update for 2023.05-rc1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-05-15 08:05:54 +02:00
Peter Korsgaard
19f5a10f49 docs/website: update for 2023.02.1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-05-10 22:34:29 +02:00
Peter Korsgaard
e320dd681c docs/website: update for 2022.02.12
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-05-04 22:53:11 +02:00
Yann E. MORIN
4468f82885 doc/manual: fix formatting slightly
Signed-off-by: Thierry GUIBERT <thierry.guibert@croix-rouge.fr>
[yann.morin.1998@free.fr: split off the previous patch by Thierry]
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2023-04-16 14:33:42 +02:00
Thierry GUIBERT
d9228faa4d doc/manual: add documentation about docker registry on gitlab.com
Add a paragraph and an example about using the Buildroot image registry
hosted on gtilab.com, for people who want to build their own image based
on the offical one.

Signed-off-by: Thierry GUIBERT <thierry.guibert@croix-rouge.fr>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2023-04-16 14:32:29 +02:00
Vincent Fazio
5b00b40a05 docs/manual: rewrite section for upstream documentation
Previously, the documentation only requested links to upstream commits
when backporting patches.

Based on a mailing list discussion [0], patches should, when possible
and when approriate, provide a link as evidence that the patch has been
submitted upstream.

The motivation is that hopefully the patch gets applied to upstream at
some point reducing the long term maintenance burden within Buildroot.
This also makes future patch review on subsequent package version bumps
more streamlined.

For patches that are unique to BR and do not apply to the upstream
repository, patches should have a comment explaining why they do not
apply upstream.

[0] https://lists.buildroot.org/pipermail/buildroot/2023-March/666000.html

Signed-off-by: Vincent Fazio <vfazio@gmail.com>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2023-04-15 19:36:46 +02:00
Yann E. MORIN
7c01d5a1bb doc/website: tap2open have sponsored the association again
.. so update and move their entry in the sponsors page.

Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2023-04-13 22:27:38 +02:00
Yann E. MORIN
6a6a11f64b package/doc-asciidoc: allow docs to request a specific TOC depth
For some documents, we may want a terse or deeper TOC depth. For
example, short documents may want just the level-0 in the TOC, while
longer documents may want depth 1 or 2, or even deeper; also, some
documents may not use the document-title levels [0], only section
levels [1], and so may want to increase the TOC depth.

Additionally, allow per-format depth. For example, split-html has a
single page dedicated to the TOC, so there we may want a deeper TOC,
while on the html output, where the TOC is on the same page as the
whole document, a shorter TOC is preferred.

[0] https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#document-header
[1] https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#section-titles

Signed-off-by: Yann E. MORIN <yann.morin@orange.com>
Signed-off-by: Arnout Vandecappelle <arnout@mind.be>
2023-04-10 21:49:22 +02:00
Luca Ceresoli
9a3d4e3818 docs/manual: ditch redundant -f 'rm' flag
The value of the RM variable in make is 'rm -f' [0], thus the additional
-f is redundant. Avoid it on the docs to avoid developers taking it as a
good example to follow.

[0] https://www.gnu.org/software/make/manual/make.html#index-RM

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2023-03-28 21:36:07 +02:00
Vincent Fazio
2bc95879f7 manual: drop LIBFOO_GETTEXTIZE, add LIBFOO_AUTOPOINT
Signed-off-by: Vincent Fazio <vfazio@gmail.com>
Signed-off-by: Arnout Vandecappelle <arnout@mind.be>
2023-03-25 21:56:19 +01:00
Vincent Fazio
067a69412a manual: remove LIBFOO_GETTEXTIZE_OPTS
Signed-off-by: Vincent Fazio <vfazio@gmail.com>
Signed-off-by: Arnout Vandecappelle <arnout@mind.be>
2023-03-25 21:22:10 +01:00
Peter Korsgaard
48781ec960 docs/website: update for 2022.02.11
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-03-19 14:58:53 +01:00
Peter Korsgaard
e39cbef783 docs/website: update for 2022.11.3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-03-19 14:58:53 +01:00
Peter Korsgaard
c53258975a docs/website/news.html: add 2023.02 announcement link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-03-12 21:59:33 +01:00
Peter Korsgaard
8cca1e6de1 Update for 2023.02
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-03-12 21:20:41 +01:00
Peter Korsgaard
50d3883fba Update for 2023.02-rc3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-03-08 22:53:48 +01:00
Peter Korsgaard
61f1601536 docs/website: update for 2022.02.10
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-03-01 22:44:02 +01:00
Peter Korsgaard
8b5253b1c0 docs/website: update for 2022.11.2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-03-01 21:26:45 +01:00
Peter Korsgaard
debec267fc Update for 2023.02-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-02-27 17:43:10 +01:00
Peter Korsgaard
e8c4b360fd Update for 2023.02-rc1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-02-20 21:13:02 +01:00
Arnout Vandecappelle
c77e31e0b3 docs/manual: add 'menuconfig' to out-of-tree examples
If the examples given for launching an out-of-tree build are executed
as-is, this will result in the error message

    Please configure Buildroot first (e.g. "make menuconfig")

Even if "make menuconfig" was run before, it's still not going to work
because the out-of-tree build doesn't use the in-tree .config.

Therefore, the example really should start with some config option.
Since "make menuconfig" is used in most other examples of creating a
config, use that here as well. Extend both examples with "menuconfig".

Reported-by: AndreiCherniaev <dungeonlords789@yandex.ru>
Signed-off-by: Arnout Vandecappelle <arnout@mind.be>
2023-02-15 22:28:58 +01:00
Ricardo Martincoski
efccb2a7dd docs/manual: check-package before submitting patch
Add 'utils/docker-run make check-package' to the default workflow of
submitting patches, just after the rebase and before using format-patch.

Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
Cc: Romain Naour <romain.naour@gmail.com>
Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2023-02-06 18:54:18 +01:00
Angelo Compagnucci
101b05a374 docs/website: better recent commits/discussions output
Removing the "[Buildroot]" and the "Re:" from messages title to have a
cleaner look on the "news" boxes.

Signed-off-by: Angelo Compagnucci <angelo@amarulasolutions.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2023-02-06 11:59:03 +01:00
Angelo Compagnucci
ca97c78ee0 docs/website: fixing js for the new feed source
Feed source is moved to a local atom file available on the web server to
remove further problems with unreliable feed sources.
Moving the feed required a bit of refactor of the load_activity function
so it won't download two times te same url.

This change requires a cron job like this enabled on the website:
* * * * * wget -O new.atom https://lore.kernel.org/buildroot/new.atom

Signed-off-by: Angelo Compagnucci <angelo@amarulasolutions.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2023-02-06 10:51:28 +01:00
Peter Korsgaard
a8447f17b8 docs/website: update for 2022.02.9
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-01-18 17:57:30 +01:00
Peter Korsgaard
281e51f00b docs/website: update for 2022.11.1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-01-18 17:53:51 +01:00
Peter Korsgaard
f1d7155952 Cleanup/simplify copyright info
Historically we have been (more-or-less consistently, sometimes forgetting
some files) updating the end year of the copyright statements at the
beginning of a new year.

We're naturally not alone in that.  Recently this was discussed in curl, and
it turns out that copyright years are not really required:

https://daniel.haxx.se/blog/2023/01/08/copyright-without-years/

So drop the years and simplify the copyright statements.  While we're at it,
also ensure the same syntax (capital C, email address) is used everywhere.

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2023-01-14 21:16:07 +01:00
Thomas Petazzoni
fce9f0eea0 docs/website: update sponsors.html page
- Thank Smile for sponsoring the Buildroot Developers Meeting of
  February 2023 by providing the meeting room

- Thank Armadeus and Logilin for their financial sponsoring in 2022

- Move older sponsors to the "Past sponsors" section

- Remove section about the Buildroot.org domain sponsor, as that
  sponsoring ended in 2019.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2023-01-11 22:21:11 +01:00
Peter Korsgaard
8de04b2cb6 docs/website: update for 2022.02.8
The announcement mail didn't make it to the mailman archive, so use the lore
link instead.

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-12-10 20:59:24 +01:00
Peter Korsgaard
21321a9836 docs/website/news.html: add notice about 2022.08.3 release
The announcement mail didn't make it to the mailman archive, so use the lore
link instead.

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-12-10 20:55:34 +01:00
Peter Korsgaard
45c6747fae docs/website/news.html: add 2022.11 announcement link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-12-05 08:59:51 +01:00
Peter Korsgaard
40bd4a32aa Update for 2022.11
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-12-05 08:23:19 +01:00