Link Git debug trace vars in git debug docs
What does this MR do?
Adds Git-Internals-Environment-Variables - Debugging link to our Useful Git Commands - Debug docs for a complete list of Git's embedded traces.
This was brought up by @cody in a slack thread regarding how to troubleshoot this Premium support ticket
Traces like these examples are missing from our docs, but they could be extremely helpful in troubleshooting:
GIT_TRACE_PERFORMANCE controls logging of performance data. The output shows how long each particular git invocation takes.
GIT_TRACE_SETUP shows information about what Git is discovering about the repository and environment it’s interacting with.
GIT_TRACE_PACKET enables packet-level tracing for network operations.
Alternatively, we could mention these traces in our existing documentation instead of linking to the upstream source.
Related issues
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
If applicable, update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the documentation label.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.