From 61dcf9ef043abb69a7e42f29baf71ef2adb53728 Mon Sep 17 00:00:00 2001 From: Bartek Kryza Date: Sat, 21 Jan 2023 20:30:14 +0100 Subject: [PATCH] Updated docs --- docs/configuration_file.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/configuration_file.md b/docs/configuration_file.md index 26397e64..136db40a 100644 --- a/docs/configuration_file.md +++ b/docs/configuration_file.md @@ -5,6 +5,7 @@ * [Top level options](#top-level-options) * [Diagram options](#diagram-options) * [Example complete config](#example-complete-config) +* [Paths](#paths) @@ -113,4 +114,20 @@ diagrams: # Add this line to the beginning of the resulting puml file before: - 'title clang-uml class diagram model' -``` \ No newline at end of file +``` + +## Paths +By default, all paths specified in the configuration file, including: + +* `glob` +* `output_directory` +* `compilation_database_dir` +* `paths` filter + +are relative to the parent directory of the configuration file. This can be +changed in the following ways: +* by specifying `relative_to` option in the configuration file +* by providing `--paths-relative-to-pwd` command line option, in which + case all paths will be relative to the directory where `clang-uml` is + executed (this only makes sense for automation where `clang-uml` is executed + from the same location relative to the project directory \ No newline at end of file