summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc: document the new SAMA5D2 boardsAhmad Fatoum2020-11-012-0/+24
| | | | | | | | Add some basic documentation for the two new boards added in the previous commits. Suggested-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
* doc: rpi: mention that Raspberry Pi Zero W is also supportedRoland Hieber2020-09-152-4/+4
| | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: hardware: add toctrees for mips and x86_64Roland Hieber2020-09-041-0/+30
| | | | | | | | | | | sphinx complained about them: checking consistency... .../distrokit/platform-x86_64/state/docs/hardware_mips_qemu.rst: WARNING: document isn't included in any toctree .../distrokit/platform-x86_64/state/docs/hardware_x86_64_qemu.rst: WARNING: document isn't included in any toctree done Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: hardware: strip down boilerplate documentationRoland Hieber2020-09-041-55/+39
| | | | | | | | | It is enough to describe only once how to select the platform and build the images, as the steps are the same for every platform. Only the platformconfig and the toolchain architecture changes, so summarise them in a table at the beginning of the section. Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: restructure the quick start steps in the introRoland Hieber2020-09-042-13/+32
| | | | | | | | | | Give a brief documentation on how to install the correct PTXdist and toolchain versions, and update outdated links to the PTXdist homepage. Signed-off-by: Roland Hieber <rhi@pengutronix.de> --- Robert, this relies on updated documentation on the PTX homepage. Please merge www.pengutronix.de, branch rhi/topic/toolchain-install first :-)
* add x86_64 platformOleksij Rempel2020-07-241-0/+6
| | | | | | and add a qemu script for testing. Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
* platform-mips: add basic qemu malta supportOleksij Rempel2020-02-161-0/+13
| | | | | | | | Currently this platform can build rootfs and run only barebox. Other parts need more work, but even on this stage we would be able to make toolchain and barebox regression tests. Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
* doc: hardware: reduce clutter in sub-toctreesRoland Hieber2020-01-071-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | All those hardware sections have roughly the same sub-sections, reduce it to only the board names: 2.1.1.1. QEmu 2.1.1.2. Beaglebone White 2.1.1.2.1. Boot Media 2.1.1.2.2. Serial Console 2.1.1.3. Beaglebone Black 2.1.1.3.1. Boot Media 2.1.1.3.2. Serial Console 2.1.1.4. Boundary Devices Nitrogen6X 2.1.1.4.1. Bootloader 2.1.1.4.2. Boot Media 2.1.1.4.3. Serial Console 2.1.1.5. RIoT-Board 2.1.1.5.1. Boot Media 2.1.1.5.2. Serial Console 2.1.1.6. Raspberry Pi 2 2.1.1.6.1. Boot Media 2.1.1.6.2. Serial Console 2.1.1.7. Raspberry Pi 3 2.1.1.7.1. Boot Media 2.1.1.7.2. Serial Console 2.1.1.8. Udoo Neo 2.1.1.8.1. Boot Media 2.1.1.8.2. Serial Console Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: fix sphinx warning "guru is already assigned section numbers"Roland Hieber2020-01-071-1/+0
| | | | | | | | guru.rst is included from index.rst, which already assigned the numbers in the toctree, so we don't need to number the toctree in guru.rst again. Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: add infos about contributing and licenseRoland Hieber2020-01-071-0/+54
| | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: hardware: degrade header levelRoland Hieber2020-01-071-3/+3
| | | | | | These subsections belong to the respective platform sections. Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: guru: sync with upstream PTXdistRoland Hieber2020-01-072-4/+2
| | | | | | | | | | | | Add contributing.rst from upstream PTXdist (sphinx warns about "docs/contributing.rst: WARNING: document isn't included in any toctree") and move faq.rst from intro.rst to guru.rst for the sake of consistency. Remove the index and search pages in guru.rst, as they are already included in index.rst at the top level. Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: note that platform-rpi is not actively maintained currentlyRoland Hieber2020-01-071-0/+8
| | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* Add support for Marvell espressobin2018-02-espressobin-v3Uwe Kleine-König2018-03-112-0/+32
|
* doc: v7a: riotboard: document boot switch settingsRoland Hieber2018-03-111-1/+12
| | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>
* doc: v7a: document Nitrogen6X boardDistroKit-2018.03.0Roland Hieber2018-02-192-0/+23
| | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>
* doc: v7a: include a generic way to get DistroKit running on new boardsRoland Hieber2018-01-221-0/+42
| | | | | | | | A short overview of our several barebox packages and images should suffice here, everything else should be added in the upstream PTXdist manual. Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>
* doc: index: also include the FAQRoland Hieber2018-01-221-0/+1
| | | | | | | | Sphinx warns that this document isn't included in any toctree, and we should include it as it probably constitutes the most important section :-) Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>
* doc: raspi3: fix typo in headerRoland Hieber2018-01-221-1/+1
| | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>
* doc: add documentation for platform-rpiRoland Hieber2017-07-132-0/+52
| | | | Signed-off-by: Roland Hieber <rohieb@rohieb.name>
* doc: udoo neo: extend documentationChris Fiege2017-07-042-0/+19
| | | | | | | | | The documentation does now contain the names of the images and information about where to find the serial console ports of the boards. Signed-off-by: Chris Fiege <c.fiege@pengutronix.de> [improve commit message, split from last patch] Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: rpi3: extend documentationChris Fiege2017-07-042-1/+12
| | | | | | | | | The documentation does now contain the names of the images and information about where to find the serial console ports of the boards. Signed-off-by: Chris Fiege <c.fiege@pengutronix.de> [improve commit message, split from last patch] Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: rpi2: extend documentationChris Fiege2017-07-042-1/+12
| | | | | | | | | The documentation does now contain the names of the images and information about where to find the serial console ports of the boards. Signed-off-by: Chris Fiege <c.fiege@pengutronix.de> [improve commit message, split from last patch] Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: riotboard: extend documentationChris Fiege2017-06-302-0/+16
| | | | | | | | | The documentation does now contain the names of the images and information about where to find the serial console ports of the boards. Signed-off-by: Chris Fiege <c.fiege@pengutronix.de> [improve commit message, split from last patch] Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: extend documentation for supported hardwareChris Fiege2017-06-304-5/+25
| | | | | | | | | | | | | | | The documentation does now contain the names of the images and information about where to find the serial console ports of the boards. As some hardware platforms do currently not work again after the recent rework, we remove them from the ToC for now and re-add them later when they have been tested and fixed. Adding Build doc to .gitignore. Signed-off-by: Chris Fiege <c.fiege@pengutronix.de> [improve commit message] Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: add sphinx/rst based documentationRobert Schwebel2017-06-269-0/+155
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>