Skip to content

Commit

Permalink
Update OS doc
Browse files Browse the repository at this point in the history
  • Loading branch information
n.danilyuk committed Jul 6, 2023
1 parent 76b37ae commit cc70162
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions developerGuide/software/build/debian.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Build Red Pitaya OS
Overview
********

Executable scripts from ``OS/debian`` directory:
Executable scripts from ``debian`` directory:

+---------------------+------------------------------------------------------------------------------+
| script | description |
Expand Down Expand Up @@ -107,7 +107,7 @@ it will be integrated and the result will be a fully functional SD card image.
Dependencies
************

Ubuntu 2016.04.2 was used to build Debian/Ubuntu SD card images for Red Pitaya.
Ubuntu 2022.04 was used to build Debian/Ubuntu SD card images for Red Pitaya.

The next two packages need to be installed on the host PC:

Expand All @@ -123,7 +123,7 @@ The next steps should be executed in the root directory of the Red Pitaya Git re

.. code-block:: shell-session
$ git clone https://github.com/RedPitaya/RedPitaya.git
$ git clone https://github.com/RedPitaya/ubuntu.git
$ cd RedPitaya
Run the next command to build the OS image. Root or ``sudo`` privileges are needed.
Expand All @@ -132,9 +132,8 @@ otherwise some configuration files will be placed into the wrong users home dire

.. note::

Before you execute next step, the Ecosystem_ must be built.
Before you execute next step, the `Ecosystem <ecosystem>` must be built.

.. _Ecosystem: http://redpitaya.readthedocs.io/en/latest/developerGuide/ecosystem/ecosystem.html


.. code-block:: shell-session
Expand All @@ -143,22 +142,22 @@ otherwise some configuration files will be placed into the wrong users home dire
# OS/debian/image.sh
# exit
:download:`image.sh <https://github.com/RedPitaya/RedPitaya/blob/master/OS/debian/debian.sh>` will create an SD card image with a name containing the current
date and time. Two partitions are created a 128MB FAT32 partition for the ecosystem and a slightly less then 4GB Ext4 partition.
:download:`image.sh <https://github.com/RedPitaya/ubuntu/blob/main/debian/image.sh>` will create an SD card image with a name containing the current
date and time. Two partitions are created a 512MB FAT32 partition for the ecosystem and a slightly less then 8GB Ext4 partition.

:download:`image.sh <https://github.com/RedPitaya/RedPitaya/blob/master/OS/debian/image.sh>` will call :download:`ubuntu.sh <https://github.com/RedPitaya/RedPitaya/blob/master/OS/debian/ubuntu.sh>`
:download:`image.sh <https://github.com/RedPitaya/ubuntu/blob/main/debian/image.sh>` will call :download:`ubuntu.sh <https://github.com/RedPitaya/ubuntu/blob/main/debian/ubuntu.sh>`
which installs the base system and some additional packages. It also configures APT (Debian packaging system),
locales, hostname, timezone, file system table, U-boot and users (access to UART console).

:download:`ubuntu.sh <https://github.com/RedPitaya/RedPitaya/blob/master/OS/debian/ubuntu.sh>` also executes
:download:`network.sh <https://github.com/RedPitaya/RedPitaya/blob/master/OS/debian/network.sh>` which creates a
:download:`ubuntu.sh <https://github.com/RedPitaya/ubuntu/blob/main/debian/ubuntu.sh>` also executes
:download:`network.sh <https://github.com/RedPitaya/ubuntu/blob/main/debian/network.sh>` which creates a
``systemd-networkd`` based wired and wireless network setup. And it executes
:download:`redpitaya.sh <https://github.com/RedPitaya/RedPitaya/blob/master/OS/debian/redpitaya.sh>` which installs additional Debian packages (mostly libraries)
needed by Red Pitaya applications. :download:`redpitaya.sh <https://github.com/RedPitaya/RedPitaya/blob/master/OS/debian/redpitaya.sh>` also extracts
:download:`redpitaya.sh <https://github.com/RedPitaya/ubuntu/blob/main/debian/redpitaya.sh>` which installs additional Debian packages (mostly libraries)
needed by Red Pitaya applications. :download:`redpitaya.sh <https://github.com/RedPitaya/ubuntu/blob/main/debian/redpitaya.sh>` also extracts
``ecosystem*.zip`` (if one exists in the current directory) into the FAT partition.

Optionally (code can be commented out) :download:`ubuntu.sh <https://github.com/RedPitaya/RedPitaya/blob/master/OS/debian/ubuntu.sh>` also executes
:download:`jupyter.sh <https://github.com/RedPitaya/RedPitaya/blob/master/OS/debian/jupyter.sh>` and :download:`tft.sh <https://github.com/RedPitaya/RedPitaya/blob/master/OS/debian/tft.sh>` which provide
Optionally (code can be commented out) :download:`ubuntu.sh <https://github.com/RedPitaya/ubuntu/blob/main/debian/ubuntu.sh>` also executes
:download:`jupyter.sh <https://github.com/RedPitaya/ubuntu/blob/main/debian/jupyter.sh>` and :download:`tft.sh <https://github.com/RedPitaya/ubuntu/blob/main/debian/tft.sh>` which provide
additional functionality.

===========================
Expand All @@ -170,7 +169,7 @@ it can be extracted later to the FAT partition (128MB) of the SD card.
In addition to Red Pitaya tools, this ``ecosystem_*.zip`` file contains a boot image (containing FPGA code),
a boot script (``u-boot.scr``) and the Linux kernel.

A script :download:`image-update.sh <https://github.com/RedPitaya/RedPitaya/blob/master/OS/debian/image-update.sh>` is provided for updating an existing image
A script :download:`image-update.sh <https://github.com/RedPitaya/ubuntu/blob/main/debian/image-update.sh>` is provided for updating an existing image
to a newer ``ecosystem_*.zip`` file without making modifications to the ``ext4`` partition.

The script should be run with the image and ecosystem files as arguments:
Expand All @@ -179,7 +178,7 @@ The script should be run with the image and ecosystem files as arguments:
# ./OS/debian/image-update.sh redpitaya_OS_*.img ecosystem-*.zip
Now you can burn a micro SD card (sized 4GB) e.g.,
Now you can burn a micro SD card (sized 8GB) e.g.,

.. code-block:: shell-session
Expand All @@ -192,7 +191,7 @@ File system check
If the image creation involved multiple steps performed by the user,
for example some installation/setup procedure performed on a live Red Pitaya,
there is a possibility a file system might be corrupted.
The :download:`image-fsck.sh <https://github.com/RedPitaya/RedPitaya/blob/master/OS/debian/image-fsck.sh>` script performs a file system check without changing
The :download:`image-fsck.sh <https://github.com/RedPitaya/ubuntu/blob/main/debian/image-fsck.sh>` script performs a file system check without changing
anything.

Use this script on an image before releasing it.
Expand Down

0 comments on commit cc70162

Please sign in to comment.