mirror of
https://gitlab.com/buildroot.org/buildroot.git
synced 2026-09-09 16:01:54 -09:00
4f59ababc0
The doc-asciidoc infra allows document to define sources and resources, and those can only be local (there is no download support for documents). The currently documented way to specify those is to use the $(pkgdir) macro to point to the document sources and resources when they are along the .mk. However, this works only for sources and not for resources. Indeed, sources are used to generate Makefile dependency rules, so $(pkgdir) is expanded and evaluated during the call to $(doc-asciidoc), while resources are expanded and evaluated when the rules are executed, which always happen after all the parsing has be done, at which point $(pkgdir) expands to the last Makefile that was parsed, which is always Buildroot's own manual. This went unnoticed so far because Buildroot's manual is 1) the last to be parsed, and 2) not using $(pkgdir) anyway. Additionally, $(pkgdir) is mostly an internal macro, that is, as this change demonstrates, difficult to use, and thus should not be used, in packages or in documents. We fix that by introducing $(FOO_DOCDIR), similar to $(FOO_PKGDIR), which points to the document directory. We choose not to name the variable FOO_PKGDIR, because it semantically is not a package. As a consequence, the last argument to the doc-asciidoc macro is now superfluous, so it is removed, which causes a little bit of churn in the main macro. As a further consequence, the third argument in the inner macro is no longer needed either, so it too is removed, which causes a bit more churn yet in the inner macro. Signed-off-by: Yann E. MORIN <yann.morin@orange.com> Cc: Frederic GARDES <frederic.gardes@orange.com> Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Buildroot is a simple, efficient and easy-to-use tool to generate embedded Linux systems through cross-compilation. The documentation can be found in docs/manual. You can generate a text document with 'make manual-text' and read output/docs/manual/manual.text. Online documentation can be found at http://buildroot.org/docs.html To build and use the buildroot stuff, do the following: 1) run 'make menuconfig' 2) select the target architecture and the packages you wish to compile 3) run 'make' 4) wait while it compiles 5) find the kernel, bootloader, root filesystem, etc. in output/images You do not need to be root to build or run buildroot. Have fun! Buildroot comes with a basic configuration for a number of boards. Run 'make list-defconfigs' to view the list of provided configurations. Please feed suggestions, bug reports, insults, and bribes back to the buildroot mailing list: buildroot@buildroot.org You can also find us on #buildroot on OFTC IRC. If you would like to contribute patches, please read https://buildroot.org/manual.html#submitting-patches