Skip to content

Commit ba8da4b

Browse files
cshilwantStaticRocket
authored andcommitted
fix(source): Follow a common convention for console logs
- 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]>
1 parent 72afe0b commit ba8da4b

File tree

6 files changed

+25
-25
lines changed

6 files changed

+25
-25
lines changed

source/devices/AM62PX/linux/_Release_Specific_QSG.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ on the target to verify that you are using the newly-built Linux kernel.
7676

7777
.. code-block:: console
7878
79-
target# cat /proc/version
79+
root@<machine>:~# cat /proc/version
8080
8181
The output should indicate the build date, host PC name, etc. This verifies
8282
that your SDK has been setup correctly, enabling you to start development.

source/devices/AM62X/linux/_Release_Specific_QSG.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ on the target to verify that you are using the newly-built Linux kernel.
7676

7777
.. code-block:: console
7878
79-
target# cat /proc/version
79+
root@<machine>:~# cat /proc/version
8080
8181
The output should indicate the build date, host PC name, etc. This verifies
8282
that your SDK has been setup correctly, enabling you to start development.

source/linux/Foundational_Components/Hypervisor/Jailhouse.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -750,7 +750,7 @@ the values using
750750

751751
.. code-block:: console
752752
753-
target# cat /proc/interrupts | grep uio
753+
root@<machine>:~# cat /proc/interrupts | grep uio
754754
755755
Below changes in :file:`ivshmem-demo.c` can be done to send characters from root to inmate
756756
and vice versa.

source/linux/How_to_Guides/Target/How_to_Recalibrate_the_Touchscreen.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ in this case if you already have a pointercal file on the SD card you
4646
will need to export the **TSLIB\_CALIBFILE** variable to point to that
4747
location before you run **ts\_calibrate**. i.e.
4848

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

114-
::
114+
.. code-block:: console
115115
116-
rm /etc/udev/rules.d/ws-calibrate.rules
117-
rm /run/media/mmcblk0p1/ws-calibrate.rules
118-
reboot
116+
root@<machine>:~# rm /etc/udev/rules.d/ws-calibrate.rules
117+
root@<machine>:~# rm /run/media/mmcblk0p1/ws-calibrate.rules
118+
root@<machine>:~# reboot
119119

source/linux/How_to_Guides/Target/Processor_SDK_Linux_File_System_Optimization_Customization.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ by :command:`opkg` by running the following command on the target device:
2424

2525
.. code-block:: console
2626
27-
target# opkg
27+
root@<machine>:~# opkg
2828
2929
To check the version of :command:`opkg` packaged in filesystem,
3030

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

4242
.. code-block:: console
4343
44-
target# opkg list-installed
44+
root@<machine>:~# opkg list-installed
4545
4646
.. important::
4747

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

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

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

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

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

132132
.. code-block:: console
133133
134-
target# opkg remove --force-removal-of-dependent-packages <pkgname>
134+
root@<machine>:~# opkg remove --force-removal-of-dependent-packages <pkgname>
135135
136136
.. tip::
137137

source/linux/How_to_Guides/Target/Update_U-Boot_Environment_Variables_stored_in_SPI_Flash_from_Linux.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ SPI MTD partitioning.
5353
Please note that the CROSS\_COMPILE flag is not used by the u-boot
5454
makefile here, the HOSTCC= variable must be set.
5555

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

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

110-
::
110+
.. code-block:: console
111111
112-
target# ./fw_setenv autoload no
112+
root@<machine>:~# ./fw_setenv autoload no
113113

0 commit comments

Comments
 (0)