Document that .gdignore files' contents are ignored

This commit is contained in:
Hugo Locurcio
2021-10-11 23:36:17 +02:00
parent 2b71895814
commit 81fea66371
3 changed files with 6 additions and 5 deletions
@@ -68,7 +68,7 @@ library a better place for all users.
:ref:`doc_gdscript_styleguide` or the :ref:`doc_c_sharp_styleguide`.
* If you have screenshots in your repo, place them in their own subfolder
and add a **.gdignore** file in the same folder (note: **gd**, not **git**).
and add an empty **.gdignore** file in the same folder (note: **gd**, not **git**).
This prevents Godot from importing your screenshots.
On Windows, open a command prompt in the project folder and run
``type nul > .gdignore`` to create a file whose name starts with a period.
@@ -85,10 +85,11 @@ This can be useful to speed up the initial project importing.
command prompt: ``type nul > .gdignore``
Once the folder is ignored, resources in that folder can't be loaded anymore
using the ``load()`` and ``preload()`` methods.
using the ``load()`` and ``preload()`` methods. Ignoring a folder will also
automatically hide it from the FileSystem dock, which can be useful to reduce clutter.
Ignoring a folder will also automatically hide it from the FileSystem dock,
which can be useful to reduce clutter.
Note that the ``.gdignore`` file's contents are ignored, which is why the file
should be empty. It does not support patterns like ``.gitignore`` files do.
.. _doc_project_organization_case_sensitivity:
@@ -52,7 +52,7 @@ extensions must be ``gd`` and ``cs`` respectively.
.. note:: The script templates have the same extension as the regular script
files. This may lead to an issue of a script parser treating those templates as
actual scripts within a project. To avoid this, make sure to ignore the
directory containing them by creating a ``.gdignore`` file. The directory won't be
directory containing them by creating an empty ``.gdignore`` file. The directory won't be
visible throughout the project's filesystem anymore, yet the templates can be
modified by an external text editor anytime.