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

Message

Guillaume Cogoni April 7, 2022, 8:40 p.m. UTC

Derrick Stolee <[e-mail]> writes:

> Cogoni: In conclusion, I think that if you remove the change to
> MyFirstContribution.txt, then your patch can be merged pretty
> quickly (probably, that's not my decision). 
> I expect this discussion about a potential "WorkingOnGit" file to continue, 
> but if it come to fruition, your section on VS Code would be welcome.

Yes, I got the same conclusion, from the discussion between you and
Ævar Arnfjörð Bjarmason. So, I remove the change to MyFirstContribution.txt.
It sounds like the best plan for now.

But, I agreed on some point with Ævar Arnfjörð Bjarmason, we have to try 
to recommending also free alternatives.

And, yes, a new file is the best option. So, I keep my change somewhere, and 
I will come again with a new patch but not in its thread because it seems to 
be out of the scope now.


> Sounds like a good thing to have, but would there truly be hints and
> tips so specific to this project, I have to wonder. I do not think
> we are in the business of making "how to hack on and debug a project
> code that is mostly written in C and whose history is managed in
> Git" tutorial for each IDE, so I am not sure how well it would fly
> (not opposed to, but skeptical).

I think, it can help a newcomer, but not necessarily people with a 
lot of experience on various projects. But, we can give it a try and 
see where it goes.

Thanks everyone for your reviews, your ideas and help.


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

 contrib/vscode/README.md | 6 +++++-
 contrib/vscode/init.sh   | 1 -
 2 files changed, 5 insertions(+), 2 deletions(-)

Diff-intervalle vs v3 :
1:  0600ab64f8 ! 1:  59de991a2d contrib/vscode/: debugging with VS Code and gdb
    @@ Commit message
         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.
    -
         Helped-by: Matthieu Moy <[e-mail]>
         Helped-by: Derrick Stolee <[e-mail]>
         Co-authored-by: BRESSAT Jonathan <[e-mail]>
         Signed-off-by: COGONI Guillaume <[e-mail]>
     
    - ## Documentation/MyFirstContribution.txt ##
    -@@ Documentation/MyFirstContribution.txt: 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
    -+
    -+=== Visual Studio Code (VS Code)
    -+
    -+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.
    -+
    -+In particular, this script enables using the VS Code visual debugger, including
    -+setting breakpoints, logpoints, conditional breakpoints in the editor.
    -+In addition, it includes the ability to see the call stack, the line of code that
    -+is executing and more. It is possible to visualize the variables and their values
    -+and change them during execution.
    -+
    -+In sum, using the built-in debugger can be particularly helpful to understand
    -+how Git works internally.
    -+It can be used to isolate certain parts of code, with this you may be able to ask
    -+more precises question when you are stuck. (See getting-help sections).
    -
      ## contrib/vscode/README.md ##
     @@ contrib/vscode/README.md: code editor which runs on your desktop and is available for
      [Windows](https://code.visualstudio.com/docs/setup/windows),