DGNum/liminix
14
0
Fork 2
Code Issues 15 Pull requests 7 Projects Releases Packages Wiki Activity Actions

doc: proofread admin section, add link to TFTP

Browse source
This commit is contained in:
Daniel Barlow 2023-09-17 21:44:32 +01:00
parent dd0b1734c1
commit c81ee62374
2 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
doc/admin.rst
View file

@ -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. The flash procedure from an existing Liminix-system has two steps.
First we reboot the device (using "kexec") into an "ephemeral" First we reboot the device (using "kexec") into an "ephemeral"
@ -34,7 +34,7 @@ For example
.. code-block:: console .. 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" --arg device "import ./devices/gl-ar750"
-A outputs.kexecboot && \ -A outputs.kexecboot && \
(tar chf - result | ssh root@the-device tar -C /run -xvf -) (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 Building the second (permanent) image
------------------------------------- -------------------------------------
While running in the kexecboot system, you can copy the permanent While running in the kexecboot system, you can build the permanent
image to the device with :command:`ssh` image and copy it to the device with :command:`ssh`
.. code-block:: console .. 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 | \ build-machine$ tar chf - result/firmware.bin | \
ssh root@the-device tar -C /run -xvf - 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 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. of some kind to connect it to, you can probably use U-Boot and a TFTP
This is quite hardware-specific, and sometimes involves soldering: server to download and flash the image. This is quite
please refer to the Developer Manual. hardware-specific, and sometimes involves soldering: please refer
to the :ref:`development manual <tftp server>`.
Flashing from OpenWrt (not currently advised!) Flashing from OpenWrt (not currently advised!)

2
doc/development.rst
View file

@ -87,6 +87,8 @@ time with configurations for RP-PPPoE and/or Accel PPP.`
Hardware devices Hardware devices
**************** ****************
.. _tftp server:
How you get your image onto hardware will vary according to the 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 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 serial console pads/headers, then using U-Boot to fetch images over