aboutsummaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* manual: remove the extra whitespacesGravatar Jerzy Grzegorek2014-12-2012-24/+24
| | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Rename BR2_PREFER_STATIC_LIB to BR2_STATIC_LIBSGravatar Thomas Petazzoni2014-12-112-2/+2
| | | | | | | | | | | | | | | | | | | | | | | Since a while, the semantic of BR2_PREFER_STATIC_LIB has been changed from "prefer static libraries when possible" to "use only static libraries". The former semantic didn't make much sense, since the user had absolutely no control/idea of which package would use static libraries, and which packages would not. Therefore, for quite some time, we have been starting to enforce that BR2_PREFER_STATIC_LIB should really build everything with static libraries. As a consequence, this patch renames BR2_PREFER_STATIC_LIB to BR2_STATIC_LIBS, and adjust the Config.in option accordingly. This also helps preparing the addition of other options to select shared, shared+static or just static. Note that we have verified that this commit can be reproduced by simply doing a global rename of BR2_PREFER_STATIC_LIB to BR2_STATIC_LIBS plus adding BR2_PREFER_STATIC_LIB to Config.in.legacy. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
* website: Javascript code cleanupGravatar Maxime Hadjinlian2014-12-091-26/+27
| | | | | | | | By inversing the "if (!result.error)" we gain one level of indent. Also moving variable declarations into a more correct block of code. Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* website: Fix indentationGravatar Maxime Hadjinlian2014-12-091-39/+41
| | | | | | | [Thomas: fix commit title.] Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* website: Remove debug messageGravatar Maxime Hadjinlian2014-12-091-1/+0
| | | | | Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs: fix typo in cmake-package documentationGravatar Thomas Petazzoni2014-12-071-1/+1
| | | | | | | | | | | The cmake-package documentation was referring to BR2_PREFER_STATIC_LIBS, while the option is actually named BR2_PREFER_STATIC_LIB. This commit fixes this mistake. Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
* docs/manual: document the new patch naming conventionGravatar Yann E. MORIN2014-12-071-7/+14
| | | | | | | | | | | | | | | | To ease generating patches, we now use a naming convention that is in line with what git-format-patch does, that is: - do not prefix patches with the package name - prefix patches with a 4-digit mber - start numbering at 0001 Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Peter Korsgaard <jacmet@uclibc.org> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs: RWD website - upgrading bootswatch theme fileGravatar Angelo Compagnucci2014-12-023-355/+858
| | | | | | | | | | This patch updates to the latest bootstrap versione (3.3.0) and contextually pushes the colour theme and fonts required by our style. The patch provides source files (*.less) to recompile bootstrap.min.css . Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2014.112014.11Gravatar Peter Korsgaard2014-12-012-7/+16
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2014.11-rc32014.11-rc3Gravatar Peter Korsgaard2014-11-282-5/+17
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: Add newline before block codeGravatar Maxime Hadjinlian2014-11-221-0/+5
| | | | | | | | This won't change the output, it's only a style issue. Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: Add missing vim headerGravatar Maxime Hadjinlian2014-11-223-0/+3
| | | | | | Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: Remove trailing spaceGravatar Maxime Hadjinlian2014-11-222-5/+5
| | | | | | Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: Rework makedevs syntaxGravatar Maxime Hadjinlian2014-11-221-11/+13
| | | | | | | | | | State that it should be a space separated list and fix the example. Also reduce the number of dash used to 4. [Thomas: replace tab by space, as noted by Yann.] Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Update for 2014.11-rc22014.11-rc2Gravatar Peter Korsgaard2014-11-212-5/+18
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual/resources.txt: fix patchwork linkGravatar Peter Korsgaard2014-11-131-1/+1
| | | | | | | The patchwork website needs the trailing slash, otherwise it returns a 404. Reported-by: Peter Seiderer <ps.report@gmx.net> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* doc/news.html: fix html tag closingGravatar Peter Korsgaard2014-11-131-1/+1
| | | | | | From the recent dev days meeting report addition. Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/news.html: add link to report from ELCE developers daysGravatar Peter Korsgaard2014-11-131-0/+16
| | | | | | And annonce the next one as well. Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/news.html: add 2014.11-rc1 announcement linkGravatar Peter Korsgaard2014-11-131-1/+2
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2014.11-rc12014.11-rc1Gravatar Peter Korsgaard2014-11-122-7/+20
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: cleanup github helper docsGravatar Yann E. MORIN2014-11-111-1/+2
| | | | | | | | | | | | | Explicitly state that the github helper should not be used when there is a release tarball. Properly render the list by separating it from the previous paragraph. [Peter: fix typo as pointed out by Maxime] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs: responsive web design websiteGravatar Angelo Compagnucci2014-11-0114-152/+221
| | | | | | | | | | | This patch migrate the layout to a responsive web design one. * Fixing the layout of all pages to be fully responsive * Adding panels around "Recent commints" and "Recent discussion" * Adding fonts for glyphs in buttons Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs: responsive web design website - upgrading bootstrap/jqueryGravatar Angelo Compagnucci2014-11-018-10192/+14
| | | | | | | | | * Upgrading to Bootstrap 3.2.0 * Upgrading to Jquery 1.11.1 * Removing older files Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: update cmake-package infrastructure sectionGravatar Samuel Martin2014-10-261-1/+11
| | | | | | | | | | This patch documents the CMake options preset by the cmake-package infrastructure. [Thomas: minor wording tweak.] Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document makeusers group-only creationGravatar Gustavo Zacarias2014-10-221-1/+2
| | | | | | | | [Thomas: slightly reword according to the help text.] Signed-off-by: Gustavo Zacarias <gustavo@zacarias.com.ar> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: Add note about uses of github helperGravatar Maxime Hadjinlian2014-10-161-0/+17
| | | | | | | | | | | | Add a little comment regarding the uses of the github helper for the releases. [Arnout: extend the comment a little] Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Cc: Samuel Martin <s.martin49@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: slightly improve faq entry about compiler on targetGravatar Thomas Petazzoni2014-10-121-1/+3
| | | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: document the asciidoc infraGravatar Yann E. MORIN2014-10-122-0/+121
| | | | | | | | | | [Peter: move periods outside paranthesis as suggested by Thomas De Schampheleire] 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>
* doc/asciidoc: always apply Buildroot's AsciiDoc configGravatar Yann E. MORIN2014-10-121-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | As suggested by Thomas: the AsciiDoc options we use ensure we get a sane output of the document. We want that configuration to be applied to other documents as well. Up until now, it was implicit that the configuration was applied to our manual, becasue we only supported document-specific configuration, and the configuration we had was in our manual dir, so we got to use it. But now, we can render other documents, especially ones from br2-external, and we want those to also use the default configuration from Buildroot, but still be able to provide their own customisation. So, always add Buildroot's configuration first, if available, before we append the document's configuration. 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/asciidoc: make it possible to use $(@D) in hooksGravatar Yann 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 infrastructureGravatar Yann 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 definitionGravatar Yann 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 directoryGravatar Yann 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 rulesGravatar Yann 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 packageGravatar Yann 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 rulesGravatar Yann 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 manualGravatar Yann 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_INNERGravatar Yann 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 areGravatar Yann 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 documentGravatar Yann 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 GENDOCGravatar Yann 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 ruleGravatar Yann 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 dependenciesGravatar Yann 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 actionGravatar Yann 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 GENDOCGravatar Yann 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 buggyGravatar Samuel 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 warningGravatar Samuel 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/manualGravatar Samuel 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>
* packages: rename FOO_KCONFIG_OPT into FOO_KCONFIG_OPTSGravatar Thomas De Schampheleire2014-10-041-1/+1
| | | | | | | | | | | | To be consistent with the recent change of FOO_MAKE_OPT into FOO_MAKE_OPTS, make the same change for FOO_KCONFIG_OPT. Sed command used: find * -type f | xargs sed -i 's#_KCONFIG_OPT\>#&S#g' Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* packages: rename FOO_GETTEXTIZE_OPT into FOO_GETTEXTIZE_OPTSGravatar Thomas De Schampheleire2014-10-041-1/+1
| | | | | | | | | | | | To be consistent with the recent change of FOO_MAKE_OPT into FOO_MAKE_OPTS, make the same change for FOO_GETTEXTIZE_OPT. Sed command used: find * -type f | xargs sed -i 's#_GETTEXTIZE_OPT\>#&S#g' Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>