On 4/6/22 00:45, COGONI Guillaume wrote:
The externalConsole=true setting is broken for many users (launching the debugger with such setting results in VS Code waiting forever without actually starting the debugger). Also, this setting is a matter of user preference, and is arguably better set in a "launch" section in the user-wide settings.json than hardcoded in our script. Remove the line to use VS Code's default, or the user's setting. Add useful links in contrib/vscode/README.md to help the user to configure VS Code and how to use the debugging feature. Add a mention to the README and the init.sh in Documentation/MyFirstContribution.txt and a part to convince a newcomer that VS Code can help him.
You may avoid the gender-specific formulation here, women should be as interested as men in the document.
--- a/Documentation/MyFirstContribution.txt +++ b/Documentation/MyFirstContribution.txt @@ -1265,3 +1265,14 @@ against the appropriate GitGitGadget/Git branch. If you're using `git send-email`, you can use it the same way as before, but you should generate your diffs from `<topic>..<mybranch>` and base your work on `<topic>` instead of `master`. + +[[Bonus-useful-tools]] +== Bonus - useful tools + +=== VS Code + +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.
I'd start with the last sentence. People already familiar with VS Code may find the first line boring, and stop reading before reaching the important information.
With or without changes, this is Acked-by: Matthieu Moy <git@xxxxxxxxxxxxxxx> -- Matthieu Moy https://matthieu-moy.fr/
