summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* doc: ref_make_macros: document the 'extract' macroRoland Hieber2019-06-121-0/+15
| | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* templates: add src-meson-prog templateUlrich Ölmann2019-06-051-7/+29
| | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* ptxdist: clean root should clean all image packages tooRoland Hieber2019-05-241-1/+1
| | | | | | | | The images are already removed by 'clean root', so the image packages are built again anyways on the next build. Remove all left-over state for the image packages too, as those files are now useless. Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* ptxdist: introduce the "clean target" subcommandRoland Hieber2019-05-241-0/+6
| | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_make_macros: document ptx/yesno, ptx/falsetrue, ptx/onoffRoland Hieber2019-04-051-0/+22
| | | | | | | Sort them thematically betweem the existing macros. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_make_macros: merge parameter macros into a single sectionRoland Hieber2019-04-051-119/+46
| | | | | | | | | | | All of these macros can be explained concisely with one table and one combined example, no need to repeat a whole section and paragraph of the text for each one of them that only differ in a few words. Also mention some use cases, and give real-life examples from existing code to better explain the usage. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_make_macros: install_tree knows a "strip" parameter tooRoland Hieber2019-04-051-1/+5
| | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_manual: split up into multiple filesRoland Hieber2019-04-054-1539/+1542
| | | | | | | | | | 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: remove search page and genindex from indexBastian Krause2019-03-251-4/+0
| | | | | | | | | | | | | | | | | | | | | | The ptxdist documentation does not use index directives (e.g. ".. index:: Foo"), so the automatically generated index page is always empty. So remove it. If this directive is used some day we can add it again. The ptxdist theme already includes search functionality, so remove the search directive as well. These special names are documented here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#special-names This is also a workaround for a sphinx bug accidentally showing these directives in pdf output: https://github.com/sphinx-doc/sphinx/issues/2827 Signed-off-by: Bastian Krause <bst@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: 'notice' environment was replaced by 'sphinxadmonition'Enrico Joerns2019-03-131-1/+10
| | | | | | | | | | | | | | | | | | | | Spinx deprecated 'notice' environment in 1.6b1 and finally removed in 1.7.0b1. Anyway, environment renewal to show warning symbol for note rst directive was not working in between. This patch both fixes warning symbol in sphinx versions between 1.6b1 and 1.7.0b1 and tex generation error after version 1.7.0b1: | ! LaTeX Error: Environment notice undefined. Instead of renewing a possible non-existing environment, we create a new one and override sphinxadmonition environment only if it existed before, or notice environment if not. Signed-off-by: Enrico Joerns <ejo@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: it's an open project, thus use open fontsEnrico Joerns2019-03-131-2/+2
| | | | | | | This replaces LT Project font by Open Sans. Signed-off-by: Enrico Joerns <ejo@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: daily work: multi images: fix typos and apply more markupRoland Hieber2019-03-011-3/+3
| | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: improve the suboption name scheme descriptionJuergen Borleis2019-02-261-3/+4
| | | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: follow the rule to use breaking linesJuergen Borleis2019-02-261-3/+4
| | | | | | | Synchronize the examples. Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: mention dedicated PTXdist macros to be used in rule filesJuergen Borleis2019-02-261-31/+9
| | | | | | | | | In order to simplify rule files, it's worth to use more of the provided rule file option macros PTXdist already provides. Show only this optimized example and remove the previous version from the old days. Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: describe a strange behaviour and its solutionJuergen Borleis2019-02-262-0/+18
| | | | | | | | 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-263-4/+4
| | | | | | | 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>
* doc: BUILDTIME versus RUNTIMEJuergen Borleis2019-02-262-0/+63
| | | | | | | | Describe the difference of some detailed dependency descriptions in Kconfig menufiles. Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* ptxdist: add new command 'bsp-info'Michael Olbrich2019-02-201-0/+4
| | | | 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: document local_src clean behaviourRouven Czerwinski2019-01-231-0/+5
| | | | | | | | | For local_src directories, ptxdist only calls the clean command on a full clean, not for a clean with the individual package. Document this in a note for the workflow. Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_parameter: we no longer have separate image sections in menuRoland Hieber2019-01-161-3/+0
| | | | | Signed-off-by: Roland Hieber <rohieb@rohieb.name> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_parameter: copy editing, readability improvements and typo fixesRoland Hieber2019-01-161-50/+56
| | | | | Signed-off-by: Roland Hieber <rohieb@rohieb.name> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref manual: document {HOST_, CROSS_, EXTRA_, }PACKAGES{-y, -m, } variablesRoland Hieber2019-01-122-0/+27
| | | | | | | | 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>
* ptxdist: add --progress optionMichael Olbrich2018-12-061-0/+6
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* ptxdist: add --dirty optionMichael Olbrich2018-10-171-0/+9
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: fix link to the mailing listMichael Olbrich2018-10-172-1/+3
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: user_manual: use |ptxdist{BSP, Platform}Name| where appropriateAhmad Fatoum2018-10-092-4/+7
| | | | | | Suggested-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* rules: introduce EXTRA_PACKAGESMichael Olbrich2018-10-061-2/+2
| | | | | | | | | | Packages that are added to this list will be built normally during 'ptxdist go'. However, they are not installed into a root filesystem by default. This is useful for specialized packages that are only needed for specific images. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: Fix typosAhmad Fatoum2018-10-056-28/+28
| | | | | Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: environment: general proof-reading and copy editingRoland Hieber2018-10-051-106/+106
| | | | | | | | | | | | Yes, this patch looks kind of messy, but it hopefully tidies the environment section up. A lot of the patch is just inserting punctuation at the right places and omitting them in not so right places, harmonizing spelling, adding reST markup, and bringing the text up to date. Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> [mol: remove bogus newline] Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: contributing: fix typos, add links, and make text easier to parseRoland Hieber2018-10-051-15/+16
| | | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: getting help: prune section with only one subsectionRoland Hieber2018-10-051-5/+2
| | | | | | | | | Previously several mailing lists were mentioned in this section, but now it has been shrunk down to only the PTXdist mailing list. Reflect this change in the section header. Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: dev_manual: improve Patch Series sectionRoland Hieber2018-10-051-14/+14
| | | | | | | | A list is better readable here than prose. Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> [mol: keep using ptxdistPlatformConfigDir] Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: hide incorrect figureMichael Olbrich2018-10-051-5/+6
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: fix pre-built archive documentationMichael Olbrich2018-10-051-4/+4
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: fix and improve rule file documentationMichael Olbrich2018-10-052-92/+136
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: Fix typo in layer documentationGavin Schenk2018-09-271-1/+1
| | | | | Signed-off-by: Gavin Schenk <g.schenk@eckelmann.de> 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-213-0/+170
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* ptxdist: add package-info commandMichael Olbrich2018-09-191-0/+6
| | | | 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: add contributing guidelinesMichael Olbrich2018-08-012-0/+171
| | | | 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>
* doc: clarify relative path handling for 'local-src'Michael Olbrich2018-07-231-0/+1
| | | | 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: clear variable to avoid warningMichael Olbrich2018-06-201-0/+2
| | | | | | | | | | Without this, Sphinx v1.7.5 will produce the following warning: WARNING: the config value 'line' is set to a string with non-ASCII characters; this can lead to Unicode errors occurring. Please use Unicode strings, e.g. 'Content'. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-19 09:09:45 +0000