Skip to content

Commit 1485a45

Browse files
committed
READMEs update
1 parent 4140333 commit 1485a45

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README-MAINTAINER.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,19 @@ total 17636
454454
-rw-r--r-- 1 ilg ilg 108 Jan 30 22:54 xpack-qemu-riscv-7.2.0-1-linux-arm.tar.gz.sha
455455
```
456456

457-
### Build a debug version
457+
### Update README-MAINTAINER listing output
458+
459+
- check and possibly update the `ls -l` output in README-MAINTAINER
460+
461+
### Update the list of links in package.json
462+
463+
Copy/paste the full list of links displayed at the end of the build, in
464+
sequence, for each platform (GNU/Linux, macOS, Windows), and check the
465+
differences compared to the repository.
466+
467+
Commit if necessary.
468+
469+
### How to build a debug version
458470

459471
In some cases it is necessary to run a debug session in the binaries,
460472
or even in the libraries functions.
@@ -544,6 +556,12 @@ Publish a new release of the helper and update the reference in `package.json`.
544556
Check if the build machines have enough free space and eventually
545557
do some cleanups (`df -BG -H /` on Linux, `df -gH /` on macOS).
546558

559+
To remove previous builds, use:
560+
561+
```sh
562+
rm -rf ~/Work/xpack-dev-tools/*/build
563+
```
564+
547565
### Manually trigger the build GitHub Actions
548566

549567
To trigger the GitHub Actions build, use the xPack action:
@@ -741,12 +759,11 @@ watching this project.
741759

742760
## Update the READMEs listings and examples
743761

744-
- check and possibly update the `ls -l` output
745-
- check and possibly update the output of the `--version` runs
746-
- check and possibly update the output of `tree -L 2`
762+
- check and possibly update the output of `tree -L 2` in README
763+
- check and possibly update the output of the `--version` runs in README-MAINTAINER
747764
- commit changes
748765

749-
## Check the list of links
766+
## Check the list of links in package.json
750767

751768
- open the `package.json` file
752769
- check if the links in the `bin` property cover the actual binaries

0 commit comments

Comments
 (0)