summaryrefslogtreecommitdiffstats
path: root/Documentation/user
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: remote-control: fix markupStefan Lengfeld2017-01-101-2/+2
| | | | | | | | Fix missing '*' for bold text and remove indentation. It should be rendered as a single paragraph. Signed-off-by: Stefan Lengfeld <s.lengfeld@phytec.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: bootchooser: fix typosUlrich Ölmann2017-01-101-26/+31
| | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/misc'Sascha Hauer2016-10-101-3/+5
|\
| * Documentation: clarify that patches should target the master branch.Robert Schwebel2016-09-261-3/+5
| | | | | | | | | | | | | | | | | | I asked Sascha if he still prefers patches against 'next', and it turned out that this is not true any more and patches should be sent against master. Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | boot: add framework for redundant boot scenariosMarc Kleine-Budde2016-09-223-0/+277
|/ | | | | | | | | | | | | | | There are several use cases where a redundant Linux system is needed. The barebox bootchooser framework provides the building blocks to model different use cases without the need to start from the scratch over and over again. The bootchooser works on abstract boot targets, each with a set of properties and implements an algorithm which selects the highest priority target to boot. See the documentation contained in this patch for more information. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de> Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: imd: fix sphinx warningAntony Pavlov2016-09-211-2/+6
| | | | | | | | | | The patch fixes this sphinx warnings: barebox/Documentation/user/imd.rst:27: WARNING: Could not lex literal_block as "c". Highlighting skipped. Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Cc: Sascha Hauer <s.hauer@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: usb: fix sphinx warningAntony Pavlov2016-09-091-1/+3
| | | | | | | | | | The patch fixes this sphinx warnings: barebox/Documentation/user/usb.rst:61: WARNING: Could not lex literal_block as "c". Highlighting skipped. Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Cc: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: variables: fix error in "code-block" directiveAntony Pavlov2016-08-151-0/+1
| | | | | | | | | | | | | | | | | | The patch fixes this sphinx error: barebox/Documentation/user/variables.rst:79: ERROR: Error in "code-block" directive: maximum 1 argument(s) allowed, 15 supplied. .. code-block:: sh barebox@Phytec phyCARD-i.MX27:/ nv dev.nand0.partitions: 4M(barebox),1M(barebox-environment),-(root) barebox@Phytec phyCARD-i.MX27:/ devinfo nand0 Parameters: [...] partitions: 4M(barebox),1M(barebox-environment),8M(kernel),1011M(root) [...] Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: barebox: fix 'Could not lex literal_block as "c"' warningAntony Pavlov2016-08-151-15/+45
| | | | | | | | | | | | The patch fixes these sphinx warnings: barebox/Documentation/user/barebox.rst:19: WARNING: Could not lex literal_block as "c". Highlighting skipped. barebox/Documentation/user/barebox.rst:33: WARNING: Could not lex literal_block as "c". Highlighting skipped. barebox/Documentation/user/barebox.rst:186: WARNING: Could not lex literal_block as "c". Highlighting skipped. barebox/Documentation/user/barebox.rst:205: WARNING: Could not lex literal_block as "c". Highlighting skipped. Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/state'Sascha Hauer2016-07-112-0/+47
|\
| * docs: Add/Update state documentationMarkus Pargmann2016-07-082-0/+47
| | | | | | | | | | Signed-off-by: Markus Pargmann <mpa@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Introduce non volatile device variablesSascha Hauer2016-07-061-0/+18
|/ | | | | | | | | | | | | | Non volatile device variables are used to make device parameters persistent. They are like normal non volatile variables, but set the values of the device parameters with the corresponding name. Every nv variable beginning with nv.dev is a non volatile device variable. They have the form nv.dev.<devname>.<paramname> and act on the parameter <paramname> of the device named <devname>. The non volatile device variables are designated for example for video modes, ethernet device ip addresses or mtd partitioning. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* bootm: Optionally add a root= option to Kernel command lineSascha Hauer2016-05-041-0/+14
| | | | | | | | | It becomes a common case that the Kernel is loaded from the filesystem which later becomes the rootfs. This adds a possibility to let bootm automatically append the root= option to the kernel command line. This is done when global.bootm.appendroot is true. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* bbu: Allow to refresh/repair imagesSascha Hauer2016-04-081-0/+8
| | | | | | | | | | Some SoCs allow to store multiple boot images on a device in order to improve robustness. This adds a -r option to barebox_update to indicate we do not want to make an update but instead repair/refresh an existing image. Handlers which want to support this feature must set the BBU_HANDLER_CAN_REFRESH flag during registration. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/misc'Sascha Hauer2016-03-111-2/+51
|\
| * Documentation: fastboot: fastboot erase is implementedSascha Hauer2016-02-231-3/+0
| | | | | | | | | | | | | | fastboot erase was implemented from the start, remove note stating that it's not implemented. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * Documentation: Update USB fastboot sectionMarkus Pargmann2016-02-231-0/+52
| | | | | | | | | | | | | | | | Add some documentation about fastboot 'flash' command and some useful example how to use it to boot an initrd. Signed-off-by: Markus Pargmann <mpa@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/doc'Sascha Hauer2016-03-114-23/+36
|\ \
| * | Documentation: networking: improve docsRobert Schwebel2016-02-111-17/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add the following improvements: - clarify commands vs. filesystems for network file transport protocols - Beautify links with prosa text instead of standard headlines - adapt 'devinfo eth0' parameter output to current code - improve console texts - add docs for netconsole.active Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: user manual: improve tftp descriptionRobert Schwebel2016-02-111-1/+3
| | | | | | | | | | | | | | | Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: user manual: clarify kconfig+kbuildRobert Schwebel2016-02-111-3/+3
| | | | | | | | | | | | | | | Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: user manual: include documentation for remote-controlRobert Schwebel2016-02-101-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | This documentation snippet was already added to the tree, but not included anywhere. Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: booting linux: improve wordingRobert Schwebel2016-02-101-2/+2
| |/ | | | | | | | | | | | | | | 'bootm' is the lowlevel boot command, in contrast to 'boot', which is more highlevel. Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* / Documentation: usb: fix otg mode parameter descriptionPhilipp Zabel2016-02-171-1/+1
|/ | | | | | | Replace ``device`` otg.mode option with the correct ``peripheral``. Signed-off-by: Philipp Zabel <philipp.zabel@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/ratp'Sascha Hauer2016-02-081-0/+134
|\
| * barebox remote control: DocumentationSascha Hauer2016-01-181-0/+134
| | | | | | | | Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | nfs: forward filesystem options to the kernel command lineJuergen Borleis2016-02-081-1/+1
|/ | | | | | | | | | | | | | | | | | | | | | | | | | Using NFS in conjunction with boot spec and the feature to let Barebox auto generate a kernel command line must keep the options the NFS filesystem was mounted in Barebox. This patch extends the kernel command line parameter on demand if something different than the defaults are used. The command: barebox:/ boot nfs://myhost//root expands to the kernel command line: nfsroot=myhost:/root,v3,tcp while the command: barebox:/ boot nfs://myhost:2049//root expands now to the kernel command line: nfsroot=myhost:/root,v3,tcp,mountport=2049,port=2049 Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* video: implement framebuffer consoleAntony Pavlov2015-07-201-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | This patch realizes framebuffer console support for barebox. It supports colors and enough escape sequences to show the barebox console and editor properly. fbconsole mini-HOWTO ==================== 1. compile sandbox barebox with CONFIG_VIDEO=y CONFIG_FRAMEBUFFER_CONSOLE=y CONFIG_DRIVER_VIDEO_SDL=y 2. run barebox 3. test fbconsole fbconsole0.active=oe Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/blspec'Sascha Hauer2015-07-061-0/+7
|\
| * blspec: Automatically append rootargSascha Hauer2015-06-181-0/+7
| | | | | | | | | | | | | | | | | | | | | | This patch makes it possible to automatically add a suitable root= option for booting Linux from the same filesystem on which the bootspec entry has been found. This adds an additional 'linux-appendroot' option to bootspec which if set to 'true' will cause barebox to automatically add a root= option. This currently works for NFS, UBIFS and regular block devices like ATA, SD/MMC using the root=PARTUUID= mechanism. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/mtd'Sascha Hauer2015-07-031-29/+15
|\ \ | | | | | | | | | | | | Conflicts: drivers/mtd/core.c
| * | ubi: Update documentationSascha Hauer2015-06-261-29/+15
| |/ | | | | | | | | | | | | The previous patches changed the UBI naming and made automounting UBIFS easier. Update the documentation accordingly. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: be more precise about the topicJuergen Borleis2015-06-221-4/+4
| | | | | | | | | | | | | | 'system restart' is the correct topic here. Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: fix spellingJuergen Borleis2015-06-221-1/+1
| | | | | | | | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: add some info about the reset variantsJuergen Borleis2015-06-172-0/+65
| | | | | | | | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: add some info about the reset reason frameworkJuergen Borleis2015-06-172-0/+48
|/ | | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: fix typoJuergen Borleis2015-06-161-1/+1
| | | | | | | This change enables Sphinx to resolve the reference. Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/misc'Sascha Hauer2015-06-091-6/+7
|\
| * Documentation: booting linux: improve doc textRobert Schwebel2015-05-151-6/+7
| | | | | | | | | | Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: blspec: Document blspec over NFSSascha Hauer2015-05-261-0/+7
| | | | | | | | | | | | | | We support booting blspec entries found on NFS servers, add documentation for it. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: blspec: Fix typoSascha Hauer2015-05-261-1/+1
|/ | | | | | The device index is missing in the example, add it. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* docs: correct link to microcom repoLucas Stach2015-03-261-1/+1
| | | | | | | | It's not nice to land on a 404 page and having to search for the right location manually. Signed-off-by: Lucas Stach <dev@lynxeye.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: booting-linux: Fix wrong variable nameSascha Hauer2015-03-181-1/+1
| | | | | | | All variables starting with global.linux.bootargs. are concatemated to bootargs, not global.bootargs. . Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Fix spelling: pathes -> pathsWadim Egorov2015-01-282-3/+3
| | | | | Signed-off-by: Wadim Egorov <w.egorov@phytec.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* 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>