Skip to content

Commit f4de322

Browse files
authored
Merge pull request #2460 from WilliamAntonRohm/W-deploy-batch-2
VS "deployment" fixes -- gerunds, capitalization, and formatting -- batch #2
2 parents d7afeed + 0b7ab79 commit f4de322

10 files changed

+111
-111
lines changed

docs/deployment/clickonce-and-application-settings.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,39 +17,39 @@ manager: douge
1717
ms.workload:
1818
- "multiple"
1919
---
20-
# ClickOnce and Application Settings
20+
# ClickOnce and application settings
2121
Application settings for Windows Forms makes it easy to create, store, and maintain custom application and user preferences on the client. The following document describes how application settings files work in a ClickOnce application, and how ClickOnce migrates settings when the user upgrades to the next version.
2222

23-
The information below applies only to the default application settings provider, the <xref:System.Configuration.LocalFileSettingsProvider> class. If you supply a custom provider, that provider will determine how it stores its data and how it upgrades its settings between versions. For more information on application settings providers, see [Application Settings Architecture](/dotnet/framework/winforms/advanced/application-settings-architecture).
23+
The information below applies only to the default application settings provider, the \<xref:System.Configuration.LocalFileSettingsProvider> class. If you supply a custom provider, that provider will determine how it stores its data and how it upgrades its settings between versions. For more information on application settings providers, see [Application settings architecture](/dotnet/framework/winforms/advanced/application-settings-architecture).
2424

25-
## Application Settings Files
26-
Application settings consumes two files: *app*.exe.config and user.config, where *app* is the name of your Windows Forms application. user.config is created on the client the first time your application stores user-scoped settings. *app*.exe.config, by contrast, will exist prior to deployment if you define default values for settings. Visual Studio will include this file automatically when you use its **Publish** command. If you create your ClickOnce application using Mage.exe or MageUI.exe, you must make sure this file is included with your application's other files when you populate your application manifest.
25+
## Application settings files
26+
Application settings consumes two files: *\<app>.exe.config* and *user.config*, where *app* is the name of your Windows Forms application. *user.config* is created on the client the first time your application stores user-scoped settings. *\<app>.exe.config*, by contrast, will exist prior to deployment if you define default values for settings. Visual Studio will include this file automatically when you use its **Publish** command. If you create your ClickOnce application using *Mage.exe* or *MageUI.exe*, you must make sure this file is included with your application's other files when you populate your application manifest.
2727

28-
In a Windows Forms applications not deployed using ClickOnce, an application's *app*.exe.config file is stored in the application directory, while the user.config file is stored in the user's **Documents and Settings** folder. In a ClickOnce application, *app*.exe.config lives in the application directory inside of the ClickOnce application cache, and user.config lives in the ClickOnce data directory for that application.
28+
In a Windows Forms applications not deployed using ClickOnce, an application's *\<app>.exe.config* file is stored in the application directory, while the *user.config* file is stored in the user's **Documents and Settings** folder. In a ClickOnce application, *\<app>.exe.config* lives in the application directory inside of the ClickOnce application cache, and *user.config* lives in the ClickOnce data directory for that application.
2929

30-
Regardless of how you deploy your application, application settings ensures safe read access to *app*.exe.config, and safe read/write access to user.config.
30+
Regardless of how you deploy your application, application settings ensures safe read access to *\<app>.exe.config*, and safe read/write access to *user.config*.
3131

32-
In a ClickOnce application, the size of the configuration files used by application settings is constrained by the size of the ClickOnce cache. For more information, see [ClickOnce Cache Overview](../deployment/clickonce-cache-overview.md).
32+
In a ClickOnce application, the size of the configuration files used by application settings is constrained by the size of the ClickOnce cache. For more information, see [ClickOnce cache overview](../deployment/clickonce-cache-overview.md).
3333

34-
## Version Upgrades
34+
## Version upgrades
3535
Just as each version of a ClickOnce application is isolated from all other versions, the application settings for a ClickOnce application are isolated from the settings for other versions as well. When your user upgrades to a later version of your application, application settings compares most recent (highest-numbered) version's settings against the settings supplied with the updated version and merges the settings into a new set of settings files.
3636

3737
The following table describes how application settings decides which settings to copy.
3838

3939
|Type of Change|Upgrade Action|
4040
|--------------------|--------------------|
41-
|Setting added to *app*.exe.config|The new setting is merged into the current version's *app*.exe.config|
42-
|Setting removed from *app*.exe.config|The old setting is removed from the current version's *app*.exe.config|
43-
|Setting's default changed; local setting still set to original default in user.config|The setting is merged into the current version's user.config with the new default as the value|
44-
|Setting's default changed; setting set to non-default in user.config|The setting is merged into the current version's user.config with the non-default value retained|
41+
|Setting added to *\<app>.exe.config*|The new setting is merged into the current version's *\<app>.exe.config*|
42+
|Setting removed from *\<app>.exe.config*|The old setting is removed from the current version's *\<app>.exe.config*|
43+
|Setting's default changed; local setting still set to original default in *user.config*|The setting is merged into the current version's *user.config* with the new default as the value|
44+
|Setting's default changed; setting set to non-default in *user.config*|The setting is merged into the current version's *user.config* with the non-default value retained|
4545

46-
If you have created your own application settings wrapper class and wish to customize the update logic, you can override the <xref:System.Configuration.ApplicationSettingsBase.Upgrade%2A> method.
46+
If you have created your own application settings wrapper class and wish to customize the update logic, you can override the \<xref:System.Configuration.ApplicationSettingsBase.Upgrade%2A> method.
4747

48-
## ClickOnce and Roaming Settings
49-
ClickOnce does not work with roaming settings, which allows your settings file to follow you across machines on a network. If you need roaming settings, you will need either to implement an application settings provider that stores settings over the network, or develop your own custom settings classes for storing settings on a remote computer. For more information in settings providers, see [Application Settings Architecture](/dotnet/framework/winforms/advanced/application-settings-architecture).
48+
## ClickOnce and roaming settings
49+
ClickOnce does not work with roaming settings, which allows your settings file to follow you across machines on a network. If you need roaming settings, you will need either to implement an application settings provider that stores settings over the network, or develop your own custom settings classes for storing settings on a remote computer. For more information in settings providers, see [Application settings architecture](/dotnet/framework/winforms/advanced/application-settings-architecture).
5050

51-
## See Also
52-
[ClickOnce Security and Deployment](../deployment/clickonce-security-and-deployment.md)
53-
[Application Settings Overview](/dotnet/framework/winforms/advanced/application-settings-overview)
54-
[ClickOnce Cache Overview](../deployment/clickonce-cache-overview.md)
55-
[Accessing Local and Remote Data in ClickOnce Applications](../deployment/accessing-local-and-remote-data-in-clickonce-applications.md)
51+
## See also
52+
[ClickOnce security and deployment](../deployment/clickonce-security-and-deployment.md)
53+
[Application settings overview](/dotnet/framework/winforms/advanced/application-settings-overview)
54+
[ClickOnce cache overview](../deployment/clickonce-cache-overview.md)
55+
[Access local and remote data in ClickOnce applications](../deployment/accessing-local-and-remote-data-in-clickonce-applications.md)

docs/deployment/clickonce-and-authenticode.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,21 @@ ms.workload:
2626

2727
The following sections describe the different types of digital certificates used in Authenticode, how certificates are validated using Certificate Authorities (CAs), the role of time-stamping in certificates, and the methods of storage available for certificates.
2828

29-
## Authenticode and Code Signing
29+
## Authenticode and code signing
3030
A *digital certificate* is a file that contains a cryptographic public/private key pair, along with metadata describing the publisher to whom the certificate was issued and the agency that issued the certificate.
3131

32-
There are various types of Authenticode certificates. Each one is configured for different types of signing. For [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)] applications, you must have an Authenticode certificate that is valid for code signing. If you attempt to sign a [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)] application with another type of certificate, such as a digital e-mail certificate, it will not work. For more information, see [Introduction to Code Signing](http://go.microsoft.com/fwlink/?LinkId=179452).
32+
There are various types of Authenticode certificates. Each one is configured for different types of signing. For [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)] applications, you must have an Authenticode certificate that is valid for code signing. If you attempt to sign a [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)] application with another type of certificate, such as a digital e-mail certificate, it will not work. For more information, see [Introduction to code signing](http://go.microsoft.com/fwlink/?LinkId=179452).
3333

3434
You can obtain a certificate for code signing in one of three ways:
3535

3636
- Purchase one from a certificate vendor.
3737

3838
- Receive one from a group in your organization responsible for creating digital certificates.
3939

40-
- Generate your own certificate by using the New-SelfSignedCertificate PowerShell cmdlet, or by using MakeCert.exe, which is included with the [!INCLUDE[winsdklong](../deployment/includes/winsdklong_md.md)].
40+
- Generate your own certificate by using the New-SelfSignedCertificate PowerShell cmdlet, or by using *MakeCert.exe*, which is included with the [!INCLUDE[winsdklong](../deployment/includes/winsdklong_md.md)].
4141

42-
### How Using Certificate Authorities Helps Users
43-
A certificate generated using New-SelfSignedCertificate or the MakeCert.exe utility is commonly called a *self-cert* or a *test cert*. This kind of certificate works much the same way that a .snk file works in the .NET Framework. It consists solely of a public/private cryptographic key pair, and contains no verifiable information about the publisher. You can use self-certs to deploy [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)] applications with high trust on an intranet. However, when these applications run on a client computer, [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)] will identify them as coming from an Unknown Publisher. By default, [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)] applications signed with self-certs and deployed over the Internet cannot utilize Trusted Application Deployment.
42+
### How using certificate authorities helps users
43+
A certificate generated using New-SelfSignedCertificate or the *MakeCert.exe* utility is commonly called a *self-cert* or a *test cert*. This kind of certificate works much the same way that a *.snk* file works in the .NET Framework. It consists solely of a public/private cryptographic key pair, and contains no verifiable information about the publisher. You can use self-certs to deploy [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)] applications with high trust on an intranet. However, when these applications run on a client computer, [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)] will identify them as coming from an Unknown Publisher. By default, [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)] applications signed with self-certs and deployed over the Internet cannot utilize Trusted Application Deployment.
4444

4545
By contrast, if you receive a certificate from a CA, such as a certificate vendor, or a department within your enterprise, the certificate offers more security for your users. It not only identifies the publisher of the signed software, but it verifies that identity by checking with the CA that signed it. If the CA is not the root authority, Authenticode will also "chain" back to the root authority to verify that the CA is authorized to issue certificates. For greater security, you should use a certificate issued by a CA whenever possible.
4646

@@ -51,7 +51,7 @@ ms.workload:
5151

5252
To include a timestamp in an application server, a timestamp server must be available. For information about how to select a timestamp server, see [How to: Sign Application and Deployment Manifests](../ide/how-to-sign-application-and-deployment-manifests.md).
5353

54-
### Updating Expired Certificates
54+
### Update expired certificates
5555
In earlier versions of the .NET Framework, updating an application whose certificate had expired could cause that application to stop functioning. To resolve this problem, use one of the following methods:
5656

5757
- Update the .NET Framework to version 2.0 SP1 or later on Windows XP, or version 3.5 or later on Windows Vista.
@@ -60,12 +60,12 @@ ms.workload:
6060

6161
- Create a command-line assembly that updates the certificate. Step-by-step information about this process can be found at [Microsoft Support Article 925521](http://go.microsoft.com/fwlink/?LinkId=179454).
6262

63-
### Storing Certificates
63+
### Store certificates
6464

65-
- You can store certificates as a .pfx file on your file system, or you can store them inside of a key container. A user on a Windows domain can have a number of key containers. By default, MakeCert.exe will store certificates in your personal key container, unless you specify that it should save it to a .pfx instead. Mage.exe and MageUI.exe, the [!INCLUDE[winsdkshort](../debugger/debug-interface-access/includes/winsdkshort_md.md)] tools for creating [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)] deployments, enable you to use certificates stored in either fashion.
65+
- You can store certificates as a *.pfx* file on your file system, or you can store them inside of a key container. A user on a Windows domain can have a number of key containers. By default, *MakeCert.exe* will store certificates in your personal key container, unless you specify that it should save it to a *.pfx* instead. *Mage.exe* and *MageUI.exe*, the [!INCLUDE[winsdkshort](../debugger/debug-interface-access/includes/winsdkshort_md.md)] tools for creating [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)] deployments, enable you to use certificates stored in either fashion.
6666

67-
## See Also
68-
[ClickOnce Security and Deployment](../deployment/clickonce-security-and-deployment.md)
69-
[Securing ClickOnce Applications](../deployment/securing-clickonce-applications.md)
70-
[Trusted Application Deployment Overview](../deployment/trusted-application-deployment-overview.md)
67+
## See also
68+
[ClickOnce security and deployment](../deployment/clickonce-security-and-deployment.md)
69+
[Secure ClickOnce applications](../deployment/securing-clickonce-applications.md)
70+
[Trusted application deployment overview](../deployment/trusted-application-deployment-overview.md)
7171
[Mage.exe (Manifest Generation and Editing Tool)](/dotnet/framework/tools/mage-exe-manifest-generation-and-editing-tool)

0 commit comments

Comments
 (0)