index.rst 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  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. macos_debug
  10. vulkan/index
  11. Debugging the editor
  12. --------------------
  13. When working on the Godot editor keep in mind that by default the executable
  14. will start in the Project Manager mode. Opening a project from the Project
  15. Manager spawns a new process, which stops the debugging session. To avoid that
  16. you should launch directly into the project using ``-e`` and ``--path`` launch
  17. options.
  18. For example, using ``gdb`` directly, you may do this:
  19. .. code-block:: none
  20. $ gdb godot
  21. > run -e --path ~/myproject
  22. You can also run the editor directly from your project's folder. In that case,
  23. only the ``-e`` option is required.
  24. .. code-block:: none
  25. $ cd ~/myproject
  26. $ gdb godot
  27. > run -e
  28. You can learn more about these launch options and other command line arguments
  29. in the :ref:`command line tutorial <doc_command_line_tutorial>`.
  30. If you're using a code editor or an IDE to debug Godot, check out our
  31. :ref:`configuration guides <doc_configuring_an_ide>`, which cover the setup
  32. process for building and debugging with your particular editor.