commit c81ee6237493d9ade6f7bc54663dba6a44f331a6
parent dd0b1734c1a54e7aa2f04b833e1ff8f5a3141fb3
Author: Daniel Barlow <dan@telent.net>
Date: Sun, 17 Sep 2023 21:44:32 +0100
doc: proofread admin section, add link to TFTP
Diffstat:
2 files changed, 16 insertions(+), 8 deletions(-)
diff --git a/doc/admin.rst b/doc/admin.rst
@@ -12,8 +12,8 @@ Flashing and updating
-Flashing from an existing Liminix system with :command:`flashcp`
-================================================================
+Flashing from Liminix
+=====================
The flash procedure from an existing Liminix-system has two steps.
First we reboot the device (using "kexec") into an "ephemeral"
@@ -34,7 +34,7 @@ For example
.. code-block:: console
- nix-build --show-trace -I liminix-config=./examples/arhcive.nix \
+ nix-build -I liminix-config=./examples/arhcive.nix \
--arg device "import ./devices/gl-ar750"
-A outputs.kexecboot && \
(tar chf - result | ssh root@the-device tar -C /run -xvf -)
@@ -59,11 +59,16 @@ to the old configuration it finds in flash.
Building the second (permanent) image
-------------------------------------
-While running in the kexecboot system, you can copy the permanent
-image to the device with :command:`ssh`
+While running in the kexecboot system, you can build the permanent
+image and copy it to the device with :command:`ssh`
.. code-block:: console
+ build-machine$ nix-build -I liminix-config=./examples/arhcive.nix \
+ --arg device "import ./devices/gl-ar750"
+ -A outputs.default && \
+ (tar chf - result | ssh root@the-device tar -C /run -xvf -)
+
build-machine$ tar chf - result/firmware.bin | \
ssh root@the-device tar -C /run -xvf -
@@ -109,9 +114,10 @@ Flashing from the boot monitor
==============================
If you are prepared to open the device and have a TTL serial adaptor
-of some kind to connect it to, you can probably flash it using U-Boot.
-This is quite hardware-specific, and sometimes involves soldering:
-please refer to the Developer Manual.
+of some kind to connect it to, you can probably use U-Boot and a TFTP
+server to download and flash the image. This is quite
+hardware-specific, and sometimes involves soldering: please refer
+to the :ref:`development manual <tftp server>`.
Flashing from OpenWrt (not currently advised!)
diff --git a/doc/development.rst b/doc/development.rst
@@ -87,6 +87,8 @@ time with configurations for RP-PPPoE and/or Accel PPP.`
Hardware devices
****************
+.. _tftp server:
+
How you get your image onto hardware will vary according to the
device, but is likely to involve taking it apart to add wires to
serial console pads/headers, then using U-Boot to fetch images over
