Skip to content

Commit

Permalink
doc: mention no-cache mode for editoast and core debugging
Browse files Browse the repository at this point in the history
Signed-off-by: Pierre-Etienne Bougué <[email protected]>
  • Loading branch information
bougue-pe authored and ElysaSrc committed Feb 5, 2025
1 parent d5b6165 commit 716e6c8
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
10 changes: 10 additions & 0 deletions core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,16 @@ For core:
./gradlew shadowJar && ALL_INFRA=true java -jar -ea -Xmx12g -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=dump.hprof build/libs/osrd-all.jar worker --editoast-url http://localhost:8090/
```

Removing cache on editoast is also usually helpful to repeat requests
(please see the [dedicated section](../editoast/README.md#no-cache-mode)). \
For editoast server, combining single-worker and no-cache modes requires a
local instance (or a tweak of `docker-compose.single-worker.yml`):
```sh
cd ../editoast
EDITOAST_CORE_SINGLE_WORKER=true NO_CACHE=true cargo run -- runserver
```


Clean or restart the whole stack can be necessary sometimes and is also available
through docker compose CLI (the following wipes the database too):
```sh
Expand Down
7 changes: 7 additions & 0 deletions editoast/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,13 @@ cargo install --locked taplo-cli

To setup `grcov`, please see [its documentation](https://github.com/mozilla/grcov#how-to-get-grcov)

## No-cache mode

Running editoast with deactivated cache can help repeating calls when debugging.
```sh
NO_CACHE=true cargo run -- runserver
```

## For M1 MacOS users

Our `docker-compose.yml` at the root of the project uses the `postgis` image by default.
Expand Down

0 comments on commit 716e6c8

Please sign in to comment.