summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc: dev/ref manual: describe the <PKG>_PATCHES variableRoland Hieber2019-10-082-1/+14
| | | | | | Fixes: 2e2242356f0bc72a56bc ("ptxd_make_world_patchin: allow specifying a custom patch directory") Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: dev manual: patches: clean up literal formattingRoland Hieber2019-10-081-3/+3
| | | | | | | | Make variable formatting consistent with the rest of the document by using reST syntax instead of Markdown syntax. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* ptxdist: improve variable printingMichael Olbrich2019-10-031-0/+9
| | | | | | | | | This adds a new 'printnext' command. It prints the value of the value of the variable. The print code is refactored to allow this. The make error must be parsed to determine which variable is undefined. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: environment: correct typos, grammar and wordingRoland Hieber2019-09-191-9/+9
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: contributing: mention configure_helper.py support for cmakeRoland Hieber2019-09-191-7/+2
| | | | | | | | This was introduced in commit 41d0336d4aec17d671f2 ("configure_helper: add cmake support"). Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* ptxd_make_world_prepare_init: allow keeping the build tree during prepare ↵Michael Olbrich2019-09-161-0/+5
| | | | | | for oot packages Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: update toolchain installation instructionsMichael Olbrich2019-09-062-9/+60
| | | | | | | The build instructions for OSELAS.Toolchain-2019.09.0 are a bit different. Extend the build instructions to handle old and new toolchains. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: remove empty chapter "Working with GIT sources"Roland Hieber2019-09-033-9/+1
| | | | | | | | | | | | | | All options for git:// <PKG>_URLs are explained in that same paragraph, `git ptx-patches` is already explained in the "Patching Packages" chapter, and out-of-tree building is explained in the Daily Work chapter. If anything else related to Git is still open, this chapter can be re-added later, but it is useless for now (and regularly confuses me when looking for the location where all those things mentioned above are explained). Fixes: 185c2bebaa1686f2faac ("Split the daily-work section into separate files") Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: dev manual: proof-read and update the "Patching Packages" sectionRoland Hieber2019-09-031-19/+33
| | | | | | | | | | | Remind the reader to upstream their patches, mention the layer mechanism for search order, fix the logical structure of the whole chapter by removing the superfluous "Creating Patches for a Package" header, mention why `--git` can break packages, and general proof-reading and typo correction. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: dev_manual: fix typosUlrich Ölmann2019-08-241-20/+20
| | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: dev_manual: add explanation of *_SOURCE variableUlrich Ölmann2019-08-241-0/+2
| | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* ptxdist: document 'getdev' actionRoland Hieber2019-08-241-0/+5
| | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: dev_manual: two URL fixesRoland Hieber2019-07-071-2/+2
| | | | | | | | | | The gnu.org URL never showed SPDX identifiers, replace it by a link to the official license list. The licenses-list repository has been renamed and restructured. Signed-off-by: Roland Hieber <rohieb@rohieb.name> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_make_macros: document new ptx/wow macroRoland Hieber2019-07-071-0/+3
| | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* rootfs: keep /var writable, even if the rootfs is read-onlyJuergen Borleis2019-06-281-0/+101
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Having a read-only root filesystem is always a source of pain and trouble. Many applications and tools expect to be able to store their state or caching data or at least their logs somewhere in the filesystem. The '/var' directory tree has a well known structure according to the "File System Hierarchy Standard" and is used by all carefully designed programs. Thus, this change provides a way to have this '/var' directory tree writable, even if the main root filesystem is mounted read-only. It uses an overlay filesystem and by default a RAM disk to store changed and added data to this directory tree in a non persistent manner. Due to the nature of the overlay filesystem the underlaying files from the main root filesystem can still be accessed. This approach requires the overlay filesystem support from the Linux kernel. In order to use it, the feature CONFIG_OVERLAY_FS must be enabled. The ugly details to establish the required overlaying filesystem are hidden behind a "mount helper" for a dummy filesystem (here called 'varoverlayfs'). Thus, a BSP can change the overlaying filesystem by providing its own 'run-varoverlay.mount' in order to restrict the default RAM disk differently or to switch to a different local storage. The '/etc/fstab' file gets touched in this change, to enable some already used RAM disks on demand, to gain backward compatibility if no overlay approach is used. Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: remove obsolete pipe from code blockThorsten Scherer2019-06-281-1/+1
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: update '--dirty' documentationMichael Olbrich2019-06-251-1/+1
| | | | | | | | With the latest improvements, changes patches will cause the extract stage to be executed again. '--dirty' can be used to skip this. Expand the documentation accordingly. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_make_macros: add more details to the 'extract' documentationMichael Olbrich2019-06-251-0/+6
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* ptxd_lib_dgen: error out for targetinstall stages in host/cross/image packagesRoland Hieber2019-06-121-0/+12
| | | | | | | | | | This point came up multiple times in the past and the special handling of targetinstall stages lead to confusion when trying to depend on image packages. Document it to prevent further confusion in that matter, and warn the user if such a make target exists. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_make_macros: improve language, typos and markupRoland Hieber2019-06-121-11/+7
| | | | | | | | | | | | | The literal blocks don't need to be code-blocks, as there is no code to be highlighted. Turn down the inline markup to make the text better readable. A technical term doesn't need to be emphasized every time it occurs. Use semantic newlines where applicable. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* 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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-20 01:52:39 +0000