diff options
Diffstat (limited to 'doc/develop')
| -rw-r--r-- | doc/develop/distro.rst | 15 | ||||
| -rw-r--r-- | doc/develop/gdb.rst | 10 |
2 files changed, 16 insertions, 9 deletions
diff --git a/doc/develop/distro.rst b/doc/develop/distro.rst index 637bc27fc2d..1d2f9c4c32b 100644 --- a/doc/develop/distro.rst +++ b/doc/develop/distro.rst @@ -67,11 +67,16 @@ Boot Configuration Files ------------------------ The standard format for boot configuration files is that of extlinux.conf, as -handled by U-Boot's "syslinux" (disk) or "pxe boot" (network). This is roughly -as specified at `Boot Loader Specification`_: +handled by U-Boot's "syslinux" (disk) or "pxe boot" (network). This format is +not formally standardized and documented in a single location. However, other +implementations do document it and we attempt to be as compatible as possible. +* The UAPI Group Specifications `Boot Loader Specification`_ -... with the exceptions that the Boot Loader Specification document: +* The Syslinux Project documents both `PXELINUX`_ and `SYSLINUX`_ files and is + the originator of the format. + +That said, we have some differences to these documents, namely: * Prescribes a separate configuration per boot menu option, whereas U-Boot lumps all options into a single extlinux.conf file. Hence, U-Boot searches @@ -440,7 +445,9 @@ way in future u-boot versions. In particular the <device type>_boot variables (e.g. mmc_boot, usb_boot) are a strictly internal implementation detail and must not be used as a public interface. -.. _`Boot Loader Specification`: https://systemd.io/BOOT_LOADER_SPECIFICATION/ +.. _`Boot Loader Specification`: https://uapi-group.org/specifications/specs/boot_loader_specification/ +.. _`PXELINUX`: https://wiki.syslinux.org/wiki/index.php?title=PXELINUX +.. _`SYSLINUX`: https://wiki.syslinux.org/wiki/index.php?title=SYSLINUX .. sectionauthor:: (C) Copyright 2014 Red Hat Inc. .. sectionauthor:: Copyright (c) 2014-2015, NVIDIA CORPORATION. All rights reserved. diff --git a/doc/develop/gdb.rst b/doc/develop/gdb.rst index 4e359c7f226..79510ee94d3 100644 --- a/doc/develop/gdb.rst +++ b/doc/develop/gdb.rst @@ -8,12 +8,12 @@ Using a JTAG adapter it is possible to debug a running U-Boot with GDB. A common way is to connect a debug adapter to the JTAG connector of your board, run a GDB server, connect GDB to the GDB server, and use GDB as usual. -Similarly QEMU can provide a GDB server. +Similarly, QEMU can provide a GDB server. Preparing build --------------- -Building U-Boot with with reduced optimization (-Og) and without link time +Building U-Boot with reduced optimization (-Og) and without link time optimization is recommended for easier debugging:: CONFIG_CC_OPTIMIZE_FOR_DEBUG=y @@ -24,7 +24,7 @@ Otherwise build, install, and run U-Boot as usual. Using OpenOCD as GDB server --------------------------- -`OpenOCD <https://openocd.org/>`_ is an open source tool supporting hardware +`OpenOCD <https://openocd.org/>`_ is an open-source tool supporting hardware debug probes, and providing a GDB server. It is readily available in major Linux distributions or you can build it from source. @@ -144,7 +144,7 @@ riscv gp sh r13 ============ ======== -On these architecture the relocation address cat be determined by +On these architectures the relocation address can be determined by dereferencing the global data pointer stored in register, *r9* in the example: .. code-block:: console @@ -153,7 +153,7 @@ dereferencing the global data pointer stored in register, *r9* in the example: $1 = 0x27f7a000 In the GDB shell discard the previously loaded symbol file and add it once -again with the relocation address like this: +again, with the relocation address like this: .. code-block:: console |