[PATCH v2 0/1] contrib/vscode/: debugging with VS Code and gdb

From: COGONI Guillaume <cogoni.guillaume@gmail.com>
Date: Apr 6, 2022, 15:18 UTC
Message-ID: <20220406151858.5047-1-cogoni.guillaume@gmail.com>
In-Reply-To: <84f77a5b-5721-3583-8ed8-9d360928cf35@matthieu-moy.fr>

> On 6/5/22 10:54 AM, Matthieu Moy wrote:

> but I think if we (as a free software project) are
> recommending proprietary software we should put that in some context
> where we explain if/why it's needed, and if free alternatives are also
> suitable.

> If that's the case wouldn't it suffice to link to some generic getting
> started guide for debuggers?

You got a point, it's a bit paradoxical, but I don't know any good alternatives and I don't want to advise someone with something that I don't be familiar with. But, in the future, if someone wants to add alternatives it will be good.

> I haven't used the VSCode integration you're documenting, but from the
> diff and the "gdb" mention I gather that this isn't using some "native"
> debugger of MSVC/VS's, but just using the VSCode editor as a wrapper for
> gdb?

It can be use as a wrapper for the following debugger:
    Linux: GDB
    macOS: LLDB or GDB
    Windows: the Visual Studio Windows Debugger or GDB (using Cygwin or MinGW)
Source : https://code.visualstudio.com/docs/cpp/cpp-debug#_gdb-lldb-and-lldbmi-commands-gdblldb

Thanks for your reviewing.

> On 6/5/22 1:59 PM, Matthieu Moy wrote:

> 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.

Yeah, sure, I don't think about the expert that must just want to know about the script.

> Acked-by: Matthieu Moy <git@matthieu-moy.fr>

Thanks.

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(-)

Diff-intervalle between v1 and v2 :
1:  2a7d50ca5c ! 1:  367a478855 contrib/vscode/: debugging with VS Code and gdb
    @@ Commit message
    
    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.
+   can be helpful.
    
    Signed-off-by: COGONI Guillaume <cogoni.guillaume@gmail.com>
    Co-authored-by: BRESSAT Jonathan <git.jonathan.bressat@gmail.com>

    @@ Documentation/MyFirstContribution.txt: against the appropriate GitGitGadget/Git
+
+=== 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.
+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.
\ No newline at end of file
    
    ## contrib/vscode/README.md ##

-- 
2.25.1