doc(debug): add why breakpoints may fail and clean up manual configuration

[briandealwis]

@quoctruong, @etanshaul: should we add anything else here for Go, like -trimpath?

[etanshaul]

What do you think about adding IDE specific instructions (since I'd imagine nearly all users of debug are using one of the IDEs unless they are....adventurous). Some JB specific things I can think of:

• GoLand (and Ultimate + Go plugin) does not support source mapping. Rather, the application must be a Go modules based app AND the user must explicitly configure the IDE to use Go modules in the IDE settings.
• Go, Python, and Javascript debugging in IDEA Ultimate requires the corresponding language plugin to be installed. If it is not installed, the debugger will not attach and breakpoints will not be hit (though the skaffold debug session will still start up).

I don't recall what we found with regards to -trimpath. I vaguely remember a conversation around this where it turned out to be useful in IntelliJ but I don't recall the specifics. Will update if I can dig it up.

[briandealwis]

PTAL @etanshaul

[codecov]

Codecov Report

Merging #6893 (66149bf) into main (290280e) will decrease coverage by 1.64%.
The diff coverage is 63.63%.

@@            Coverage Diff             @@
##             main    #6893      +/-   ##
==========================================
- Coverage   70.48%   68.83%   -1.65%     
==========================================
  Files         515      551      +36     
  Lines       23150    25301    +2151     
==========================================
+ Hits        16317    17416    +1099     
- Misses       5776     6712     +936     
- Partials     1057     1173     +116     

Impacted Files	Coverage Δ
cmd/skaffold/app/cmd/deploy.go	52.00% <ø> (-1.85%)	⬇️
cmd/skaffold/app/cmd/dev.go	84.61% <0.00%> (ø)
cmd/skaffold/app/cmd/render.go	36.66% <0.00%> (-4.72%)	⬇️
cmd/skaffold/skaffold.go	0.00% <0.00%> (ø)
cmd/skaffold/app/cmd/inspect_tests.go	62.50% <14.28%> (-1.14%)	⬇️
cmd/skaffold/app/cmd/fix.go	68.85% <40.00%> (-7.62%)	⬇️
cmd/skaffold/app/cmd/lint.go	42.85% <42.85%> (ø)
cmd/skaffold/app/cmd/find_configs.go	48.88% <50.00%> (+0.24%)	⬆️
cmd/skaffold/app/skaffold.go	76.19% <70.00%> (-8.43%)	⬇️
cmd/skaffold/app/cmd/inspect_build_env.go	65.11% <75.00%> (+6.39%)	⬆️
... and 170 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b87553...66149bf. Read the comment docs.

[tejal29]

What do you mean by startup path here?

[briandealwis]

I meant the container execution initialization path (e.g., from main() to listening)

[briandealwis]

Retitled: let me know if that's still unclear.

[tejal29]

Is there a way to manually fix this mapping ? any pointers on how users can look into this setting and where it is configured.

[tejal29]

ah looks like you have documented resolution here.

[tejal29]

Can we add more details around how to fix it?

[briandealwis]

Cloud Code generally prompts in these situations. It really is IDE-by-IDE