diff --git a/CMakeLists.txt b/CMakeLists.txt index f6177b2f1..f6de54d97 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 2.8.12) # Configure some stuff that needs to be set really early if(BUILD_ANDROID) set(CMAKE_TOOLCHAIN_FILE - "${CMAKE_SOURCE_DIR}/scripts/android.toolchain.cmake" + "${CMAKE_SOURCE_DIR}/util/android.toolchain.cmake" CACHE STRING "The Android toolchain file") @@ -264,5 +264,5 @@ if(ENABLE_QRENDERDOC OR ENABLE_PYRENDERDOC) endif() # install documentation files -install (FILES scripts/LINUX_DIST_README DESTINATION share/doc/renderdoc RENAME README) +install (FILES util/LINUX_DIST_README DESTINATION share/doc/renderdoc RENAME README) install (FILES LICENSE.md DESTINATION share/doc/renderdoc) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 38423e3d4..aced05741 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,7 +90,7 @@ To make things easier for everyone, I've adopted clang-format for keeping code c | :warning: | **I have fixed the version used for RenderDoc at [clang-format-3.8](http://releases.llvm.org/download.html#3.8.1).** | :warning: | | :warning: | **This formatting is enforced by CI checks that run on PRs, so if you aren't running the same version locally it will show up there.** | :warning: | -If you want to format a single file, run: `clang-format -i file.cpp`. If you want to format any changes you make before you commit them, you'll need python installed and then run: `git clang-format`. To clang-format the whole codebase, you can run the bash script `scripts/clang_format_all.sh` but be sure to squash any changes into the right commits. +If you want to format a single file, run: `clang-format -i file.cpp`. If you want to format any changes you make before you commit them, you'll need python installed and then run: `git clang-format`. To clang-format the whole codebase, you can run the bash script `util/clang_format_all.sh` but be sure to squash any changes into the right commits. There are instructions on how to set up git hooks or IDE integration [on the wiki](https://github.com/baldurk/renderdoc/wiki/Code-formatting-(using-clang-format)). @@ -247,7 +247,7 @@ sudo apt-get install openjdk-8-jdk export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64 ``` -The Android SDK and NDK can be set up with the following steps. They are also mirrored in our Travis-CI [setup script](scripts/travis/android_setup.sh) for Android. We are currently targeting build-tools 26.0.1 and NDK r14b. +The Android SDK and NDK can be set up with the following steps. They are also mirrored in our Travis-CI [setup script](util/travis/android_setup.sh) for Android. We are currently targeting build-tools 26.0.1 and NDK r14b. SDK links are pulled from [here](https://developer.android.com/studio/index.html). @@ -308,18 +308,17 @@ If you have a change you'd like to see make it into mainline, create a fork of r There are [several pages](https://github.com/baldurk/renderdoc/wiki/Code-Dives) on the wiki explaining different aspects of how the code fits together - like how the capture-side works vs replay-side, how shader debugging works, etc. renderdoc/ - CMakeLists.txt ; The cmake file, will recurse into subdirectories to build them - renderdoc.sln ; VS2015 solution for windows building + CMakeLists.txt ; The cmake file, will recurse into subdirectories to build them + renderdoc.sln ; VS2015 solution for windows building renderdoc/ - 3rdparty/ ; third party utilities & libraries included - drivers/ ; API-specific back-ends, can be individually skipped/removed - ... ; everything else in here consists of the core renderdoc runtime - renderdoccmd/ ; A small C++ utility program that runs to do various little tasks - renderdocshim/ ; A tiny C DLL using only kernel32.dll that is used for global hooking - qrenderdoc/ ; The Qt UI layer built on top of renderdoc/ - docs/ ; source documentation for the .chm file or http://docs.renderdoc.org/ - ; in the Sandcastle help file builder - scripts/ ; folder for small scripts - e.g. for CI, installers, distribution + 3rdparty/ ; third party utilities & libraries included + drivers/ ; API-specific back-ends, can be individually skipped/removed + ... ; everything else in here consists of the core renderdoc runtime + renderdoccmd/ ; A small C++ utility program that runs to do various little tasks + renderdocshim/ ; A tiny C DLL using only kernel32.dll that is used for global hooking + qrenderdoc/ ; The Qt UI layer built on top of renderdoc/ + docs/ ; source documentation for the .chm file or http://docs.renderdoc.org/ + util/ ; folder for utility/support files - e.g. build scripts, installers, CI config # Testing diff --git a/qrenderdoc/qrenderdoc.pro b/qrenderdoc/qrenderdoc.pro index 4e182f5da..53e6ce58e 100644 --- a/qrenderdoc/qrenderdoc.pro +++ b/qrenderdoc/qrenderdoc.pro @@ -136,7 +136,7 @@ win32 { ICON = $$OSX_ICONFILE INFO_PLIST_PATH = $$shell_quote($$DESTDIR/$${TARGET}.app/Contents/Info.plist) - QMAKE_POST_LINK += $$_PRO_FILE_PWD_/../scripts/set_plist_version.sh $${RENDERDOC_VERSION}.0 $${INFO_PLIST_PATH} + QMAKE_POST_LINK += $$_PRO_FILE_PWD_/../util/set_plist_version.sh $${RENDERDOC_VERSION}.0 $${INFO_PLIST_PATH} } else { QT += x11extras DEFINES += RENDERDOC_PLATFORM_POSIX RENDERDOC_PLATFORM_LINUX RENDERDOC_WINDOWING_XLIB RENDERDOC_WINDOWING_XCB diff --git a/scripts/LINUX_DIST_README b/util/LINUX_DIST_README similarity index 100% rename from scripts/LINUX_DIST_README rename to util/LINUX_DIST_README diff --git a/scripts/android.toolchain.cmake b/util/android.toolchain.cmake similarity index 100% rename from scripts/android.toolchain.cmake rename to util/android.toolchain.cmake diff --git a/scripts/appveyor.yml b/util/appveyor.yml similarity index 100% rename from scripts/appveyor.yml rename to util/appveyor.yml diff --git a/scripts/clang_format_all.sh b/util/clang_format_all.sh similarity index 100% rename from scripts/clang_format_all.sh rename to util/clang_format_all.sh diff --git a/scripts/dist.sh b/util/dist.sh similarity index 90% rename from scripts/dist.sh rename to util/dist.sh index 4d45c7f71..26e9015eb 100644 --- a/scripts/dist.sh +++ b/util/dist.sh @@ -4,7 +4,7 @@ AUTOBUILD=1 if [ ! -f LICENSE.md ]; then echo "This script should be run from the root of the checkout."; - echo "e.g. ./scripts/dist.sh"; + echo "e.g. ./util/dist.sh"; exit; fi @@ -104,10 +104,10 @@ VERSION=`grep -E "#define RENDERDOC_VERSION_(MAJOR|MINOR)" renderdoc/api/replay/ export RENDERDOC_VERSION="${VERSION}" -"$WIX/bin/candle.exe" -o dist/Installer32.wixobj scripts/installer/Installer32.wxs -"$WIX/bin/light.exe" -ext WixUIExtension -sw1076 -loc scripts/installer/customtext.wxl -o dist/Installer32.msi dist/Installer32.wixobj +"$WIX/bin/candle.exe" -o dist/Installer32.wixobj util/installer/Installer32.wxs +"$WIX/bin/light.exe" -ext WixUIExtension -sw1076 -loc util/installer/customtext.wxl -o dist/Installer32.msi dist/Installer32.wixobj -"$WIX/bin/candle.exe" -o dist/Installer64.wixobj scripts/installer/Installer64.wxs -"$WIX/bin/light.exe" -ext WixUIExtension -sw1076 -loc scripts/installer/customtext.wxl -o dist/Installer64.msi dist/Installer64.wixobj +"$WIX/bin/candle.exe" -o dist/Installer64.wixobj util/installer/Installer64.wxs +"$WIX/bin/light.exe" -ext WixUIExtension -sw1076 -loc util/installer/customtext.wxl -o dist/Installer64.msi dist/Installer64.wixobj rm dist/*.wixobj dist/*.wixpdb diff --git a/scripts/installer/Installer32.wxs b/util/installer/Installer32.wxs similarity index 98% rename from scripts/installer/Installer32.wxs rename to util/installer/Installer32.wxs index d0d478d2d..904bbe2ce 100644 --- a/scripts/installer/Installer32.wxs +++ b/util/installer/Installer32.wxs @@ -109,7 +109,7 @@ - + @@ -348,12 +348,12 @@ - + - - + + - + diff --git a/scripts/installer/Installer64.wxs b/util/installer/Installer64.wxs similarity index 98% rename from scripts/installer/Installer64.wxs rename to util/installer/Installer64.wxs index 63b3c3c98..5a4eeb8b9 100644 --- a/scripts/installer/Installer64.wxs +++ b/util/installer/Installer64.wxs @@ -98,7 +98,7 @@ - + @@ -373,12 +373,12 @@ - + - - + + - + diff --git a/scripts/installer/LICENSE.rtf b/util/installer/LICENSE.rtf similarity index 100% rename from scripts/installer/LICENSE.rtf rename to util/installer/LICENSE.rtf diff --git a/scripts/installer/bannrbmp.bmp b/util/installer/bannrbmp.bmp similarity index 100% rename from scripts/installer/bannrbmp.bmp rename to util/installer/bannrbmp.bmp diff --git a/scripts/installer/chm.ico b/util/installer/chm.ico similarity index 100% rename from scripts/installer/chm.ico rename to util/installer/chm.ico diff --git a/scripts/installer/customtext.wxl b/util/installer/customtext.wxl similarity index 100% rename from scripts/installer/customtext.wxl rename to util/installer/customtext.wxl diff --git a/scripts/installer/dlgbmp.bmp b/util/installer/dlgbmp.bmp similarity index 100% rename from scripts/installer/dlgbmp.bmp rename to util/installer/dlgbmp.bmp diff --git a/scripts/set_plist_version.sh b/util/set_plist_version.sh similarity index 100% rename from scripts/set_plist_version.sh rename to util/set_plist_version.sh diff --git a/scripts/travis/android_compile.sh b/util/travis/android_compile.sh similarity index 100% rename from scripts/travis/android_compile.sh rename to util/travis/android_compile.sh diff --git a/scripts/travis/android_setup.sh b/util/travis/android_setup.sh similarity index 100% rename from scripts/travis/android_setup.sh rename to util/travis/android_setup.sh diff --git a/scripts/travis/compile.sh b/util/travis/compile.sh similarity index 79% rename from scripts/travis/compile.sh rename to util/travis/compile.sh index ee4b40fa0..b608c9472 100644 --- a/scripts/travis/compile.sh +++ b/util/travis/compile.sh @@ -2,7 +2,7 @@ if [[ "$DOCS_BUILD" == "1" ]]; then echo "== Compiling documentation build."; - . ./scripts/travis/docs_compile.sh; + . ./util/travis/docs_compile.sh; else @@ -12,11 +12,11 @@ else if [[ "$LINUX_BUILD" == "1" ]]; then - . ./scripts/travis/linux_compile.sh; + . ./util/travis/linux_compile.sh; elif [[ "$ANDROID_BUILD" == "1" ]]; then - . ./scripts/travis/android_compile.sh; + . ./util/travis/android_compile.sh; else @@ -29,7 +29,7 @@ else if [[ "$APPLE_BUILD" == "1" ]]; then - . ./scripts/travis/osx_compile.sh + . ./util/travis/osx_compile.sh else diff --git a/scripts/travis/docs_compile.sh b/util/travis/docs_compile.sh similarity index 100% rename from scripts/travis/docs_compile.sh rename to util/travis/docs_compile.sh diff --git a/scripts/travis/docs_setup.sh b/util/travis/docs_setup.sh similarity index 100% rename from scripts/travis/docs_setup.sh rename to util/travis/docs_setup.sh diff --git a/scripts/travis/linux_compile.sh b/util/travis/linux_compile.sh similarity index 100% rename from scripts/travis/linux_compile.sh rename to util/travis/linux_compile.sh diff --git a/scripts/travis/linux_setup.sh b/util/travis/linux_setup.sh similarity index 98% rename from scripts/travis/linux_setup.sh rename to util/travis/linux_setup.sh index fbdb959ed..8d967eb9e 100644 --- a/scripts/travis/linux_setup.sh +++ b/util/travis/linux_setup.sh @@ -32,7 +32,7 @@ fi # check formatting matches clang-format-3.8. Since newer versions can have # changes in formatting even without any rule changes, we have to fix on a # single version. -. ./scripts/clang_format_all.sh +. ./util/clang_format_all.sh git clean -f diff --git a/scripts/travis/osx_compile.sh b/util/travis/osx_compile.sh similarity index 100% rename from scripts/travis/osx_compile.sh rename to util/travis/osx_compile.sh diff --git a/scripts/travis/osx_setup.sh b/util/travis/osx_setup.sh similarity index 100% rename from scripts/travis/osx_setup.sh rename to util/travis/osx_setup.sh diff --git a/scripts/travis/setup.sh b/util/travis/setup.sh similarity index 80% rename from scripts/travis/setup.sh rename to util/travis/setup.sh index 9dd43ed27..dd502f11f 100644 --- a/scripts/travis/setup.sh +++ b/util/travis/setup.sh @@ -2,7 +2,7 @@ if [[ "$DOCS_BUILD" == "1" ]]; then echo "== Setting up documentation build."; - . ./scripts/travis/docs_setup.sh; + . ./util/travis/docs_setup.sh; else @@ -12,11 +12,11 @@ else if [[ "$LINUX_BUILD" == "1" ]]; then - . ./scripts/travis/linux_setup.sh; + . ./util/travis/linux_setup.sh; elif [[ "$ANDROID_BUILD" == "1" ]]; then - . ./scripts/travis/android_setup.sh; + . ./util/travis/android_setup.sh; else @@ -29,7 +29,7 @@ else if [[ "$APPLE_BUILD" == "1" ]]; then - . ./scripts/travis/osx_setup.sh + . ./util/travis/osx_setup.sh else diff --git a/scripts/valgrind.supp b/util/valgrind.supp similarity index 100% rename from scripts/valgrind.supp rename to util/valgrind.supp