From 871685fe867bd0d8102aec2b9aabe282e9f54762 Mon Sep 17 00:00:00 2001 From: baldurk Date: Mon, 17 Sep 2018 17:31:05 +0100 Subject: [PATCH] Split up CONTRIBUTING.md and move it under docs/ --- CONTRIBUTING.md | 329 ------------------------- README.md | 13 +- docs/CONTRIBUTING.md | 41 +++ docs/CONTRIBUTING/Code-Explanation.md | 16 ++ docs/CONTRIBUTING/Compiling.md | 52 ++++ docs/CONTRIBUTING/Dependencies.md | 172 +++++++++++++ docs/CONTRIBUTING/Developing-Change.md | 22 ++ docs/CONTRIBUTING/Preparing-Commits.md | 46 ++++ docs/CONTRIBUTING/Testing.md | 5 + docs/pull_request_template.md | 3 +- util/LINUX_DIST_README | 6 +- util/travis/linux_setup.sh | 3 +- 12 files changed, 369 insertions(+), 339 deletions(-) delete mode 100644 CONTRIBUTING.md create mode 100644 docs/CONTRIBUTING.md create mode 100644 docs/CONTRIBUTING/Code-Explanation.md create mode 100644 docs/CONTRIBUTING/Compiling.md create mode 100644 docs/CONTRIBUTING/Dependencies.md create mode 100644 docs/CONTRIBUTING/Developing-Change.md create mode 100644 docs/CONTRIBUTING/Preparing-Commits.md create mode 100644 docs/CONTRIBUTING/Testing.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index f6d8c6bb13..0000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,329 +0,0 @@ -# Contributing to RenderDoc - -If you're interested in contributing to RenderDoc, this is the place! - -**For those in a hurry, please just read the [commit message](#commit-messages) and [code formatting](#code-formatting) sections to get an idea of what a good PR will look like.** - -For small changes like one-line fixes or minor tweaks then don't worry too much about reading this end-to-end and getting every thing perfect the first time. The point of this isn't to be restrictive about rules, so I'm happy to help out with any changes needed to get your PR ready to merge. If you're unfamiliar with git and need help making any changes, feel free to ask as well! - -If you're a regular contributor or if you have a larger amount of code to change, please read on as it will make life easier for everyone if you to follow along with these guidelines from the start. - -1. [Compiling](#compiling) -2. [Code of Conduct](#code-of-conduct) -3. [Preparing commits](#preparing-commits) -4. [Developing a change](#developing-a-change) -5. [Copyright / Contributor License Agreement](#copyright--contributor-license-agreement) -6. [Dependencies](#dependencies) -7. [Where to Start](#where-to-start) -8. [Code Explanation](#code-explanation) -9. [Testing](#testing) - -# Compiling - -### Windows - -The main [renderdoc.sln](renderdoc.sln) is a VS2015 solution. It should also compile in VS2017, just select to update the compilers if you don't have the 2015 compilers available. - -There are no external dependencies, all libraries/headers needed to build are included in the git checkout. On windows, the `Development` configuration is recommended for day-to-day dev. It's debuggable but not too slow. The `Release` configuration is then obviously what you should compile for any builds you'll send out to people or if you want to evaluate performance. - -### Linux - -Currently linux should work with gcc 5+ and clang 3.4+ as it requires C++14 compiler support. The Travis CI builds with gcc-6.0 and clang-3.5. Within reason other compilers will be supported if the required patches are minimal. Distribution packages should be built with the `Release` CMake build type so that warnings do not trigger errors. To build just run: - -``` -cmake -DCMAKE_BUILD_TYPE=Debug -Bbuild -H. -make -C build -``` - -Configuration is available for cmake, [documented elsewhere](https://cmake.org/documentation/). You can override the compiler with environment variables `CC` and `CXX`, and there are some options you can toggle in the root CMakeLists files such as `cmake -DENABLE_GL=OFF`. - -### Mac - -Mac support is pretty early and while it will compile, it's not usable for debugging yet. Builds happen with cmake the same way as Linux. - -### Android - -To build the components required to debug an Android target, first gather everything from [Dependencies](#dependencies) below, then run: - -``` -mkdir build-android -cd build-android -cmake -DBUILD_ANDROID=On -DANDROID_ABI=armeabi-v7a .. -make -``` - -On Windows, you need to specify the 'generator' type to the cmake invocation. The exact parameter will depend on your bash shell, but options are e.g. `-G "MSYS Makefiles"` or `-G "MinGW Makefiles"`, i.e.: - -``` -cmake -DBUILD_ANDROID=On -DANDROID_ABI=armeabi-v7a -G "MSYS Makefiles" .. -``` - -With GLES programs on Android, the built-in hooking method doesn't always work. If you have trouble with crashes or problems capturing GLES programs, try enabling building with [interceptor-lib](renderdoc/3rdparty/interceptor-lib/README.md). **WARNING**: Building this requires a hefty dependency. - -# Code of Conduct - -I want to ensure that anyone can contribute to RenderDoc with only the next bug to worry about. For that reason the project has adopted the [contributor covenent](docs/CODE_OF_CONDUCT.md) as a code of conduct to be enforced for anyone taking part in RenderDoc development. If you have any queries in this regard you can get in touch with me [directly over email](mailto:baldurk@baldurk.org). - -# Preparing commits - -### Commit Messages - -Ensure commit messages have a single title of at most 72 characters, followed by a body if necessary: - -``` -Short summary text, maximum of 72 characters. That's out to here ---->X - -Longer paragraph that details the change and any logic behind needing -to make the change, other impacts, future work etc. Keeping the title -to 72 characters means it will display fully in git log and github logs. -``` - -Merge commits should **not** be included in pull requests as they just muddy the history. Please use `git rebase` when bringing code up to date against latest `v1.x`. - -Likewise commits for code formatting or compile fixes should be squashed into the relevant commits that they update, rather than left in the history. - -### Code formatting - -To make things easier for everyone, I've adopted clang-format for keeping code consistently formatted. - -| :warning: | | :warning: | -| --------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------- | -| :warning: | **Unfortunately clang-format output changes between versions even with the same config.** | :warning: | -| :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 `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)). - -All intermediate commits should follow the formatting conventions. Having several intermediate commits with mismatched formatting then a single 'reformatted code' commit at the end makes history harder to read, which is an important tool for others to understand your code. It is much easier to enforce proper formatting on each commit as you go along, than to try and untangle and merge formatting changes in after the fact. - -Since it's not covered by a pure formatting check, don't use overly modern C++ unnecessarily. Although the minimum compiler spec is now higher than it was in the past (as of March 2017) and modern features may be supported, some modern C++ constructs do not fit with the style of the rest of the code. - -### Branch history - -Different people have different preferences on how history should be organised. Some people prefer to commit often and then squash down changes into a single commit after they've finished working. Others prefer to combine commits intermittently when they reach a logical boundary and or next step. Some like to avoid committing until they have a 'final' commit that they are ready to make. - -I'm flexible about whether branches are squashed or expanded when they are put up for PR. The history should be reasonable though; if you have a change that modifies a dozen files and changes hundreds of lines of code then it should not be squashed into a single commit. Likewise, intermittent changes where something was tried and then reverted, or minor fixes and tweaks as you go should be rebased and squashed together to form a more coherent whole. As a rule of thumb, try to keep your commit messages describing what they do roughly, even if it is a minor change. Commit messages like "fix stuff" or "compile fix" or any message with "WIP", "amend", "temp", etc should probably not remain in the final PR. - -With fixes from a code review it's up to you whether you keep changes as a separate commit or squash them in. With the exception of formatting and compile fix commits, which as noted before should be squashed into the relevant commits. - -For overall scope of a change/branch read the [developing a change](#developing-a-change) section. - -# Developing a change - -If you're making a tiny bugfix that only changes a few lines, then you don't really have to worry about how you structure your development or organise branches. You can just make your fix, open up a pull request, and everything can be handled from there on the fly. - -When making a larger change though, there are more things to take into consideration. Your changes need to be compatible with the project on a larger scale, as well as making sure your development process can merge into the mainline development with other contributors and the project maintainer. - -There are a few guidelines to follow to make sure that everyone can work together with as little friction as possible: - -Be proactive about communication. You can always [email me](mailto:baldurk@baldurk.org) about anything RenderDoc related including work you are planning, or currently doing. You can also open an issue to discuss a change. Staying in communication particularly with me can head off problems at a much earlier stage - perhaps a design you were planning would conflict with the direction of the project or with a better idea of the whole picture I can suggest something that would be more appropriate. It's much better to have a conversation and avoid spending time doing work that will be rejected or require rewrites at PR stage. - -Aim to merge your work to the main line in reasonably sized chunks. How big is a 'reasonably sized' chunk is debateable, but bear in mind that your code must be able to be reviewed. If in doubt you can always split the work into a smaller standalone chunk, but keeping any one PR under 1000 lines changed at the very most is a good mental limit. Keeping a large change on a branch means that you have to do more merges from the mainline to keep up to date, and increases the chance that your changes will diverge away from the project. The [LLVM developer policy](http://llvm.org/docs/DeveloperPolicy.html#incremental-development) describes this kind of workflow and its benefits much better than I can. - -Have a clear idea of what your change is to do. This goes hand in hand with the above, but if your change involves a lot of work then it's better to split it up into smaller components that can be developed and merged individually, towards the larger goal. Doing this makes it more easily digestible for the rest of the people on the project as well as making it easier to review the changes when they land. - -It's fine to land features one-by-one in different drivers. Historically there have been features that only worked on certain APIs so don't feel that you must implement any new feature on all APIs. At the same time, feature parity is a goal of the project so you should aim to implement features that can be later ported to other APIs where possible either by yourself or by others. - -# Copyright / Contributor License Agreement - -Any code you submit will become part of the repository and be distributed under the [RenderDoc license](LICENSE.md). By submitting code to the project you agree that the code is your own work and that you have the ability to give it to the project. - -You also agree by submitting your code that you grant all transferrable rights to the code to the project maintainer, including for example re-licensing the code, modifying the code, distributing in source or binary forms. Specifically this includes a requirement that you assign copyright to the project maintainer (Baldur Karlsson). For this reason, do not modify any copyright statements in files in any PRs. - -# Dependencies - -### Windows - -On Windows there are no dependencies - you can always compile the latest version just by downloading the code and compiling the solution in Visual Studio. If you want to modify the Qt UI you will need a version of Qt installed - at least version 5.6. - -### Linux - -Requirements for the core library and renderdoccmd are libx11, libxcb, libxcb-keysyms and libGL. The exact are packages for these vary by distribution. - -For qrenderdoc you need Qt5 >= 5.6 along with the 'svg' and 'x11extras' packages. You also need python3-dev for the python integration, and bison, autoconf, automake and libpcre3-dev for building the custom SWIG tool for generating bindings. - -This is the apt-get line you'd need to install the requirements bar Qt on Ubuntu 14.04 or above: - -``` -sudo apt-get install libx11-dev libx11-xcb-dev mesa-common-dev libgl1-mesa-dev libxcb-keysyms1-dev cmake python3-dev bison autoconf automake libpcre3-dev -``` - -Your version of Ubuntu might not include a recent enough Qt version, so you can use [Stephan Binner's ppas](https://launchpad.net/~beineri) to install a more recent version of Qt. At least 5.6.2 is required. If you choose to instead install an [official Qt release](https://download.qt.io/official_releases/qt/) or build Qt from source, add `-DQMAKE_QT5_COMMAND=/path/to/qmake` to your cmake arguments. - -For Archlinux (as of 2017.04.18) you'll need: - -``` -sudo pacman -S libx11 libxcb xcb-util-keysyms mesa libgl qt5-base qt5-svg qt5-x11extras cmake python3 bison autoconf automake pcre -``` - -For Gentoo (as of 2017.04.18), you'll need: - -``` -sudo emerge --ask x11-libs/libX11 x11-libs/libxcb x11-libs/xcb-util-keysyms dev-util/cmake dev-qt/qtcore dev-qt/qtgui dev-qt/qtwidgets dev-qt/qtsvg dev-qt/qtx11extras sys-devel/bison sys-devel/autoconf sys-devel/automake dev-lang/python dev-libs/libpcre -``` - -Checking that at least Qt 5.6 installs. - -On CentOS 7 (as of 2018.01.18), you'll need to install from several repos: - -``` -# Dependencies in default repo -yum install libX11-devel libxcb-devel mesa-libGL-devel xcb-util-keysyms-devel cmake qt5-qtbase-devel qt5-qtsvg-devel qt5-qtx11extras-devel bison autoconf automake pcre-devel - -# python3 via EPEL -yum install epel-release -yum install python34-devel - -# Newer GCC via SCL's devtoolset-7 -yum install centos-release-scl -yum install devtoolset-7 -``` - -Then when building, you must first set up the devtoolset-7 from SCL: -``` -scl enable devtoolset-7 bash -``` - -And build within the resulting bash shell, which has the tools first in PATH. - -On any distribution if you find qmake isn't available under its default name, or if `qmake -v` lists a Qt4 version, make sure you have qtchooser installed in your package manager and use it to select Qt5. This might be done by exporting `QT_SELECT=qt5`, but check with your distribution for details. - -For some distributions such as CentOS, the Qt5 qmake command is `qmake-qt5`. To select this explicitly, pass `-DQMAKE_QT5_COMMAND=qmake-qt5` when invoking `cmake`. - -If you know the required packages for another distribution, please share (or pull request this file!) - -### Mac - -Mac requires a recent version of CMake, and the same Qt version as the other platforms (at least 5.6.2). If you're using [homebrew](http://brew.sh) then this will do the trick: - -``` -brew install cmake qt5 -brew link qt5 --force -``` - -### Android - -To build for Android, you must download components of the Android SDK, the Android NDK, and Java Development Kit. - -If you've already got the tools required, simply set the following three environment variables: -``` -export ANDROID_SDK= -export ANDROID_NDK= -export JAVA_HOME= -``` -Otherwise, below are steps to acquire the tools for each platform. - -#### Windows - -JDK can be installed from the following [link](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html). - -``` -set JAVA_HOME= -``` - -Android NDK and SDK: - -``` -# Set up the Android SDK -set ANDROID_SDK= -cd %ANDROID_SDK% -wget https://dl.google.com/android/repository/sdk-tools-windows-3859397.zip -unzip sdk-tools-windows-3859397.zip -cd tools\bin -sdkmanager --sdk_root=%ANDROID_SDK% "build-tools;26.0.1" "platforms;android-23" -# Accept the license - -# Set up the Android NDK -cd %ANDROID_SDK% -wget http://dl.google.com/android/repository/android-ndk-r14b-windows-x86_64.zip -unzip android-ndk-r14b-windows-x86_64.zip -set ANDROID_NDK=%ANDROID_SDK%\android-ndk-r14b -``` - -#### Linux -The Java Development Kit can be installed with: -``` -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](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). - -NDK links are pulled from [here](https://developer.android.com/ndk/downloads/older_releases.html). -``` -# Set up Android SDK -export ANDROID_SDK= -pushd $ANDROID_SDK -wget http://dl.google.com/android/repository/sdk-tools-linux-3859397.zip -unzip sdk-tools-linux-3859397.zip -cd tools/bin/ -./sdkmanager --sdk_root=$ANDROID_SDK "build-tools;26.0.1" "platforms;android-23" -# Accept the license - -# Set up Android NDK -pushd $ANDROID_SDK -wget http://dl.google.com/android/repository/android-ndk-r14b-linux-x86_64.zip -unzip android-ndk-r14b-linux-x86_64.zip -export ANDROID_NDK=$ANDROID_SDK/android-ndk-r14b -``` - -#### macOS - -JDK can be installed with brew: - -``` -brew cask install java -export JAVA_HOME="$(/usr/libexec/java_home)" -``` - -Android NDK and SDK: - -``` -# Set up Android SDK -export ANDROID_SDK= -pushd $ANDROID_SDK -wget https://dl.google.com/android/repository/sdk-tools-darwin-3859397.zip -unzip sdk-tools-darwin-3859397.zip -cd tools/bin/ -./sdkmanager --sdk_root=$ANDROID_SDK "build-tools;26.0.1" "platforms;android-23" -# Accept the license - -# Set up Android NDK -pushd $ANDROID_SDK -wget https://dl.google.com/android/repository/android-ndk-r14b-darwin-x86_64.zip -unzip android-ndk-r14b-darwin-x86_64.zip -export ANDROID_NDK=$ANDROID_SDK/android-ndk-r14b -``` - -# Where to Start - -There are always plenty of things to do, if you'd like to chip in! Check out the [Roadmap](https://github.com/baldurk/renderdoc/wiki/Roadmap) page in the wiki for future tasks to tackle, or have a look at the [issues](https://github.com/baldurk/renderdoc/issues) for outstanding bugs. I'll try and tag things that seem like small changes that would be a good way for someone to get started with. - -If you have a change you'd like to see make it into mainline, create a fork of renderdoc, make your changes to a branch, and open a pull request on github. You can look around for instructions on that - it's pretty simple. - -# Code Explanation - -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 - 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/ - util/ ; folder for utility/support files - e.g. build scripts, installers, CI config - -# Testing - -At the moment the testing of any features and changes is pretty much ad-hoc. I've been working on a proper test suite that will test both API capture/replay support as well as the analysis features. - -Until then, test any changes you make around the area that you've tested - if I have any particular suggestions on testing I will probably bring it up in the pull request. diff --git a/README.md b/README.md index 4d3dec7102..3a8b2567d7 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ RenderDoc is a frame-capture based graphics debugger, currently available for Vu If you have any questions, suggestions or problems or you can [create an issue](https://github.com/baldurk/renderdoc/issues/new) here on github, [email me directly](mailto:baldurk@baldurk.org) or [come into IRC](https://kiwiirc.com/client/irc.freenode.net/#renderdoc) to discuss it. -To install on windows run the appropriate installer for your OS ([64-bit](https://renderdoc.org/stable/1.0/RenderDoc_1.0_64.msi) | [32-bit](https://renderdoc.org/stable/1.0/RenderDoc_1.0_32.msi)) or download the portable zip from the [builds page](https://renderdoc.org/builds). On linux there is a [binary tarball](https://renderdoc.org/stable/1.0/renderdoc_1.0.tar.gz) available, or your distribution may package it. If not you can [build from source](CONTRIBUTING.md#compiling). +To install on windows run the appropriate installer for your OS ([64-bit](https://renderdoc.org/stable/1.0/RenderDoc_1.0_64.msi) | [32-bit](https://renderdoc.org/stable/1.0/RenderDoc_1.0_32.msi)) or download the portable zip from the [builds page](https://renderdoc.org/builds). On linux there is a [binary tarball](https://renderdoc.org/stable/1.0/renderdoc_1.0.tar.gz) available, or your distribution may package it. If not you can [build from source](docs/CONTRIBUTING/Compiling.md). * **Downloads**: https://renderdoc.org/builds ( [Symbol server](https://renderdoc.org/symbols) ) * **Documentation**: [HTML online](https://renderdoc.org/docs), [CHM in builds](https://renderdoc.org/docs/renderdoc.chm), [Videos](http://www.youtube.com/user/baldurkarlsson/) * **Contact**: [baldurk@baldurk.org](mailto:baldurk@baldurk.org), [#renderdoc on freenode IRC](https://kiwiirc.com/client/irc.freenode.net/#renderdoc) * **Code of Conduct**: [Contributor Covenant](docs/CODE_OF_CONDUCT.md) -* **Information for contributors**: [CONTRIBUTING.md](CONTRIBUTING.md), [Compilation instructions](CONTRIBUTING.md#compiling), [Roadmap](https://github.com/baldurk/renderdoc/wiki/Roadmap) +* **Information for contributors**: [All contribution information](docs/CONTRIBUTING.md), [Compilation instructions](docs/CONTRIBUTING/Compiling.md), [Roadmap](https://github.com/baldurk/renderdoc/wiki/Roadmap) Screenshots -------------- @@ -58,10 +58,13 @@ License RenderDoc is released under the MIT license, see [LICENSE.md](LICENSE.md) for full text as well as 3rd party library acknowledgements. +Compiling +--------- + +Building RenderDoc is fairly straight forward on most platforms. See [Compiling.md](docs/CONTRIBUTING/Compiling.md) for more details. + Contributing & Development -------------- -Building RenderDoc is fairly straight forward. See [CONTRIBUTING.md](CONTRIBUTING.md#compiling) for more details. - -I've added some notes on how to contribute, as well as where to get started looking through the code in [CONTRIBUTING.md](CONTRIBUTING.md). +I've added some notes on how to contribute, as well as where to get started looking through the code in [Developing-Change.md](docs/CONTRIBUTING/Developing-Change.md). All contribution information is available under [CONTRIBUTING.md](docs/CONTRIBUTING.md). diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000000..f621c5d366 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing to RenderDoc + +This document is split up and organised into several sections to aid reading and linking. For small changes like one-line fixes or minor tweaks then you can just read the [quick start section](#quick-start) below. + +Don't worry about reading all of these documents end-to-end and getting everything perfect the first time. The point of this information isn't to be restrictive about rules and reject contributions, but to give people guidance and help about how to contribute. I'm happy to help out with any changes needed to get your PR ready to merge, until you get the hang of things. If you're unfamiliar with git and need help making any changes, feel free to ask as well! + +If you're a regular contributor or if you have a larger amount of code to change, please do read through these as it will make life easier for everyone if you to follow along with these guidelines from the start. + +## Code of Conduct + +I want to ensure that anyone can contribute to RenderDoc with only the next bug to worry about. For that reason the project has adopted the [contributor covenent](CODE_OF_CONDUCT.md) as a code of conduct to be enforced for anyone taking part in RenderDoc development. This includes any comments on issues or any public discussion e.g. in the #renderdoc IRC channel. + +If you have any queries or concerns in this regard you can get in touch with me [directly over email](mailto:baldurk@baldurk.org). + +## Copyright / Contributor License Agreement + +Any code you submit will become part of the repository and be distributed under the [RenderDoc license](../LICENSE.md). By submitting code to the project you agree that the code is your own work and that you have the ability to give it to the project. + +You also agree by submitting your code that you grant all transferrable rights to the code to the project maintainer, including for example re-licensing the code, modifying the code, distributing in source or binary forms. Specifically this includes a requirement that you assign copyright to the project maintainer (Baldur Karlsson). For this reason, do not modify any copyright statements in files in any PRs. + +## Contributing information + +1. [Dependencies](CONTRIBUTING/Dependencies.md) +2. [Compiling](CONTRIBUTING/Compiling.md) +3. [Preparing commits](CONTRIBUTING/Preparing-Commits.md) +4. [Developing a change](CONTRIBUTING/Developing-Change.md) +5. [Testing](CONTRIBUTING/Testing.md) +6. [Code Explanation](CONTRIBUTING/Code-Explanation.md) + +## Quick Start + +The two things you'll need to bear in mind for a small change are the [commit message](CONTRIBUTING/Preparing-Commits.md#commit-messages) and [code formatting](CONTRIBUTING/Preparing-Commits.md#code-formatting). + +Commit messages should have a first line with a **maximum of 72 characters**, then a gap, then if you need it a longer explanation in any format you want. The reason for this is that limiting the first line to 72 characters means that `git log` and github's history always displays the full message without it being truncated. + +For more information, check the section about [commit messages](CONTRIBUTING/Preparing-Commits.md#commit-messages). + +Code should be formatted using **clang-format 3.8**. The reason we fix a specific version of clang-format is that unfortunately different versions can format code in different ways using the same config file, so this would cause problems with automatic verification of code formatting. + +For more information, check the section about [code formatting](CONTRIBUTING/Preparing-Commits.md#code-formatting). + diff --git a/docs/CONTRIBUTING/Code-Explanation.md b/docs/CONTRIBUTING/Code-Explanation.md new file mode 100644 index 0000000000..324c4884f3 --- /dev/null +++ b/docs/CONTRIBUTING/Code-Explanation.md @@ -0,0 +1,16 @@ +# Code Explanation + +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 + 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/ + util/ ; folder for utility/support files - e.g. build scripts, installers, CI config diff --git a/docs/CONTRIBUTING/Compiling.md b/docs/CONTRIBUTING/Compiling.md new file mode 100644 index 0000000000..22fa91b2bc --- /dev/null +++ b/docs/CONTRIBUTING/Compiling.md @@ -0,0 +1,52 @@ +# Compiling + +## Windows + +The main [renderdoc.sln](renderdoc.sln) is a VS2015 solution. It should also compile in VS2017, just select to update the compilers if you don't have the 2015 compilers available. + +There are no external dependencies apart from the Windows SDK and any version will work, otherwise all libraries/headers needed to build are included in the git checkout. + +On windows, the `Development` configuration is recommended for day-to-day dev. It's debuggable but not too slow. The `Release` configuration is then obviously what you should compile for any builds you'll send out to people or if you want to evaluate performance. + +## Linux + +First check that you have all of the [required dependencies](Dependencies.md#linux). + +Currently linux should work with gcc 5+ and clang 3.4+ as it requires C++14 compiler support. The Travis CI builds with gcc-6.0 and clang-3.5. Within reason other compilers will be supported if the required patches are minimal. Distribution packages should be built with the `Release` CMake build type so that warnings do not trigger errors. To build just run: + +``` +cmake -DCMAKE_BUILD_TYPE=Debug -Bbuild -H. +make -C build +``` + +Configuration is available for cmake, [documented elsewhere](https://cmake.org/documentation/). You can override the compiler with environment variables `CC` and `CXX`, and there are some options you can toggle in the root CMakeLists files such as `cmake -DENABLE_GL=OFF`. + +## Mac + +First check that you have all of the [required dependencies](Dependencies.md#mac). + +Mac support is pretty early and while it will compile, it's not usable for debugging yet and is not officially supported. Builds happen with cmake the same way as Linux. + +## Android + +First check that you have all of the [required dependencies](Dependencies.md#android). + +To build the components required to debug an Android target invoke cmake and enable `BUILD_ANDROID=On`: + +``` +mkdir build-android +cd build-android +cmake -DBUILD_ANDROID=On -DANDROID_ABI=armeabi-v7a .. +make +``` + +On Windows, you need to specify the 'generator' type to the cmake invocation. The exact parameter will depend on your bash shell, but options are e.g. `-G "MSYS Makefiles"` or `-G "MinGW Makefiles"`, i.e.: + +``` +cmake -DBUILD_ANDROID=On -DANDROID_ABI=armeabi-v7a -G "MSYS Makefiles" .. +``` + +### Note: + +With GLES programs on Android, the built-in hooking method doesn't always work. If you have trouble with crashes or problems capturing GLES programs, try enabling building with [interceptor-lib](renderdoc/3rdparty/interceptor-lib/README.md). **WARNING**: Building this requires a hefty dependency. + diff --git a/docs/CONTRIBUTING/Dependencies.md b/docs/CONTRIBUTING/Dependencies.md new file mode 100644 index 0000000000..61d4118940 --- /dev/null +++ b/docs/CONTRIBUTING/Dependencies.md @@ -0,0 +1,172 @@ +# Dependencies + +## Windows + +On Windows there are no dependencies - you can always compile the latest version just by downloading the code and compiling the solution in Visual Studio. If you want to modify the Qt UI with a WYSIWYG editor you will need a version of Qt installed - at least version 5.6. + +## Linux + +Requirements for the core library and renderdoccmd are `libx11`, `libxcb`, `libxcb-keysyms` and `libGL`. The exact are packages for these vary by distribution. + +For qrenderdoc you need Qt5 >= 5.6 along with the 'svg' and 'x11extras' packages. You also need `python3-dev` for the python integration, and `bison`, `autoconf`, `automake` and `libpcre3-dev` for building the custom SWIG tool for generating bindings. + +This is the apt-get line you'd need to install the requirements bar Qt on Ubuntu 14.04 or above: + +``` +sudo apt-get install libx11-dev libx11-xcb-dev mesa-common-dev libgl1-mesa-dev libxcb-keysyms1-dev cmake python3-dev bison autoconf automake libpcre3-dev +``` + +Your version of Ubuntu might not include a recent enough Qt version, so you can use [Stephan Binner's ppas](https://launchpad.net/~beineri) to install a more recent version of Qt. At least 5.6.2 is required. If you choose to instead install an [official Qt release](https://download.qt.io/official_releases/qt/) or build Qt from source, add `-DQMAKE_QT5_COMMAND=/path/to/qmake` to your cmake arguments. + +For Archlinux (as of 2017.04.18) you'll need: + +``` +sudo pacman -S libx11 libxcb xcb-util-keysyms mesa libgl qt5-base qt5-svg qt5-x11extras cmake python3 bison autoconf automake pcre +``` + +For Gentoo (as of 2017.04.18), you'll need: + +``` +sudo emerge --ask x11-libs/libX11 x11-libs/libxcb x11-libs/xcb-util-keysyms dev-util/cmake dev-qt/qtcore dev-qt/qtgui dev-qt/qtwidgets dev-qt/qtsvg dev-qt/qtx11extras sys-devel/bison sys-devel/autoconf sys-devel/automake dev-lang/python dev-libs/libpcre +``` + +Checking that at least Qt 5.6 installs. + +On CentOS 7 (as of 2018.01.18), you'll need to install from several repos: + +``` +# Dependencies in default repo +yum install libX11-devel libxcb-devel mesa-libGL-devel xcb-util-keysyms-devel cmake qt5-qtbase-devel qt5-qtsvg-devel qt5-qtx11extras-devel bison autoconf automake pcre-devel + +# python3 via EPEL +yum install epel-release +yum install python34-devel + +# Newer GCC via SCL's devtoolset-7 +yum install centos-release-scl +yum install devtoolset-7 +``` + +Then when building, you must first set up the devtoolset-7 from SCL: +``` +scl enable devtoolset-7 bash +``` + +And build within the resulting bash shell, which has the tools first in PATH. + +On any distribution if you find qmake isn't available under its default name, or if `qmake -v` lists a Qt4 version, make sure you have qtchooser installed in your package manager and use it to select Qt5. This might be done by exporting `QT_SELECT=qt5`, but check with your distribution for details. + +For some distributions such as CentOS, the Qt5 qmake command is `qmake-qt5`. To select this explicitly, pass `-DQMAKE_QT5_COMMAND=qmake-qt5` when invoking `cmake`. + +If you know the required packages for another distribution, please share (or pull request this file!) + +## Mac + +Mac requires a recent version of CMake, and the same Qt version as the other platforms (at least 5.6.2). If you're using [homebrew](http://brew.sh) then this will do the trick: + +``` +brew install cmake qt5 +brew link qt5 --force +``` + +## Android + +To build for Android, you must download components of the Android SDK, the Android NDK, and Java Development Kit. + +If you've already got the tools required, simply set the following three environment variables: + +``` +export ANDROID_SDK= +export ANDROID_NDK= +export JAVA_HOME= +``` + +Otherwise, below are steps to acquire the tools for each platform. + +### Android Dependencies on Windows + +JDK can be installed from the following [link](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html). + +``` +set JAVA_HOME= +``` + +Android NDK and SDK: + +``` +# Set up the Android SDK +set ANDROID_SDK= +cd %ANDROID_SDK% +wget https://dl.google.com/android/repository/sdk-tools-windows-3859397.zip +unzip sdk-tools-windows-3859397.zip +cd tools\bin +sdkmanager --sdk_root=%ANDROID_SDK% "build-tools;26.0.1" "platforms;android-23" +# Accept the license + +# Set up the Android NDK +cd %ANDROID_SDK% +wget http://dl.google.com/android/repository/android-ndk-r14b-windows-x86_64.zip +unzip android-ndk-r14b-windows-x86_64.zip +set ANDROID_NDK=%ANDROID_SDK%\android-ndk-r14b +``` + +### Android Dependencies on Linux + +The Java Development Kit can be installed with: + +``` +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](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). + +NDK links are pulled from [here](https://developer.android.com/ndk/downloads/older_releases.html). + +``` +# Set up Android SDK +export ANDROID_SDK= +pushd $ANDROID_SDK +wget http://dl.google.com/android/repository/sdk-tools-linux-3859397.zip +unzip sdk-tools-linux-3859397.zip +cd tools/bin/ +./sdkmanager --sdk_root=$ANDROID_SDK "build-tools;26.0.1" "platforms;android-23" +# Accept the license + +# Set up Android NDK +pushd $ANDROID_SDK +wget http://dl.google.com/android/repository/android-ndk-r14b-linux-x86_64.zip +unzip android-ndk-r14b-linux-x86_64.zip +export ANDROID_NDK=$ANDROID_SDK/android-ndk-r14b +``` + +### Android Dependencies on Mac + +JDK can be installed with brew: + +``` +brew cask install java +export JAVA_HOME="$(/usr/libexec/java_home)" +``` + +Android NDK and SDK: + +``` +# Set up Android SDK +export ANDROID_SDK= +pushd $ANDROID_SDK +wget https://dl.google.com/android/repository/sdk-tools-darwin-3859397.zip +unzip sdk-tools-darwin-3859397.zip +cd tools/bin/ +./sdkmanager --sdk_root=$ANDROID_SDK "build-tools;26.0.1" "platforms;android-23" +# Accept the license + +# Set up Android NDK +pushd $ANDROID_SDK +wget https://dl.google.com/android/repository/android-ndk-r14b-darwin-x86_64.zip +unzip android-ndk-r14b-darwin-x86_64.zip +export ANDROID_NDK=$ANDROID_SDK/android-ndk-r14b +``` + diff --git a/docs/CONTRIBUTING/Developing-Change.md b/docs/CONTRIBUTING/Developing-Change.md new file mode 100644 index 0000000000..6144da188d --- /dev/null +++ b/docs/CONTRIBUTING/Developing-Change.md @@ -0,0 +1,22 @@ +# Developing a change + +If you're making a tiny bugfix that only changes a few lines, then you don't really have to worry about how you structure your development or organise branches. You can just make your fix, open up a pull request, and everything can be handled from there on the fly. + +When making a larger change though, there are more things to take into consideration. Your changes need to be compatible with the project on a larger scale, as well as making sure your development process can merge into the mainline development with other contributors and the project maintainer. + +There are a few guidelines to follow to make sure that everyone can work together with as little friction as possible: + +Be proactive about communication. You can always [email me](mailto:baldurk@baldurk.org) about anything RenderDoc related including work you are planning, or currently doing. You can also open an issue to discuss a change. Staying in communication particularly with me can head off problems at a much earlier stage - perhaps a design you were planning would conflict with the direction of the project or with a better idea of the whole picture I can suggest something that would be more appropriate. It's much better to have a conversation and avoid spending time doing work that will be rejected or require rewrites at PR stage. + +Aim to merge your work to the main line in reasonably sized chunks. How big is a 'reasonably sized' chunk is debateable, but bear in mind that your code must be able to be reviewed. If in doubt you can always split the work into a smaller standalone chunk, but keeping any one PR under 1000 lines changed at the very most is a good mental limit. Keeping a large change on a branch means that you have to do more merges from the mainline to keep up to date, and increases the chance that your changes will diverge away from the project. The [LLVM developer policy](http://llvm.org/docs/DeveloperPolicy.html#incremental-development) describes this kind of workflow and its benefits much better than I can. + +# Where to Start + +There are always plenty of things to do, if you'd like to chip in! Check out the [Roadmap](https://github.com/baldurk/renderdoc/wiki/Roadmap) page in the wiki for future tasks to tackle, or have a look at the [issues](https://github.com/baldurk/renderdoc/issues) for outstanding bugs. I'll try and tag things that seem like small changes that would be a good way for someone to get started with. + +If you have a change you'd like to see make it into mainline, create a fork of renderdoc, make your changes to a branch, and open a pull request on github. You can look around for instructions on that - it's pretty simple. + +Have a clear idea of what your change is to do. This goes hand in hand with the above, but if your change involves a lot of work then it's better to split it up into smaller components that can be developed and merged individually, towards the larger goal. Doing this makes it more easily digestible for the rest of the people on the project as well as making it easier to review the changes when they land. + +It's fine to land features one-by-one in different drivers. Historically there have been features that only worked on certain APIs so don't feel that you must implement any new feature on all APIs. At the same time, feature parity is a goal of the project so you should aim to implement features that can be later ported to other APIs where possible either by yourself or by others. + diff --git a/docs/CONTRIBUTING/Preparing-Commits.md b/docs/CONTRIBUTING/Preparing-Commits.md new file mode 100644 index 0000000000..f677c6c61c --- /dev/null +++ b/docs/CONTRIBUTING/Preparing-Commits.md @@ -0,0 +1,46 @@ +# Preparing commits + +## Commit Messages + +Ensure commit messages have a single title of at most 72 characters, followed by a body if necessary: + +``` +Short summary text, maximum of 72 characters. That's out to here ---->X + +Longer paragraph that details the change and any logic behind needing +to make the change, other impacts, future work etc. Keeping the title +to 72 characters means it will display fully in git log and github logs. +``` + +Merge commits should **not** be included in pull requests as they just muddy the history. Please use `git rebase` when bringing code up to date against latest `v1.x`. + +Likewise commits for code formatting or compile fixes should be squashed into the relevant commits that they update, rather than left in the history. + +## Code formatting + +To make things easier for everyone, I've adopted clang-format for keeping code consistently formatted. + +| :warning: | | :warning: | +| --------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------- | +| :warning: | **Unfortunately clang-format output changes between versions even with the same config.** | :warning: | +| :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 `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)). + +All intermediate commits should follow the formatting conventions. Having several intermediate commits with mismatched formatting then a single 'reformatted code' commit at the end makes history harder to read, which is an important tool for others to understand your code. It is much easier to enforce proper formatting on each commit as you go along, than to try and untangle and merge formatting changes in after the fact. + +Since it's not covered by a pure formatting check, don't use overly modern C++ unnecessarily. Although the minimum compiler spec is now higher than it was in the past (as of March 2017) and modern features may be supported, some modern C++ constructs do not fit with the style of the rest of the code. + +## Branch history + +Different people have different preferences on how history should be organised. Some people prefer to commit often and then squash down changes into a single commit after they've finished working. Others prefer to combine commits intermittently when they reach a logical boundary and or next step. Some like to avoid committing until they have a 'final' commit that they are ready to make. + +I'm flexible about whether branches are squashed or expanded when they are put up for PR. The history should be reasonable though; if you have a change that modifies a dozen files and changes hundreds of lines of code then it should not be squashed into a single commit. Likewise, intermittent changes where something was tried and then reverted, or minor fixes and tweaks as you go should be rebased and squashed together to form a more coherent whole. As a rule of thumb, try to keep your commit messages describing what they do roughly, even if it is a minor change. Commit messages like "fix stuff" or "compile fix" or any message with "WIP", "amend", "temp", etc should probably not remain in the final PR. + +With fixes from a code review it's up to you whether you keep changes as a separate commit or squash them in. With the exception of formatting and compile fix commits, which as noted before should be squashed into the relevant commits. + +For overall scope of a change/branch read the [developing a change](Developing-Change.md) section. + diff --git a/docs/CONTRIBUTING/Testing.md b/docs/CONTRIBUTING/Testing.md new file mode 100644 index 0000000000..c43f69e432 --- /dev/null +++ b/docs/CONTRIBUTING/Testing.md @@ -0,0 +1,5 @@ +# Testing + +At the moment the testing of any features and changes is pretty much ad-hoc. I've been working on a proper test suite that will test both API capture/replay support as well as the analysis features. + +Until then, test any changes you make around the area that you've tested - if I have any particular suggestions on testing I will probably bring it up in the pull request. diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index 81ec5cbe83..37495f52bb 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -1,6 +1,7 @@