wbrawner/distribution
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor tweak to build docs.

Browse source 
- PROJECT should be defined when building/cleaning a package.
- List PROJECT options.
- Use export rather than defining vars on same line (save some typing).
- Clarify "manually" to mean "outside of Docker".
This commit is contained in:
littleguy77 2023-09-03 20:05:46 -04:00
parent 02f9da0fdd
commit 5cc10de5ab
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
documentation/DEVEL_BUILDING_JELOS.md
View file

@ -222,7 +222,7 @@ make docker-shell
CLEAN_PACKAGES="linux ppsspp-sa" make AMD64
exit
```
The first and last lines should be omitted if building manually.
The first and last lines should be omitted if building outside of Docker.
## Troubleshooting
The very first build after a fresh checkout is the hardest. Give yourself sufficient time to generate the first build and work through any failures before attempting to modify JELOS.
@ -239,11 +239,12 @@ Before modifying JELOS, be sure you can successfully build the unmodified `main`
When modifying individual packages, it's useful to regularly verify the build-ability of your changes. Rather than rebuild an entire device image, it is much faster to simply rebuild a single package using the following commands:
```
make docker-shell
DEVICE=AMD64 ARCH=x86_64 ./scripts/clean busybox
DEVICE=AMD64 ARCH=x86_64 ./scripts/build busybox
export PROJECT=PC DEVICE=AMD64 ARCH=x86_64
./scripts/clean busybox
./scripts/build busybox
exit
```
The first and last lines should be omitted if building manually.
The first and last lines should be omitted if building outside of Docker. PROJECT is one of `Amlogic`, `PC`, or `Rockchip` (i.e. the subdirectories of the project directory).
> Note: An EmulationStation package standalone build requires additional steps because its source code is located in a separate repository. See instructions [here](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/ui/emulationstation/package.mk).
@ -285,7 +286,7 @@ make docker-shell
vim/emacs/vscode/notepad.exe
# Export the variables needed to complete your build. We'll assume you are building AMD64; update the device to match your configuration.
export OS_VERSION=$(date +%Y%m%d) BUILD_DATE=$(date)
export PROJECT=PC ARCH=x86_64 DEVICE=AMD64
export PROJECT=PC DEVICE=AMD64 ARCH=x86_64
# Clean the package you are building.
./scripts/clean emulationstation
# Build the package.
@ -297,4 +298,4 @@ export PROJECT=PC ARCH=x86_64 DEVICE=AMD64
exit
```
The first and last lines should be omitted if building manually.
The first and last lines should be omitted if building outside of Docker.