summaryrefslogtreecommitdiffstats
path: root/docs/manual
Commit message (Collapse)AuthorAgeFilesLines
* manual/user guide/customization: add section on layered customizationThomas De Schampheleire2014-09-212-39/+52
| | | | | | | | | Inspired by some text in the 'project-specific patches' section, this patch adds a separate section on layering customizations by providing multiple post-build scripts, multiple rootfs overlays, etc. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide/customization: rework 'step-by-step instructions'Thomas De Schampheleire2014-09-213-52/+65
| | | | | | | | | | | | | | | | | | This patch reworks the section 'Step-by-step instructions for storing configuration' as follows: - rename into 'Quick guide to storing your project-specific customizations' and hence make it serve as a summary to the chapter - change the introduction to make this clear - update paths to line-up with section 'recommended directory structure' - recommend BR2_GLOBAL_PATCH_DIR, as is done in the section on adding patches. - mention how to add packages in a project-specific directory (to be expanded in another patch) - minor rewording - rename file into customize-quick-guide.txt Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide/customization: refer to dir structure from rootfs sectionThomas De Schampheleire2014-09-211-0/+6
| | | | | | | | | This small patch adds references to the section on 'recommended directory structure' from sections explaining the post-build script and rootfs overlay. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide/customization: add section on project-specific packagesThomas De Schampheleire2014-09-212-0/+73
| | | | | | | | | | | This patch adds a new section to chapter 'Project-specific customization' to describe how to add project-specific packages from a project-specific directory. The principle was already described in the presentation 'Using Buildroot for real projects' but was never documented in official Buildroot documentation. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide/customization: change recommendation for package pathsThomas De Schampheleire2014-09-212-12/+13
| | | | | | | | | | | | | | | | | | The Buildroot manual was recommending following paths for project-specific packages: package/<company>/<boardname>/foo/ $BR2_EXTERNAL/package/<boardname>/foo/ However, if a company has several boards, it is often the case that some packages are common for different boards. Therefore, introducing a <boardname> path component is not ideal. This patch changes the recommendation to: package/<company>/foo/ $BR2_EXTERNAL/package/foo/ Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide/customization: rename section 'Customizing packages'Thomas De Schampheleire2014-09-213-7/+8
| | | | | | | | | | This small patch renames the section 'Customizing packages' to 'Adding project-specific patches'. Additionally, a minor change is done to the introduction of this section. To better reflect the contents, the source file is renamed. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide/customization: add section on users tablesThomas De Schampheleire2014-09-213-1/+22
| | | | | | | | This patch adds basic documentation on users tables, a topic which was currently not yet covered in the manual. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide/customization: add section on device/permission tablesThomas De Schampheleire2014-09-213-0/+36
| | | | | | | | This patch adds basic documentation on device and permission tables, a topic which was currently not yet covered in the manual. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide/customization: re-order introductionThomas De Schampheleire2014-09-211-14/+15
| | | | | | | | | | | | | | This patch re-orders the enumeration of typical project customization actions: - move the 'patching packages' section downwards. - group the entries on post-build scripts and rootfs-overlays to match the actual section text. Since indented enumerations use asterixes, update the top-level entries with asterixes too for consistency. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide/customization: rework section on storing configurationThomas De Schampheleire2014-09-211-30/+24
| | | | | | | | | | | | This patch promotes the sections on Buildroot configuration and the configuration of other components to top-level sections, to match the overview in the introduction of the chapter. The introduction of the original section is removed as it does not bring additional info anymore. Some rewording is done as well. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide/customization: move section on storing configurationThomas De Schampheleire2014-09-213-65/+70
| | | | | | | | | | This patch moves the section 'Basics for storing the configuration' to a separate file and upwards in the manual section order, to line up with the listing of customization actions in the introduction of the chapter. The text itself is currently unchanged, this will be handled in the next patch. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/developer guide: minor rework of 'adding board support' sectionThomas De Schampheleire2014-09-212-6/+8
| | | | | | | | | | Minor rework of the section 'Creating your own board support', as follows: - Rename section into 'Adding support for a particular board' - Modify introduction - Refer to Project-specific customizations chapter Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: move 'Creating your own board support' from User to Developer guideThomas De Schampheleire2014-09-213-36/+39
| | | | | | | | | | | | | | | | Section 'Creating your own board support' is seemingly written in the mindset of adding support for public boards. Therefore, it is more suited in the Developer guide, rather than in the User guide. Adding support for custom non-public boards falls under the 'Project-specific customizations' category and will be described in that section. This patch moves the unchanged text into a separate file, included from the Developer guide. The next patch will make some minor changes to the text itself. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide/customization: rework section on rootfs customizationThomas De Schampheleire2014-08-313-71/+121
| | | | | | | | | | | | | | | | This patch reworks the section on root filesystem customization as follows: - use labeled list instead of bulleted list to clarify the different methods - move rootfs overlay and post-build scripts to the top and label them as recommended. - split post-image to a separate section, as it is not related to the target filesystem customization - line up post-build and post-image explanations, for example regarding working directory of the script - general expansion of some of the explanation - general rewording Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual/user guide/customization: rework section on BR2_EXTERNALThomas De Schampheleire2014-08-303-61/+38
| | | | | | | | | | | | This patch reworks the section on BR2_EXTERNAL as follows: - move note about upstreaming to the chapter introduction - streamline the section with the previously added section 'Recommended directory structure', avoiding duplication. - use $(BR2_EXTERNAL) rather than BR2_EXTERNAL when referring to file paths. - some general rewording Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual/user guide/customization: add section with recommended dir structureThomas De Schampheleire2014-08-302-2/+62
| | | | | | | | | | | | | | | | Although the user is free to choose where to put project-specific files, the presentation 'Using Buildroot for real projects' [1] first described a certain recommendation. This patch briefly describes this recommendation in the form of a directory structure overview, the details will be added in subsequent patches. Since the section on BR2_EXTERNAL is logically connected to the directory structure, this section is moved right after it. [1] http://elinux.org/images/2/2a/Using-buildroot-real-project.pdf Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual/user guide/customization: expand introduction textThomas De Schampheleire2014-08-301-4/+21
| | | | | | | | | This patch expands the introduction text of chapter 'Project-specific customization' by listing the type of customizations that can be performed by a project. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: file organization: rename files to match new section titleThomas De Schampheleire2014-08-213-2/+2
| | | | | | | | After the renaming of some sections, rename the corresponding files for clarity. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: file organization: avoid unnecessary indirectionThomas De Schampheleire2014-08-214-37/+21
| | | | | | | | | Some source files of the manual merely contain inclusion of other files. Especially at top-level this is unnecessary, and one could just as well add these includes in manual.txt. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide: rework 'Configuration of other components' chapterThomas De Schampheleire2014-08-216-83/+54
| | | | | | | | | | | | | | | | This patch reworks the chapter 'Configuration of other components' as follows: - remove separate customize-xxx-config.txt files in favor of one shared file configure-other-componenents.txt - use labeled list instead of separate sections, as the information in each section is limited. - simplify instructions for busybox/uclibc thanks to the kconfig-package infrastructure - rewrite instructions for Linux - add instructions for Barebox Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide: move tip on configuration searchesThomas De Schampheleire2014-08-212-13/+18
| | | | | | | | | | This patch moves the tip on searching in the configuration editors into the section 'Buildroot configuration', which is more logical. The wording of that section is slightly adapted to fit this new part. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide: high-level restructuringThomas De Schampheleire2014-08-2111-94/+45
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch performs some additional restructuring of the manual, specifically in the User Guide. In detail: - Rename 'Daily use' to 'General Buildroot usage' - Move chapters 'make tips', 'Eclipse integration', and 'Advanced usage' as sections under the 'General Buildroot usage' chapter. - Rename 'Details on Buildroot configuration' into 'Buildroot configuration' - Rework the 'Customization' section as follows: - Move the short section on debugging the external toolchain wrapper into the rest of the explanation on external toolchains. - Remove the now redundant section on toolchains, as this is already explained in much more detail in the 'Buildroot configuration' chapter. - Move the sections on busybox/uclibc/kernel configuration from chapter 'Customization' into a separate chapter 'Configuration of other components'. - Rename the remaining part of the original 'Customization' chapter into 'Project-specific customization' and fold it together with the next chapter 'Storing the configuration' - Remove the chapter 'Going further in Buildroot innards' thanks to: - Moving the chapter 'How Buildroot works' to the Developer guide. - Moving the 'Advanced Buildroot usage' section to the 'General Buildroot usage' chapter. - Remove the chapter 'Hacking Buildroot' by: - Adding a reference to adding packages to the 'Project-specific customizations' chapter - Leaving out the explicit reference to creating board support, as this is part of the previous chapter already, so an extra reference is redundant. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/getting started: minor improvements to 'Using Buildroot' sectionThomas De Schampheleire2014-08-211-2/+3
| | | | | | | | | | | | This patch renames the section 'Using Buildroot' into 'Buildroot quick start' as real details about Buildroot usage will be in the User Guide rather than in 'Getting Started'. Additionally, add a cross-reference to the section about configuring Buildroot. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: document dependencies on atomic operationsAnton Kolesov2014-08-181-0/+5
| | | | | | | | | | | | Add atomic operations to the list of generic dependencies. Since this is an architecture option, there is no comment string to be added. Signed-off-by: Anton Kolesov <Anton.Kolesov@synopsys.com> [yann.morin.1998@free.fr: use the new arch-option; remove comment string] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: update documentation about gettext handlingThomas Petazzoni2014-08-181-7/+22
| | | | | | | | | This commit updates the Buildroot manual regarding how gettext related issues are handled, now that we have cases where the gettext package should be selected even with glibc toolchains. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual/getting started: rework 'Using Buildroot' sectionThomas De Schampheleire2014-08-171-26/+33
| | | | | | | | This patch does some general rewording of the 'Using buildroot' section of the manual. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/getting started: rework 'Getting Buildroot' sectionThomas De Schampheleire2014-08-171-18/+8
| | | | | | | | | | This patch reworks the 'Getting Buildroot' section of the manual as follows: - be more specific on the Buildroot release cycle - refer to the download page of the website for details on snapshots and git, instead of duplicating the information. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/getting started: rework 'System requirements' sectionThomas De Schampheleire2014-08-171-18/+22
| | | | | | | | | | | | | This patch reworks the requirements section of the manual as follows: - some general rewording - move configuration editor dependencies above the download tools, as this is the first thing people come in contact with. - move sentence regarding -dev packages to configuration editor dependencies and restrict to 'libraries'. - clarify the download tools part. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/getting started: rework 'Community resources' sectionThomas De Schampheleire2014-08-172-88/+79
| | | | | | | | | | | | | | | | | This patch reworks the section 'Community resources' as follows: - use a labeled list instead of subsections, as the content of each section is so small that it does not deserve a real section. Related to this, the anchors for each of these subsections are removed, as referencing such anchors that do not correspond to a section boundary are not displayed nicely. - move the part about applying patches from patchwork to the Contributing section in the Developer Guide - reword some parts of the text - add link texts to some links, instead of showing the URL directly, to make the HTML / PDF display nicer. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/getting started: rename and move 'Getting involved' sectionThomas De Schampheleire2014-08-172-3/+3
| | | | | | | | | | The Getting Involved section is actually an overview of the ways to interact with the Buildroot community, which is useful for developers _and_ users. Therefore, this patch moves the section from the Developer Guide to the Getting Started section, and renames it to 'Community Resources'. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: remove 'Events' sectionThomas De Schampheleire2014-08-171-16/+0
| | | | | | | | | The list of buildroot events is outdated, a sign that the manual is not the best place to refer to timely things like events. The wiki page is better suited for such information. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: high-level restructuringThomas De Schampheleire2014-08-1722-62/+60
| | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* manual-text: hide image representationsThomas De Schampheleire2014-08-161-0/+6
| | | | | | | | | | | | | | | | Images specified in the asciidoc sources (currently only the logo) are displayed as the file name in the text version of the manual. This causes an odd line to appear: logo.png Avoid this by setting the image representation macros to {empty} in manual-text. 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> Tested-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual-text: make sure URLs are displayed if a link text was providedThomas De Schampheleire2014-08-161-0/+17
| | | | | | | | | | | | | | | | | | | | | When the asciidoc source contain URLs of the form: http://example.com[An example website] the text representation of the manual would only contain: An example website without displaying the actual URL. This patch adds an asciidoc configuration file that sets the inline macros for several URL types so that the display becomes: An example website [http://example.com] For URLs where no link text was provided, the display becomes: http://example.com which is the same as before. 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> Tested-by: "Yann E. MORIN" <yann.morin.1998@free.fr> 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>
* manual: fix copy/paste error in python package exampleDanomi Manchego2014-08-061-1/+1
| | | | | | | | The SOURCE references "LIBFOO_VERSION", should be "PYTHON_FOO_VERSION". Signed-off-by: Danomi Manchego <danomimanchego123@gmail.com> Acked-by: Thomas De Schampheleire < thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: add documentation for kconfig-packageThomas De Schampheleire2014-08-042-0/+58
| | | | | | | | | | | | | | This patch adds documentation for the new kconfig-package infrastructure to the manual. Note that due to the simplicity of the infrastructure, the documentation is not split in a 'tutorial' and a 'reference', like for the other infrastructures. Instead, the usage is described in one section. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> [me: slight grammar fix 'copy -back- the configuration +back+ to...'] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* toolchain: linker options with a $ sign are not supportedYann E. MORIN2014-07-311-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | As reported in bug #7172 [0], setting BR2_TARGET_LDFLAGS to a value containing a $ sign can lead to unexpected results. This is because it is very hard to know when the $ sign gets evaluated: - in the Buildroot-level make - in the shell called by the Buildroot-level make - in the package's own build-system, either at configure time, in the Makefile, in a shell in the Makefile... So, it is very difficult to know how much escaping that would need. A proposal is to use a shell variable to pass such values unmolested. But it is not that simple either, since it still contains a $ sign, and there is not much certainty as to when it would be evaluated. Instead, just document this limitation, both in the help text for BR2_TARGET_LDFLAGS, and in the known-issues section in the manual. Does not really fix #7172, but at least the limitation is documented. [0] https://bugs.buildroot.org/show_bug.cgi?id=7172 Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Mike Zick <minimod@morethan.org> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/adding-packages-perl.txt: remove the trailing slash sign from ↵Jerzy Grzegorek2014-07-311-1/+1
| | | | | | | | | | | | | description of PERL_SITE variable Since the trailing slash is stripped from $($(PKG)_SITE) by pkg-generic.mk: $(call DOWNLOAD,$($(PKG)_SITE:/=)/$($(PKG)_SOURCE)) so it is redundant. Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add sob line for patch seriesWaldemar Brodkorb2014-07-291-1/+1
| | | | | | | | The -s is missing in the documentation when teaching how to use 'git format-patch' to automatically add the sob line. Signed-off-by: Waldemar Brodkorb <wbx@openadk.org> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: enhance doc for BR2_TOOLCHAIN_HEADERS_AT_LEAST_X_YYann E. MORIN2014-07-271-2/+2
| | | | | | | | | | | | | | The BR2_TOOLCHAIN_HEADERS_AT_LEAST_X_Y symbols can be used to denote the lowest required kernel headers version, but also the highest supported version. Document that. Use the `...` construct instead of +...+ used eveywhere else, otherwise asciidoc would render +<=+ to the ⇐ arrow, while `...` does no rendering at all. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* pkg-autotools: add support for <pkg>_AUTORECONF_ENVRick Taylor2014-07-231-0/+5
| | | | | | | | | | | | | This commit improves the autotools-package infrastructure to support a <pkg>_AUTORECONF_ENV variable, which allows a package maintainer to pass additional variables in the environment of the autoreconf execution. This is useful in the situation where configure.ac contains shell commands using environment variables that are only executed when autoreconf is run. Signed-off-by: Rick Taylor <rick.taylor@cassidian.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* support/scripts/scancpan: automatically populate LICENSE_FILESFrancois Perrad2014-07-181-3/+0
| | | | | | | | | This commit improves the scancpan script to automatically populate the LICENSE_FILES variable using informations available in the Perl package MANIFEST file. Signed-off-by: Francois Perrad <francois.perrad@gadz.org> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: add gettextize explanations in the manualYann E. MORIN2014-07-171-0/+12
| | | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Gustavo Zacarias <gustavo@zacarias.com.ar> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Baruch Siach <baruch@tkos.co.il> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* pkg-python: add staging installation supportThomas Petazzoni2014-07-161-14/+13
| | | | | | | | python-numpy needs to be installed to the staging directory, since it also installs some header files. Therefore, this commit extends the Python package infrastructure to support staging installation. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* give a hint about git rebaseWaldemar Brodkorb2014-07-151-0/+3
| | | | | | | | | | | It seems common knowledge to use git rebase in interactive mode to fixup issues while respinning patch series, but I found it hard to find any hint about it. Add a note for git beginners like me. [Thomas: take into account Arnout's comment.] Signed-off-by: Waldemar Brodkorb <wbx@openadk.org> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* infra/pkg-perl: add possibility to pass extra env at configure timeFrancois Perrad2014-07-141-0/+4
| | | | | | | | | | | | | | | | | | | Some perl packages may use environment variables as a hint to know how to be configured. That's for example the case for perl-net-ssleay that uses OPENSSL_PREFIX, if it is set in the environment, as the prefix to openssl. Add a new variable that packages can set if they need extra environment variables. Update the manual accordingly. Signed-off-by: Francois Perrad <francois.perrad@gadz.org> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Tested-by: "Yann E. MORIN" <yann.morin.1998@free.fr> [yann.morin.1998@free.fr: enhance the commit log] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: add documentation about packages' hashesYann E. MORIN2014-07-041-0/+66
| | | | | | | | | | | | | | Although md5 is, for legacy reasons, a supported hash type, it is not documented on purpose, since it is now known to be weak. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Baruch Siach <baruch@tkos.co.il> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: (faq-boot-hang-after-starting) fix config entriesVivien Didelot2014-06-221-5/+5
| | | | | Signed-off-by: Vivien Didelot <vivien.didelot@savoirfairelinux.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
OpenPOWER on IntegriCloud