Commit Graph

1478 Commits (e98b07dedee7fc80c58b10b4a0b2a6ad57f3bb62)

Author SHA1 Message Date
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
Zikui Zhao a34dcba9eb docs/manual: fixed some spelling mistakes
Fixed some spelling mistakes of countable nouns.

Signed-off-by: Zikui Zhao <zhaozikui@eswincomputing.com>
Reviewed-by: Woodrow Douglass <wdouglass@carnegierobotics.com>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2022-12-02 20:41:13 +01:00
Peter Korsgaard 269c1e9368 Update for 2022.11-rc3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-11-24 17:47:01 +01:00
Peter Korsgaard dd72799739 docs/website: update for 2022.02.7
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-11-17 15:18:33 +01:00
Peter Korsgaard bc9b716296 docs/website: update for 2022.08.2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-11-17 08:29:20 +01:00
Peter Korsgaard 90f2700c09 Update for 2022.11-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-11-16 13:58:00 +01:00
Peter Korsgaard aa8903447c Update for 2022.11-rc1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-11-03 16:50:49 +01:00
Peter Korsgaard 959610fd79 docs/website/news.html: fix 2022.08.1 entry
This was naturally about 2022.08.1, NOT 2022.05.1.

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-11-03 16:48:05 +01:00
Peter Korsgaard 84b29a3941 docs/website: update for 2022.08.1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-10-03 08:52:43 +02:00
Peter Korsgaard 2572faace9 docs/website: update for 2022.02.6
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-10-02 23:05:31 +02:00
Peter Korsgaard c57ee9d7cf docs/website/news.html: add 2022.05.3 announcement
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-10-02 18:45:02 +02:00
Peter Korsgaard 446fb4f170 docs/website/news.html: add 2022.08 announcement link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-09-10 17:44:02 +02:00
Peter Korsgaard 0003fdbed3 Update for 2022.08
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-09-10 17:00:09 +02:00
Peter Korsgaard 1c0da88a83 Update for 2022.08-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-09-01 10:19:48 +02:00
Peter Korsgaard 02104e86cc docs/website: update for 2022.02.5
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-09-01 00:05:37 +02:00
Peter Korsgaard 0f2c0c24d3 docs/website/news.html: correct 2022.05.1 entry
This was naturally 2022.05.1, NOT 2021.05.1.

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-08-31 21:09:42 +02:00
Peter Korsgaard 5fddfefb3f docs/website: update for 2022.05.2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-08-31 21:09:15 +02:00
Julien Olivain 5ac1b1866d docs/manual: patch subjects shall not be numbered
The script "utils/check-package" checks that patch email prefix are
not be numbered. See:
https://git.buildroot.org/buildroot/tree/utils/checkpackagelib/lib_patch.py?h=2022.08-rc1#n42

The error message recommends to generate patches to be included in
Buildroot with the command 'git format-patch -N'.

The patch policy section in the Buildroot manual does mention that.

This commit adds a note about that requirement.

Signed-off-by: Julien Olivain <ju.o@free.fr>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2022-08-28 11:51:23 +02:00
Julien Olivain 7652817c93 docs/manual/prerequisite.txt: add findutils in dependencies
The "find" and "xargs" commands, from the "findutils" package are used
during the build process. See for example [1].

Even if it's a quite common package which is almost sure to be present
on the host, it should be listed here. When writing new recipes, hooks
and scripts, it is generally safe and portable to restrict to the
host dependencies listed in those prerequisites.

This commit just add the missing "findutils" package in this list.

[1] https://git.buildroot.org/buildroot/tree/Makefile?h=2022.05.1#n737

Signed-off-by: Julien Olivain <ju.o@free.fr>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2022-08-15 22:21:33 +02:00
Thomas Petazzoni a09e9f0c18 Update for 2022.08-rc1
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2022-08-12 21:31:20 +02:00