Reimagine C# compiler options section #22797
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BillWagner
force-pushed
the
consolidate-compiler-options
branch
2 times, most recently
from
2a4332c to
cd1c14d
Compare
BillWagner
force-pushed
the
consolidate-compiler-options
branch
from
a641103 to
7935982
Compare
BillWagner
force-pushed
the
consolidate-compiler-options
branch
3 times, most recently
from
ed6d700 to
a1893c5
Compare
BillWagner
force-pushed
the
consolidate-compiler-options
branch
from
362551e to
522f35d
Compare
BillWagner
force-pushed
the
consolidate-compiler-options
branch
from
6a63eaa to
8934ac6
Compare
Move all information pertaining to how to set compiler options into the index topic for this section. fix markdown lint warning
remove links to old content
Update listed-by-category.md
2nd pass through security.
BillWagner
changed the title
BillWagner
requested review from
cartermp,
gewarren,
IEvangelist,
KathleenDollard,
tdykstra and
a team
as code owners
cartermp
approved these changes
Mar 12, 2021
tdykstra
approved these changes
Mar 12, 2021
There was a problem hiding this comment.
Great work -- This was a major undertaking and it's a big improvement for this part of the TOC -- easier for readers to browse options and easier for us to maintain them. I have mostly minor style suggestions. I learned some new things reading through all this material. 😄
Co-authored-by: Tom Dykstra <[email protected]>
Co-authored-by: Tom Dykstra <[email protected]>
Co-authored-by: Tom Dykstra <[email protected]>
Co-authored-by: Tom Dykstra <[email protected]>
|
|
||
| An internal compiler error (ICE) results when the compiler can't process a source code file. When an ICE occurs, the compiler doesn't produce an output file or any useful diagnostic that you can use to fix your code. | ||
|
|
||
| By using **ErrorReport**, you can provide ICE information to the C# team. Your error reports can help improve future compiler releases. A user's ability to send reports depends on computer and user policy permissions. |
There was a problem hiding this comment.
I don't believe the ErrorReport property does what you claim here. Filed #23323 as this PR has already been merged.
gewarren
reviewed
Mar 24, 2021
| }, | ||
| { | ||
| "source_path": "docs/csharp/language-reference/compiler-options/refout-compiler-option.md", | ||
| "redirect_url": "/dotnet/csharp/language-reference/compiler-options/optimizations" |
There was a problem hiding this comment.
@BillWagner This doesn't seem to be a valid redirect target. Where should this redirect actually go?
Comment on lines
+237
to
+239
| ```xml | ||
| <ErrorEndLocation>filename</ErrorEndLocation> | ||
| ``` |
There was a problem hiding this comment.
Filed #27368 about filename.
BillWagner
added a commit
to BillWagner/docs
that referenced
this pull request
May 16, 2024
Fixes dotnet#40355 I also checked other files deleted in dotnet#22797 and nothing else was lost.
BillWagner
added a commit
that referenced
this pull request
May 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #22659 (for this task)
Currently open issues on the compiler options sections
Fixes #20061
Fixes #20162
Fixes #18371
Fixes #22460
Fixes #6773
Closed as "won't fix" articles on the compiler options sections that were fixed in this PR
Fixes #17370
Fixes #4192
Guidance for reviewers:
The work done here is to consolidate all the compiler options pages into groups. Instead of a single page for each option, this organization groups options by usage. In addition, the existing pages all used the "classic" syntax. The updates focus on the new MSBuild syntax, but provides the csc alternative for existing users and translation to the updated syntax.
This is a large PR, but it's focused in concept. One option is to review it commit by commit. Each of the early commits simplify one section. Later commits fix links to the files that were deleted.
Another option is to review the files by type of change:
Notes on changes:
Most of the changes involved moving content, and trimming that content. In addition old options were translated to the new MSBuild options. There are a few exceptions to this: the
-bugreportoption is no longer supported. Theerrorreportoption should be used instead. Therecurseoption is no longer supported, and was removed. Most links were updated to use the new MSBuild syntax. A couple places that weren't were for compiler errors where the order of the compiler options impacted the error. These links continued to use the old syntax.Review site link This goes to the index for the section with new content.