Skip to content

Commit e333a32

Browse files
ilg-ulilg-ul
committed
READMEs: update ${HOME}/Work
1 parent 9fcc841 commit e333a32

File tree

4 files changed

+45
-45
lines changed

4 files changed

+45
-45
lines changed

‎README-BUILD.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ Git repo.
6868
To download them, issue the following commands:
6969

7070
```sh
71-
rm -rf ~/Downloads/qemu-riscv-xpack.git; \
71+
rm -rf ${HOME}/Work/qemu-riscv-xpack.git; \
7272
git clone \
7373
https://github.com/xpack-dev-tools/qemu-riscv-xpack.git \
74-
~/Downloads/qemu-riscv-xpack.git; \
75-
git -C ~/Downloads/qemu-riscv-xpack.git submodule update --init --recursive
74+
${HOME}/Work/qemu-riscv-xpack.git; \
75+
git -C ${HOME}/Work/qemu-riscv-xpack.git submodule update --init --recursive
7676
```
7777

7878
> Note: the repository uses submodules; for a successful build it is
@@ -82,12 +82,12 @@ For development purposes, clone the `xpack-develop`
8282
branch:
8383

8484
```sh
85-
rm -rf ~/Downloads/qemu-riscv-xpack.git; \
85+
rm -rf ${HOME}/Work/qemu-riscv-xpack.git; \
8686
git clone \
8787
--branch xpack-develop \
8888
https://github.com/xpack-dev-tools/qemu-riscv-xpack.git \
89-
~/Downloads/qemu-riscv-xpack.git; \
90-
git -C ~/Downloads/qemu-riscv-xpack.git submodule update --init --recursive
89+
${HOME}/Work/qemu-riscv-xpack.git; \
90+
git -C ${HOME}/Work/qemu-riscv-xpack.git submodule update --init --recursive
9191
```
9292

9393
## The `Work` folder
@@ -166,7 +166,7 @@ Before running a build for the first time, it is recommended to preload the
166166
docker images.
167167

168168
```sh
169-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh preload-images
169+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh preload-images
170170
```
171171

172172
The result should look similar to:
@@ -201,14 +201,14 @@ network connection or a computer entering sleep.
201201
screen -S qemu
202202

203203
sudo rm -rf ~/Work/qemu-riscv-*
204-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --all
204+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --all
205205
```
206206

207207
or, for development builds:
208208

209209
```sh
210210
sudo rm -rf ~/Work/qemu-riscv-*
211-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --develop--without-pdf --without-html --disable-tests --linux64 --win64
211+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --develop--without-pdf --without-html --disable-tests --linux64 --win64
212212
```
213213

214214
To detach from the session, use `Ctrl-a` `Ctrl-d`; to reattach use
@@ -251,7 +251,7 @@ Before running a build for the first time, it is recommended to preload the
251251
docker images.
252252

253253
```sh
254-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh preload-images
254+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh preload-images
255255
```
256256

257257
The result should look similar to:
@@ -271,14 +271,14 @@ network connection or a computer entering sleep.
271271
screen -S qemu
272272

273273
sudo rm -rf ~/Work/qemu-riscv-*
274-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --all
274+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --all
275275
```
276276

277277
or, for development builds:
278278

279279
```sh
280280
sudo rm -rf ~/Work/qemu-riscv-*
281-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --without-pdf --without-html --disable-tests --arm32 --arm64
281+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --without-pdf --without-html --disable-tests --arm32 --arm64
282282
```
283283

284284
To detach from the session, use `Ctrl-a` `Ctrl-d`; to reattach use
@@ -319,14 +319,14 @@ network connection or a computer entering sleep.
319319
screen -S qemu
320320

321321
rm -rf ~/Work/qemu-riscv-*
322-
caffeinate bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --macos
322+
caffeinate bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --macos
323323
```
324324

325325
or, for development builds:
326326

327327
```sh
328328
rm -rf ~/Work/qemu-riscv-*
329-
caffeinate bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --without-pdf --without-html --disable-tests --macos
329+
caffeinate bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --without-pdf --without-html --disable-tests --macos
330330
```
331331

332332
To detach from the session, use `Ctrl-a` `Ctrl-d`; to reattach use
@@ -364,19 +364,19 @@ On Arm, instead of `--all`, you can use any combination of:
364364
To remove most build temporary files, use:
365365

366366
```sh
367-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --all clean
367+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --all clean
368368
```
369369

370370
To also remove the library build temporary files, use:
371371

372372
```sh
373-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --all cleanlibs
373+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --all cleanlibs
374374
```
375375

376376
To remove all temporary files, use:
377377

378378
```sh
379-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --all cleanall
379+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --all cleanall
380380
```
381381

382382
Instead of `--all`, any combination of `--win64 --linux64`

‎README-DEVELOP.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -171,11 +171,11 @@ Git repo.
171171
To download them, use:
172172

173173
```sh
174-
rm -rf ~/Downloads/qemu-riscv-xpack.git; \
174+
rm -rf ${HOME}/Work/qemu-riscv-xpack.git; \
175175
git clone \
176176
https://github.com/xpack-dev-tools/qemu-riscv-xpack.git \
177-
~/Downloads/qemu-riscv-xpack.git; \
178-
git -C ~/Downloads/qemu-riscv-xpack.git submodule update --init --recursive
177+
${HOME}/Work/qemu-riscv-xpack.git; \
178+
git -C ${HOME}/Work/qemu-riscv-xpack.git submodule update --init --recursive
179179
```
180180

181181
For more details please read the `README-BUILD.md` file.
@@ -193,13 +193,13 @@ To build a binary which is suitable for debug sessions, run the
193193
```sh
194194
rm -rf ~/Work/qemu-riscv-dev
195195

196-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build-native.sh --debug --develop
196+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build-native.sh --debug --develop
197197
```
198198

199199
To build the Windows binaries, use:
200200

201201
```sh
202-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build-native.sh --debug --develop --win
202+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build-native.sh --debug --develop --win
203203
```
204204

205205
The result is the `${HOME}/Work/qemu-riscv-dev/${platform}-${arch}` folder. The build
@@ -237,27 +237,27 @@ in preparation for a new build.
237237
The operation can also be performed manually:
238238

239239
```sh
240-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build-native.sh clean
240+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build-native.sh clean
241241
```
242242

243243
To remove the library folders, use:
244244

245245
```sh
246-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build-native.sh cleanlibs
246+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build-native.sh cleanlibs
247247
```
248248

249249
To remove all:
250250

251251
```sh
252-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build-native.sh cleanall
252+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build-native.sh cleanall
253253
```
254254

255255
To clean the Windows build, the commands are similar:
256256

257257
```sh
258-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build-native.sh --win clean
259-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build-native.sh --win cleanlibs
260-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build-native.sh --win cleanall
258+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build-native.sh --win clean
259+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build-native.sh --win cleanlibs
260+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build-native.sh --win cleanall
261261
```
262262

263263
### Edit & IntelliSense

‎README-RELEASE.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -90,23 +90,23 @@ or the production machines (`xbbma`, `xbbmi`):
9090
```sh
9191
sudo rm -rf ~/Work/qemu-riscv-*
9292

93-
caffeinate bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --macos
93+
caffeinate bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --macos
9494
```
9595

9696
Similarly on the Intel Linux (`xbbli`):
9797

9898
```sh
9999

100-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --linux64
100+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --linux64
101101

102-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --win64
102+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --win64
103103
```
104104

105105
And on the Arm Linux (`xbbla`):
106106

107107
```sh
108-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --arm64
109-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --arm32
108+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --arm64
109+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/build.sh --develop --arm32
110110
```
111111

112112
Work on the scripts until all platforms pass the build.
@@ -151,7 +151,7 @@ To trigger the GitHub Actions build, use the xPack action:
151151
This is equivalent to:
152152

153153
```sh
154-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/trigger-workflow-build.sh
154+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/trigger-workflow-build.sh
155155
```
156156

157157
This script requires the `GITHUB_API_DISPATCH_TOKEN` to be present
@@ -182,9 +182,9 @@ To trigger the GitHub Actions tests, use the xPack actions:
182182
These are equivalent to:
183183

184184
```sh
185-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/tests/trigger-workflow-test-prime.sh
186-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-intel.sh
187-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-arm.sh
185+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/tests/trigger-workflow-test-prime.sh
186+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-intel.sh
187+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-arm.sh
188188
```
189189

190190
These scripts require the `GITHUB_API_DISPATCH_TOKEN` variable to be present
@@ -207,7 +207,7 @@ To trigger the Travis test, use the xPack action:
207207
This is equivalent to:
208208

209209
```sh
210-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/tests/trigger-travis-macos.sh
210+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/tests/trigger-travis-macos.sh
211211
```
212212

213213
This script requires the `TRAVIS_COM_TOKEN` variable to be present

‎scripts/tests/README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ The binaries can be available from one of the pre-releases:
99
The test script is part of the QEMU RISC-V xPack:
1010

1111
```sh
12-
rm -rf ~/Downloads/qemu-riscv-xpack.git; \
12+
rm -rf ${HOME}/Work/qemu-riscv-xpack.git; \
1313
git clone \
1414
--branch xpack-develop \
1515
https://github.com/xpack-dev-tools/qemu-riscv-xpack.git \
16-
~/Downloads/qemu-riscv-xpack.git; \
17-
git -C ~/Downloads/qemu-riscv-xpack.git submodule update --init --recursive
16+
${HOME}/Work/qemu-riscv-xpack.git; \
17+
git -C ${HOME}/Work/qemu-riscv-xpack.git submodule update --init --recursive
1818
```
1919

2020
## Start a local test
2121

2222
To check if QEMU RISC-V starts on the current platform, run a native test:
2323

2424
```sh
25-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/tests/native-test.sh \
25+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/tests/native-test.sh \
2626
--base-url "https://github.com/xpack-dev-tools/pre-releases/releases/download/test/"
2727
```
2828

@@ -41,15 +41,15 @@ The multi-platform tests run on GitHub Actions; they do not fire on
4141
git commits, but only via a manual POST to the GitHub API.
4242

4343
```sh
44-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/tests/trigger-workflow-test-prime.sh \
44+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/tests/trigger-workflow-test-prime.sh \
4545
--branch xpack-develop \
4646
--base-url "https://github.com/xpack-dev-tools/pre-releases/releases/download/test/"
4747

48-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-intel.sh \
48+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-intel.sh \
4949
--branch xpack-develop \
5050
--base-url "https://github.com/xpack-dev-tools/pre-releases/releases/download/test/"
5151

52-
bash ~/Downloads/qemu-riscv-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-arm.sh \
52+
bash ${HOME}/Work/qemu-riscv-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-arm.sh \
5353
--branch xpack-develop \
5454
--base-url "https://github.com/xpack-dev-tools/pre-releases/releases/download/test/"
5555

0 commit comments

Comments
 (0)