Skip to content

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

Description

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

Activity

  1. rpetrusha commented on Aug 6, 2018

    @rpetrusha
    Contributor

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

  2. tmat commented on Aug 9, 2018

    @tmat
    Member
  3. BillWagner commented on Aug 10, 2018

    @BillWagner
    Member

    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.

  4. tmat commented on Aug 10, 2018

    @tmat
    Member

    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.

  5. tmat commented on Aug 10, 2018

    @tmat
    Member
  6. added this to the Backlog milestone on Aug 14, 2018
  7. 22 remaining items

  8. removed
    won't fixIssues that were closed as part of automated backlog grooming
    on Jan 25, 2021
  9. BillWagner commented on Jan 25, 2021

    @BillWagner
    Member

    @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)
  10. sharwell commented on Jan 25, 2021

    @sharwell
    Contributor

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

  11. ericsampson commented on Jan 25, 2021

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

  12. BillWagner commented on Jan 25, 2021

    @BillWagner
    Member

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

  13. removed this from the Backlog milestone on Mar 11, 2021
  14. akoeplinger commented on Mar 22, 2021

    @akoeplinger
    Member

    #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 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions