Document USE_STANDARD_FILESYSTEM

This commit is contained in:
Martchus 2019-07-13 14:11:45 +02:00
parent d318585fb2
commit 23dc7580a4
2 changed files with 6 additions and 0 deletions

View File

@ -87,6 +87,8 @@ make DESTDIR="/temporary/install/location" install
However, this will only affect applications. To force linking statically when building shared libraries set `STATIC_LIBRARY_LINKAGE=ON`.
* If thread local storage is not supported by your compiler/platform (might be the case on MacOS), you can disable making use of it
via `ENABLE_THREAD_LOCAL=OFF`.
* To disable use of `std::filesystem`, set `USE_STANDARD_FILESYSTEM=OFF`. This is required when building for MacOS and Android at the time of
writing this documentation. Note that the Bash completion will not be able to suggest files and directory with `USE_STANDARD_FILESYSTEM=OFF`.
* For more detailed documentation, see the documentation about build variables (in
[directory doc](https://github.com/Martchus/cpp-utilities/blob/master/doc/buildvariables.md) and
in Doxygen version accessible via "Related Pages").

View File

@ -86,6 +86,10 @@ None of these are enabled or set by default, unless stated otherwise.
* This feature is implemented in `c++utilities`, so the option must be specified
when building `c++utilities`. Specifying it only when building eg. `tagparser`
has *no* effect.
* `USE_STANDARD_FILESYSTEM=ON/OFF`: enables use of `std::filesystem` (default)
* Disabing this is required when building for MacOS and Android at the time of
writing this documentation.
* Bash completion will not be able to suggest files and directory when disabled.
#### Variables for specifying location of 3rd party dependencies
The build script tries to find the required dependencies at standard loctions