From 5642a9b9208f6bd75b1577b76a1da1ce2347a954 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Wed, 1 Jul 2020 19:48:12 +0200 Subject: [PATCH] Document how to clean generated files using SCons This closes #3717. --- .../compiling/introduction_to_the_buildsystem.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/development/compiling/introduction_to_the_buildsystem.rst b/development/compiling/introduction_to_the_buildsystem.rst index 4b4066f98..7a273310a 100644 --- a/development/compiling/introduction_to_the_buildsystem.rst +++ b/development/compiling/introduction_to_the_buildsystem.rst @@ -222,6 +222,18 @@ features to include/disable. Check the output of ``scons --help`` for details about each option for the version you are willing to compile. +Cleaning generated files +------------------------ + +Sometimes, you may encounter an error due to generated files being present. You +can remove them by using ``scons --clean ``, where ```` is the +list of build options you've used to build Godot previously. + +Alternatively, you can use ``git clean -fixd`` which will clean build artifacts +for all platforms and configurations. Beware, as this will remove all untracked +and ignored files in the repository. Don't run this command if you have +uncommitted work! + .. _doc_overriding_build_options: Overriding the build options