mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
95fb178429
This allows users to leave comments on pages that don't have `:allow_comments: False` somewhere in the page's source. Both manual and class reference pages can receive comments. Index pages cannot have comments, as discussion should occur on "leaf" pages. GitHub Discussions is used as a backend on the same repository. This means that Discussions *must* be enabled on godotengine/godot-docs before this commit is merged to `master`. Users can choose to use the "Custom" watch mode if they don't want to get notifications for discussion updates, but still get notifications for issue and pull request updates. User comments are intended to be used for the following purposes: - Add a clarification or correct something in the documentation, without having to open a pull request. Contributors are encouraged to take a look at discussions from time to time, and see if there's information worth incorporating in the pages themselves. Don't forget to reply to the comment when doing so :) - Mention a workaround for a common issue. - Link to useful third-party resources that are relevant to the current page, such as tutorials or add-ons. User comments should *not* be used for technical support. Other community platforms should be used for that. Page-to-discussion matching is done using the `pagename` Sphinx variable, which is independent of the Godot version and documentation language. Being independent of the Godot version allows keeping old comments when the Godot version changes, while also allowing users from `/stable` and `/4.1` to "see" each other in discussions. See https://giscus.app for more information.
49 lines
1.4 KiB
ReStructuredText
49 lines
1.4 KiB
ReStructuredText
:allow_comments: False
|
|
|
|
Debugging and profiling
|
|
=======================
|
|
|
|
This section contains pages that provide guidance if you're looking at the
|
|
engine code trying to find an underlying issue or an optimization possibility.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:name: toc-devel-cpp-debug-profiling
|
|
|
|
using_cpp_profilers
|
|
using_sanitizers
|
|
macos_debug
|
|
vulkan/index
|
|
|
|
Debugging the editor
|
|
--------------------
|
|
|
|
When working on the Godot editor keep in mind that by default the executable
|
|
will start in the Project Manager mode. Opening a project from the Project
|
|
Manager spawns a new process, which stops the debugging session. To avoid that
|
|
you should launch directly into the project using ``-e`` and ``--path`` launch
|
|
options.
|
|
|
|
For example, using ``gdb`` directly, you may do this:
|
|
|
|
.. code-block:: none
|
|
|
|
$ gdb godot
|
|
> run -e --path ~/myproject
|
|
|
|
You can also run the editor directly from your project's folder. In that case,
|
|
only the ``-e`` option is required.
|
|
|
|
.. code-block:: none
|
|
|
|
$ cd ~/myproject
|
|
$ gdb godot
|
|
> run -e
|
|
|
|
You can learn more about these launch options and other command line arguments
|
|
in the :ref:`command line tutorial <doc_command_line_tutorial>`.
|
|
|
|
If you're using a code editor or an IDE to debug Godot, check out our
|
|
:ref:`configuration guides <doc_configuring_an_ide>`, which cover the setup
|
|
process for building and debugging with your particular editor.
|