add new compiler options #5408

BillWagner · 2018-05-15T23:10:16Z

Fixes #1800
Fixes #3242
Fixes #4625

The new options are:

-pathmap
-publicsign
-keyfile now works on CoreCLR (-keycontainer does not)

Update lists of alphabetic commands, pages by category, and TOC.

Also, fixed a variety of markdown lint warnings. These are mostly whitespace.

Reviews will be easier using the rich diff view.

/cc @jcouv

jcouv · 2018-05-16T01:26:17Z

Tagging @tmat @agocke for review.

@jcouv

Fixes #5289 This PR adds the overview to "What's new in C# 7.3". I updated the wording in the TOC to remove the repeated "What's new" phrasing. /cc @jcouv @MadsTorgersen /cc @Welchen This PR relies on new files added in PR #5408

The new options are: -pathmap -publicsign -keyfile now works on CoreCLR (-keycontainer does not) Also, fixed a variety of markdown lint warnings. These are mostly whitespace. Reviews will be easier using the rich diff view.

svick · 2018-05-21T11:31:22Z

docs/csharp/language-reference/compiler-options/pathmap-compiler-option.md

+---
+# -pathmap (C# Compiler Options)
+
+The **-pathmap** compiler option mapping for source path names output by the compiler.


Is this missing a verb (possibly "specifies")?

svick · 2018-05-21T11:33:50Z

docs/csharp/language-reference/compiler-options/publicsign-compiler-option.md

+---
+# -publicsign (C# Compiler Options)
+
+This option causes the compiler to apply a public key without actually signing it. The **-publicsign** option also sets a bit in the assembly that tells the runtime that the file is actually signed.


In the first sentence, I think it's not clear what "it" refers to.

svick · 2018-05-21T11:34:57Z

docs/csharp/language-reference/compiler-options/publicsign-compiler-option.md

+
+The **-publicsign** and **-delaysign** options are mutually exclusive.
+
+Sometimes called "fake sign" or "OSS sign" public signing is including the public key in an output assembly and setting the "signed" flag, but not actually signing the assembly with a private key. This is useful for open source projects where people want to build assemblies which are compatible with the released "fully signed" assemblies, but don't have access to the private key used to sign the assemblies. Since almost no consumers actually need to check if the assembly is fully signed, these publicly built assemblies are useable in almost every scenario that the fully signed one would be used in.


Missing comma before "public signing" in the first sentence?

And update a few grammar inconsistencies.

JRAlexander

Looks good, @BillWagner - just a few small things.

JRAlexander · 2018-05-23T14:55:12Z

docs/csharp/language-reference/compiler-options/pathmap-compiler-option.md

+ `sourcePath1`
+ The source path substituted for `path1` in any output files.
+
+You can specify multiple mappings, separating each with a comma.


ing. How about something like "To specify multiple mapped source paths, separate each with a comma."?

JRAlexander · 2018-05-23T15:03:01Z

docs/csharp/language-reference/compiler-options/keycontainer-compiler-option.md


 ## Remarks  
- When the **-keycontainer** option is used, the compiler creates a sharable component by inserting a public key from the specified container into the assembly manifest and signing the final assembly with the private key. To generate a key file, type sn -k `file` at the command line. sn -i installs the key pair into a container.  
+ When the **-keycontainer** option is used, the compiler creates a sharable component by inserting a public key from the specified container into the assembly manifest and signing the final assembly with the private key. To generate a key file, type sn -k `file` at the command line. sn -i installs the key pair into a container. This option is not supported when the compiler is running on CoreCLR. To sign an assembly when building on CoreCLR, use the [-keyfile](keyfile-compiler-option.md) option.


Multiple "ings".
Maybe "When the -keycontainer option is used, the compiler creates a sharable component with the following steps:

Inserts a public key from the specified container into the assembly manifest.

Signs the final assembly with the private key.", and maybe something like:
" This option is not supported when the compiler runs on CoreCLR. To sign an assembly for CoreCLR build scenarios, use the -keyfile option."

I changed it a bit differently, but all the -ings are gone.

JRAlexander · 2018-05-23T15:07:00Z

docs/csharp/language-reference/compiler-options/delaysign-compiler-option.md

+
+The **-delaysign** and **-publicsign** options are mutually exclusive.
+
+When you request a fully signed assembly, the compiler hashes the file that contains the manifest (assembly metadata) and signs that hash with the private key. The resulting digital signature is stored in the file that contains the manifest. When an assembly is delay signed, the compiler does not compute and store the signature, but reserves space in the file so the signature can be added later.


ing. "The output is a digital signature stored in the file that contains the manifest."?

JRAlexander · 2018-05-23T15:13:57Z

docs/csharp/language-reference/compiler-options/pathmap-compiler-option.md

+---
+# -pathmap (C# Compiler Options)
+
+The **-pathmap** compiler option specifies a mapping for source path names output by the compiler.


Ing. "The -pathmap compiler option specifies a source path names map output by the compiler."?

JRAlexander · 2018-05-23T15:52:53Z

docs/csharp/language-reference/compiler-options/publicsign-compiler-option.md

+---
+# -publicsign (C# Compiler Options)
+
+This option causes the compiler to apply a public key without actually signing the assembly. The **-publicsign** option also sets a bit in the assembly that tells the runtime that the file is actually signed.


Ing. Maybe "This option causes the compiler to apply a public key without an assembly sign."?

JRAlexander · 2018-05-23T17:06:15Z

Excellent, @BillWagner!

mairaw · 2018-05-23T17:08:16Z

docs/csharp/language-reference/compiler-options/listed-alphabetically.md

+|[-baseaddress](baseaddress-compiler-option.md)|Specifies the base address for the library to be built.|
+|[-bugreport](bugreport-compiler-option.md)|Creates a 'Bug Report' file. This file will be sent together with any crash information if it is used with -errorreport:prompt or -errorreport:send.|
+|[-checked](checked-compiler-option.md)|Causes the compiler to generate overflow checks.|
+|-checksumalgorithm:\<alg>|Specify the algorithm for calculating the source file checksum stored in PDB.  Supported values are: SHA1 (default) or SHA256.|


all the others are in 3rd person, why change here?

I'll address this in a new PR.

I'm not seeing a change in person here. What am I missing?

It used to say specifies and it was matching the other lines - Causes, Links, Names, Displays, etc.

Makes sense @BillWagner?

mairaw · 2018-05-23T17:09:07Z

docs/csharp/language-reference/compiler-options/pathmap-compiler-option.md

+csc -pathmap:C:\work\tests=\publish t.cs
+```
+
+## See Also


nit: sentence case

This PR adds a few small changes requested in PR #5408 that got missed.

@jcouv

Fixes #5289 This PR adds the overview to "What's new in C# 7.3". I updated the wording in the TOC to remove the repeated "What's new" phrasing. /cc @jcouv @MadsTorgersen /cc @Welchen This PR relies on new files added in PR #5408

@jcouv

* create "what's new in C# 7.3" Fixes #5289 This PR adds the overview to "What's new in C# 7.3". I updated the wording in the TOC to remove the repeated "What's new" phrasing. /cc @jcouv @MadsTorgersen /cc @Welchen This PR relies on new files added in PR #5408 * respond to feedback * respond to feedback * more feedback * respond to feedback. * fix a build error compile => compiler.

BillWagner requested review from mairaw and rpetrusha May 16, 2018 00:12

jcouv mentioned this pull request May 16, 2018

Confused about v 7.3 dotnet/csharplang#1516

Closed

agocke approved these changes May 16, 2018

View reviewed changes

BillWagner mentioned this pull request May 17, 2018

create "what's new in C# 7.3" #5448

Merged

add new compiler options

a9cfbaa

The new options are: -pathmap -publicsign -keyfile now works on CoreCLR (-keycontainer does not) Also, fixed a variety of markdown lint warnings. These are mostly whitespace. Reviews will be easier using the rich diff view.

BillWagner force-pushed the update-compiler-options branch from 5a2e202 to a9cfbaa Compare May 18, 2018 14:58

svick reviewed May 21, 2018

View reviewed changes

respond to feedback

7513ed7

And update a few grammar inconsistencies.

JRAlexander suggested changes May 23, 2018

View reviewed changes

respond to feedback

917a567

BillWagner added the changes-addressed label May 23, 2018

JRAlexander approved these changes May 23, 2018

View reviewed changes

BillWagner merged commit da2fb55 into dotnet:master May 23, 2018

BillWagner deleted the update-compiler-options branch May 23, 2018 17:08

mairaw reviewed May 23, 2018

View reviewed changes

BillWagner referenced this pull request in BillWagner/docs May 23, 2018

address feedback from #5408

18a45c5

This PR adds a few small changes requested in PR #5408 that got missed.

BillWagner mentioned this pull request May 23, 2018

address feedback from #5408 #5564

Merged

BillWagner added a commit that referenced this pull request May 23, 2018

address feedback from #5408 (#5564)

dcf0a30

This PR adds a few small changes requested in PR #5408 that got missed.

mairaw removed the changes-addressed label Aug 8, 2018

gewarren mentioned this pull request Mar 15, 2021

Add clarification for private protected dotnet/dotnet-api-docs#5437

Merged


		The -publicsign and -delaysign options are mutually exclusive.

		Sometimes called "fake sign" or "OSS sign" public signing is including the public key in an output assembly and setting the "signed" flag, but not actually signing the assembly with a private key. This is useful for open source projects where people want to build assemblies which are compatible with the released "fully signed" assemblies, but don't have access to the private key used to sign the assemblies. Since almost no consumers actually need to check if the assembly is fully signed, these publicly built assemblies are useable in almost every scenario that the fully signed one would be used in.


		The -delaysign and -publicsign options are mutually exclusive.

		When you request a fully signed assembly, the compiler hashes the file that contains the manifest (assembly metadata) and signs that hash with the private key. The resulting digital signature is stored in the file that contains the manifest. When an assembly is delay signed, the compiler does not compute and store the signature, but reserves space in the file so the signature can be added later.

add new compiler options #5408

add new compiler options #5408

Uh oh!

Conversation

BillWagner commented May 15, 2018

Uh oh!

jcouv commented May 16, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JRAlexander left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JRAlexander commented May 23, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

JRAlexander left a comment •

edited

Loading