Skip to content

Commit

Permalink
doc: Update documentation after removing build.sh
Browse files Browse the repository at this point in the history
In 5634985, scripts/build.sh was removed, but related documentation
wasn’t updated. This change revises the docs to reflect that removal.
Additionally, to address c-ares incompatibility in the container image,
the updated command in doc/tutorial.md now builds a compatible c-ares
version from source.

Signed-off-by: Kefu Chai <[email protected]>
  • Loading branch information
tchaikov committed Feb 24, 2025
1 parent 8ab0267 commit 336ef88
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 14 deletions.
13 changes: 0 additions & 13 deletions doc/building-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,3 @@ $ seabuild() { docker run -v $HOME/seastar/:/seastar -u $(id -u):$(id -g) -w /se
$ seabuild ./configure.py
$ seabuild ninja -C build/release
```

Alternatively there's a `scripts/build.sh` script with the usage of

```
build.sh <mode> [<compiler>] [<compiler version>] [<c++ dialect>]
```

that will do the above steps itself, e.g. the above example would be like

```
$ scripts/build.sh release
```

3 changes: 2 additions & 1 deletion doc/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ To compile this program (it's present in the `demos/hello-world.cc` file) you ca
```
$ docker build -t seastar-dev -f ./docker/dev/Dockerfile .
$ scripts/build.sh dev
$ docker run -it --rm -v $(pwd):/seastar seastar-dev /seastar/configure --mode=dev --cook=c-ares
$ docker run -it --rm -v $(pwd):/seastar seastar-dev ninja -C /seastar/build/dev
$ docker run -it --rm -v $(pwd):/seastar seastar-dev /seastar/build/dev/demos/hello-world_demo -c1
```
Expand Down

0 comments on commit 336ef88

Please sign in to comment.