The purpose of this guide is to have a place where GIT developer can share their own best practices, tools or workflows to the community in order to help the GIT developer. Signed-off-by: COGONI Guillaume <cogoni.guillaume@xxxxxxxxx> --- Documentation/Makefile | 1 + Documentation/WorkingOnGit.txt | 53 ++++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 Documentation/WorkingOnGit.txt diff --git a/Documentation/Makefile b/Documentation/Makefile index 44c080e3e5..82badee19a 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -93,6 +93,7 @@ SP_ARTICLES += $(API_DOCS) TECH_DOCS += MyFirstContribution TECH_DOCS += MyFirstObjectWalk TECH_DOCS += SubmittingPatches +TECH_DOCS += WorkingOnGit TECH_DOCS += technical/bundle-format TECH_DOCS += technical/hash-function-transition TECH_DOCS += technical/http-protocol diff --git a/Documentation/WorkingOnGit.txt b/Documentation/WorkingOnGit.txt new file mode 100644 index 0000000000..d324d9fcd8 --- /dev/null +++ b/Documentation/WorkingOnGit.txt @@ -0,0 +1,53 @@ +Guide of the best practices and custom workflow +=============================================== +:sectanchors: + +[[summary]] +== Summary + +This book aims to put together a lot of useful tools, best practices and +custom workflows that might help the Git developer. + +[[author]] +=== Author + +The Git community. + +[[table_of_contents]] +== Table of contents + +- <<debuggers>> + +[[debuggers]] +== Using debuggers + +You'll probably find it useful to use a debugger to interactively inspect +your code as it's running. + +There's numerous such debuggers, and you may even have one installed +already along with your development toolchain. + +The GNU debugger (gdb) is probably the most common one command-line +debugger, along with the LLDB debugger (lldb): + +==== https://www.sourceware.org/gdb/ +==== https://lldb.llvm.org/ + +=== GUIs + +==== Visual Studio Code (VS Code) + +The contrib/vscode/init.sh script creates configuration files that enable +several valuable VS Code features. See contrib/vscode/README.md for more +information on using the script. + +In particular, this script enables using the VS Code visual debugger, including +setting breakpoints, logpoints, conditional breakpoints in the editor. +In addition, it includes the ability to see the call stack, the line of code that +is executing and more. It is possible to visualize the variables and their values +and change them during execution. + +In sum, using the built-in debugger can be particularly helpful to understand +how Git works internally. +It can be used to isolate certain parts of code, with this you may be able to ask +more precises question when you are stuck. -- 2.25.1
