index.rst 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. Debugging and profiling
  2. =======================
  3. This section contains pages that provide guidance if you're looking at the
  4. engine code trying to find an underlying issue or an optimization possibility.
  5. .. toctree::
  6. :maxdepth: 1
  7. :name: toc-devel-cpp-debug-profiling
  8. using_cpp_profilers
  9. using_sanitizers
  10. macos_debug
  11. vulkan/index
  12. Debugging the editor
  13. --------------------
  14. When working on the Godot editor keep in mind that by default the executable
  15. will start in the Project Manager mode. Opening a project from the Project
  16. Manager spawns a new process, which stops the debugging session. To avoid that
  17. you should launch directly into the project using ``-e`` and ``--path`` launch
  18. options.
  19. For example, using ``gdb`` directly, you may do this:
  20. .. code-block:: none
  21. $ gdb godot
  22. > run -e --path ~/myproject
  23. You can also run the editor directly from your project's folder. In that case,
  24. only the ``-e`` option is required.
  25. .. code-block:: none
  26. $ cd ~/myproject
  27. $ gdb godot
  28. > run -e
  29. You can learn more about these launch options and other command line arguments
  30. in the :ref:`command line tutorial <doc_command_line_tutorial>`.
  31. If you're using a code editor or an IDE to debug Godot, check out our
  32. :ref:`configuration guides <doc_configuring_an_ide>`, which cover the setup
  33. process for building and debugging with your particular editor.