summaryrefslogtreecommitdiffstats
path: root/docs/manual
Commit message (Collapse)AuthorAgeFilesLines
...
* docs/manual: remove references to IPv6Gustavo Zacarias2015-04-222-13/+8
| | | | | | | | It's no longer an option so remove all references to it. 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>
* docs/manual: documentation for recursive makedevs syntaxAngelo Compagnucci2015-04-111-1/+9
| | | | | | | | | | | This patch adds the documentation for the new makedevs recursive syntax. [Thomas: s/folder/directory/ as suggested by Yann.] Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add _PATCH_DEPENDENCIESYann E. MORIN2015-04-091-0/+9
| | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: Romain Naour <romain.naour@openwide.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: update documentation about applying patchesThomas Petazzoni2015-04-062-7/+6
| | | | | | | | | | | The Buildroot manual is currently wrong when describing how patches are applied: it says that <packagename>-*.patch is applied, and that <packagename>-<seq>-*.patch is the recommended name for patches. This is incorrect, since we're now using just <seq>-*.patch. This commit adjusts the documentation accordingly. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
* Makefile: split off 'list-defconfigs' from 'help'Arnout Vandecappelle2015-04-042-3/+9
| | | | | | | | | | | | | As discussed in the FOSDEM2015 BR developer meeting, the output of 'make help' is too long for comfortable reading. To shorten it, split off the list of defconfigs in a new target, 'list-defconfigs'. Declare the new target as phony. Add 'list-defconfigs' to the documentation. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* support/download: always fail when there's no hashYann E. MORIN2015-04-031-4/+4
| | | | | | | | | | | | | | | | | | At the time we introduced hashes, we did not want to be too harsh in the beginning, and give people some time to adapt and accept the hashes. So we so far only whined^Wwarned about a missing hash (when the .hash file exists). Some time has passed now, and people are still missing updating hashes when bumping packages. Let's make that warning a little bit more annoying... Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Arnout Vandecappelle <arnout@mind.be> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* support/download: add explicit no-hash supportYann E. MORIN2015-04-031-2/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | Add support to explicitly state that an archive has no hash. This can be used for archives downloaded from a repository, like a git-clone or a subversion checkout, or using the github helper. This will come in handy when we'll eventually make hashes mandatory as soon as a .hash file exists: for some packages, like gcc, some versions are downloaded as archives from upstream, while other versions may come from a GitHub repository (via the github herlper). In this case, a .hash file would exist, that contains hashes for the downloaded tarballs, but archives downloaded from the repository would not have a hash (since it is currently not possible to have reproducible such archives). So, we'd need a way to explicitly state there is no hash, on purpose, for those archives. So, add 'none' as a new type of hash. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Arnout Vandecappelle <arnout@mind.be> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* package infra: do not check hashes when downloading from a repositoryYann E. MORIN2015-04-031-0/+6
| | | | | | | | | | | | | When downloading from a repository, we have no way to ensure the reproducibility of the generated archives, so we can't check the hashes. Do not specifiy a hash file in those cases. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs: add links to the rest of the licensesYegor Yefremov2015-04-021-4/+12
| | | | | | Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: remove references to largefileGustavo Zacarias2015-04-012-36/+32
| | | | | | | | | | Switch from the ACL package example to RRDTOOL since ACL has no dual (depends + select) dependencies any more and doesn't fit the example scenario. 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>
* docs/manual: document new graph-depends optionsYann E. MORIN2015-04-011-0/+8
| | | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Francois Perrad <fperrad@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: update documentation about <pkg>_SOURCE, <pkg>_PATCH and ↵Thomas Petazzoni2015-03-301-13/+17
| | | | | | | | | | | | | | | | | | | | | | | <pkg>_EXTRA_DOWNLOADS This commit updates the Buildroot manual for the variables used to indicate where to download the source code from: - It updates the description of <pkg>_SOURCE to make it clear that Buildroot assume that the tarball is hosted at <pkg>_SITE. - It updates the description of <pkg>_PATCH to indicate that not only file names (assumed to be hosted at <pkg>_SITE) can be used, but also full URLs. This allows to match with what the current code is doing. - It updates the description of <pkg>_EXTRA_DOWNLOADS to also indicate that full URLs are now accepted, following the change made in the previous commit. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: Romain Naour <romain.naour@openwide.fr> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
* docs/manual: add documentation on Config.in.hostJan Heylen2015-03-161-4/+46
| | | | | | | | | | | | + rearrange the structure a bit by adding a new paragraph for the Config files Signed-off-by: Jan Heylen <heyleke@gmail.com> [ThomasDS: - clarify commit title - add list continuations to fix indentation of Config.in.host details] Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* pkg-cmake: allow to build package in a subdirectoryGwenhael Goavec-Merou2015-03-131-0/+4
| | | | | | | | | | | | | | | For some cmake based packages, like GNURadio, it's forbidden to do the compilation directly in the sources directory. This patch add a new variable to specify, if needed, the name of a sub-directory used to compile. [Thomas: put the documentation at the right place in the manual, not in the middle of the <pkg>_CONF_OPTS description.] Signed-off-by: Gwenhael Goavec-Merou <gwenhael.goavec-merou@trabucayre.com> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Tested-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: download: remove trailing slash from package FOO_SITELuca Ceresoli2015-03-101-1/+1
| | | | | | | | The recommended form is without the trailing slash. Buildroot will add a slash between FOO_SITE and FOO_SOURCE as appropriate. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: reinstall targetDoug Kehn2015-02-031-0/+2
| | | | | | | | | | Add reinstall target information to package-make-target.txt. [Thomas: update to take into account the fact that we now have a single <pkg>-reinstall target.] Signed-off-by: Doug Kehn <rdkehn@yahoo.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add FAQ entry about speeding up the build processThomas Petazzoni2015-02-031-0/+34
| | | | | | | | | | | | This is a very frequently asked question, so let's add a FAQ entry about it, that we can progressively extend with more advices for our users. [Thomas: remove the part about your boss buying new hardware, as suggested by reviewers.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
* docs/manual: add documentation for the pkg-rebar infrastructureYann E. MORIN2015-02-032-0/+104
| | | | | | | Signed-off-by: Johan Oudinet <johan.oudinet@gmail.com> [yann.morin.1998@free.fr: split the doc into its own patch] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document LIBFOO_INSTALL_IMAGESYann E. MORIN2015-01-011-0/+5
| | | | | | | Document it as are LIBFOO_INSTALL_STAGING and LIBFOO_INSTALL_TARGET. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: remove the extra whitespacesJerzy 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_LIBSThomas 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>
* docs: fix typo in cmake-package documentationThomas 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 conventionYann 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>
* manual: Add newline before block codeMaxime 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 headerMaxime 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 spaceMaxime 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 syntaxMaxime 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>
* docs/manual/resources.txt: fix patchwork linkPeter 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>
* docs/manual: cleanup github helper docsYann 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/manual: update cmake-package infrastructure sectionSamuel 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 creationGustavo 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 helperMaxime 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 targetThomas 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 infraYann 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 configYann E. MORIN2014-10-121-23/+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 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>
OpenPOWER on IntegriCloud