diff --git a/web/content/docs/devguide/troubleshooting/build.pandoc b/web/content/docs/devguide/troubleshooting/build.pandoc new file mode 100644 index 0000000000000000000000000000000000000000..75163402d4a19509dd1d52bb14d85abe5035d1f6 --- /dev/null +++ b/web/content/docs/devguide/troubleshooting/build.pandoc @@ -0,0 +1,21 @@ +--- +date: "2018-02-26T11:00:13+01:00" +title: "Build" +author: "Lars Bilke" +weight: 1043 + +menu: + devguide: + parent: troubleshooting + identifier: build-troubleshooting +--- + +## Cotire-related (pre-compiled headers) + +If you get some error during build which mentions `cotire` or `*.prefix.hxx.gch` you can try to clean the pre-compiled headers with: + +```bash +make clean_cotire +``` + +This may occur after updating the compiler or system libraries. Related to configurations with `OGS_USE_PCH=ON` only. diff --git a/web/content/docs/devguide/troubleshooting/cmake.pandoc b/web/content/docs/devguide/troubleshooting/cmake.pandoc new file mode 100644 index 0000000000000000000000000000000000000000..4e82560d21b7e9019c93c79cdc21300066b7d17a --- /dev/null +++ b/web/content/docs/devguide/troubleshooting/cmake.pandoc @@ -0,0 +1,18 @@ ++++ +date = "2018-02-26T11:00:13+01:00" +title = "CMake" +author = "Lars Bilke" +weight = 1041 + +[menu] + [menu.devguide] + parent = "troubleshooting" ++++ + +## <i class="fas fa-exclamation-triangle"></i> General advice + +If something goes when running CMake please try again with an **empty** or newly created build-directory! This is very first thing you should try! + +Please read the CMake output carefully. Often it will tell you what went wrong. + +Check also [Conans troubleshooting page]({{< relref "conan.pandoc" >}}) if you use Conan for dependencies. diff --git a/web/content/docs/devguide/troubleshooting/conan.pandoc b/web/content/docs/devguide/troubleshooting/conan.pandoc new file mode 100644 index 0000000000000000000000000000000000000000..a4e9533826a86daa2b111fe5939489f4c4062260 --- /dev/null +++ b/web/content/docs/devguide/troubleshooting/conan.pandoc @@ -0,0 +1,33 @@ ++++ +date = "2018-02-26T11:00:13+01:00" +title = "Conan" +author = "Lars Bilke" +weight = 1042 + +[menu] + [menu.devguide] + parent = "troubleshooting" ++++ + +## Something went wrong during CMake run + +When CMake is run Conan will download library packages. You can see under `Requirements` in the CMake output from where the packages will be downloaded. Most packages will come `from ogs`: + +```bash +$ cmake ../ogs -DOGS_USE_CONAN=ON +... +-- Conan executing: conan install . -g cmake -s build_type=Release -s os=Macos -s compiler=apple-clang -s compiler.version=9.0 -s compiler.libcxx=libc++ --build=missing --update +PROJECT: Installing /Users/bilke/code/ogs6/build-n/conanfile.txt +Requirements + Boost/1.64.0@conan/stable from conan-community + Eigen3/3.2.9@bilke/stable from ogs + Qt/5.9.2@osechet/stable from ogs + Shapelib/1.3.0@bilke/stable from ogs + VTK/7.1.0@bilke/stable from ogs + libgeotiff/1.4.2@bilke/stable from ogs + libtiff/4.0.6@bilke/stable from ogs + proj/4.9.2@bilke/stable from ogs + zlib/1.2.11@conan/stable from conan-center +``` + +You can always delete the Conan cache directory in `$HOME/.conan` to start fresh. This can fix errors. diff --git a/web/content/docs/devguide/troubleshooting/git.pandoc b/web/content/docs/devguide/troubleshooting/git.pandoc new file mode 100644 index 0000000000000000000000000000000000000000..8d12f275e7a10cc69fa71ebb421b797f959e8986 --- /dev/null +++ b/web/content/docs/devguide/troubleshooting/git.pandoc @@ -0,0 +1,16 @@ ++++ +date = "2018-02-26T11:00:13+01:00" +title = "Git" +author = "Lars Bilke" +weight = 1044 + +[menu] + [menu.devguide] + parent = "troubleshooting" ++++ + +## General Git Help + +If you have any Git-related questions first look at these links: + +- [Git Flight Rules](https://github.com/k88hudson/git-flight-rules)