aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTom Rini2021-08-02 08:54:23 -0400
committerTom Rini2021-08-02 08:54:23 -0400
commit73994c452fc5a960114360a651201ac48b135e81 (patch)
tree6a70a64de049b6fe1876b2ddff76a52e5637aa0a /doc
parent99bb5f248ade371ee4713e0ef51401708ecbb13c (diff)
parent78e6b871fdcf4bb86c6d7292a0e5d4a98e1435b6 (diff)
Merge tag 'efi-2021-10-rc2' of https://source.denx.de/u-boot/custodians/u-boot-efi
Pull request for efi-2021-10-rc2 Documentation: * handle 'make htmldocs' warnings as errors * add missing board/ti/index.rst Bug fixes: * avoid buffer overrun in TrueType console * lib: disable CONFIG_SPL_HEXDUMP by default
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile2
-rw-r--r--doc/board/sifive/unleashed.rst20
-rw-r--r--doc/board/sifive/unmatched.rst30
-rw-r--r--doc/board/ti/index.rst9
-rw-r--r--doc/build/gcc.rst6
5 files changed, 38 insertions, 29 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 683e4b56099..050d9dd2391 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -6,7 +6,7 @@ subdir-y :=
# You can set these variables from the command line.
SPHINXBUILD = sphinx-build
-SPHINXOPTS =
+SPHINXOPTS = -W
SPHINXDIRS = .
_SPHINXDIRS = $(patsubst $(srctree)/doc/%/conf.py,%,$(wildcard $(srctree)/doc/*/conf.py))
SPHINX_CONF = conf.py
diff --git a/doc/board/sifive/unleashed.rst b/doc/board/sifive/unleashed.rst
index 4e4c852ff37..c8a62068a77 100644
--- a/doc/board/sifive/unleashed.rst
+++ b/doc/board/sifive/unleashed.rst
@@ -456,21 +456,21 @@ device tree blob (hifive-unleashed-a00.dtb)
Format the SD card (make sure the disk has GPT, otherwise use gdisk to switch)
-.. code-block:: none
+.. code-block:: bash
- # sudo sgdisk --clear \
- > --set-alignment=2 \
- > --new=1:34:2081 --change-name=1:loader1 --typecode=1:5B193300-FC78-40CD-8002-E86C45580B47 \
- > --new=2:2082:10273 --change-name=2:loader2 --typecode=2:2E54B353-1271-4842-806F-E436D6AF6985 \
- > --new=3:10274: --change-name=3:rootfs --typecode=3:0FC63DAF-8483-4772-8E79-3D69D8477DE4 \
- > /dev/sda
+ sudo sgdisk --clear \
+ --set-alignment=2 \
+ --new=1:34:2081 --change-name=1:loader1 --typecode=1:5B193300-FC78-40CD-8002-E86C45580B47 \
+ --new=2:2082:10273 --change-name=2:loader2 --typecode=2:2E54B353-1271-4842-806F-E436D6AF6985 \
+ --new=3:10274: --change-name=3:rootfs --typecode=3:0FC63DAF-8483-4772-8E79-3D69D8477DE4 \
+ /dev/sdX
Program the SD card
-.. code-block:: none
+.. code-block:: bash
- sudo dd if=spl/u-boot-spl.bin of=/dev/sda seek=34
- sudo dd if=u-boot.itb of=/dev/sda seek=2082
+ sudo dd if=spl/u-boot-spl.bin of=/dev/sdX seek=34
+ sudo dd if=u-boot.itb of=/dev/sdX seek=2082
Booting
~~~~~~~
diff --git a/doc/board/sifive/unmatched.rst b/doc/board/sifive/unmatched.rst
index e65b0d32063..6b024f07f6d 100644
--- a/doc/board/sifive/unmatched.rst
+++ b/doc/board/sifive/unmatched.rst
@@ -61,31 +61,31 @@ device tree blob (hifive-unmatched-a00.dtb)
Format the SD card (make sure the disk has GPT, otherwise use gdisk to switch)
-.. code-block:: none
+.. code-block:: bash
- # sudo sgdisk -g --clear -a 1 \
- > --new=1:34:2081 --change-name=1:spl --typecode=1:5B193300-FC78-40CD-8002-E86C45580B47 \
- > --new=2:2082:10273 --change-name=2:uboot --typecode=2:2E54B353-1271-4842-806F-E436D6AF6985 \
- > --new=3:16384:282623 --change-name=3:boot --typecode=3:0x0700 \
- > --new=4:286720:13918207 --change-name=4:root --typecode=4:0x8300 \
- > /dev/sdb
+ sudo sgdisk -g --clear -a 1 \
+ --new=1:34:2081 --change-name=1:spl --typecode=1:5B193300-FC78-40CD-8002-E86C45580B47 \
+ --new=2:2082:10273 --change-name=2:uboot --typecode=2:2E54B353-1271-4842-806F-E436D6AF6985 \
+ --new=3:16384:282623 --change-name=3:boot --typecode=3:0x0700 \
+ --new=4:286720:13918207 --change-name=4:root --typecode=4:0x8300 \
+ /dev/sdX
Copy linux Image.gz and hifive-unmatched-a00.dtb to boot partition
-.. code-block:: none
+.. code-block:: bash
- sudo mkfs.vfat /dev/sdb3
- sudo mkfs.ext4 /dev/sdb4
+ sudo mkfs.vfat /dev/sdX3
+ sudo mkfs.ext4 /dev/sdX4
- sudo mount /dev/sdb3 /media/sdb3
- sudo cp Image.gz hifive-unmatched-a00.dtb /media/sdb3/
+ sudo mount /dev/sdX3 /media/sdX3
+ sudo cp Image.gz hifive-unmatched-a00.dtb /media/sdX3/
Program the SD card
-.. code-block:: none
+.. code-block:: bash
- sudo dd if=spl/u-boot-spl.bin of=/dev/sda seek=34
- sudo dd if=u-boot.itb of=/dev/sda seek=2082
+ sudo dd if=spl/u-boot-spl.bin of=/dev/sdX seek=34
+ sudo dd if=u-boot.itb of=/dev/sdX seek=2082
Booting
-------
diff --git a/doc/board/ti/index.rst b/doc/board/ti/index.rst
new file mode 100644
index 00000000000..c0da04b109c
--- /dev/null
+++ b/doc/board/ti/index.rst
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Texas Instruments
+=================
+
+.. toctree::
+ :maxdepth: 2
+
+ j721e_evm
diff --git a/doc/build/gcc.rst b/doc/build/gcc.rst
index 8ffb4e3447b..e03e0b94600 100644
--- a/doc/build/gcc.rst
+++ b/doc/build/gcc.rst
@@ -24,9 +24,9 @@ Depending on the build targets further packages maybe needed
.. code-block:: bash
sudo apt-get install bc bison build-essential coccinelle \
- device-tree-compiler dfu-util efitools flex gdisk liblz4-tool \
- libguestfs-tools libncurses-dev libpython3-dev libsdl2-dev libssl-dev \
- lz4 lzma lzma-alone openssl python3 python3-coverage \
+ device-tree-compiler dfu-util efitools flex gdisk graphviz imagemagick \
+ liblz4-tool libguestfs-tools libncurses-dev libpython3-dev libsdl2-dev \
+ libssl-dev lz4 lzma lzma-alone openssl python3 python3-coverage \
python3-pycryptodome python3-pyelftools python3-pytest \
python3-sphinxcontrib.apidoc python3-sphinx-rtd-theme python3-virtualenv \
swig