From: Derrick Stolee <derrickstolee@github.com>
To: COGONI Guillaume <cogoni.guillaume@gmail.com>, avarab@gmail.com
Cc: Matthieu.Moy@univ-lyon1.fr, git.jonathan.bressat@gmail.com,
git@vger.kernel.org
Subject: Re: [PATCH v2 1/1] contrib/vscode/: debugging with VS Code and gdb
Date: Wed, 6 Apr 2022 14:03:12 -0400 [thread overview]
Message-ID: <378c5790-f587-4e26-87be-8f856974e5ca@github.com> (raw)
In-Reply-To: <20220406151858.5047-2-cogoni.guillaume@gmail.com>
On 4/6/2022 11:18 AM, 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 be helpful.
Sorry for not getting to this in v1.
> Signed-off-by: COGONI Guillaume <cogoni.guillaume@gmail.com>
> Co-authored-by: BRESSAT Jonathan <git.jonathan.bressat@gmail.com>
> Helped-by: Matthieu Moy <Matthieu.Moy@univ-lyon1.fr>
> Helped-by: Derrick Stolee <derrickstolee@github.com>
Here, you probably want to flip the order here (Helped-by, then
Co-authored-by, then Signed-off-by). You probably also want the
sign-off of your co-author, too.
The sign-off should be the last thing in the message, because
the previous lines are covered by that sign-off.
> +
> +[[Bonus-useful-tools]]
> +== Bonus - useful tools
> +
> +=== VS Code
Here, maybe use the full name, then the short version.
=== Visual Studio Code (VS Code)
> +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.
This passive voice could be made active such as:
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.
Make a new paragraph before talking about debuggers.
> +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).
I would focus less on "benefits of debugging" and focus instead on
"benefits of debugging using your GUI editor". Something like this
might be a good start:
In particular, this script enables using the VS Code visual debugger,
including setting breakpoints in the editor.
> \ No newline at end of file
Fix this missing newline.
> diff --git a/contrib/vscode/README.md b/contrib/vscode/README.md
> index 8202d62035..f383c95e1f 100644
> --- a/contrib/vscode/README.md
> +++ b/contrib/vscode/README.md
> @@ -6,7 +6,11 @@ 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 get help about "how to personalize your settings" read:
> +[How to set up your settings](https://code.visualstudio.com/docs/getstarted/settings)
These changes are pretty standard, and I have no concerns here.
> "stopAtEntry": false,
> "cwd": "\${workspaceFolder}",
> "environment": [],
> - "externalConsole": true,
And this is the necessary fix.
Thanks for working on this!
Thanks,
-Stolee
next prev parent reply other threads:[~2022-04-06 20:15 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-24 8:16 contrib/vscode/: debugging with vscode and gdb Jonathan Bressat
2022-03-25 13:19 ` Derrick Stolee
[not found] ` <2a7eecb4a0b247ef8f855f1c4fb5d510@SAMBXP02.univ-lyon1.fr>
2022-03-25 18:27 ` Matthieu Moy
2022-03-25 19:01 ` Derrick Stolee
2022-03-26 14:11 ` Jonathan Bressat
2022-04-03 20:18 ` Guillaume Cogoni
[not found] ` <7b139f2c480e4ebc8dc6615b44cd5f24@SAMBXP02.univ-lyon1.fr>
2022-04-05 9:43 ` Matthieu Moy
2022-04-05 22:45 ` [PATCH V1 0/1] contrib/vscode/: debugging with VS Code " COGONI Guillaume
2022-04-05 22:45 ` [PATCH V1 1/1] " COGONI Guillaume
2022-04-06 8:47 ` Ævar Arnfjörð Bjarmason
2022-04-06 11:59 ` Matthieu Moy
2022-04-06 13:35 ` Matthieu Moy
2022-04-06 15:18 ` [PATCH v2 0/1] " COGONI Guillaume
2022-04-06 15:18 ` [PATCH v2 1/1] " COGONI Guillaume
2022-04-06 18:03 ` Derrick Stolee [this message]
2022-04-06 20:23 ` Junio C Hamano
2022-04-06 23:39 ` [PATCH v3 0/1] " COGONI Guillaume
2022-04-06 23:39 ` [PATCH v3 1/1] " COGONI Guillaume
2022-04-07 11:17 ` Ævar Arnfjörð Bjarmason
2022-04-07 13:09 ` Derrick Stolee
2022-04-07 16:43 ` Junio C Hamano
2022-04-07 20:40 ` [PATCH v4 0/1] " COGONI Guillaume
2022-04-07 20:40 ` [PATCH v4 1/1] " COGONI Guillaume
[not found] ` <66f08cb2e81647e29a080af05d7c867e@SAMBXP02.univ-lyon1.fr>
2022-04-07 8:59 ` [PATCH V1 " Matthieu Moy
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=378c5790-f587-4e26-87be-8f856974e5ca@github.com \
--to=derrickstolee@github.com \
--cc=Matthieu.Moy@univ-lyon1.fr \
--cc=avarab@gmail.com \
--cc=cogoni.guillaume@gmail.com \
--cc=git.jonathan.bressat@gmail.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).