summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc: highlight inline code with gray boxEnrico Jorns2020-09-111-0/+3
| | | | | | | | | This should ease distinguishing inline code snippets from default text and is also more similar to what the sphinx html outputs look like. Signed-off-by: Enrico Jorns <ejo@pengutronix.de> Message-Id: <20200911103204.9745-1-ejo@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_make_macros: make clear that permission should be four digitsRoland Hieber2020-08-211-3/+3
| | | | | | | | | | | | Three octal digits are not enough, we must also respect the sticky/setuid/setgid bits. Even if these are mostly implied to be 0, we should be explicit here. This should also help to prevent permission clashes when more than one packages install the same directory. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Acked-by: Alexander Dahl <ada@thorsis.com> Message-Id: <20200819105909.21441-1-rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_make_macros: unify and fix label namesRoland Hieber2020-08-212-6/+4
| | | | | | | | | | The install_copy label was in the wrong place, remove it. We already had install_copy,reference too. Remove the ',reference' part from the already existing to be in line with the other labels in the same file. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Message-Id: <20200819105144.17850-1-rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref parameter: document 'alldefconfig'Roland Hieber2020-08-141-4/+5
| | | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Message-Id: <20200807104425.30276-3-rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* ptxdist: improve umask handlingMichael Olbrich2020-08-141-0/+8
| | | | | | | | | | | | | Currently any umask other than 0022 is not really supported. There is no check but strange things may happen, either at build-time or at runtime. Improve this by: - setting the umask to 0022 if it it currently more permissive - fail with a clear error message if it is more restrictive Expand the documentation to explain the new behaviour. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* docs: limit the characters allowed for the PDF file nameMichael Olbrich2020-07-051-1/+4
| | | | | | | | ptxdistHwVendor and ptxdistHwProduct may contain any character, including spaces. This breaks building the PDF documentation. Avoid this by replacing any sequence of special characters with a '-'. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: fix man page generationptxdist-2020.07.0Michael Olbrich2020-07-031-1/+1
| | | | | | | ref_parameter.inc was renamed to ref_parameter.rst. Update the man page generation to use the new file name. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: dev_code_signing: add "Managing Certificate Authority Keyrings"Bastian Krause2020-06-261-0/+26
| | | | | | Signed-off-by: Bastian Krause <bst@pengutronix.de> Message-Id: <20200624160849.6966-2-bst@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_code_signing_helpers: clarify CA keyring function usageBastian Krause2020-06-261-7/+17
| | | | | | Signed-off-by: Bastian Krause <bst@pengutronix.de> Message-Id: <20200624160849.6966-1-bst@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: introduce ref_code_signing_helpersBastian Krause2020-06-192-0/+249
| | | | | | | | 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: dev_code_signing: rework and extend code signing sectionBastian Krause2020-06-191-23/+125
| | | | | | | | 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-6-bst@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: move code signing docs from scripts/ into doc/Bastian Krause2020-06-192-0/+37
| | | | | | | | 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-5-bst@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: dev_manual: split up into multiple filesBastian Krause2020-06-196-1755/+1749
| | | | | | | | | | | | | Split the lengthy developer's manual into multiple files to ease navigation when editing. No further change to the content. 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-4-bst@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* ptxdist: add licensecheck command for individual packagesMichael Olbrich2020-06-051-2/+3
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_manual: break up large HTML file into smaller chaptersRoland Hieber2020-06-055-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-052-10/+11
| | | | | | 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>
* ptxdist: add licensecheck commandRoland Hieber2020-05-291-0/+3
| | | | | | | | | | Make it possible to check all MD5 sums of license files by building all report stages without also building the license report (which produces tons of LaTeX output). Signed-off-by: Roland Hieber <rhi@pengutronix.de> Message-Id: <20200529091339.8396-1-rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: update toolchain to 2019.09.1Philipp Zabel2020-05-291-1/+1
| | | | | | | | | Update the toolchain fallback to OSELAS.Toolchain-2019.09.1 so the official documentation suggests the latest bugfix release. Signed-off-by: Philipp Zabel <p.zabel@pengutronix.de> Message-Id: <20200528082554.31439-1-p.zabel@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: daily_work: fix "title underline too short" warningRoland Hieber2020-04-241-1/+1
| | | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Message-Id: <20200423214035.2482-1-rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: add some documentation about file permissions on nfsrootMichael Olbrich2020-04-091-0/+44
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc/welcome.rst: fix spellingFelicitas Jung2020-04-071-14/+14
| | | | | | | Signed-off-by: Felicitas Jung <f.jung@pengutronix.de> Reviewed-by: Roland Hieber <rhi@pengutronix.de> Message-Id: <20200406120227.8669-1-f.jung@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: Fix typos found by codespellAlexander Dahl2020-03-2010-18/+18
| | | | | | | Reviewed-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Alexander Dahl <ada@thorsis.com> Message-Id: <20200310212623.22821-4-post@lespocky.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* configure_helper: allow passing --force to ptxdistRoland Hieber2020-01-241-0/+3
| | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: patches for ptxdist upstream should be created with gitMichael Olbrich2020-01-241-0/+3
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: ref_make_macros: add missing binary ptx/* switches to header and usageRoland Hieber2019-11-281-2/+5
| | | | | | | | These macros are mentioned in the table below, but are not found in the header or the usage. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* 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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-26 10:48:27 +0000