summaryrefslogtreecommitdiffstats
path: root/Documentation/user
Commit message (Collapse)AuthorAgeFilesLines
* docs: fix broken referenceLucas Stach2015-01-191-2/+2
| | | | | Signed-off-by: Lucas Stach <dev@lynxeye.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* netconsole: fix DocumentationJean-Christophe PLAGNIOL-VILLARD2014-12-171-3/+3
| | | | | | | | | | | since commit 8eacfa71abcba857ab9aa1dcad49e2ba7d83406b Refs: v2014.07.0-156-g8eacfa7 Author: Sascha Hauer <s.hauer@pengutronix.de> the netconsole device have a static device name 'netconsole' Signed-off-by: Jean-Christophe PLAGNIOL-VILLARD <plagnioj@jcrosoft.com>
* doc: usb: add missing new line in codeblockLucas Stach2014-12-091-0/+1
| | | | | | | | Fixes an error during doc generation that leads to the code block being missing in the resulting docs. Signed-off-by: Lucas Stach <l.stach@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Add support for non volatile variablesSascha Hauer2014-11-061-0/+41
| | | | | | | | | | | | | | | This adds (back) support for non volatile variables. Non volatile variables are variables which are stored in the environment over reboot. They are used in the same way as the global variables, but with a 'nv' command and device. The variables are stored under /env/nv/, one variable per file. Adding a nv variable automatically adds a global variable with the same name. Changing a nv variable also changes the same global variable, but not the other way round. This allows for example to configure the username as: nv user=sha; saveenv Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/musb'Sascha Hauer2014-10-021-0/+21
|\
| * Documentation: USB: Add description for OTG deviceSascha Hauer2014-09-261-0/+21
| | | | | | | | Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: Add some TI AM335x specific documentationSascha Hauer2014-09-301-0/+2
|/ | | | Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/usb-gadget'Sascha Hauer2014-08-071-0/+55
|\ | | | | | | | | | | | | | | Conflicts: commands/Makefile common/Kconfig common/Makefile drivers/usb/gadget/dfu.c
| * Documentation: Add documentation for Fastboot and Composite Multifunction GadgetSascha Hauer2014-07-241-0/+48
| | | | | | | | Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * Documentation: Add documentation for USB serial consoleSascha Hauer2014-07-241-0/+7
| | | | | | | | Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Add support for metadata in barebox imagesSascha Hauer2014-08-073-0/+58
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | It's often useful to get some information about a barebox image before starting or flashing it. This patch introduces barebox Image MetaData (IMD). When enabled a barebox image will contain a list of tags containing the desired information. We have tags for: - the barebox release (2014.07.0-00160-g035de50-dirty) - the build timestamp (#741 Mon Jul 28 15:08:54 CEST 2014) - the board model the image is intended for - the device tree toplevel compatible property Also there is an additional generic key-value store which stores parameters for which no dedicated tag exists. In this patch it is used for the memory size an image supports. Since there is no fixed offset in a barebox image which can be used for storing the information, the metadata is stored somewhere in the image and found by iterating over the image. This works for most image types, but obviously not for SoC images which are encoded or encrypted in some way. There is a 'imd' tool compiled from the same sources for barebox, for the compile host and for the target, so the metadata information is available whereever needed. For device tree boards the model and of_compatible tags are automatically generated. Example output of the imd tool for a Phytec phyFLEX image: build: #889 Wed Jul 30 16:08:54 CEST 2014 release: 2014.07.0-00167-g6b2070d-dirty parameter: memsize=1024 of_compatible: phytec,imx6x-pbab01 phytec,imx6dl-pfla02 fsl,imx6dl model: Phytec phyFLEX-i.MX6 Duallite Carrier-Board Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* crc32: Proper name of command is "crc32".Robert P. J. Day2014-07-081-1/+1
| | | | | Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: usb chapter of user manualRobert P. J. Day2014-07-041-16/+41
| | | | | | | | A number of minor fixes, and including the help output from the "dfu-util" command for the benefit of the reader. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: Various tweaks to user manual, device tree chapter.Robert P. J. Day2014-07-041-14/+15
| | | | | | | Grammar, typoes, font, link fixes. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: defaultenv chapter from user manual.Robert P. J. Day2014-07-041-17/+37
| | | | | | | | A number of grammar fixes, typoes, font changes from the defaultenv-2 chapter. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: Numerous typoes/fixes in first few chapters of user manual.Robert P. J. Day2014-07-037-22/+24
| | | | | | | | | | | | Doc fixes such as: * font changes * spelling * punctuation * capitalization Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: User manual, "barebox" sectionRobert P. J. Day2014-07-021-22/+66
| | | | | | | | | Various grammar/font fixes to that section, including adding an additional section describing how to properly do "out of tree" configuration and building. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: link back from variables to device parametersHolger Schurig2014-06-272-2/+7
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: move variables near device parametersHolger Schurig2014-06-271-1/+1
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: remove board type from barebox prompt examplesHolger Schurig2014-06-274-8/+8
| | | | | | | I kept however the one example that directly demos the bootup on an Efika board. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: add hint on how to calculate in hushHolger Schurig2014-06-271-0/+8
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: add colon after NOTE and HINTHolger Schurig2014-06-276-6/+6
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: mention "make xconfig"Holger Schurig2014-06-271-0/+3
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: only include own download chapterHolger Schurig2014-06-271-1/+6
| | | | | | | Also make this download chapter note the next branch. Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: start (almost) all headlines with a capitalHolger Schurig2014-06-275-7/+7
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: make "System setup" an appendixHolger Schurig2014-06-272-3/+3
| | | | | | | | Note that I used "Appendix: " as text, because it looks like python-sphinx doesn't know about appendices. Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: Add new sphinxs docsSascha Hauer2014-06-2619-0/+1460
This is a rewrite of the Documentation in reStructuredText format using Sphinx as build system, see http://sphinx-doc.org/. The documentation is built into static html pages with 'make docs'. The pages can be found under Documentation/html after building. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-25 09:00:35 +0000