summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Just fix a typoJuergen Borleis2016-06-203-3/+3
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Re-work of the description of the binary file template packageJuergen Borleis2016-06-201-29/+16
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Mention more supported package templatesJuergen Borleis2016-06-201-0/+15
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Use the BSPs compiler instead of a placeholderJuergen Borleis2016-06-201-4/+4
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Fix the meaning of this sentenceJuergen Borleis2016-06-201-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Fix path description for alternative filesJuergen Borleis2016-06-202-4/+7
| | | | | | | The directory in the PTXdist installation is the same 'projectroot' as for regular BSPs and platforms. So, use this directory name now. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Re-factor the adaption of the BSPJuergen Borleis2016-06-201-0/+43
| | | | | | This section is now more generic to match most of the BSPs Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Remove special examples for the generic BSPJuergen Borleis2016-06-201-220/+0
| | | | | | These examples make no sense in the PTXdist documentation. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Don't wrap the line manuallyJuergen Borleis2016-06-201-2/+1
| | | | | | Lets do so by the framework instead (on demand). Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Fix the sentenceJuergen Borleis2016-06-201-1/+1
| | | | | | This way it makes more sense Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Mention one more Kconfig componentJuergen Borleis2016-06-201-0/+5
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Add missing platform name into the sentenceJuergen Borleis2016-06-201-1/+1
| | | | Seems it was lost while the transition from latex to rst
* Fix spellingJuergen Borleis2016-06-201-2/+2
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Fix spelling: 'run-time' versus 'runtime'Juergen Borleis2016-06-205-20/+20
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Emphasize a filesystem pathJuergen Borleis2016-06-201-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Move text where it belongs toJuergen Borleis2016-06-201-8/+3
| | | | | | | Mention the toolchain makes no sense at this section, move it to a section it belongs to. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* This PTXdist feature will fade out. Remove it from the docsJuergen Borleis2016-06-202-30/+0
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* With a comma, this sentence is more preciseJuergen Borleis2016-06-201-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* 'package' seems the better wordingJuergen Borleis2016-06-201-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Fix the wrong passive sentence.Juergen Borleis2016-06-201-3/+3
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Emphasize the finale directory name and fix the spellingJuergen Borleis2016-06-201-2/+2
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* In the PTXdist Guru documentation this was emphasized. Do it again.Juergen Borleis2016-06-201-3/+3
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Fix build-time Python errorJuergen Borleis2016-06-201-3/+3
| | | | | | | | | Building the documentation inside PTXdist (e.g. outside of a BSP project) else fails with: TypeError: Can't convert 'NoneType' object to str implicitly Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* This is BSP specific and not PTXdist relatedJuergen Borleis2016-06-201-4/+0
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Remove a less used feature of PTXdistJuergen Borleis2016-06-202-4/+2
| | | | | | Using variants is used very seldom. Ignore it for now. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* The platform name mostly includes the 'platform-' stringJuergen Borleis2016-06-201-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* All of our BSP names start with the 'OSELAS.BSP' stringJuergen Borleis2016-06-201-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* doc: add testsFlorian Scherf2016-06-201-0/+21
| | | | Signed-off-by: Florian Scherf <f.scherf@pengutronix.de>
* doc: cleanup substitutions and use code sectionsMichael Olbrich2016-06-204-60/+60
| | | | | | | | | Now, that substitutions happen before the sphinx run, the '\ ' magic so that the substitute patters are found, are no longer needed. And code sections can now be used here. This is needed to break long lines for in latex output. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: do replacements before running sphinxMichael Olbrich2016-06-201-36/+30
| | | | | | This is necessary to make replacements in code sections possible. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: set 'sh' as default highlight languageMichael Olbrich2016-06-201-1/+1
| | | | | | | Otherwise sphinx 1.4.x produces a lot of warnings: WARNING: Could not lex literal_block as "c". Highlighting skipped. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: 'file://' is not a URLMichael Olbrich2016-06-201-4/+4
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* ptxdist: add support for BSP specific documentationMichael Olbrich2016-06-201-16/+66
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: rename files to avoid warningsMichael Olbrich2016-06-203-2/+2
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: remove oselasTCNVendorPatchLevel variableMichael Olbrich2016-06-203-12/+11
| | | | | | | | The toolchain version should contain the patch-level version in all cases so a separate variable is not needed. This fixes several instances where the toolchain version was used incorrectly without the patch-level version. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: document install_globMichael Olbrich2016-05-291-0/+54
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: document --output-syncMichael Olbrich2016-05-291-0/+14
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: cleanup & expand variable referenceMichael Olbrich2015-12-031-85/+295
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* docs: expand and improve the command documentationMichael Olbrich2015-12-031-5/+182
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* generate basic man-pageMichael Olbrich2015-12-031-0/+20
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* docs: split parameter documentation into a separate fileMichael Olbrich2015-12-032-120/+121
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* docs: use matching platform & toolchain examplesMichael Olbrich2015-12-031-3/+3
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* environment.rst: replace fixes & cleanupsMichael Olbrich2015-12-031-6/+5
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* docs: extract ptxdist version when building the documentationMichael Olbrich2015-12-031-4/+4
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: use classic themeMichael Olbrich2015-12-032-2/+2
| | | | | | This requires Sphinx 1.3.x Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* Reference manual: provide one more referenceJuergen Borleis2015-12-032-0/+4
| | | | | | | Connect the user's manuals and the reference part. Maybe both sections provide the same and should be melded. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Reference manual: make it more clear what's meantJuergen Borleis2015-12-031-6/+8
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Reference manual: spelling fixedJuergen Borleis2015-12-031-2/+2
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Reference manual: JFFS2 is outdated....Juergen Borleis2015-12-031-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Reference manual: emphasize where to use these variables and macrosJuergen Borleis2015-12-031-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-30 11:06:01 +0000