index.rst 1.4 KB

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