summaryrefslogtreecommitdiffstats
path: root/docs/manual/manual.mk
Commit message (Collapse)AuthorAgeFilesLines
* docs/asciidoc: make it possible to use $(@D) in hooksYann E. MORIN2014-10-121-1/+1
| | | | | | | | | | | | | | | | | Currently, it is not possible to use $(@D) in documents' hooks, because there is no actual target file for the copying rule. So, use the same mechanism as for generic-package. We do not touch the target file, so it is easy to regenerate the manual without calling the -clean rule first. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs: rename the GENDOC infrastructureYann E. MORIN2014-10-121-1/+1
| | | | | | | | | | | | Rename the GENDOC infrastructure so that it more closely matches the way we handle the packages infras. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs: separate the GENDOC infra from our manual definitionYann E. MORIN2014-10-121-150/+1
| | | | | | | | | | | | | | | | | | | Move the GENDOC infra to its own file, so it is even less tied to our manual document, so that it is more obvious that GENDOC is an infra like our packages infras, and 'manual' is a document like we have packages. Ideally, this new file should better go in docs/ rather than in package/ . However, docs/ is already full of our website stuff, so adding it in there would just serve to clutter the website. So, let's just put alongside the other infrastructures, in package/ . Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: always look for resources in destination directoryYann E. MORIN2014-10-121-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | Our manual does not use external filters in asciidoc, so we are happy with just looking for resources from our source tree. However, other documents (like ones in br2-external) may use such filters, to generate diagrams, graphs... External filters generate their output files in the output directory, so we must also look for resources in there. Note: external filters in asccidoc are used thus: ["filter-name"] ---- Text to be rendered ---- In the future, our own manual may even make use of filters to include some of the graphs we generate, to store in the documentation. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: use the new hooks instead of gendoc rulesYann E. MORIN2014-10-121-7/+10
| | | | | | | | | | | | Also reorder a bit the definition of the variables, to more resemble a package. Yet a bit more... Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: allow documents to define some hooks, as for a packageYann E. MORIN2014-10-121-2/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Allow documents to define two hooks: - DOC_CHECK_EXTRA_DEPENDENCIES_HOOKS to check for extra dependencies required by this document - DOC_CHECK_EXTRA_DEPENDENCIES_FMT_HOOKS ditto, but for the specific format - DOC_POST_EXTRACT_HOOKS: to run additional actions to fill-in the build directory (Replace 'DOC' with the uppercase name of the document, and 'FMT' with the format.) This is supposed to replace the current use of overloading the internal dependency rules, and makes GENDOC behave yet a bit more like the package infrastructure. Note that GENDOC_INNER already has the uppercase name as an argument, whereas GENDOC does not, so the two foreach loops are not exactly similar (for now.) Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Acked-by: Thomas De Schampheleire <patrickdepinguin@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: rename the generic dependency rulesYann E. MORIN2014-10-121-3/+6
| | | | | | | | | | | | | | | | | | Those rules are generic, and not specific to our manual, we want them always called: - manual-check-dependencies - manual-check-dependencies-pdf So, rename them to be generic to gendoc. Cascade the document's dependency checking to call those rules, too. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: properly separate rules specific for our manualYann E. MORIN2014-10-121-18/+23
| | | | | | | | | | | | | | Move the rules specific to our own manual, so that they do not interfere with the generic rules of GENDOC. Separate them with a shiny header. ;-) Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: last pass at removing hard-coded path in GENDOC_INNERYann E. MORIN2014-10-121-34/+40
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | GENDOC_INNER still has one hard-coded path to the document's directory: the asciidoc .conf files. Add a new argument to GENDOC_INNER to pass the directory of the document. Notes: - this makes for overly-long lines, but splitting is not possible, otherwise the first argument on the continuation line would get (at least) a leading space or tab, and that would break either or all of the variables names, the dependency rules, or the filenames we look for. A future patch will further clean this up (see: docs/asciidoc: call $(pkgname) and $(pkgdir) in a single place.) - this means that another document would be missing our tweaks from asciidoc-text.conf to not render images and sanely render hyperlinks. But that was already the case anyway, since we were using docs/$(1)/ to search for that file. A further patch will allow us to have such configuration in a common place. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: allow a document to declare where its resources areYann E. MORIN2014-10-121-1/+5
| | | | | | | | | | | | Avoids hard-coding document's resources in GENDOC_INNER, so we can generate another document with different resources (if any). Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: do not hardcode name of the generated documentYann E. MORIN2014-10-121-46/+47
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Currently, GENDOC_INNER hard-codes some variables to have the name of the document in them: MANUAL_$(2)_ASCIIDOC_CONF MANUAL_$(2)_ASCIIDOC_OPTS MANUAL_$(2)_A2X_OPTS MANUAL_$(2)_INSTALL_CMDS ... Also, it defines some dependency on the generation rule, onto: manual-check-dependencies manual-check-dependencies-$(3) manual-prepare-sources This is problematic, as it is not possible to have another document generated with the GENDOC infra, or it would trigger the rules, and use the variables for our own document, 'manual'. Add a new argument to GENDOC_INNER to be the uppercase name of the document, much like it is done for the PKG_*_INNER functions. Replace any reference to 'manual' with the currently passed named of the current document, $(1). The remaining references to 'manual' are on purpose, as they really pertain to our manual. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: move manual-prepare-sources rule into GENDOCYann E. MORIN2014-10-121-1/+3
| | | | | | | | | | | | | Copying the document's source files is a generic GENDOC action, that will be common to all documents, so the dependency rule should be handled in GENDOC, rather than letting all documents duplicate it. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: manual-update-lists is not a generic GENDOC ruleYann E. MORIN2014-10-121-1/+2
| | | | | | | | | | | | Move the manual-update-lists .PHONY declaration out of GENDOC, since not all the documents may have an -update-lists rule. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: simplify generation dependenciesYann E. MORIN2014-10-121-2/+1
| | | | | | | | | | | | The document's main file is already part of MANUAL_SOURCES, so no need to explicitly depend on it. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: copying the manual sources is a common actionYann E. MORIN2014-10-121-7/+7
| | | | | | | | | | | | | | | Move the creation of $(BUILD_DIR)/manual and the rsyncing of the sources into GENDOC. This is is needed so that GENDOC can be easily used to generate another document, without requiring that document to duplicate the copying rules. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: get rid of legacy comment in GENDOCYann E. MORIN2014-10-121-3/+0
| | | | | | | | | | | | | | Since dd935d6 (gendoc infra: use $(pkgname) instead of explicitly passing 'manual', the GENDOC infra no longer expect any argument. Remove the stray comment. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* gendoc infra: disable pdf manual generation if xsltproc is buggySamuel Martin2014-10-121-1/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The PDF manual generation reaches the default xsltproc's template recursion limit when processing the target package list; this makes the PDF manual generation fail [1-3]. This limit can be raised with the '--maxvars' option. Unfortunately, this option is not correctly handled in the latest xsltproc/libxslt release (1.1.28), but this bug is already fixed in the libxslt repository [4]. This patch disables the PDF manual generation (makes it warn with a meaningful error message) when the xsltproc program found in the PATH does not support the --maxvars option. So, one can still generate the PDF manual if he/she extends PATH with the location of a working xsltproc, by running: $ PATH=/path/to/custom-xsltproc/bin:${PATH} make manual-pdf [1] http://lists.busybox.net/pipermail/buildroot/2014-August/104390.html [2] http://lists.busybox.net/pipermail/buildroot/2014-August/104418.html [3] http://lists.busybox.net/pipermail/buildroot/2014-August/104421.html [4] https://gitorious.org/libxslt/libxslt/commit/5af7ad745323004984287e48b42712e7305de35c Reported-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> [yann.morin.1998@free.fr: move the assignment block out of GENDOC_INNER, no need to retest for each type of each document: it's always the same answer; make it a warning as per Thomas DS. suggestion] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* gendoc infra: avoid a2x warningSamuel Martin2014-10-121-1/+16
| | | | | | | | | | | | | | | | | | Though the --destination-dir option works as expected, a2x displays the following message when generating the pdf and text manual: a2x: WARNING: --destination-dir option is only applicable to HTML based outputs To avoid this warning, we now just build the manual in its build location, then move the generated files into $(O)/docs/manual. Reported-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> [yann.morin.1998@free.fr: tested all but PDF] Tested-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* gendoc infra: move manual build location into $(BUILD_DIR)/docs/manualSamuel Martin2014-10-121-8/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch reworks the manual source preparation by: - moving the build directory under $(BUILD_DIR)/, this keeps consistency with the other Buildroot infrastructures; - adding a couple of targets: 'manual-rsync' and 'manual-prepare-sources', to deal more efficiently with the manual sources and avoid rsync-ing them on every single manual-* target. The 'manual-rsync' target only copies the manual sources under git, while the 'manual-prepare-sources' also takes care of the generated ones. These targets are now run only once, and the manual build is no longer cleaned after each manual format generation. Now, the 'manual-clean' target only remove the manual build directory, but keeps the output one $(O)/output/doc/manual unchanged. Doing so (moving the manual build directory and keeping it between 2 manual format generation) ensures that all generated sources are taken in account when generating the manual [1]. [1] http://lists.busybox.net/pipermail/buildroot/2014-August/104421.html Cc: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> [yann.morin.1998@free.fr: moved into $(BUILD_DIR)/docs/manual as per Thomas P. suggestion] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* gendoc infra: cosmetic fixesSamuel Martin2014-09-211-5/+8
| | | | | | | | | | | | - wrap lines to 80 characters - fix space/tab mixup Signed-off-by: Samuel Martin <s.martin49@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> [yann.morin.1998@free.fr: tested all but PDF] Tested-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: high-level restructuringThomas De Schampheleire2014-08-171-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | The structure of the buildroot manual is not always clear. There is a large number of chapters, and some chapters seem to overlap. The distinction between general usage and developer information is not always clear. This patch restructures the manual into four large parts: - getting started - user guide - developer guide - appendix Except for the names of these parts, the section names are not yet changed. Content-wise there are no changes yet either. This will be handled in subsequent patches. In order to achieve the introduction of a new level 'parts' above 'chapters', the section indicators (=, ==, ===, ...) of several sections have to be moved one level down. Additionally, the leveloffset indication to asciidoc has to be removed. Finally, to maintain more or less the same level of detail in the table of contents, the toc.section.depth attribute is reduced as well. Note that for some sections, less detail is visible now. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* gendoc infra: add support for asciidoc configuration filesThomas De Schampheleire2014-08-161-1/+7
| | | | | | | | | | | | | | | This patch introduces support for asciidoc configuration files, specific for each output format (html, text, pdf, ...). This is useful to make certain tweaks in the document generation. If a file docs/manual/asciidoc-<format>.conf is present, it is passed to asciidoc as configuration file. If no file for the current format is present, the options passed to asciidoc are empty. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* gendoc infra: use $(pkgname) instead of explicitly passing 'manual'Thomas De Schampheleire2014-08-161-10/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | In the gendoc infrastructure, using an assignment of the form FOO = docs/$(1)/bar inside GENDOC_INNER does not work as expected: the $(1) value is empty here and the value of FOO becomes 'docs//bar'. Parameters $(2), $(3), etc. do not have this problem. The specific thing about $(1) is that it is a parameter to GENDOC itself (indicating the document to create) and passed transparently to GENDOC_INNER. This is different from the package infrastructures, where $(1) is set from $(pkgname). In fact, the same strategy could be used by the gendoc infrastructure as well, as $(pkgname) resolves to 'manual' for file docs/manual/manual.mk. This has the advantage that the described problem does not occur. Note that this means that if we want to use the same GENDOC infrastructure for another document, it will have to reside in a separate directory than the manual. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Tested-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* infra: consistently use double dollar signs inside inner-xxx-targetsThomas De Schampheleire2014-06-141-9/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The inner-xxx-targets in the buildroot package infrastructures are evaluated using $(eval) which causes variable references to be a bit different than in regular make code. As we want most references to be expanded only at the time of the $(eval) we should not use standard references $(VAR) but rather use double dollar signs $$(VAR). This includes function references like $(call), $(subst), etc. The only exception is the reference to pkgdir/pkgname and numbered variables, which are parameters to the inner block: $(1), $(2), etc. This patch introduces consistent usage of double-dollar signs throughout the different inner-xxx-targets blocks. In some cases, this would potentially cause circular references, in particular when the value of HOST_FOO_VAR would be obtained from the corresponding FOO_VAR if HOST_FOO_VAR is not defined. In these cases, a test is added to check for a host package (the only case where such constructions are relevant; these are not circular). Benefits of these changes are: - behavior of variables is now again as expected. For example, setting $(2)_VERSION = virtual in pkg-virtual.mk will effectively work, while originally it would cause very odd results. - The output of 'make printvars' is now much more useful. This target shows the value of all variables, and the expression that led to that value. However, if the expression was coming from an inner-xxx-targets block, and was using single dollar signs, it would show in printvars as VAR = value (value) while if double dollar signs are used, it would effectively look like VAR = value (actual expression) as is intended. This improvement is for example effective for FOO_DL_VERSION, FOO_RAWNAME, FOO_SITE_METHOD and FOO_MAKE. The correctness of this patch has been verified using 'make printvars', 'make manual' and 'make legal-info' before and after applying this patch, and comparing the output. Insight-provided-by: Arnout Vandecappelle <arnout@mind.be> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* core: introduce the BR2_EXTERNAL variableThomas Petazzoni2013-12-081-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit introduces the BR2_EXTERNAL environment variable, which will allow to keep Buildroot customization (board-specific configuration files or root filesystem overlays, package Config.in and makefiles, as well as defconfigs) outside of the Buildroot tree. This commit only introduces the variable itself, and ensures that it is available within Config.in options. This allows us to use $BR2_EXTERNAL in a 'source' statement in Config.in. Following patches extend the usage of BR2_EXTERNAL to other areas (packages and defconfigs). In details, this commit: * Introduces the BR2_EXTERNAL Kconfig option. This option has no prompt, and is therefore not visible to the user and also not stored in the .config file. It is automatically set to the value of the BR2_EXTERNAL environment variable. The only purpose of this BR2_EXTERNAL Kconfig option is to allow $BR2_EXTERNAL to be properly expanded when used inside Kconfig source statements. * Calculates the BR2_EXTERNAL value to use. If passed on the command line, then this value is taken in priority, and saved to a .br-external hidden file in the output directory. If not passed on the command line, then we read the .br-external file from the output directory. This allows the user to not pass the BR2_EXTERNAL value at each make invocation. If no BR2_EXTERNAL value is passed, we define it to support/dummy-external, so that the kconfig code finds an existing $(BR2_EXTERNAL)/package/Config.in file to include. * Passes the BR2_EXTERNAL into the *config environment, so that its value is found when parsing/evaluating Config.in files and .config values. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Tested-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Ryan Barnett <rjbarnet@rockwellcollins.com> Tested-by: "Samuel Martin" <s.martin49@gmail.com> Acked-by: "Samuel Martin" <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: do not generate .pyc filesYann E. MORIN2013-12-061-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | Python saves a pre-compiled support/scripts/kconfiglib.pyc file side-to-side with the corresponding .py file. This does not work if the Buildroot source tree is read-only (but this is not an error for Python, which keep going OK). But this may cause issues for out-of-tree builds in case the same Buildroot source tree is shared by many builds. Also, 'make clean' currently does not clean this file, and out-of-tree builds can remove it either, at the risk of causing issues for other out-of-tree builds running at the same time. Just tell Python not to generate .pyc files: - call the script via python, don't use the sha-bang - thus, make the script non-executable, and remove the sha-bang Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: limit the depth of the TOC in the HTML outputYann E. MORIN2013-12-031-2/+2
| | | | | | | | | | | | | | | | | | | | | | The current TOC level is set to 4, which does not mean 'a 4-level deep TOC', but really means 'a TOC deep to the 4th level', with the first level being level 0, which means we have: 12. Appendix 12.1. Makedev syntax documentation 12.2. Makeuser syntax documentation 12.3. Partition table layout description syntax 12.3.1. The global section Properties for the global section Which a bit too much. And yet, the fifth level is not shown, since we don't have any! :-/ Limit the depth of the TOC to three levels, which is just enough to be usefull, yet not cluttered by low-level titles. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual generation: rename manual-txt into manual-textThomas De Schampheleire2013-11-011-1/+1
| | | | | | | | | | The output extension and the generation messages refer to 'text', but the make target was confusingly 'txt'. This patch changes the make target for consistency. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual generation: check dependencies firstThomas De Schampheleire2013-11-011-1/+31
| | | | | | | | | | | To generate the manual, you need a few tools. If these are not present, pretty cryptic error messages are given. This patch adds a simple check for these dependencies, before attempting to build the manual. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual generation: change capitalization of messagesThomas De Schampheleire2013-09-201-3/+3
| | | | | | | | | | | | | | | | | | | | | | When generating the manual, you see following messages: >>> Generating HTML manual... >>> Generating Split HTML manual... >>> Generating PDF manual... >>> Generating Text manual... >>> Generating EPUB manual... and with this patch the capitalization is changed so that it becomes: >>> Generating HTML manual... >>> Generating split HTML manual... >>> Generating PDF manual... >>> Generating text manual... >>> Generating ePUB manual... Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* Fix build reproducibility in Make 3.82Jérôme Pouiller2013-09-061-1/+1
| | | | | | | | | | | | Make 3.82 no longer sort the result of wildcards (see http://comments.gmane.org/gmane.comp.gnu.make.bugs/4260). This may break build reproducibility. This patch sort results of wildcards to ensure reproducibility. Signed-off-by: Jérôme Pouiller <jezz@sysmic.org> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add a make target 'manual-update-lists'Samuel Martin2013-05-041-5/+14
| | | | | | | | | | The generated lists are automatically updated when building the manual. [Peter: fix typos] Signed-off-by: Samuel Martin <s.martin49@gmail.com> [yann.morin.1998@free.fr: indentation, remove temp dir, intro to host utils] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: sprinkle with some calls to MESSAGESamuel Martin2013-02-171-1/+1
| | | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: set toc depth to 4 for html outputsSamuel Martin2012-11-151-2/+2
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: make clean target consistent with others in buildrootSamuel Martin2012-11-151-3/+3
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* Move the manual build infrastructure to docs/manual/manual.mkThomas Petazzoni2012-04-201-0/+48
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
OpenPOWER on IntegriCloud