Skip to content

Commit 0c3e23f

Browse files
committed
improve documentation
1 parent 34b53e1 commit 0c3e23f

File tree

19 files changed

+58
-58
lines changed

19 files changed

+58
-58
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ import (
160160
Build the [TamaGo compiler](https://github.com/usbarmory/tamago-go)
161161
(or use the [latest binary release](https://github.com/usbarmory/tamago-go/releases/latest)):
162162

163-
```
163+
```sh
164164
wget https://github.com/usbarmory/tamago-go/archive/refs/tags/latest.zip
165165
unzip latest.zip
166166
cd tamago-go-latest/src && ./all.bash
@@ -170,7 +170,7 @@ cd ../bin && export TAMAGO=`pwd`/go
170170
Go applications can be compiled with the compiler built in the previous step,
171171
with the addition of a few flags/variables:
172172

173-
```
173+
```sh
174174
# set this library as `runtime/goos` overlay
175175
export GOOSPKG=github.com/usbarmory/tamago
176176

@@ -196,7 +196,7 @@ each specific target.
196196
Build tags
197197
==========
198198

199-
The following build tags allow application to override the package own
199+
The following build tags allow applications to override the package own
200200
definition for the `runtime/goos` overlay:
201201

202202
* `linkramstart`: override `ramStart`
@@ -217,7 +217,7 @@ execution.
217217
An emulated run of the [example application](https://github.com/usbarmory/tamago-example)
218218
can be launched as follows:
219219

220-
```
220+
```sh
221221
git clone https://github.com/usbarmory/tamago-example
222222
cd tamago-example && make qemu
223223
```
@@ -248,7 +248,7 @@ Additional resources
248248
====================
249249

250250
* [Package API](https://pkg.go.dev/github.com/usbarmory/tamago)
251-
* [Runtime API](https://github.com/usbarmory/tamago-go/src/runtime/goos/README.md)
251+
* [Runtime API](https://github.com/usbarmory/tamago-go/blob/latest/src/runtime/goos/README.md)
252252
* [Compatibility](https://github.com/usbarmory/tamago/wiki/Compatibility)
253253
* [Internals](https://github.com/usbarmory/tamago/wiki/Internals)
254254
* [FAQ](https://github.com/usbarmory/tamago/wiki/Frequently-Asked-Questions-(FAQ))

amd64/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Supported hardware
5050
Build tags
5151
==========
5252

53-
The following build tags allow application to override the package own
53+
The following build tags allow applications to override the package own
5454
definition for the `runtime/goos` overlay:
5555

5656
* `linkramstart`: exclude `ramStart` from `mem.go`

arm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Supported hardware
4747
Build tags
4848
==========
4949

50-
The following build tags allow application to override the package own
50+
The following build tags allow applications to override the package own
5151
definition for the `runtime/goos` overlay:
5252

5353
* `linkramstart`: exclude `ramStart` from `mem.go`

arm64/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Supported hardware
4646
Build tags
4747
==========
4848

49-
The following build tags allow application to override the package own
49+
The following build tags allow applications to override the package own
5050
definition for the `runtime/goos` overlay:
5151

5252
* `linkramstart`: exclude `ramStart` from `mem.go`

board/cloud_hypervisor/vm/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ import (
6767
Build the [TamaGo compiler](https://github.com/usbarmory/tamago-go)
6868
(or use the [latest binary release](https://github.com/usbarmory/tamago-go/releases/latest)):
6969

70-
```
70+
```sh
7171
wget https://github.com/usbarmory/tamago-go/archive/refs/tags/latest.zip
7272
unzip latest.zip
7373
cd tamago-go-latest/src && ./all.bash
@@ -77,7 +77,7 @@ cd ../bin && export TAMAGO=`pwd`/go
7777
Go applications can be compiled as usual, using the compiler built in the
7878
previous step, but with the addition of the following flags/variables:
7979

80-
```
80+
```sh
8181
GOOS=tamago GOOSPKG=github.com/usbarmory/tamago GOARCH=amd64 \
8282
${TAMAGO} build -ldflags "-T 0x10010000 -R 0x1000" main.go
8383
```
@@ -88,7 +88,7 @@ An example application, targeting the Cloud Hypervisor platform, is
8888
Build tags
8989
==========
9090

91-
The following build tags allow application to override the package own
91+
The following build tags allow applications to override the package own
9292
definition for the `runtime/goos` overlay:
9393

9494
* `linkramsize`: exclude `ramSize` from `mem.go`
@@ -102,7 +102,7 @@ reference usage and a Makefile target for automatic creation of an ELF image
102102
which can be executed under paravirtualization with
103103
[cloud-hypervisor](https://www.cloudhypervisor.org/docs/prologue/quick-start/#firmware-booting):
104104

105-
```
105+
```sh
106106
cloud-hypervisor --kernel example --cpus boot=1 --memory size=4096M --net "tap=tap0" --serial tty --console off
107107
```
108108

board/firecracker/microvm/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ import (
6767
Build the [TamaGo compiler](https://github.com/usbarmory/tamago-go)
6868
(or use the [latest binary release](https://github.com/usbarmory/tamago-go/releases/latest)):
6969

70-
```
70+
```sh
7171
wget https://github.com/usbarmory/tamago-go/archive/refs/tags/latest.zip
7272
unzip latest.zip
7373
cd tamago-go-latest/src && ./all.bash
@@ -77,7 +77,7 @@ cd ../bin && export TAMAGO=`pwd`/go
7777
Go applications can be compiled as usual, using the compiler built in the
7878
previous step, but with the addition of the following flags/variables:
7979

80-
```
80+
```sh
8181
GOOS=tamago GOOSPKG=github.com/usbarmory/tamago GOARCH=amd64 \
8282
${TAMAGO} build -ldflags "-T 0x10010000 -R 0x1000" main.go
8383
```
@@ -88,7 +88,7 @@ is [available](https://github.com/usbarmory/tamago-example).
8888
Build tags
8989
==========
9090

91-
The following build tags allow application to override the package own
91+
The following build tags allow applications to override the package own
9292
definition for the `runtime/goos` overlay:
9393

9494
* `linkramsize`: exclude `ramSize` from `mem.go`
@@ -106,14 +106,14 @@ which can be executed under paravirtualization with
106106
Firectl
107107
-------
108108

109-
```
109+
```sh
110110
firectl --kernel example --root-drive /dev/null --tap-device tap0/06:00:AC:10:00:01 -c 1 -m 4096
111111
```
112112

113113
Firecracker
114114
-----------
115115

116-
```
116+
```sh
117117
firecracker --config-file vm_config.json
118118
```
119119

board/google/gcp/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ import (
6767
Build the [TamaGo compiler](https://github.com/usbarmory/tamago-go)
6868
(or use the [latest binary release](https://github.com/usbarmory/tamago-go/releases/latest)):
6969

70-
```
70+
```sh
7171
wget https://github.com/usbarmory/tamago-go/archive/refs/tags/latest.zip
7272
unzip latest.zip
7373
cd tamago-go-latest/src && ./all.bash
@@ -77,7 +77,7 @@ cd ../bin && export TAMAGO=`pwd`/go
7777
Go applications can be compiled as usual, using the compiler built in the
7878
previous step, but with the addition of the following flags/variables:
7979

80-
```
80+
```sh
8181
GOOS=tamago GOOSPKG=github.com/usbarmory/tamago GOARCH=amd64 \
8282
${TAMAGO} build -ldflags "-T 0x10010000 -R 0x1000" main.go
8383
```
@@ -88,7 +88,7 @@ is [available](https://github.com/usbarmory/tamago-example).
8888
Build tags
8989
==========
9090

91-
The following build tags allow application to override the package own
91+
The following build tags allow applications to override the package own
9292
definition for the `runtime/goos` overlay:
9393

9494
* `linkramsize`: exclude `ramSize` from `mem.go`
@@ -111,7 +111,7 @@ T2D.
111111
QEMU
112112
----
113113

114-
```
114+
```sh
115115
qemu-system-x86_64 \
116116
-machine q35,pit=off,pic=off \
117117
-enable-kvm -cpu host,invtsc=on,kvmclock=on -no-reboot \

board/nxp/imx8mpevk/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ import (
6767
Build the [TamaGo compiler](https://github.com/usbarmory/tamago-go)
6868
(or use the [latest binary release](https://github.com/usbarmory/tamago-go/releases/latest)):
6969

70-
```
70+
```sh
7171
wget https://github.com/usbarmory/tamago-go/archive/refs/tags/latest.zip
7272
unzip latest.zip
7373
cd tamago-go-latest/src && ./all.bash
@@ -77,7 +77,7 @@ cd ../bin && export TAMAGO=`pwd`/go
7777
Go applications can be compiled as usual, using the compiler built in the
7878
previous step, but with the addition of the following flags/variables:
7979

80-
```
80+
```sh
8181
GOOS=tamago GOOSPKG=github.com/usbarmory/tamago GOARCH=arm64 \
8282
${TAMAGO} build -ldflags "-T 0x40010000 -R 0x1000" main.go
8383
```
@@ -88,7 +88,7 @@ is [available](https://github.com/usbarmory/tamago-example).
8888
Build tags
8989
==========
9090

91-
The following build tags allow application to override the package own
91+
The following build tags allow applications to override the package own
9292
definition for the `runtime/goos` overlay:
9393

9494
* `linkramsize`: exclude `ramSize` from `mem.go`
@@ -106,7 +106,7 @@ QEMU
106106

107107
The target can be executed under emulation as follows:
108108

109-
```
109+
```sh
110110
qemu-system-aarch64 \
111111
-machine imx8mp-evk -m 512M \
112112
-nographic -monitor none -serial stdio -serial null \
@@ -118,7 +118,7 @@ The emulated target can be debugged with GDB by adding the `-S -s` flags to the
118118
previous execution command, this will make qemu waiting for a GDB connection
119119
that can be launched as follows:
120120

121-
```
121+
```sh
122122
arm-none-eabi-gdb -ex "target remote 127.0.0.1:1234" example
123123
```
124124

board/nxp/mx6ullevk/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ import (
6464
Build the [TamaGo compiler](https://github.com/usbarmory/tamago-go)
6565
(or use the [latest binary release](https://github.com/usbarmory/tamago-go/releases/latest)):
6666

67-
```
67+
```sh
6868
wget https://github.com/usbarmory/tamago-go/archive/refs/tags/latest.zip
6969
unzip latest.zip
7070
cd tamago-go-latest/src && ./all.bash
@@ -74,7 +74,7 @@ cd ../bin && export TAMAGO=`pwd`/go
7474
Go applications can be compiled as usual, using the compiler built in the
7575
previous step, but with the addition of the following flags/variables:
7676

77-
```
77+
```sh
7878
GOOS=tamago GOOSPKG=github.com/usbarmory/tamago GOARM=7 GOARCH=arm \
7979
${TAMAGO} build -ldflags "-T 0x80010000 -R 0x1000" main.go
8080
```
@@ -85,7 +85,7 @@ is [available](https://github.com/usbarmory/tamago-example).
8585
Build tags
8686
==========
8787

88-
The following build tags allow application to override the package own
88+
The following build tags allow applications to override the package own
8989
definition for the `runtime/goos` overlay:
9090

9191
* `linkramsize`: exclude `ramSize` from `mem.go`
@@ -109,7 +109,7 @@ Native hardware: imx image on microSD
109109

110110
Copy the built `imx` image to a microSD as follows:
111111

112-
```
112+
```sh
113113
sudo dd if=<path to imx file> of=/dev/sdX bs=1M conv=fsync
114114
```
115115
*IMPORTANT*: /dev/sdX must be replaced with your microSD device (not eventual
@@ -132,7 +132,7 @@ Standard output
132132
The standard output can be accessed through the debug console found
133133
on micro USB connector J1901 and the following `picocom` configuration:
134134

135-
```
135+
```sh
136136
picocom -b 115200 -eb /dev/ttyUSB0 --imap lfcrlf
137137
```
138138

@@ -150,7 +150,7 @@ set remote hardware-watchpoint-limit 4
150150

151151
Example:
152152

153-
```
153+
```sh
154154
# start openocd daemon
155155
openocd -f interface/ftdi/jtagkey.cfg -f target/imx6ul.cfg -c "adapter speed 1000"
156156

@@ -173,7 +173,7 @@ QEMU
173173

174174
The target can be executed under emulation as follows:
175175

176-
```
176+
```sh
177177
qemu-system-arm \
178178
-machine mcimx6ul-evk -cpu cortex-a7 -m 512M \
179179
-nographic -monitor none -serial null -serial stdio \
@@ -185,7 +185,7 @@ The emulated target can be debugged with GDB by adding the `-S -s` flags to the
185185
previous execution command, this will make qemu waiting for a GDB connection
186186
that can be launched as follows:
187187

188-
```
188+
```sh
189189
arm-none-eabi-gdb -ex "target remote 127.0.0.1:1234" example
190190
```
191191

board/qemu/microvm/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ import (
6767
Build the [TamaGo compiler](https://github.com/usbarmory/tamago-go)
6868
(or use the [latest binary release](https://github.com/usbarmory/tamago-go/releases/latest)):
6969

70-
```
70+
```sh
7171
wget https://github.com/usbarmory/tamago-go/archive/refs/tags/latest.zip
7272
unzip latest.zip
7373
cd tamago-go-latest/src && ./all.bash
@@ -77,7 +77,7 @@ cd ../bin && export TAMAGO=`pwd`/go
7777
Go applications can be compiled as usual, using the compiler built in the
7878
previous step, but with the addition of the following flags/variables:
7979

80-
```
80+
```sh
8181
GOOS=tamago GOOSPKG=github.com/usbarmory/tamago GOARCH=amd64 \
8282
${TAMAGO} build -ldflags "-T 0x10010000 -R 0x1000" main.go
8383
```
@@ -90,7 +90,7 @@ Two examples application, targeting the QEMU microvm platform, are available:
9090
Build tags
9191
==========
9292

93-
The following build tags allow application to override the package own
93+
The following build tags allow applications to override the package own
9494
definition for the `runtime/goos` overlay:
9595

9696
* `linkramsize`: exclude `ramSize` from `mem.go`
@@ -106,7 +106,7 @@ well as paravirtualized execution.
106106
QEMU
107107
----
108108

109-
```
109+
```sh
110110
qemu-system-x86_64 \
111111
-machine microvm,x-option-roms=on,pit=off,pic=off,rtc=on \
112112
-global virtio-mmio.force-legacy=false \
@@ -120,7 +120,7 @@ The paravirtualized target can be debugged with GDB by adding the `-S -s` flags
120120
to the previous execution command, this will make qemu waiting for a GDB
121121
connection that can be launched as follows:
122122

123-
```
123+
```sh
124124
gdb -ex "target remote 127.0.0.1:1234" example
125125
```
126126

0 commit comments

Comments
 (0)