summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: add a section how to generate the documentationJuergen Borleis2016-06-212-0/+74
| | | | | | | | This also includes some hints how to extend and/or adapt the existing documentation. It defines the external dependencies to be able to build the documentation as well. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: fix indentionJuergen Borleis2016-06-211-2/+2
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: use the project specific path to the images/ directoryJuergen Borleis2016-06-211-1/+1
| | | | | | Its better to be more precise about the path. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: fix more typosJuergen Borleis2016-06-211-3/+3
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* doc: index: remove 'Contents:' stringMichael Olbrich2016-06-211-2/+0
| | | | | | It's not really necessary and adds an ugly page in the latex documentation. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* doc: latex improvementsMichael Olbrich2016-06-216-5/+157
| | | | Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* Doc: remove an outdated toolchain requirementJuergen Borleis2016-06-211-5/+0
| | | | | | | | Nowadays 'fakeroot' will be built as a host-tool when the toolchain is going to be built. There is no need for this tool to be present on the host anymore. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Doc: update the PTXdist directory listingJuergen Borleis2016-06-211-22/+21
| | | | | | ..some years later the content looks different. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Wipe out mention the PTXdist 'generic' directory.Juergen Borleis2016-06-201-2/+2
| | | | | | This should be 'projectroot' instead. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* install_alternative: adapt the docs to the real worldJuergen Borleis2016-06-201-3/+5
| | | | | | | The listed directory search order corresponds to the one used in 'scripts/lib/ptxd_make_xpkg_pkg.sh' in function *ptxd_install_setup_src()' Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Fix yet more typos.Juergen Borleis2016-06-203-3/+3
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Explain the debugging support in more detailsJuergen Borleis2016-06-201-8/+14
| | | | | | This also adds the hint, that the 'debug-root' feature will fade-out soon. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Keep this string verbatim to use it everywhereJuergen Borleis2016-06-203-17/+17
| | | | | | | | Adapt this variable to the same manner as all other variables as well. This ensures we can use them everywhere we want and can define the visible layout locally where we use it. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Provide the PTXdist release to be as precise as possibleJuergen Borleis2016-06-201-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Link both User's and Developer's manual nicelyJuergen Borleis2016-06-202-1/+3
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Add info about the last and final check for a new packageJuergen Borleis2016-06-201-0/+21
| | | | | | After this check, the new package is ready for mainline. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Porting isn't finished at this point of time, only 'almost'Juergen Borleis2016-06-201-1/+1
| | | | | | There is still one step to be done... Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* docs: use better variable name for the platform config directoryMichael Olbrich2016-06-203-6/+6
| | | | | | | The directory containing the platformconfig is called platformconfigdir in ptxdist. Name the variable accordingly and set the default value correctly. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
* Split the daily-work section into separate filesJuergen Borleis2016-06-208-164/+236
| | | | | | ...to be able to replace or append the content individually. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Split the user manual section into separate fileJuergen Borleis2016-06-205-211/+218
| | | | | | ...to be able to replace or append the content individually. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Use the really used PTXdist release versionJuergen Borleis2016-06-201-1/+1
| | | | | | | To not confuse newbies following this doc their first time be as exact as possible with the path. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Remove a seldom used feature for nowJuergen Borleis2016-06-201-15/+0
| | | | | | | | Collections are seldomly used, so remove it from the main content, because its mechanism and setup isn't explained elsewhere in the docs. Keep this stuff for a separate file to be re-added later on. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Make the sentence more understandableJuergen Borleis2016-06-201-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Let Spinx link both sectionsJuergen Borleis2016-06-201-2/+6
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* Make the sentence more understandableJuergen Borleis2016-06-201-1/+1
| | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
* 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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-25 10:32:13 +0000