The behaviour of asciidoc on my laptop (Debian 10.2.0-1) changed at the end of last year, causing the BR2_VERSION logic to no longer work: grep 'manual generated' buildroot-2023.02.*/docs/manual/manual.text buildroot-2023.02.6/docs/manual/manual.text:Buildroot 2023.02.6 manual generated on 2023-10-16 08:41:26 UTC from buildroot-2023.02.7/docs/manual/manual.text:Buildroot ${BR2_VERSION%%-git*} manual generated on 2023-11-14 buildroot-2023.02.8/docs/manual/manual.text:Buildroot ${BR2_VERSION%%-git*} manual generated on 2023-12-04 We don't really NEED to strip the -git suffix; indeed, for a git tag, there would be not -git suffix, while for any other commit there will be one and we want to see it (e.g. in the nightly manual, or on a development branch locally). So just drop that to unbreak the version output. Signed-off-by: Peter Korsgaard <peter@korsgaard.com> [yann.morin.1998@free.fr: explain why wew don't want to drop it] Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr> (cherry picked from commit ec270a08150980e37e36eeb43f4471ed8f7d662e) Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
76 lines
1.4 KiB
Plaintext
76 lines
1.4 KiB
Plaintext
// -*- mode:doc; -*-
|
|
// vim: set syntax=asciidoc:
|
|
|
|
= The Buildroot user manual
|
|
:toc:
|
|
|
|
Buildroot {sys:echo $BR2_VERSION} manual generated on {localdate}
|
|
{localtime} from git revision {sys:git rev-parse --short HEAD}
|
|
|
|
The Buildroot manual is written by the Buildroot developers.
|
|
It is licensed under the GNU General Public License, version 2. Refer to the
|
|
http://git.buildroot.org/buildroot/tree/COPYING?id={sys:git rev-parse HEAD}[COPYING]
|
|
file in the Buildroot sources for the full text of this license.
|
|
|
|
Copyright (C) The Buildroot developers <buildroot@buildroot.org>
|
|
|
|
image::logo.png[]
|
|
|
|
= Getting started
|
|
|
|
include::introduction.adoc[]
|
|
|
|
include::prerequisite.adoc[]
|
|
|
|
include::getting.adoc[]
|
|
|
|
include::quickstart.adoc[]
|
|
|
|
include::resources.adoc[]
|
|
|
|
= User guide
|
|
|
|
include::configure.adoc[]
|
|
|
|
include::configure-other-components.adoc[]
|
|
|
|
include::common-usage.adoc[]
|
|
|
|
include::customize.adoc[]
|
|
|
|
include::integration.adoc[]
|
|
|
|
include::faq-troubleshooting.adoc[]
|
|
|
|
include::known-issues.adoc[]
|
|
|
|
include::legal-notice.adoc[]
|
|
|
|
include::beyond-buildroot.adoc[]
|
|
|
|
= Developer guide
|
|
|
|
include::how-buildroot-works.adoc[]
|
|
|
|
include::writing-rules.adoc[]
|
|
|
|
include::adding-board-support.adoc[]
|
|
|
|
include::adding-packages.adoc[]
|
|
|
|
include::patch-policy.adoc[]
|
|
|
|
include::download-infra.adoc[]
|
|
|
|
include::debugging-buildroot.adoc[]
|
|
|
|
include::contribute.adoc[]
|
|
|
|
include::developers.adoc[]
|
|
|
|
include::release-engineering.adoc[]
|
|
|
|
= Appendix
|
|
|
|
include::appendix.adoc[]
|