Skip to content

Commit 2fdc1c0

Browse files
Update README.md
Signed-off-by: Simon Beaudoin <sbeaudoi@qti.qualcomm.com>
1 parent 06cb8cf commit 2fdc1c0

File tree

1 file changed

+11
-25
lines changed

1 file changed

+11
-25
lines changed

README.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ See the **Github Workflow** section below.
2323

2424
1. Clone the repository \[in some tooling folder\]:
2525
```bash
26-
git clone https://github.com/qualcomm-linux/docker_deb_build.git
26+
git clone https://github.com/qualcomm-linux/docker-pkg-build.git
2727
```
2828

2929
2. Ensure Docker is running and you have permissions to build containers. The build scripts does multiple pre-flight checks.
3030
Should any test fail, there will be instructions on what to do to fix the issue.
3131

3232
3. Pro tip: Say you cloned this to your home folder, create a quick alias in your .bashrc file (debb == **deb**ian **b**uild:
3333
```
34-
alias debb="~/docker_deb_build/docker_deb_build.py"
34+
alias debb="~/docker-pkg-build/docker_deb_build.py"
3535
```
3636

3737
## First time using
@@ -55,13 +55,14 @@ You should then see the following (if you built on an X64_64 machine):
5555

5656
```
5757
$ docker image ls
58-
REPOSITORY TAG IMAGE ID CREATED SIZE
59-
ghcr.io/qualcomm-linux/pkg-builder amd64-noble efc7d13f70f2 42 seconds ago 2.41GB
60-
ghcr.io/qualcomm-linux/pkg-builder amd64-questing 3c037366744a 13 days ago 2.33GB
58+
REPOSITORY TAG IMAGE ID CREATED SIZE
59+
ghcr.io/qualcomm-linux/pkg-builder arm64-questing ac7b0936a006 About an hour ago 1.32GB
60+
ghcr.io/qualcomm-linux/pkg-builder arm64-resolute c41a1b076a1b About an hour ago 1.35GB
61+
ghcr.io/qualcomm-linux/pkg-builder arm64-sid 8090ef2d71cc About an hour ago 1.52GB
62+
ghcr.io/qualcomm-linux/pkg-builder arm64-trixie d00e2414b324 2 hours ago 1.47GB
63+
ghcr.io/qualcomm-linux/pkg-builder arm64-noble bdbf1ec3b9bf 2 hours ago 1.25GB
6164
```
6265

63-
You can see that in our case, two containers have been built: one for noble and one for questing.
64-
As time goes by, we will add more suites (questing, resolute, etc)
6566
You can see in the TAG that the containers's tag is prepended with amd64 to show that those containers
6667
(vs the amd64 ones) are for amd64 host to cross-compile for arm64.
6768

@@ -90,7 +91,7 @@ Head over to the [pkg-example](www.github.com/qualcomm-linux/pkg-example) page a
9091
Then, clone and build :
9192

9293
```
93-
alias debb=<docker_deb_build location>/docker_deb_build.py
94+
alias debb=<docker-pkg-build location>/docker_deb_build.py
9495
9596
git clone git@github.com:qualcomm-linux/pkg-example.git
9697
@@ -116,22 +117,7 @@ docker_deb_build.py --help
116117

117118
### Docker Images
118119

119-
The `docker/` folder contains pre-configured Dockerfiles:
120-
- `Dockerfile.amd64.noble`: For AMD64 builds on Ubuntu Noble.
121-
- `Dockerfile.amd64.questing`: For AMD64 builds on Ubuntu Questing.
122-
- `Dockerfile.arm64.noble`: For ARM64 builds on Ubuntu Noble.
123-
- `Dockerfile.arm64.questing`: For ARM64 builds on Ubuntu Questing.
124-
125-
To add a new suite (like Trixie, Resolute, etc), copy the two Dockerfile (amd64 and arm64) for a given suite (say Questing) and tweak them to reflect the new version.
126-
Then, in the **docker_deb_build** script, add a new line for that suite in :
127-
```
128-
if args.rebuild:
129-
rebuild_docker_image(image_base, build_arch, 'noble')
130-
rebuild_docker_image(image_base, build_arch, 'questing')
131-
<HERE>
132-
sys.exit(0)
133-
```
134-
This will ensure that the new suite is built when running **$docker_deb_build.py --rebuild**
120+
To add a new suite, copy the two Dockerfile (amd64 and arm64) for a given suite (say Questing) and tweak them to reflect the new version.
135121
The last step is to ensure the containers (amd64 and arm64) for that suite are also pushed to GHCR as part of the **container-build-and-upload** workflow
136122
by adding a new line in the _.github/actions/build_container/action.yml_ in the _Push to GHCR_ step :
137123
```
@@ -150,7 +136,7 @@ This also applies for non-github-workflow local builds; doing a **docker_deb_bui
150136

151137
## Adding tooling
152138

153-
If additional tooling is required, the user shall add it in every Dockerfile found in Docker, open and merge the PR which will automatically trigger a post-merge build and upload to GHCR. Then, next time a github workflow build happens, the new tool will be present in the image hosted in GHCR.
139+
If additional tooling is required, the user shall add it to the **Dockerfiles/base-packages.txt**, open and merge the PR which will automatically trigger a post-merge build and upload to GHCR. Then, next time a github workflow build happens, the new tool will be present in the image hosted in GHCR.
154140

155141
## How to enter the container
156142

0 commit comments

Comments
 (0)