From 4d240a9f660ed0aed7b41ce9e7da18be9ea8feac Mon Sep 17 00:00:00 2001 From: rrrutledge Date: Thu, 8 Jun 2023 11:41:02 -0500 Subject: [PATCH] docs: Show how to route output to current directory By default the output is written inside the container. Signed-off-by: rrrutledge --- docs/hints-for-use-with-docker.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/hints-for-use-with-docker.md b/docs/hints-for-use-with-docker.md index fad1b20f3978c..893173e9e7acc 100644 --- a/docs/hints-for-use-with-docker.md +++ b/docs/hints-for-use-with-docker.md @@ -9,7 +9,9 @@ docker run \ -v $PWD/:/project \ # Mount current working directory into /project to use as input. ort --info \ -c /project/ort/config.yml \ # Use file from "/ort" as config. - analyze -i /project [...] # Insert further arguments for the command. + analyze -i /project \ # Analyze the current working directory using the alias (set earlier in the -v option). + -o /project \ # Output goes into the current working directory. + [...] # Insert further arguments for the command. ``` If only a subproject shall be analyzed, change the input path `-i /project` to `-i /project/subproject`. Note that still the projects root directory needs to be mounted to Docker for ORT to detect VCS information.