search

u-eff-gee / alpaca

a linearly-polarized angular-correlation application
GNU General Public License v3.0
1 stars 1 forks source link

renamed ALPACE_SOURCE_DIR to ALPACA_ROOT_DIR to avoid ambiguity #1

Closed nichtmonti closed 2 years ago

nichtmonti commented 2 years ago

Following the steps from the README is now little a bit easier as the project root can no longer be confused with the source folder

u-eff-gee commented 2 years ago

Before I received your pull request, I would have thought that the terms "root folder" and "source folder" are synonyms. I used "source" because I thought that's what CMake calls the directory with the top-level CMakeLists.txt (https://cmake.org/cmake/help/latest/variable/CMAKE_SOURCE_DIR.html). I'm sure your pull request makes sense, but please help me understand the difference.

nichtmonti commented 2 years ago

Hi Udo, thanks for your response. By renaming the folder I'm, trying to resolve the ambiguity between the folder alpaca/source, and the folder alpaca/ itself. One might be tempted to run $ cmake -DBUILD_DOCUMENTATION=ON -DBUILD_TESTS=ON ./source instead of $ cmake -DBUILD_DOCUMENTATION=ON -DBUILD_TESTS=ON . which would result in the build failing and me being confused. I'm not really familiar with Cmake and its conventions, but coming from a Linux background I'd expect the keyword root to indicate the top folder of some folder structure. Hope this clarifies my request.

u-eff-gee commented 2 years ago

Flawless reasoning. Thanks for the explanation!