[V1,0/1] contrib/vscode/: debugging with VS Code and gdb

Commit Message

Guillaume Cogoni April 5, 2022, 10:45 p.m. UTC

> On 4/5/22 11:43, Matthieu Moy wrote:

> How did you generate this patch? It doesn't apply with 'git am', I 
> suspect you copy-pasted incorrectly into your mailer. Using 'git 
> send-email' helps sending properly formatted patches.

My bad, I copy and paste. 
I'm a bit ashamed to say it, but I didn't know about the command 'git am',
but never too late to know about it, so thanks.

> I usually explain the problem first, and then the solution.

Yes, if you don't mind, I take your explanation and put it inside the commit
because it sounds really good to me. So, if I had to add a special tag for 
this alert me.

> A set of scripts and instructions to use VS Code on Git's codebase is
> available in `contrib/vscode/README.md` ?.

Indeed, it's a bit confused the way I said it. So, I change the text 
to something more accurate.

> I'm reluctant to adding general programming tips in a Git-specific
> document. Perhaps shorten it to eg. just "Using the integrated debugger
> can be particularly helpful to understand how Git works internally"?

I know, it can be strange to talk about programming tips, but I also think that,
it can be a good idea if it could help a beginer. And I also think that, in 
MyFirstContribution it's the right place to talk about it, because it might be
the first reading of newcomers. But, maybe create another file to talk
about things like this with a mention of this file in MyFirstContribution 
can be good too.

> Why not, but I don't think it's necessary here. People familiar with VS
> Code don't need such link, and people not familiar at all with is would
> better read a tutorial.

You got a point, but like you said, why not.


Thanks for your help and for taking your time to review.



COGONI Guillaume (1):
  contrib/vscode/: debugging with VS Code and gdb

 Documentation/MyFirstContribution.txt | 11 +++++++++++
 contrib/vscode/README.md              |  6 +++++-
 contrib/vscode/init.sh                |  1 -
 3 files changed, 16 insertions(+), 2 deletions(-)


Difference between V0 and V1

Patch

diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index 97f53f536d..7f48990cb8 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -1271,9 +1271,8 @@  should generate your diffs from `<topic>..<mybranch>` and base your work on
 
 === VS Code
 
-To see "how to use VS Code" read contrib/vscode/README.md.
-If you want to try to understand "how git works internally", the debugging
-feature of VS Code can help you. It will not give you all the keys to fully understand it, but
-it can give you an idea of "how the informations travel inside the code".
-It can help you to isolate some parts of code, with this you are able
-to ask more precises question when you are stuck. (See getting-help sections).
+Using the integrate debugger can be particularly helpful to understand how Git works internally.
+It can be used to isolate some parts of code, with this you may be able to ask more precises
+question when you are stuck. (See getting-help sections).
+A script that creates the configuration files is available in contrib/vscode/init.sh. Useful links
+and explanation of how to use the script are available in contrib/vscode/README.md.

diff --git a/contrib/vscode/README.md b/contrib/vscode/README.md
index a416a752c1..f383c95e1f 100644
--- a/contrib/vscode/README.md
+++ b/contrib/vscode/README.md
@@ -6,10 +6,9 @@  code editor which runs on your desktop and is available for
 [Windows](https://code.visualstudio.com/docs/setup/windows),
 [macOS](https://code.visualstudio.com/docs/setup/mac) and
 [Linux](https://code.visualstudio.com/docs/setup/linux). Among other languages,
-it has [support for C/C++ via an extension](https://github.com/Microsoft/vscode-cpptools).
+it has [support for C/C++ via an extension](https://github.com/Microsoft/vscode-cpptools) with
+[debugging support](https://code.visualstudio.com/docs/editor/debugging)
 
-To understand "how works the debbuging part" read:
-[Help with the debbuging part](https://code.visualstudio.com/docs/editor/debugging)
 To get help about "how to personalize your settings" read:
 [How to set up your settings](https://code.visualstudio.com/docs/getstarted/settings)