Skip to content

Commit

Permalink
fix(source): Follow a common convention for console logs
Browse files Browse the repository at this point in the history
- Switch from target# to root@<machine>:~# to make it more
descriptive & ensure there is a consistency in entire docs.

- Also, switch to .. code-blocks for few instances & fix
indentation of code section underneath

Signed-off-by: Chirag Shilwant <[email protected]>
  • Loading branch information
cshilwant authored and StaticRocket committed Dec 17, 2024
1 parent 72afe0b commit ba8da4b
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion source/devices/AM62PX/linux/_Release_Specific_QSG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ on the target to verify that you are using the newly-built Linux kernel.

.. code-block:: console
target# cat /proc/version
root@<machine>:~# cat /proc/version
The output should indicate the build date, host PC name, etc. This verifies
that your SDK has been setup correctly, enabling you to start development.
2 changes: 1 addition & 1 deletion source/devices/AM62X/linux/_Release_Specific_QSG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ on the target to verify that you are using the newly-built Linux kernel.

.. code-block:: console
target# cat /proc/version
root@<machine>:~# cat /proc/version
The output should indicate the build date, host PC name, etc. This verifies
that your SDK has been setup correctly, enabling you to start development.
Original file line number Diff line number Diff line change
Expand Up @@ -750,7 +750,7 @@ the values using

.. code-block:: console
target# cat /proc/interrupts | grep uio
root@<machine>:~# cat /proc/interrupts | grep uio
Below changes in :file:`ivshmem-demo.c` can be done to send characters from root to inmate
and vice versa.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ in this case if you already have a pointercal file on the SD card you
will need to export the **TSLIB\_CALIBFILE** variable to point to that
location before you run **ts\_calibrate**. i.e.

::
.. code-block:: console
target# export TSLIB_CALIBFILE=/run/media/mmcblk0p1/pointercal
target# ts_calibrate
root@<machine>:~# export TSLIB_CALIBFILE=/run/media/mmcblk0p1/pointercal
root@<machine>:~# ts_calibrate
**NOTE:** If you have Matrix or any other GUI application already
running you should stop that application (`How to Stop
Expand Down Expand Up @@ -111,9 +111,9 @@ Alternatively, you may delete the above listed files directly from the
EVM's console by issuing the following commands at EVM's Linux prompt,
and reboot the EVM to allow recalibration of the LCD.

::
.. code-block:: console
rm /etc/udev/rules.d/ws-calibrate.rules
rm /run/media/mmcblk0p1/ws-calibrate.rules
reboot
root@<machine>:~# rm /etc/udev/rules.d/ws-calibrate.rules
root@<machine>:~# rm /run/media/mmcblk0p1/ws-calibrate.rules
root@<machine>:~# reboot
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ by :command:`opkg` by running the following command on the target device:

.. code-block:: console
target# opkg
root@<machine>:~# opkg
To check the version of :command:`opkg` packaged in filesystem,

.. code-block:: console
target# opkg --version
opkg version 0.6.3 (libsolv 0.7.28)
root@<machine>:~# opkg --version
opkg version 0.6.3 (libsolv 0.7.28)
Show all installed packages
===========================
Expand All @@ -41,7 +41,7 @@ each package you can run the following command on the target device:

.. code-block:: console
target# opkg list-installed
root@<machine>:~# opkg list-installed
.. important::

Expand All @@ -58,7 +58,7 @@ this you can use the following command:

.. code-block:: console
target# opkg files <pkgname>
root@<machine>:~# opkg files <pkgname>
Where <pkgname> is the name of the package as given in the *opkg
list-installed* output. This command will produce a list of all the
Expand All @@ -73,7 +73,7 @@ following command:

.. code-block:: console
target# opkg search <file>
root@<machine>:~# opkg search <file>
This command will find which package installed the given file. This may
be useful later when you want to remove an particular file because this
Expand All @@ -89,7 +89,7 @@ find the longer list of dependencies using:

.. code-block:: console
target# opkg whatdepends <pkgname>
root@<machine>:~# opkg whatdepends <pkgname>
This command will print the list of packages the depend on the package
you entered, as well as the packages that depend on those packages, and
Expand All @@ -104,7 +104,7 @@ pre-built packages). Removing a package is often as simple as:

.. code-block:: console
target# opkg remove <pkgname>
root@<machine>:~# opkg remove <pkgname>
However, sometimes a package is a DEPENDENCY of another package. In this
case you have the following options:
Expand All @@ -131,7 +131,7 @@ case you have the following options:

.. code-block:: console
target# opkg remove --force-removal-of-dependent-packages <pkgname>
root@<machine>:~# opkg remove --force-removal-of-dependent-packages <pkgname>
.. tip::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ SPI MTD partitioning.
Please note that the CROSS\_COMPILE flag is not used by the u-boot
makefile here, the HOSTCC= variable must be set.

::
.. code-block:: console
host# make HOSTCC=arm-arago-linux-gnueabi-gcc env
host# make HOSTCC=arm-arago-linux-gnueabi-gcc env
This command is issued from the top of the u-boot source directory.
Please be sure to see that the cross compiler was actually called and
Expand Down Expand Up @@ -100,14 +100,14 @@ will run in.
The executable fw\_printenv will dump the entire environment space,
individual variables can be read by:

::
.. code-block:: console
target# ./fw_printenv autoload
root@<machine>:~# ./fw_printenv autoload
To set an environment variable use fw\_setenv . This example will set
the variable autoload to no, use fw\_printenv to read back the change.

::
.. code-block:: console
target# ./fw_setenv autoload no
root@<machine>:~# ./fw_setenv autoload no

0 comments on commit ba8da4b

Please sign in to comment.