Skip to content

Commit 50c2fbe

Browse files
committed
doc: mention no-cache mode for editoast and core debugging
Signed-off-by: Pierre-Etienne Bougué <bougue.pe@proton.me>
1 parent ce0a093 commit 50c2fbe

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

core/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,16 @@ For core:
111111
./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/
112112
```
113113

114+
Removing cache on editoast is also usually helpful to repeat requests
115+
(please see the [dedicated section](../editoast/README.md#no-cache-mode)). \
116+
For editoast server, combining single-worker and no-cache modes requires a
117+
local instance (or a tweak of `docker-compose.single-worker.yml`):
118+
```sh
119+
cd ../editoast
120+
EDITOAST_CORE_SINGLE_WORKER=true NO_CACHE=true cargo run -- runserver
121+
```
122+
123+
114124
Clean or restart the whole stack can be necessary sometimes and is also available
115125
through docker compose CLI (the following wipes the database too):
116126
```sh

editoast/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,13 @@ cargo install --locked taplo-cli
7777

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

80+
## No-cache mode
81+
82+
Running editoast with deactivated cache can help repeating calls when debugging.
83+
```sh
84+
NO_CACHE=true cargo run -- runserver
85+
```
86+
8087
## For M1 MacOS users
8188

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

0 commit comments

Comments
 (0)