Skip to content
Snippets Groups Projects
Commit ed0fb02b authored by Florian Spreckelsen's avatar Florian Spreckelsen
Browse files

DOC: Add troubleshooting remark about symlinks on Windows

parent b282b325
No related branches found
No related tags found
2 merge requests!61Release 0.3.0,!58Fix conan create on Windows
Pipeline #56448 passed with warnings
Pipeline: caosdb-cppinttest

#56449

    ......@@ -65,7 +65,7 @@ commands:
    vcpkg/vcpkg install
    Copy the ``grpc-cpp-plugin`` to the build directory (TODO: This should ideally be done automatically by CMake):
    Copy the ``grpc-cpp-plugin`` to the build directory (TODO: This should ideally be done automatically by CMake):
    .. code:: console
    ......@@ -83,7 +83,7 @@ Then compile the project with CMake by including the vcpkg toolchain file:
    Alternatively, on Linux, you can use the provided `Makefile` targets
    .. code:: console
    make vcpkg-build-release
    ......@@ -108,7 +108,7 @@ How to build on Windows
    We use `Visual Studio
    2022 <https://visualstudio.microsoft.com/de/vs/features/cplusplus/>`__
    as compiler. We use `cmake <https://cmake.org/download/>`__ as build
    tool, which can be installed together with Visual Studio.
    tool, which can be installed together with Visual Studio.
    1. Install Python and create a virtual environment with the dependencies in
    `requirements.txt`.
    ......@@ -128,7 +128,7 @@ Troubleshooting
    ERROR: The default build profile '~/.conan2/profiles/default' doesn't exist
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    Follow the instructions and run
    Follow the instructions and run
    .. code:: console
    ......@@ -175,6 +175,18 @@ to, e.g., ``std::string_view`` being unavailable, try specifying the cpp
    standard manually by
    ``conan install .. [other options] -s "compiler.cppstd=17"``.
    Problems with symlinks on Windows
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    If you're experiencing problems with symlinks, e.g., errors like ``
    \linkahead-cpplib\test_package\test_info.cpp(1,1): error C2059: syntax
    error '.'`` when running ``conan create`` on Windows you might need to
    activate the Windows Development Mode and adjust yor git config to
    allow symlinks as described in `this Stackoverflow post
    <https://stackoverflow.com/questions/5917249/git-symbolic-links-in-windows/59761201#59761201>`_. Without
    development mode and the proper git configuration, windows treats
    symlinks as text files instead of links.
    Client Configuration
    --------------------
    ......@@ -220,7 +232,7 @@ For the tests the build type has to be Debug. As a shorthand you can run ``make
    test``. If you want to build manually, follow these steps:
    1. ``conan install . -s build_type=Debug --build=missing``
    2. ``cd build/Debug``
    2. ``cd build/Debug``
    3. ``cmake -S ../.. -G "Unix Makefiles" -DCMAKE_TOOLCHAIN_FILE=generators/conan_toolchain.cmake -DCMAKE_POLICY_DEFAULT_CMP0091=NEW -DCMAKE_BUILD_TYPE=Debug``
    - If your clang-format version is too old, formatting, linting etc. can
    be skipped:
    ......
    0% Loading or .
    You are about to add 0 people to the discussion. Proceed with caution.
    Finish editing this message first!
    Please register or to comment