summaryrefslogtreecommitdiffstats
path: root/docs/manual/common-usage.txt
Commit message (Collapse)AuthorAgeFilesLines
* support/scripts/graph-depends: use colors instead of coloursThomas Petazzoni2018-04-011-2/+2
| | | | | | | | | | | | | | | | The graph-depends was not very consistent in colors vs. colours: some parts were using colours, some parts were using colors. Let's settle on the US spelling, colors. This change the user-visble option --colours to --colors, but it is unlikely that a lot of users customize the colors through BR2_GRAPH_DEPS_OPTS, so this user interface change is considered reasonable. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: update old references to support/scriptsArnout Vandecappelle2017-07-011-1/+1
| | | | | | | | | | | | | There were still some references to the old location of the scripts in the manual. Replace them by utils/. While we're at it, remove the redundant ./ at the beginning of some of the example commands. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Cc: "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>
* docs/manual: centralize recommendations about BR2_DL_DIRLuca Ceresoli2017-02-071-2/+3
| | | | | | | | | | | | | | | | We currently have two places where we recommend where BR2_DL_DIR should be set: "Environment variables" and "Location of downloaded packages". The former recommends setting BR2_DL_DIR in the .config, the latter kind of endorses using ~/.bashrc. We prefer suggesting the ~/.bashrc way since it avoids downloading the same file multiple times, and anyway it's wise to have all the details in a unique place. So remove the .config suggestion from "Environment variables" and let it just point to "Location of downloaded packages". Cc: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: update graph-depends documentation about --stop-onThomas Petazzoni2016-02-081-3/+4
| | | | | | | | | | This commit updates the graph-depends documentation to take into account the new 'host' keyword that can be passed to the --stop-on and --exclude options. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* support/scripts: add size-stats-compare scriptThomas De Schampheleire2016-02-071-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Leverage the CSV files produces by size-stats (make graph-size) to allow for a comparison of rootfs size between two different buildroot compilations. The script takes the file-size CSV files of two compilations as input, and produces a textual report of the differences per package. Using the -d/--detail flag, the report will show the file size changes instead of package size changes. The -t/--threshold option allows to ignore file size differences smaller or equal than the given threshold (in bytes). Example output is: Size difference per package (bytes), threshold = 0 -------------------------------------------------------------------------------- -8192 busybox 228572 added dmalloc 301584 added jq -------------------------------------------------------------------------------- 521964 TOTAL or with detailed view: Size difference per file (bytes), threshold = 0 -------------------------------------------------------------------------------- -8192 bin/busybox 18152 added usr/bin/jq 39252 added usr/bin/dmalloc 46968 added usr/lib/libdmalloc.so 47288 added usr/lib/libdmallocxx.so 47316 added usr/lib/libdmallocth.so 47748 added usr/lib/libdmallocthcxx.so 283432 added usr/lib/libjq.so.1.0.4 -------------------------------------------------------------------------------- 521964 TOTAL Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: minor fixes in the graph-size documentationThomas De Schampheleire2016-02-011-4/+4
| | | | | | | | | Fix some typos and references to a size-stats 'target' (the script is called 'size-stats' but the make target is 'graph-size'). Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* ccache: allow for BR2_CCACHE_DIR environment overrideGustavo Zacarias2015-10-171-0/+3
| | | | | | | | | | | | | Allow the BR2_CCACHE_DIR .config option to be overriden by the BR2_CCACHE_DIR env variable. This is useful for big projects where in some cases the developers home directory might be a NFS mount (slow) and real production builds aren't. Update documentation accordingly as well. Signed-off-by: Gustavo Zacarias <gustavo.zacarias@free-electrons.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add section about size graphingThomas Petazzoni2015-10-171-0/+41
| | | | | | | | Document the new graph-size target and its possibilities. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> 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>
* manual/user guide: high-level restructuringThomas De Schampheleire2014-08-211-1/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* graphs/depends: do not draw transitive dependencies by defaultYann E. MORIN2014-06-131-1/+1
| | | | | | | | | | | | | | The transitive dependencies make the graphs barely readable for large configs, with a large number of packages. So, just switch to not drawing the transitive dependencies by default. By popular demand... ;-) [Peter: reword] 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>
* manual: document the new graph-depends optionsYann E. MORIN2014-06-081-1/+10
| | | | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Cc: Samuel Martin <s.martin49@gmail.com> Reviewed-by: Thomas De Schampheleire <patrickdepinguin@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* replace references to Busybox with BusyBoxSimon Dawson2014-06-011-2/+2
| | | | | | | | | The correct capitalised form appears to be "BusyBox" rather than "Busybox"; fix all references to the latter form. (Most such references occur in the manual and in commentary in package makefiles.) Signed-off-by: Simon Dawson <spdawson@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* graph-depends: rename the variable to pass the max depthYann E. MORIN2014-05-171-2/+12
| | | | | | | | | | | | | | | | | | | | | There will soon be new options to the graph-depends script, which we can only sanely pass via environment variables. Currently, we use such an environment variable to pass the maximum depth of the dependency graph; the name of that variable is explicit that it contains just the depth. However, there has been so far no release of Buildroot which would make use of that variable, so no user should have come to rely on it. Rename that variable so it is less specific, and more generic, so it can be used to pass more options to graph-depends. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: use one-line titles instead of two-line titles (trivial)Thomas De Schampheleire2014-05-021-14/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Asciidoc supports two syntaxes for section titles: two-line titles (title plus underline consisting of a particular symbol), and one-line titles (title prefixed with a specific number of = signs). The two-line title underlines are: Level 0 (top level): ====================== Level 1: ---------------------- Level 2: ~~~~~~~~~~~~~~~~~~~~~~ Level 3: ^^^^^^^^^^^^^^^^^^^^^^ Level 4 (bottom level): ++++++++++++++++++++++ and the one-line title prefixes: = Document Title (level 0) = == Section title (level 1) == === Section title (level 2) === ==== Section title (level 3) ==== ===== Section title (level 4) ===== The buildroot manual is currenly using the two-line titles, but this has multiple disadvantages: - asciidoc also uses some of the underline symbols for other purposes (like preformatted code, example blocks, ...), which makes it difficult to do mass replacements, such as a planned follow-up patch that needs to move all sections one level down. - it is difficult to remember which level a given underline symbol (=-~^+) corresponds to, while counting = signs is easy. This patch changes all two-level titles to one-level titles in the manual. The bulk of the change was done with the following Python script, except for the level 1 titles (-----) as these underlines are also used for literal code blocks. This patch only changes the titles, no other changes. In adding-packages-directory.txt, I did add missing newlines between some titles and their content. ---------------------------------------------------------------------------- #!/usr/bin/env python import sys import mmap import re for input in sys.argv[1:]: f = open(input, 'r+') f.flush() s = mmap.mmap(f.fileno(), 0) # Level 0 (top level): ====================== = # Level 1: ---------------------- == # Level 2: ~~~~~~~~~~~~~~~~~~~~~~ === # Level 3: ^^^^^^^^^^^^^^^^^^^^^^ ==== # Level 4 (bottom level): ++++++++++++++++++++++ ===== def replace_title(s, symbol, replacement): pattern = re.compile(r'(.+\n)\%s{2,}\n' % symbol, re.MULTILINE) return pattern.sub(r'%s \1' % replacement, s) new = s new = replace_title(new, '=', '=') new = replace_title(new, '+', '=====') new = replace_title(new, '^', '====') new = replace_title(new, '~', '===') #new = replace_title(new, '-', '==') s.seek(0) s.write(new) s.resize(s.tell()) s.close() f.close() ---------------------------------------------------------------------------- Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: document BR2_GRAPH_DEPTHYann E. MORIN2014-04-141-0/+2
| | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: fix typo in abbreviation 'e.g.'Jerzy Grzegorek2014-03-291-4/+4
| | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/common-usage.txt: fix typoJerzy Grzegorek2014-03-231-1/+1
| | | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* common-usage.txt: adjust documentation for renamed BR2_GRAPH_ variablesPeter Korsgaard2014-02-241-6/+6
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: fix minor spelling/grammar mistakesThomas De Schampheleire2014-02-241-4/+4
| | | | | | | | | This commit fixes a few minor spelling or grammar mistakes since the recent additions to the manual (commits 0b100de2cf36d81910ab53978b8a379214a683ea to 7cbb476661b0cfa213d8885f3fe5d58823e84286). Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: add section about build time graphingThomas Petazzoni2014-02-231-0/+47
| | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: add section about dependency graphsThomas Petazzoni2014-02-231-0/+52
| | | | | | 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>
* manual: add explanations on limitations about using O=...Yann E. MORIN2014-02-221-3/+9
| | | | | | | | | | | | | | | | | | | | | | | | Using a relative path for O=... has limitations, since it is interpreted relative to the Buildroot tree, and thus may lead to unexpected results. For example, running this: make -C buildroot O=my-O will not create my-O in the current working directory, but as a sub-directory of the Buildroot tree, here in buildroot/my-O Explain this in the manual (as is similarly done for BR2_EXTERNAL). Also add a note that $(O) will be created if missing. Also change O=.. and -C .. to O=<...> and -C <...> to make it explicit this is an ellipse, not a relative path. Reported-by: Jérémy Rosen <jeremy.rosen@openwide.fr> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Reviewed-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>
* infra: replace BUILDROOT_DL_DIR with BR2_DL_DIR.Arnout Vandecappelle2014-02-091-1/+1
| | | | | | | | | | | To make the naming consistent (all user-visible options should be prefixed BR2_). An entry is added to Makefile.legacy to warn users who have set BUILDROOT_DL_DIR but not BR2_DL_DIR. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: add section about dealing efficiently with big image filesYann E. MORIN2014-01-091-0/+39
| | | | | | | | | | | | | | | As reported by Ryan, it is not well-known that most tools can deal efficiently with big sparse files. Add a section in the manual about this, with tar and cp used as examples, and a hinting to the man pages for the others. Reported-by: Ryan Barnett <rjbarnet@rockwellcollins.com> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Ryan Barnett <rjbarnet@rockwellcollins.com> Cc: Peter Korsgaard <jacmet@uclibc.org> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* graphs: support generating png graphsYann E. MORIN2013-12-291-0/+2
| | | | | | | | | | | | | | PDF files can not be easily embedded in other documents (eg. ODT, or HTML). Add support for generating PNG graphs, by setting the GRAPH_OUT=pdf|png on the command line: make GRAPH_OUT=png graph-build graph-depends The default is still to generate PDF graphs. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Makefile: expose target 'graph-build' to generate the build-time graphsYann E. MORIN2013-12-291-0/+2
| | | | | | | | | | | | | | | Generate the build-time graphs by calling: make graph-build This generates the graphs in $(O)/graphs/ It is possible to use the alternate color-scheme by setting the variable GRAPH_ALT=1 on the command line: make GRAPH_ALT=1 graph-build Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* mention nconfigShawn Landden2013-12-091-1/+1
| | | | | Signed-off-by: Shawn Landden <shawn@churchofgit.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: cleanup and update editor tagsSamuel Martin2013-02-171-0/+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: trivial fixesArnout Vandecappelle (Essensium/Mind)2012-11-271-4/+4
| | | | | Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: minor tweaksSimon Dawson2012-11-161-4/+4
| | | | | | | | | Minor grammatical and spelling tweaks to the manual content. Signed-off-by: Simon Dawson <spdawson@gmail.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: rework using.txt and update common-usage.txtSamuel Martin2012-11-151-0/+95
| | | | | | | | | | | | | | Consider the second chapter: "starting-up", as a tutorial. Assuming that, using.txt only contains the very first commands used to get configure and build its very first target system. So, the following subsection from using.txt have been to common-usage.txt: - Offline builds - Building out-of-tree - Environment variables Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: rework the whole documentation stubSamuel Martin2012-11-151-0/+6
The new skeleton of the manual as it has been thought: 1. About Buildroot: Presentation of Buildroot 2. Starting up: Everything to quickly and easily start working with Buildroot 3. Working with Buildroot Basics to make your work fitting your needs 4. Troubleshooting 5. Going further in Buildroot's innards Explaination of how buildroot is organised, how it works, etc 6. Developer Guidelines 7. Getting involved 8. Contibuting to Buildroot 9. Legal notice 10. Appendix It is easy to distinguish two parts in this plan: - Sections 1 to 4 mainly address people starting with Buildroot - Sections 5 to 10 are more focused on how to develop Buildroot itself Most of the existing sections have just been moved in the hierarchy, few were split and dispatch in, what i think was the relevant section, and numerous others have been created. Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
OpenPOWER on IntegriCloud