Skip to content

Latest commit

 

History

History
59 lines (33 loc) · 2.97 KB

debug.md

File metadata and controls

59 lines (33 loc) · 2.97 KB

Debug

If you're doing development on GitSavvy, the following commands may be useful.

GitSavvy: reload modules (debug)

This command will reload all GitSavvy-related Python modules and initiate a plugin reset for Sublime Text 3. Note that the editor's interface may become unresponsive for a second or two while the plugins are reloaded. However, this workflow is often preferable to closing and re-opening Sublime when testing changes to GitSavvy.

This command will only have an effect if dev_mode is set to true in GitSavvy settings.

GitSavvy: enable logging

This will start tracking the inputs and outputs of all Git commands that are running under the hood. Aggregating this data can be useful for those wanting to learn how GitSavvy works, as well as for debugging purposes.

Note: If you've logged a sequence of Git commands before, running this again will overwrite what was previously recorded.

GitSavvy: disable logging

This stops all recording Git command inputs and outputs, but does not destroy the record.

GitSavvy: view recorded log

Once you have started and stopped logging, this command will display the log in JSON format in a new scratch view.

Providing a Debug Log

Ocasionally when creating a new issue in GitSavvy, you will be requested to provide a debug log. The above commands make it easy to do, by following these steps:

  1. Open sublime, and get to the state just prior to running the failing command.

  2. Open command palette, and run the command "GitSavvy: enable logging".

  3. Perform the failing command.

  4. Run the command "GitSavvy: disable logging"

  5. Run the command "GitSavvy: view recorded log", save the file locally and attach it to your issue.

    Note: Take care to remove any sensitive information that may be recorded in GitSavvy.

Other tools / PATH issues / Different behavior from terminal and inside Sublime

Please check the tool is in your PATH inside sublime. First find the path to where the tool binaries are, open a system terminal/shell and paste:

which <tool_name>;

Check if that path is the $PATH inside sublime. To do that open the sublime console and paste in:

from os import environ; environ['PATH']

If the tool path is missing from your sublime environment's PATH variable, you need to look into correcting the env variables available to sublime on launch. The unofficial docs mention how to set it globally for windows and mac in the "Troubleshooting Build Systems" page. Alternatively, you may want to look at the packages "Environment Settings" and "Fix Mac Path".

If, however, the path is in your sublime environment, please open an issue and include these values in an issue.