529219ba96
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>
72 lines
1.3 KiB
Plaintext
72 lines
1.3 KiB
Plaintext
// -*- mode:doc; -*-
|
|
// vim: set syntax=asciidoc:
|
|
|
|
= The Buildroot user manual
|
|
:toc:
|
|
|
|
Buildroot {sys:echo $\{BR2_VERSION%%-git*\}} 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) 2004-2018 The Buildroot developers
|
|
|
|
image::logo.png[]
|
|
|
|
= Getting started
|
|
|
|
include::introduction.txt[]
|
|
|
|
include::prerequisite.txt[]
|
|
|
|
include::getting.txt[]
|
|
|
|
include::quickstart.txt[]
|
|
|
|
include::resources.txt[]
|
|
|
|
= User guide
|
|
|
|
include::configure.txt[]
|
|
|
|
include::configure-other-components.txt[]
|
|
|
|
include::common-usage.txt[]
|
|
|
|
include::customize.txt[]
|
|
|
|
include::faq-troubleshooting.txt[]
|
|
|
|
include::known-issues.txt[]
|
|
|
|
include::legal-notice.txt[]
|
|
|
|
include::beyond-buildroot.txt[]
|
|
|
|
= Developer guide
|
|
|
|
include::how-buildroot-works.txt[]
|
|
|
|
include::writing-rules.txt[]
|
|
|
|
include::adding-board-support.txt[]
|
|
|
|
include::adding-packages.txt[]
|
|
|
|
include::patch-policy.txt[]
|
|
|
|
include::download-infra.txt[]
|
|
|
|
include::debugging-buildroot.txt[]
|
|
|
|
include::contribute.txt[]
|
|
|
|
include::developers.txt[]
|
|
|
|
= Appendix
|
|
|
|
include::appendix.txt[]
|