summaryrefslogtreecommitdiffstats
path: root/doc/ref_manual.rst
Commit message (Collapse)AuthorAgeFilesLines
* doc: introduce ref_code_signing_helpersBastian Krause2020-06-191-0/+1
| | | | | | | | Signed-off-by: Bastian Krause <bst@pengutronix.de> Reviewed-by: Roland Hieber <rhi@pengutronix.de> Tested-by: Ladislav Michl <ladis@linux-mips.org> Message-Id: <20200617143125.23999-7-bst@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_manual: break up large HTML file into smaller chaptersRoland Hieber2020-06-051-6/+6
| | | | | | | | | This chapter is getting very long and could also profit from an extra table of contents. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Message-Id: <20200604121533.27886-2-rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_manual: move section start into ref_parameter.incRoland Hieber2020-06-051-10/+0
| | | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Message-Id: <20200604121533.27886-1-rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_manual: split up into multiple filesRoland Hieber2019-04-051-1539/+3
| | | | | | | | | | The reference manual has gotten quite big now. Split it up into three files so it is easier to navigate for editing. No further change to the content. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: add ptx/truefalse macro descriptionMarco Felsch2019-03-131-0/+27
| | | | | Signed-off-by: Marco Felsch <m.felsch@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: describe a strange behaviour and its solutionJuergen Borleis2019-02-261-0/+2
| | | | | | | | Using a unusual 'umask' leads to a strange erroneous behaviour. This was reported on the PTXdist mailing list. Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: follow 'proselint' and improve the textJuergen Borleis2019-02-261-2/+2
| | | | | | | Follow the hints of the nice tool 'proselint'... Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* introduce 'world/execute' and 'execute' macrosMichael Olbrich2019-02-191-4/+26
| | | | | | | | With these, arbitrary commands can be executed in the build stages. They habe the advantage that the environment is identical to the default build stages. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: add some basic documentation for 'world/*' and 'compile'Michael Olbrich2019-02-191-0/+27
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref manual: fix typosUlrich Ölmann2019-02-131-2/+2
| | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref manual: document {HOST_, CROSS_, EXTRA_, }PACKAGES{-y, -m, } variablesRoland Hieber2019-01-121-0/+25
| | | | | | | | Some of them are already mentioned in the developer manual part, but it makes sense to have all of them in the reference too. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: Fix typosAhmad Fatoum2018-10-051-5/+5
| | | | | Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: fix and improve rule file documentationMichael Olbrich2018-10-051-92/+134
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: add missing search paths for install_alternativeMichael Olbrich2018-09-211-1/+3
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: initial layer documentationMichael Olbrich2018-09-211-0/+57
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: Fix wrong use of PKGDIRptxdist-2018.09.0Alexander Dahl2018-09-171-1/+1
| | | | | | | | | | | | $(PKGDIR) expands to <platform-dir>/packages/ and contains folders with package names where artefacts from the install stage go, e.g. foo-1.0 from the package FOO. There is no root folder hierarchy directly in $(PKGDIR), but one for each package in the subfolders. For the targetinstall stage the source is the matching subfolder for the package's targetinstall, $(FOO_PKGDIR) expands to that. Signed-off-by: Alexander Dahl <ada@thorsis.com> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: document which links are installed by install_libMichael Olbrich2018-07-231-1/+5
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* image-root-tgz: Add IMAGE_ROOT_TGZ_LABEL optionJon Ringle2018-07-131-0/+4
| | | | | Signed-off-by: Jon Ringle <jringle@gridpoint.com> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: add daily work section about creating new imagesMichael Olbrich2018-06-151-0/+2
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* Doc: add license related informationJuergen Borleis2017-12-081-1/+1
| | | | | | | Dealing with licenses is very important...and really boring. This change gives some hints how to survive this task. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: adapt autotools template documentationJuergen Borleis2017-11-171-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: improve the reference manual partJuergen Borleis2017-11-141-11/+55
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Documentation: avoid warning for unparsable make syntaxRobert Schwebel2017-06-211-3/+3
| | | | | | | | | | | | These examples are by far no pure make, so remove the syntax highlighting hint for make, to make this warning go away: docs/ref_manual.rst:980: WARNING: Could not lex literal_block as "make". Highlighting skipped. docs/ref_manual.rst:1011: WARNING: Could not lex literal_block as "make". Highlighting skipped. docs/ref_manual.rst:1040: WARNING: Could not lex literal_block as "make". Highlighting skipped. Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* Documentation: avoid warning for unparsable make syntaxRobert Schwebel2017-06-211-3/+4
| | | | | | | | | Make this warning go away, by adding more make syntax: ref_manual.rst:959: WARNING: Could not lex literal_block as "make". Highlighting skipped. Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* Documentation: avoid "Title underline too short" warningsRobert Schwebel2017-06-211-1/+1
| | | | | | | The underline is too sort, adapt. Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: add some image package documentationMichael Olbrich2017-02-091-0/+50
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: add section about install_replaceAlexander Dahl2017-01-051-0/+38
| | | | | | | | This describes the install_replace macro. Some text stolen from rules/post/install.make and the existing documentation of install_lib. Signed-off-by: Alexander Dahl <post@lespocky.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* install_*: don't install a file at all if it's a symlink to /dev/nullMichael Olbrich2016-08-151-0/+10
| | | | | | | | | | | | | This is mostly useful for install_alternative/install_alternative_tree. There are use-cases where individual files installed by upstream packages are unwanted for some reason. With this change, such files can be masked by providing a symlink to /dev/null as alternative. This makes it possible to remove such files without copying and modifying the rule. Note: this does not affect install_link, so creating links to /dev/null is still possible. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* root-debug: remove it everywhereMichael Olbrich2016-07-231-8/+0
| | | | | | | | | | | Separate debug files in .debug/ directories in root/ have been available for some time. This is supported by all modern toolchains and much less confusing. Remove all references to root-debug except for cleaning: This way there won't be old root-debug/ directories lying around after upgrading and running 'ptxdist clean' or 'ptxdist clean root'. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: <PKG>_MAKE_ENV is empty by defaultMichael Olbrich2016-07-011-4/+3
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: fix section level for 'touch'Michael Olbrich2016-06-221-1/+1
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* Wipe out mention the PTXdist 'generic' directory.Juergen Borleis2016-06-201-2/+2
| | | | | | This should be 'projectroot' instead. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* install_alternative: adapt the docs to the real worldJuergen Borleis2016-06-201-3/+5
| | | | | | | The listed directory search order corresponds to the one used in 'scripts/lib/ptxd_make_xpkg_pkg.sh' in function *ptxd_install_setup_src()' Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Fix yet more typos.Juergen Borleis2016-06-201-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Split the daily-work section into separate filesJuergen Borleis2016-06-201-1/+2
| | | | | | ...to be able to replace or append the content individually. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Use the really used PTXdist release versionJuergen Borleis2016-06-201-1/+1
| | | | | | | To not confuse newbies following this doc their first time be as exact as possible with the path. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Let Spinx link both sectionsJuergen Borleis2016-06-201-2/+6
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Just fix a typoJuergen Borleis2016-06-201-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Fix path description for alternative filesJuergen Borleis2016-06-201-0/+2
| | | | | | | The directory in the PTXdist installation is the same 'projectroot' as for regular BSPs and platforms. So, use this directory name now. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Fix spelling: 'run-time' versus 'runtime'Juergen Borleis2016-06-201-2/+2
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* doc: cleanup substitutions and use code sectionsMichael Olbrich2016-06-201-2/+2
| | | | | | | | | Now, that substitutions happen before the sphinx run, the '\ ' magic so that the substitute patters are found, are no longer needed. And code sections can now be used here. This is needed to break long lines for in latex output. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: 'file://' is not a URLMichael Olbrich2016-06-201-4/+4
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: rename files to avoid warningsMichael Olbrich2016-06-201-1/+1
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: document install_globMichael Olbrich2016-05-291-0/+54
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: cleanup & expand variable referenceMichael Olbrich2015-12-031-85/+295
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* docs: split parameter documentation into a separate fileMichael Olbrich2015-12-031-120/+1
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* Reference manual: provide one more referenceJuergen Borleis2015-12-031-0/+2
| | | | | | | Connect the user's manuals and the reference part. Maybe both sections provide the same and should be melded. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Reference manual: make it more clear what's meantJuergen Borleis2015-12-031-6/+8
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Reference manual: spelling fixedJuergen Borleis2015-12-031-2/+2
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Reference manual: JFFS2 is outdated....Juergen Borleis2015-12-031-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-19 14:42:26 +0000