From a642946f24c7c6b3605877a65e97bc226dde7f31 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vadkerti=20S=C3=A1ra?= <71972627+saravadkerti@users.noreply.github.com> Date: Mon, 24 Nov 2025 15:31:18 +0100 Subject: [PATCH 1/4] Update usage.md --- doc/usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/usage.md b/doc/usage.md index bd0b10af9..53766ff22 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -123,7 +123,7 @@ CodeCompass_parser -w -n -i -i -d Date: Mon, 24 Nov 2025 15:32:12 +0100 Subject: [PATCH 2/4] Update deps.md Added recommended folder structure --- doc/deps.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/deps.md b/doc/deps.md index a0bb431bc..26dcf28d9 100644 --- a/doc/deps.md +++ b/doc/deps.md @@ -6,6 +6,17 @@ is planned). We also provide a Docker image that can be used as developer environment to CodeCompass. See its usage [in a seperate document](/docker/README.md). +It is recommended to have the following filesystem layout: + +``` +... + `-CodeCompass + |-CodeCompass # Source code from Git. + |-build # CMake runs here. + |-install # CodeCompass goes here. + `-workspace # Parsed projects' workspace directory. +``` + # Dependencies The following third-party tools are needed for building CodeCompass. These can be installed from the official repository of the given Linux distribution. From 39c5194bb0d9cafa5a95625c9ff4cd8da92309ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vadkerti=20S=C3=A1ra?= <71972627+saravadkerti@users.noreply.github.com> Date: Mon, 1 Dec 2025 07:06:18 +0100 Subject: [PATCH 3/4] Delete filesystem layout section from deps.md Removed recommended filesystem layout for CodeCompass. --- doc/deps.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/doc/deps.md b/doc/deps.md index 26dcf28d9..a0bb431bc 100644 --- a/doc/deps.md +++ b/doc/deps.md @@ -6,17 +6,6 @@ is planned). We also provide a Docker image that can be used as developer environment to CodeCompass. See its usage [in a seperate document](/docker/README.md). -It is recommended to have the following filesystem layout: - -``` -... - `-CodeCompass - |-CodeCompass # Source code from Git. - |-build # CMake runs here. - |-install # CodeCompass goes here. - `-workspace # Parsed projects' workspace directory. -``` - # Dependencies The following third-party tools are needed for building CodeCompass. These can be installed from the official repository of the given Linux distribution. From 644f6da2f3f1e4482892bfbc0429c0859fc1a516 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vadkerti=20S=C3=A1ra?= <71972627+saravadkerti@users.noreply.github.com> Date: Fri, 5 Dec 2025 16:21:50 +0100 Subject: [PATCH 4/4] Clarify database name usage in documentation --- doc/usage.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/usage.md b/doc/usage.md index 53766ff22..723324209 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -122,8 +122,7 @@ CodeCompass_parser -w -n -i -i -d