InTheForest/moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2026-01-11 18:51:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs/contributing: minor fixes

Browse Source 
- Remove mention of `BIND_DIR` as it's no longer needed
- Update some links to files that were moved

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn
2025-08-26 13:14:36 +02:00
parent 531be96bf9
commit 9f1d8be252
2 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/contributing/debug.md
View File

@@ -7,7 +7,7 @@ Also, in order to be able to debug the daemon, it has to be compiled with the de
This can be done by launching the development container with the following command:
```bash
$ make BIND_DIR=. DOCKER_DEBUG=1 DELVE_PORT=127.0.0.1:2345:2345 shell
$ make DOCKER_DEBUG=1 DELVE_PORT=127.0.0.1:2345:2345 shell
```
The `DOCKER_DEBUG` variable disables build optimizations, allowing to debug the binary,
@@ -27,7 +27,7 @@ outside the developer's machine and is not recommended.
1. Run development container with build optimizations disabled (ie. `DOCKER_DEBUG=1`) and Delve enabled:
```bash
$ make BIND_DIR=. DOCKER_DEBUG=1 DELVE_PORT=127.0.0.1:2345:2345 shell
$ make DOCKER_DEBUG=1 DELVE_PORT=127.0.0.1:2345:2345 shell
```
2. Inside the development container:
1. Build the Docker daemon:
@@ -51,7 +51,7 @@ outside the developer's machine and is not recommended.
1. Run development container with build optimizations disabled (ie. `DOCKER_DEBUG=1`) and Delve enabled:
```bash
$ make BIND_DIR=. DOCKER_DEBUG=1 DELVE_PORT=127.0.0.1:2345:2345 shell
$ make DOCKER_DEBUG=1 DELVE_PORT=127.0.0.1:2345:2345 shell
```
2. Inside the development container, run the integration test you want through the `make.sh` script:

16
docs/contributing/set-up-dev-env.md
View File

@@ -119,7 +119,7 @@ can take over 15 minutes to complete.
4. Use `make` to build a development environment image and run it in a container.
```none
$ make BIND_DIR=. shell
$ make shell
```
Using the instructions in the
@@ -230,12 +230,12 @@ can take over 15 minutes to complete.
test-execution:
```none
make DOCKER_CLI_PATH=/home/ubuntu/git/docker-ce/components/packaging/static/build/linux/docker/docker BIND_DIR=. shell
make DOCKER_CLI_PATH=~/go/src/github.com/docker/cli/build/docker shell
...
# which docker
/usr/local/cli/docker
# docker --version
Docker version 17.09.0-dev, build
Docker version 29.0.0-dev, build 09cd4ea26c
```
This Docker CLI should be built from the [docker-cli
@@ -278,16 +278,14 @@ you have:
* forked and cloned the Moby Engine code repository
* created a feature branch for development
* created and started an Engine development container from your branch
* built a binary inside of your development container
* built a binary inside your development container
* launched a `docker` daemon using your newly compiled binary
* called the `docker` client to run a `hello-world` container inside
your development container
Running the `make BIND_DIR=. shell` command mounted your local Docker repository source into
Running the `make shell` command mounted your local Docker repository source into
your Docker container.
> **Note**: Inspecting the `Dockerfile` shows a `COPY . /go/src/github.com/docker/docker` instruction, suggesting that dynamic code changes will _not_ be reflected in the container. However inspecting the `Makefile` shows that the current working directory _will_ be mounted via a `-v` volume mount.
When you start to develop code though, you'll
want to iterate code changes and builds inside the container. If you have
followed this guide exactly, you have a bash shell running a development
@@ -308,7 +306,7 @@ example, you'll edit the help for the `attach` subcommand.
Your location should be different because, at least, your username is
different.
3. Open the `cmd/dockerd/docker.go` file.
3. Open the `daemon/command/docker.go` file.
4. Edit the command's help message.
@@ -324,7 +322,7 @@ example, you'll edit the help for the `attach` subcommand.
Short: "A self-sufficient and really fun runtime for containers.",
```
5. Save and close the `cmd/dockerd/docker.go` file.
5. Save and close the `daemon/command/docker.go` file.
6. Go to your running docker development container shell.