Review/update documentation of the 'debug' C# compiler option

[cremor]

Could you please review this page and make sure that it is actually correct? Because there are a few posts that claim that parts of that documentation is wrong or outdated.

A good starting point is this question on StackOverflow. The two highest voted answers both say that this documentation is outdated and they also provide links to further information.

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 3029908f-c2ff-3620-7d51-b9f6a3b768dc
• Version Independent ID: 0f310c2a-3dc6-54a4-5014-264d7f727f2f
• Content: -debug (C# Compiler Options)
• Content Source: docs/csharp/language-reference/compiler-options/debug-compiler-option.md
• Product: dotnet-csharp
• GitHub Login: @BillWagner
• Microsoft Alias: wiwagn

[rpetrusha]

Thanks, @cremor, for your feedback. We'll have to investigate before we can revise the documentation.

[tmat]

https://github.com/dotnet/roslyn/blob/master/docs/compilers/CSharp/CommandLine.md has up to date documentation of the switch.

[BillWagner]

The current doc is missing /debug:portable and /debug:embedded descriptions.

The other key change i that /debug:pdbonly should be called out as a Windows only debug format. The /debug:portable would be preferred.

[tmat]

Also /debug:pdbonly is exactly the same as /debug:full. It's not really a Windows-only switch.
It will produce Portable PDB on Linux and Windows PDB on Windows.

[tmat]

You can link https://github.com/dotnet/designs/blob/master/accepted/diagnostics/debugging-with-symbols-and-sources.md#pdb-formats that discusses the PDB formats.

[EsaHeikkiPoutanen]

Azure function c# Visual studio 2017, debugging locally, fine, remote debugging: 'no symbols have been loaded...' crap when I try to set up break, point ! Have tried various debug options with no results..
enfuriating !!!

[EsaHeikkiPoutanen]

Oh, and this only happens when using V2 fuctions and .net code, V1 functions, remote debugging works fine

[srikcgaa2]

This documentation is still out of sync because the newly added options such as embedded, portable are not updated while there are external documentation that describes this. It will be good to capture the same information in this page as well

[ericsampson]

@IEvangelist this page is massively out of date and wrong.

[ericsampson]

@dotnet/docs this is still valid and important to update. Should be not hard.

[ericsampson]

@BillWagner I don't seem to be able to reopen this as the bot message suggests, I must not have the rights.

[akoeplinger]

Yeah only repo collaborators can reopen issues, that is a longstanding issue with GitHub: isaacs/github#583

I also think this is still needed so reopening (note that I'm not a member of dotnet/docs but looks like every dotnet organization user can do it).

[BillWagner]

@dotnet/docs should be sufficient to tag the team.

It looks like the markdown to add is the following:

[@dotnet/docs](https://github.com/orgs/dotnet/teams/docs)

[sharwell]

@BillWagner The markdown to tag the team is @dotnet/docs, but only members of the org can use it. Users outside the org can mention people, but cannot mention groups.

[ericsampson]

yeah unfortunately I already tried to tag the group. Really unfortunate that externals like regular devs can't tag as described in the bot note.

[BillWagner]

@ericsampson

Really unfortunate that externals like regular devs can't tag as described in the bot note.

Yeah, that's annoying. I've sent email to my team and we're watching closely for comments.

[akoeplinger]

#22797 didn't fully fix the original issue since https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/code-generation#debugtype still only mentions pdbonly/full and misses the portable and embedded options, even though portable is the default and recommended option for new .NET projects now.

Reopening, @BillWagner not sure if this will put it in the correct GitHub tracking state so please fix if it's wrong :)