summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* doc: fix highlight parser warningsMichael Olbrich2018-06-201-3/+3
| | | | | | | These code sections cannot be parsed as 'make' code so don't try to use it. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: add section about creating new templatesMichael Olbrich2018-06-201-0/+78
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: add daily work section about creating new imagesMichael Olbrich2018-06-154-0/+103
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* remove obsolete and broken klibc/initramfsMichael Olbrich2018-05-301-4/+0
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: daily work: gdbtui is now gdb --tuiRoland Hieber2018-03-101-1/+1
| | | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: document 'ptxdist gdb'ptxdist-2018.03.0Michael Olbrich2018-03-051-0/+4
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: the toolchain is installed to /opt not opt/Michael Olbrich2018-02-051-3/+3
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: environment: update link to toolchain downloadRoland Hieber2018-02-051-3/+3
| | | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* Doc: add license related informationJuergen Borleis2017-12-082-1/+46
| | | | | | | 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: fix leftover from Latex to RST conversionJuergen Borleis2017-12-081-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: avoid syntax highlighting by accidentJuergen Borleis2017-12-081-36/+38
| | | | | | | Some tools try to be smart and thus using an improper syntax highlighting. This change avoids guessing the highlighting by explicitly define it. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Docs: we now can provide more refers to the documentationJuergen Borleis2017-12-081-2/+3
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: just be in timeptxdist-2017.12.0Juergen Borleis2017-12-051-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: use a more recent toolchain as a defaultJuergen Borleis2017-12-051-1/+1
| | | | | | | We have end of 2017. Use the last OSELAS.Toolchain release as the new default in the absence of a BSP. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: the archive hint is from stone ageJuergen Borleis2017-12-051-1/+1
| | | | | | But keep this text, just give hint for other sources for a BSP. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: use the same help like the new website doesJuergen Borleis2017-12-051-5/+3
| | | | | | The new URL avoids the manual search for the PTXdist archive. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: remove hint to an outdated mailing listJuergen Borleis2017-12-051-10/+0
| | | | | | | This German language mailing list is dead since ages. Remove it from the documentation to avoid any confusion. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: use new website's URLJuergen Borleis2017-12-053-3/+3
| | | | | | | PTXdist's documentation is moved to a new website URL. Use the new URL all over the place. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* PTXdist: add virtual environment awarenessJuergen Borleis2017-11-172-1/+5
| | | | | | Required to work with local python tools. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: improve the 'build the docs' documentationJuergen Borleis2017-11-171-37/+64
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: adapt autotools template documentationJuergen Borleis2017-11-172-191/+351
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: make use of the PTXdist 'local-src' parameterJuergen Borleis2017-11-171-2/+4
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: define the 'xelatex' as the tool to be usedJuergen Borleis2017-11-141-0/+2
| | | | | | Generating the PDF-documentation fails with the Sphinx default tool. 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>
* Doc: avoid syntax highlighting by accidentJuergen Borleis2017-11-141-32/+32
| | | | | | | Some tools try to be smart and thus using an improper syntax highlighting. This change avoids guessing the highlighting by explicitly disable it. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* doc: pre-built packages: some additionsUlrich Ölmann2017-09-131-0/+8
| | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: pre-built packages: enhance phrasingUlrich Ölmann2017-09-131-27/+26
| | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: pre-built packages: english genitive uses an apostropheUlrich Ölmann2017-09-131-9/+9
| | | | | | | Exchange U+2019 (right single quotation mark) by a simple apostrophe. Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: pre-built packages: use consistent style in enumerationsUlrich Ölmann2017-09-131-9/+9
| | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: pre-built packages: adjust capitalization in headingsUlrich Ölmann2017-09-131-6/+6
| | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: pre-built packages: fix typosUlrich Ölmann2017-09-131-42/+42
| | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: fix resource spellingLadislav Michl2017-08-281-2/+2
| | | | | Signed-off-by: Ladislav Michl <ladis@linux-mips.org> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: fix some typos and spelling errorsptxdist-2017.07.0Michael Olbrich2017-07-201-9/+9
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: impove git workflow documentationMichael Olbrich2017-07-201-0/+6
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: css: use more ptxdist-like colors for admonitionsRoland Hieber2017-07-201-0/+14
| | | | | | | | | | | | | | | | The old colors for note blocks and important blocks didn't go well with the PTXdist logo, so use colors from the logo instead. Screenshots: Before: https://gist.github.com/rohieb/87e5d527c283a42e0919d07a44af3641/raw/8f1612b8f2c9d10f484e54f3f23dff5edbd6e473/29237df2-688d-11e7-be43-cfe49cbb0ea2.png https://gist.github.com/rohieb/87e5d527c283a42e0919d07a44af3641/raw/8f1612b8f2c9d10f484e54f3f23dff5edbd6e473/fd2ff4f6-688b-11e7-beb0-dfc6959582bc.png After: https://gist.github.com/rohieb/87e5d527c283a42e0919d07a44af3641/raw/8f1612b8f2c9d10f484e54f3f23dff5edbd6e473/cca5934e-688c-11e7-b185-376b499e80bb.png https://gist.github.com/rohieb/87e5d527c283a42e0919d07a44af3641/raw/8f1612b8f2c9d10f484e54f3f23dff5edbd6e473/b581da92-688c-11e7-8fb3-8792133838e3.png Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: faq: copy editing, small rewrites for more clarityRoland Hieber2017-07-201-32/+37
| | | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: faq: apply more structureRoland Hieber2017-07-201-149/+181
| | | | | | | | | | Give the FAQ section some more structure by inserting one heading per FAQ item, and separate questions and answers visible. This also causes the questions to appear in the table of contents. Both should lead to more readability of the FAQ section. Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: promote faq to own sectionRoland Hieber2017-07-203-1/+1
| | | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: document git patch workflowRoland Hieber2017-07-201-4/+51
| | | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: mention configure-helper.pyRoland Hieber2017-06-211-0/+32
| | | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-25 04:54:32 +0000