From: Matthieu Moy <Matthieu.Moy@univ-lyon1.fr>
To: Guillaume Cogoni <cogoni.guillaume@gmail.com>,
Jonathan Bressat <git.jonathan.bressat@gmail.com>
Cc: Derrick Stolee <derrickstolee@github.com>,
"git@vger.kernel.org" <git@vger.kernel.org>
Subject: Re: contrib/vscode/: debugging with vscode and gdb
Date: Tue, 5 Apr 2022 11:43:37 +0200 [thread overview]
Message-ID: <6f4b924d-0a13-b267-6766-a3620936b686@univ-lyon1.fr> (raw)
In-Reply-To: <7b139f2c480e4ebc8dc6615b44cd5f24@SAMBXP02.univ-lyon1.fr>
On 4/3/22 22:18, Guillaume Cogoni wrote:
> Hello,
>
> We don't know if we can revive this topic, but we still think that
> it's a good idea
> to talk more about "how it can be useful to use the debugging tool that gives
> VS Code".
>
> So, we make a patch about it.
> We retrieve what Derrick Stolee did and add what we said in our previous mail.
>
> Thanks,
> Cogoni Guillaume and Jonathan Bressat
>
> --------------------->8-----------------------------------
>
> Subject: [PATCH 0/1] contrib/vscode/: debugging with VS Code and gdb
> COGONI Guillaume (1):
> contrib/vscode/: debugging with VS Code and gdb
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.
> Remove "externalConsole" line in contrib/vscode/init.sh because it
> seems to not work for everyone, and after a discussion with Matthieu
> Moy and Derrick Stolee, we agreed that it is better to let the user
choose
> what to do with this line
I usually explain the problem first, and then the solution.
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 his own configuration).
Avoid using gender-specific formulation when not needed. It's easier to
do in English than in French.
> Add useful links in contrib/vscode/README.md to help the user to
> configure his VS Code and how to use the debugging feature.
Likewise.
> Add a mention to the README in Documentation/MyFirstContribution.txt
> and a part "To convince a newcomer that VS Code can help him".
Why use double-quotes here? You're not quoting anything, right?
> --- a/Documentation/MyFirstContribution.txt
> +++ b/Documentation/MyFirstContribution.txt
> @@ -1265,3 +1265,15 @@ 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
> +
> +To see "how to use VS Code" read contrib/vscode/README.md.
Double-quotes look weird here too. And the document is not really about
using VS Code, but more specifically on how to use VS Code on Git's
codebase.
A set of scripts and instructions to use VS Code on Git's codebase is
available in `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 information travels inside the code".
> +It can help you to isolate some parts of code, with this you are able
> +to ask more precise questions when you are stuck. (See getting-help sections).
> \ No newline at end of file
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"?
> --- a/contrib/vscode/README.md
> +++ b/contrib/vscode/README.md
> @@ -8,6 +8,11 @@ code editor which runs on your desktop and is available for
> [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).
> +To understand "how works the debugging part" read:
"How the debugging part works" to get words in the proper order.
But the flow would be more natural continuing the previous sentence IMHO:
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)
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.
Cheers,
--
Matthieu Moy
https://matthieu-moy.fr/
next prev parent reply other threads:[~2022-04-05 11:47 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 [this message]
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
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=6f4b924d-0a13-b267-6766-a3620936b686@univ-lyon1.fr \
--to=matthieu.moy@univ-lyon1.fr \
--cc=cogoni.guillaume@gmail.com \
--cc=derrickstolee@github.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).