Merge pull request #84 from bkryza/fix-relative-to-paths

Fix relative to paths

Author: bkryza

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
-
+  
+  * Added relationship deduction from `auto` return types which are template
+    specializations (#82)
+  * Fixed lambda names in class diagrams to be based on relative paths
+    with respect to `relative_to` config option (#78)
+  * Fixed relative paths in config files to be relative to the parent of
+    the configuration file by default (#69)
   * Added command line option (--dump-config) to print effective config (#77)
   * Added support for building with Microsoft Visual Studio
 

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)
 
 <!-- tocstop -->
 
@@ -113,4 +114,20 @@ diagrams:
       # Add this line to the beginning of the resulting puml file
       before:
         - 'title clang-uml class diagram model'
-```
+```
+
+## 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

docs/test_cases.md

@@ -1,15 +1,4 @@
 # Test cases index
-
-<!-- toc -->
-
-* [Class diagrams](#class-diagrams)
-* [Sequence diagrams](#sequence-diagrams)
-* [Package diagrams](#package-diagrams)
-* [Include diagrams](#include-diagrams)
-* [Configuration diagrams](#configuration-diagrams)
-
-<!-- tocstop -->
-
 ## Class diagrams
  * [t00002](./test_cases/t00002.md) - Basic class inheritance
  * [t00003](./test_cases/t00003.md) - Class field and methods
@@ -60,6 +49,7 @@
  * [t00048](./test_cases/t00048.md) - Test case for unique entity id with multiple translation units
  * [t00049](./test_cases/t00049.md) - Test case configurable type aliases
  * [t00050](./test_cases/t00050.md) - Test case for generating notes from comments using jinja templates
+ * [t00051](./test_cases/t00051.md) - Test case for relative paths in lambda names
 ## Sequence diagrams
  * [t20001](./test_cases/t20001.md) - Basic sequence diagram test case
  * [t20002](./test_cases/t20002.md) - Free function sequence diagram test case