From b16472642d8c82e63a89378b53be1d0a8640277a Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Fri, 19 Mar 2021 21:37:26 +0200 Subject: [PATCH 01/16] master -> main --- .../application-performance-management.md | 6 ++--- .../net-framework-container-scenarios.md | 4 +-- .../develop-asp-net-core-mvc-apps.md | 2 +- .../additional-tools/dotnet-svcutil-guide.md | 2 +- .../self-signed-certificates-guide.md | 8 +++--- .../additional-tools/vscode-dotnet-runtime.md | 6 ++--- .../wcf-web-service-reference-guide.md | 4 +-- ...able-reference-type-annotations-changed.md | 2 +- .../ca1416-platform-compatibility-analyzer.md | 2 +- .../publishdepsfilepath-behavior-change.md | 2 +- .../dependency-loading/collect-details.md | 2 +- docs/core/deploying/deploy-with-cli.md | 6 ++--- docs/core/deploying/deploy-with-vs.md | 2 +- docs/core/deploying/index.md | 2 +- docs/core/deploying/trim-self-contained.md | 2 +- docs/core/deploying/trimming-options.md | 2 +- docs/core/diagnostics/available-counters.md | 6 ++--- docs/core/diagnostics/debug-deadlock.md | 2 +- docs/core/diagnostics/debug-highcpu.md | 2 +- docs/core/diagnostics/debug-linux-dumps.md | 10 +++---- docs/core/diagnostics/debug-memory-leak.md | 2 +- .../diagnostics/diagnostics-in-containers.md | 2 +- docs/core/diagnostics/dotnet-dump.md | 2 +- docs/core/diagnostics/event-counters.md | 4 +-- docs/core/diagnostics/eventpipe.md | 4 +-- .../diagnostics/trace-perfcollect-lttng.md | 2 +- docs/core/extensions/console-log-formatter.md | 6 ++--- .../linux-rpm-install-dependencies.md | 2 +- docs/core/install/linux-opensuse.md | 2 +- docs/core/install/linux-scripted-manual.md | 2 +- docs/core/install/linux-sles.md | 2 +- docs/core/install/macos.md | 24 ++++++++--------- docs/core/install/windows.md | 12 ++++----- docs/core/introduction.md | 8 +++--- .../expose-components-to-com.md | 2 +- docs/core/porting/cpp-cli.md | 4 +-- docs/core/porting/libraries.md | 2 +- .../porting/net-framework-tech-unavailable.md | 2 +- docs/core/porting/project-structure.md | 8 +++--- docs/core/porting/windows-compat-pack.md | 2 +- docs/core/project-sdk/overview.md | 2 +- docs/core/releases-and-support.md | 2 +- docs/core/rid-catalog.md | 12 ++++----- docs/core/run-time-config/compilation.md | 2 +- .../run-time-config/debugging-profiling.md | 2 +- .../core/run-time-config/garbage-collector.md | 2 +- docs/core/run-time-config/globalization.md | 2 +- .../unit-testing-fsharp-with-dotnet-test.md | 4 +-- .../unit-testing-fsharp-with-mstest.md | 4 +-- .../testing/unit-testing-fsharp-with-nunit.md | 4 +-- ...t-testing-visual-basic-with-dotnet-test.md | 4 +-- .../unit-testing-visual-basic-with-mstest.md | 6 ++--- .../unit-testing-visual-basic-with-nunit.md | 6 ++--- .../testing/unit-testing-with-dotnet-test.md | 4 +-- docs/core/testing/unit-testing-with-mstest.md | 6 ++--- docs/core/testing/unit-testing-with-nunit.md | 6 ++--- docs/core/tools/dotnet-install-script.md | 2 +- docs/core/tools/dotnet-list-package.md | 4 +-- docs/core/tools/dotnet-publish.md | 2 +- docs/core/tools/dotnet.md | 6 ++--- docs/core/tools/global-tools.md | 2 +- docs/core/tools/telemetry.md | 2 +- .../creating-app-with-plugin-support.md | 2 +- docs/core/tutorials/netcore-hosting.md | 12 ++++----- docs/core/tutorials/testing-with-cli.md | 2 +- docs/core/whats-new/dotnet-core-2-0.md | 2 +- docs/core/whats-new/dotnet-core-2-2.md | 2 +- docs/core/whats-new/dotnet-core-3-0.md | 12 ++++----- docs/csharp/expression-trees-building.md | 2 +- docs/csharp/indexers.md | 2 +- docs/csharp/iterators.md | 2 +- ...pression-trees-to-build-dynamic-queries.md | 2 +- ...h-persisting-an-object-in-visual-studio.md | 2 +- .../get-started/semantic-analysis.md | 2 +- .../roslyn-sdk/get-started/syntax-analysis.md | 4 +-- .../how-to-write-csharp-analyzer-code-fix.md | 4 +-- .../tutorials/arrays-and-collections.md | 2 +- .../tutorials/branches-and-loops-local.md | 2 +- docs/csharp/tour-of-csharp/tutorials/index.md | 2 +- .../tutorials/numbers-in-csharp-local.md | 2 +- docs/csharp/tutorials/console-teleprompter.md | 2 +- docs/csharp/tutorials/console-webapiclient.md | 4 +-- .../default-interface-methods-versions.md | 4 +-- .../tutorials/nullable-reference-types.md | 2 +- docs/csharp/tutorials/pattern-matching.md | 4 +-- .../upgrade-to-nullable-references.md | 4 +-- docs/csharp/tutorials/working-with-linq.md | 2 +- docs/csharp/whats-new/csharp-7.md | 2 +- docs/csharp/whats-new/csharp-8.md | 2 +- .../whats-new/csharp-version-history.md | 2 +- docs/csharp/write-safe-efficient-code.md | 2 +- .../additional-apis/coreresponsedata.md | 2 +- .../coreresponsedata_m_responseheaders.md | 2 +- .../coreresponsedata_m_statuscode.md | 2 +- .../httpwebrequest__coreresponse.md | 2 +- .../how-to-map-hresults-and-exceptions.md | 2 +- .../tools/ngen-exe-native-image-generator.md | 2 +- docs/framework/whats-new/index.md | 2 +- docs/fsharp/using-fsharp-on-azure/index.md | 2 +- .../code-quality-rule-options.md | 4 +-- .../code-analysis/code-style-rule-options.md | 4 +-- .../code-analysis/configuration-options.md | 4 +-- docs/fundamentals/code-analysis/overview.md | 4 +-- .../predefined-configurations.md | 2 +- .../code-analysis/quality-rules/ca1416.md | 6 ++--- .../code-analysis/quality-rules/ca3001.md | 2 +- .../code-analysis/quality-rules/ca3002.md | 2 +- .../code-analysis/quality-rules/ca3003.md | 2 +- .../code-analysis/quality-rules/ca3004.md | 2 +- .../code-analysis/quality-rules/ca3005.md | 2 +- .../code-analysis/quality-rules/ca3006.md | 2 +- .../code-analysis/quality-rules/ca3007.md | 2 +- .../code-analysis/quality-rules/ca3008.md | 2 +- .../code-analysis/quality-rules/ca3009.md | 2 +- .../code-analysis/quality-rules/ca3010.md | 2 +- .../code-analysis/quality-rules/ca3011.md | 2 +- .../code-analysis/quality-rules/ca3012.md | 2 +- .../code-analysis/style-rules/naming-rules.md | 2 +- docs/iot/intro.md | 12 ++++----- .../automate-training-with-model-builder.md | 10 +++---- .../how-to-use-the-automl-api.md | 2 +- .../how-to-guides/install-ml-net-cli.md | 4 +-- ...model-serverless-azure-functions-ml-net.md | 6 ++--- .../serve-model-web-api-ml-net.md | 4 +-- .../tutorials/github-issue-classification.md | 10 +++---- ...-violation-classification-model-builder.md | 4 +-- ...ge-classification-api-transfer-learning.md | 2 +- .../tutorials/image-classification.md | 8 +++--- .../tutorials/iris-clustering.md | 4 +-- .../tutorials/movie-recommendation.md | 12 ++++----- .../object-detection-model-builder.md | 4 +-- .../phone-calls-anomaly-detection.md | 10 +++---- .../predict-prices-with-model-builder.md | 2 +- .../tutorials/predict-prices.md | 4 +-- .../tutorials/sales-anomaly-detection.md | 10 +++---- .../sentiment-analysis-model-builder.md | 2 +- .../tutorials/sentiment-analysis.md | 4 +-- .../tutorials/text-classification-tf.md | 8 +++--- .../time-series-demand-forecasting.md | 6 ++--- docs/samples-and-tutorials/index.md | 26 +++++++++---------- .../databricks-deploy-methods.md | 2 +- .../deploy-worker-udf-binaries.md | 2 +- .../dotnet-interactive-udf-issue.md | 4 +-- .../hdinsight-notebook-installation.md | 2 +- .../how-to-guides/java-udf-from-dotnet.md | 2 +- .../how-to-guides/ubuntu-instructions.md | 12 ++++----- docs/spark/how-to-guides/udf-guide.md | 6 ++--- .../how-to-guides/windows-instructions.md | 12 ++++----- docs/spark/resources/index.md | 2 +- .../tutorials/amazon-emr-spark-deployment.md | 6 ++--- docs/spark/tutorials/batch-processing.md | 4 +-- docs/spark/tutorials/databricks-deployment.md | 4 +-- docs/spark/tutorials/hdinsight-deployment.md | 2 +- docs/spark/tutorials/ml-sentiment-analysis.md | 6 ++--- docs/spark/tutorials/streaming.md | 8 +++--- docs/spark/what-is-apache-spark-dotnet.md | 4 +-- .../analyzers/platform-compat-analyzer.md | 10 +++---- .../assembly/create-use-strong-named.md | 2 +- docs/standard/assembly/sign-strong-name.md | 2 +- docs/standard/assembly/unloadability.md | 2 +- .../string-comparison-net-5-plus.md | 2 +- docs/standard/exceptions/index.md | 2 +- docs/standard/frameworks.md | 2 +- docs/standard/glossary.md | 4 +-- .../library-guidance/breaking-changes.md | 2 +- docs/standard/library-guidance/nuget.md | 2 +- docs/standard/library-guidance/sourcelink.md | 2 +- docs/standard/net-standard.md | 8 +++--- .../whats-new/whats-new-in-dotnet-standard.md | 4 +-- ...pression-trees-to-build-dynamic-queries.md | 2 +- .../reference/language-specification/index.md | 2 +- .../whats-new/breaking-changes.md | 10 +++---- .../msbuild/2.1/dotnetclitoolreference.md | 4 +-- includes/net-standard-table.md | 20 +++++++------- .../csharp/HostWithCoreClrHost/README.md | 4 +-- .../csharp/HostWithHostFxr/readme.md | 2 +- .../netcore-hosting/csharp/README.md | 2 +- 177 files changed, 366 insertions(+), 366 deletions(-) diff --git a/docs/architecture/grpc-for-wcf-developers/application-performance-management.md b/docs/architecture/grpc-for-wcf-developers/application-performance-management.md index ff59b8fb0a777..6351d24d139b1 100644 --- a/docs/architecture/grpc-for-wcf-developers/application-performance-management.md +++ b/docs/architecture/grpc-for-wcf-developers/application-performance-management.md @@ -46,7 +46,7 @@ For more information about writing log messages and available logging sinks and ## Metrics in ASP.NET Core gRPC -The .NET Core runtime provides a set of components for emitting and observing metrics. These include APIs such as the and classes. These APIs can emit basic numeric data that can be consumed by external processes, like the [dotnet-counters global tool](../../core/diagnostics/dotnet-counters.md), or Event Tracing for Windows. For more information about using `EventCounter` in your own code, see [EventCounter introduction](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.Tracing/documentation/EventCounterTutorial.md). +The .NET Core runtime provides a set of components for emitting and observing metrics. These include APIs such as the and classes. These APIs can emit basic numeric data that can be consumed by external processes, like the [dotnet-counters global tool](../../core/diagnostics/dotnet-counters.md), or Event Tracing for Windows. For more information about using `EventCounter` in your own code, see [EventCounter introduction](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Diagnostics.Tracing/documentation/EventCounterTutorial.md). For more advanced metrics and for writing metric data to a wider range of data stores, you might try an open-source project called [App Metrics](https://www.app-metrics.io). This suite of libraries provides an extensive set of types to instrument your code. It also offers packages to write metrics to different kinds of targets that include time-series databases, such as Prometheus and InfluxDB, and [Application Insights](/azure/azure-monitor/app/app-insights-overview). The [App.Metrics.AspNetCore.Mvc](https://www.nuget.org/packages/App.Metrics.AspNetCore.Mvc/) NuGet package even adds a comprehensive set of basic metrics that are automatically generated via integration with the ASP.NET Core framework. The project website provides [templates](https://www.app-metrics.io/samples/grafana/) for displaying those metrics with the [Grafana](https://grafana.com/) visualization platform. @@ -115,7 +115,7 @@ Distributed tracing is based on the concept of *spans*: named, timed operations ### Distributed tracing with `DiagnosticSource` -.NET has an internal module that maps well to distributed traces and spans: [DiagnosticSource](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md#diagnosticsource-users-guide). As well as providing a simple way to produce and consume diagnostics within a process, the `DiagnosticSource` module has the concept of an *activity*. An activity is effectively an implementation of a distributed trace, or a span within a trace. The internals of the module take care of parent/child activities, including allocating identifiers. For more information about using the `Activity` type, see the [Activity User Guide on GitHub](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/ActivityUserGuide.md#activity-user-guide). +.NET has an internal module that maps well to distributed traces and spans: [DiagnosticSource](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md#diagnosticsource-users-guide). As well as providing a simple way to produce and consume diagnostics within a process, the `DiagnosticSource` module has the concept of an *activity*. An activity is effectively an implementation of a distributed trace, or a span within a trace. The internals of the module take care of parent/child activities, including allocating identifiers. For more information about using the `Activity` type, see the [Activity User Guide on GitHub](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Diagnostics.DiagnosticSource/src/ActivityUserGuide.md#activity-user-guide). Because `DiagnosticSource` is a part of the core framework and later, it's supported by several core components. These include , Entity Framework Core, and ASP.NET Core, including explicit support in the gRPC framework. When ASP.NET Core receives a request, it checks for a pair of HTTP headers matching the [W3C Trace Context](https://www.w3.org/TR/trace-context) standard. If the headers are found, an activity is started by using the identity values and context from the headers. If no headers are found, an activity is started with generated identity values that match the standard format. Any diagnostics generated by the framework or by application code during the lifetime of this activity can be tagged with the trace and span identifiers. The `HttpClient` support extends this functionality further by checking for a current activity on every request, and automatically adding the trace headers to the outgoing request. @@ -126,7 +126,7 @@ The ASP.NET Core gRPC client and server libraries include explicit support for ` ### Add your own `DiagnosticSource` and `Activity` -To add your own diagnostics or create explicit spans within your application code, see the [DiagnosticSource User Guide](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md#instrumenting-with-diagnosticsourcediagnosticlistener) and [Activity User Guide](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/ActivityUserGuide.md#activity-usage). +To add your own diagnostics or create explicit spans within your application code, see the [DiagnosticSource User Guide](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md#instrumenting-with-diagnosticsourcediagnosticlistener) and [Activity User Guide](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Diagnostics.DiagnosticSource/src/ActivityUserGuide.md#activity-usage). ### Store distributed trace data diff --git a/docs/architecture/microservices/net-core-net-framework-containers/net-framework-container-scenarios.md b/docs/architecture/microservices/net-core-net-framework-containers/net-framework-container-scenarios.md index 447e666035dcf..386303af68f1c 100644 --- a/docs/architecture/microservices/net-core-net-framework-containers/net-framework-container-scenarios.md +++ b/docs/architecture/microservices/net-core-net-framework-containers/net-framework-container-scenarios.md @@ -15,7 +15,7 @@ In most cases for this scenario, you will not need to migrate your existing appl ## Using third-party .NET libraries or NuGet packages not available for .NET 5 -Third-party libraries are quickly embracing [.NET Standard](../../../standard/net-standard.md), which enables code sharing across all .NET flavors, including .NET 5. With .NET Standard 2.0 and later, the API surface compatibility across different frameworks has become significantly larger. Even more, .NET Core 2.x and newer applications can also directly reference existing .NET Framework libraries (see [.NET Framework 4.6.1 supporting .NET Standard 2.0](https://github.com/dotnet/standard/blob/master/docs/planning/netstandard-2.0/README.md#net-framework-461-supporting-net-standard-20)). +Third-party libraries are quickly embracing [.NET Standard](../../../standard/net-standard.md), which enables code sharing across all .NET flavors, including .NET 5. With .NET Standard 2.0 and later, the API surface compatibility across different frameworks has become significantly larger. Even more, .NET Core 2.x and newer applications can also directly reference existing .NET Framework libraries (see [.NET Framework 4.6.1 supporting .NET Standard 2.0](https://github.com/dotnet/standard/blob/main/docs/planning/netstandard-2.0/README.md#net-framework-461-supporting-net-standard-20)). In addition, the [Windows Compatibility Pack](../../../core/porting/windows-compat-pack.md) extends the API surface available for .NET Standard 2.0 on Windows. This pack allows recompiling most existing code to .NET Standard 2.x with little or no modification, to run on Windows. @@ -33,7 +33,7 @@ The following list shows most of the technologies that aren't available in .NET - Workflow-related services. Windows Workflow Foundation (WF), Workflow Services (WCF + WF in a single service), and WCF Data Services (formerly known as ADO.NET Data Services) are only available on .NET Framework. There are currently no plans to bring them to .NET 5. -In addition to the technologies listed in the official [.NET roadmap](https://github.com/dotnet/core/blob/master/roadmap.md), other features might be ported to the new [unified .NET platform](https://devblogs.microsoft.com/dotnet/introducing-net-5/). You might consider participating in the discussions on GitHub so that your voice can be heard. And if you think something is missing, file a new issue in the [dotnet/runtime](https://github.com/dotnet/runtime/issues/new) GitHub repository. +In addition to the technologies listed in the official [.NET roadmap](https://github.com/dotnet/core/blob/main/roadmap.md), other features might be ported to the new [unified .NET platform](https://devblogs.microsoft.com/dotnet/introducing-net-5/). You might consider participating in the discussions on GitHub so that your voice can be heard. And if you think something is missing, file a new issue in the [dotnet/runtime](https://github.com/dotnet/runtime/issues/new) GitHub repository. ## Using a platform or API that doesn't support .NET 5 diff --git a/docs/architecture/modern-web-apps-azure/develop-asp-net-core-mvc-apps.md b/docs/architecture/modern-web-apps-azure/develop-asp-net-core-mvc-apps.md index 4018cb3d8e521..e68cc120796bb 100644 --- a/docs/architecture/modern-web-apps-azure/develop-asp-net-core-mvc-apps.md +++ b/docs/architecture/modern-web-apps-azure/develop-asp-net-core-mvc-apps.md @@ -646,7 +646,7 @@ Consider ways in which your applications communicate directly with client applic > ### References – Client Communication > > - **ASP.NET Core SignalR**\ -> +> > - **WebSocket Manager**\ > diff --git a/docs/core/additional-tools/dotnet-svcutil-guide.md b/docs/core/additional-tools/dotnet-svcutil-guide.md index 25334cb0e9391..f03f9d5d610e4 100644 --- a/docs/core/additional-tools/dotnet-svcutil-guide.md +++ b/docs/core/additional-tools/dotnet-svcutil-guide.md @@ -174,7 +174,7 @@ If you have any questions or feedback, [open an issue on GitHub](https://github. ## Release notes -- Refer to the [Release notes](https://github.com/dotnet/wcf/blob/master/release-notes/dotnet-svcutil-notes.md) for updated release information, including known issues. +- Refer to the [Release notes](https://github.com/dotnet/wcf/blob/main/release-notes/dotnet-svcutil-notes.md) for updated release information, including known issues. ## Information diff --git a/docs/core/additional-tools/self-signed-certificates-guide.md b/docs/core/additional-tools/self-signed-certificates-guide.md index bab6be65048a3..7f150789a64ea 100644 --- a/docs/core/additional-tools/self-signed-certificates-guide.md +++ b/docs/core/additional-tools/self-signed-certificates-guide.md @@ -9,7 +9,7 @@ ms.date: 11/19/2020 When using self-signed certificates, there are different ways to create and use them for development and testing scenarios. In this guide, you'll cover using self-signed certificates with `dotnet dev-certs`, and other options like `PowerShell` and `OpenSSL`. -You can then validate that the certificate will load using an example such as an [ASP.NET Core app](https://github.com/dotnet/dotnet-docker/blob/master/samples/run-aspnetcore-https-development.md) hosted in a container. +You can then validate that the certificate will load using an example such as an [ASP.NET Core app](https://github.com/dotnet/dotnet-docker/blob/main/samples/run-aspnetcore-https-development.md) hosted in a container. ## Prerequisites @@ -41,7 +41,7 @@ Navigate to the repository locally and open up the workspace in an editor. > [!NOTE] > If you're looking to use dotnet publish parameters to *trim* the deployment, you should make sure that the appropriate dependencies are included for supporting SSL certificates. -Update the [dotnet-docker\samples\aspnetapp\aspnetapp.csproj](https://github.com/dotnet/dotnet-docker/blob/master/samples/aspnetapp/aspnetapp/aspnetapp.csproj) to ensure that the appropriate assemblies are included in the container. For reference, check how to update the .csproj file to [support ssl certificates](../deploying/trim-self-contained.md#support-for-ssl-certificates) when using trimming for self-contained deployments. +Update the [dotnet-docker\samples\aspnetapp\aspnetapp.csproj](https://github.com/dotnet/dotnet-docker/blob/main/samples/aspnetapp/aspnetapp/aspnetapp.csproj) to ensure that the appropriate assemblies are included in the container. For reference, check how to update the .csproj file to [support ssl certificates](../deploying/trim-self-contained.md#support-for-ssl-certificates) when using trimming for self-contained deployments. Make sure the `aspnetapp.csproj` includes the appropriate target framework: @@ -96,7 +96,7 @@ docker build -t aspnetapp:my-sample -f Dockerfile . For this guide, the [sample aspnetapp](https://hub.docker.com/_/microsoft-dotnet-samples) should be checked for .NET 5. -Check sample app [Dockerfile](https://github.com/dotnet/dotnet-docker/blob/master/samples/aspnetapp/Dockerfile) is using .NET 5. +Check sample app [Dockerfile](https://github.com/dotnet/dotnet-docker/blob/main/samples/aspnetapp/Dockerfile) is using .NET 5. Depending on the host OS, the ASP.NET runtime may need to be updated. For example, changing from `mcr.microsoft.com/dotnet/aspnet:5.0-nanoservercore-2009 AS runtime` to `mcr.microsoft.com/dotnet/aspnet:5.0-windowsservercore-ltsc2019 AS runtime` in the Dockerfile will help with targeting the appropriate Windows runtime. @@ -143,7 +143,7 @@ Make sure the `aspnetapp.csproj` includes the appropriate target framework: > [!NOTE] > If you want to use `dotnet publish` parameters to *trim* the deployment, make sure that the appropriate dependencies are included for supporting SSL certificates. -Update the [dotnet-docker\samples\aspnetapp\aspnetapp.csproj](https://github.com/dotnet/dotnet-docker/blob/master/samples/aspnetapp/aspnetapp/aspnetapp.csproj) to ensure that the appropriate assemblies are included in the container. For reference, check how to update the .csproj file to [support ssl certificates](../deploying/trim-self-contained.md#support-for-ssl-certificates) when using trimming for self-contained deployments. +Update the [dotnet-docker\samples\aspnetapp\aspnetapp.csproj](https://github.com/dotnet/dotnet-docker/blob/main/samples/aspnetapp/aspnetapp/aspnetapp.csproj) to ensure that the appropriate assemblies are included in the container. For reference, check how to update the .csproj file to [support ssl certificates](../deploying/trim-self-contained.md#support-for-ssl-certificates) when using trimming for self-contained deployments. Make sure you're pointing to the sample app. diff --git a/docs/core/additional-tools/vscode-dotnet-runtime.md b/docs/core/additional-tools/vscode-dotnet-runtime.md index 05a897bb53bcc..f072f24475166 100644 --- a/docs/core/additional-tools/vscode-dotnet-runtime.md +++ b/docs/core/additional-tools/vscode-dotnet-runtime.md @@ -15,9 +15,9 @@ To ensure that the .NET install tool for extension authors is the right fit for > [!NOTE] > This tool can be used to install the .NET runtime only, it currently does not have the capability to install the .NET SDK. -Once you have verified that the .NET install tool for extension authors fits your needs, you can take a dependency on it in your [extension manifest](https://code.visualstudio.com/api/references/extension-manifest) and begin using the commands we expose with the [VS Code API](https://code.visualstudio.com/api/extension-guides/command#programmatically-executing-a-command). You can find the list of commands this extension exposes on our [GitHub](https://github.com/dotnet/vscode-dotnet-runtime/blob/master/Documentation/commands.md). +Once you have verified that the .NET install tool for extension authors fits your needs, you can take a dependency on it in your [extension manifest](https://code.visualstudio.com/api/references/extension-manifest) and begin using the commands we expose with the [VS Code API](https://code.visualstudio.com/api/extension-guides/command#programmatically-executing-a-command). You can find the list of commands this extension exposes on our [GitHub](https://github.com/dotnet/vscode-dotnet-runtime/blob/main/Documentation/commands.md). -Check out this [sample extension](https://github.com/dotnet/vscode-dotnet-runtime/tree/master/sample) to see these steps in action. +Check out this [sample extension](https://github.com/dotnet/vscode-dotnet-runtime/tree/main/sample) to see these steps in action. For more examples, check out these open source extensions that currently leverage this tool: @@ -27,4 +27,4 @@ For more examples, check out these open source extensions that currently leverag ## Getting started: end users -In general, the end user should not need to interact with the .NET install tool for extension authors at all. If you are having problems with the extension, check out our [troubleshooting page](https://github.com/dotnet/vscode-dotnet-runtime/blob/master/Documentation/troubleshooting-runtime.md) or file an issue on our [GitHub](https://github.com/dotnet/vscode-dotnet-runtime/issues). +In general, the end user should not need to interact with the .NET install tool for extension authors at all. If you are having problems with the extension, check out our [troubleshooting page](https://github.com/dotnet/vscode-dotnet-runtime/blob/main/Documentation/troubleshooting-runtime.md) or file an issue on our [GitHub](https://github.com/dotnet/vscode-dotnet-runtime/issues). diff --git a/docs/core/additional-tools/wcf-web-service-reference-guide.md b/docs/core/additional-tools/wcf-web-service-reference-guide.md index e0cadf27f99b1..b946ce7ecedf3 100644 --- a/docs/core/additional-tools/wcf-web-service-reference-guide.md +++ b/docs/core/additional-tools/wcf-web-service-reference-guide.md @@ -75,7 +75,7 @@ When these processes complete, you can create an instance of the generated WCF c - [Get started with Windows Communication Foundation applications](../../framework/wcf/getting-started-tutorial.md) - [Windows Communication Foundation services and WCF data services in Visual Studio](/visualstudio/data-tools/windows-communication-foundation-services-and-wcf-data-services-in-visual-studio) -- [WCF supported features on .NET Core](https://github.com/dotnet/wcf/blob/master/release-notes/SupportedFeatures-v2.1.0.md) +- [WCF supported features on .NET Core](https://github.com/dotnet/wcf/blob/main/release-notes/SupportedFeatures-v2.1.0.md) ## Feedback & questions @@ -83,4 +83,4 @@ If you have any product feedback, report it at [Developer Community](https://aka ## Release notes -- Refer to the [Release notes](https://github.com/dotnet/wcf/blob/master/release-notes/WCF-Web-Service-Reference-notes.md) for updated release information, including known issues. +- Refer to the [Release notes](https://github.com/dotnet/wcf/blob/main/release-notes/WCF-Web-Service-Reference-notes.md) for updated release information, including known issues. diff --git a/docs/core/compatibility/aspnet-core/6.0/nullable-reference-type-annotations-changed.md b/docs/core/compatibility/aspnet-core/6.0/nullable-reference-type-annotations-changed.md index 433d3812a5865..962734e3ac52e 100644 --- a/docs/core/compatibility/aspnet-core/6.0/nullable-reference-type-annotations-changed.md +++ b/docs/core/compatibility/aspnet-core/6.0/nullable-reference-type-annotations-changed.md @@ -9,7 +9,7 @@ ms.date: 02/24/2021 _**This issue represents a work-in-progress. All breaking changes to nullability annotations will be aggregated into this issue throughout the course of ASP.NET Core 6.0.**_ -Starting in ASP.NET Core 5.0, nullability annotations have been applied to parts of the code. From the outset of this effort, [mistakes were expected](https://github.com/dotnet/runtime/blob/master/docs/coding-guidelines/api-guidelines/nullability.md#breaking-change-guidance) in these annotations and fixes would need to be made. In ASP.NET Core 6.0, some previously applied annotations are being updated. Some of these changes are considered source breaking changes. The changes lead to the APIs being incompatible or more restrictive. The updated APIs may result in build-time warnings when used in projects that have nullable reference types enabled. +Starting in ASP.NET Core 5.0, nullability annotations have been applied to parts of the code. From the outset of this effort, [mistakes were expected](https://github.com/dotnet/runtime/blob/main/docs/coding-guidelines/api-guidelines/nullability.md#breaking-change-guidance) in these annotations and fixes would need to be made. In ASP.NET Core 6.0, some previously applied annotations are being updated. Some of these changes are considered source breaking changes. The changes lead to the APIs being incompatible or more restrictive. The updated APIs may result in build-time warnings when used in projects that have nullable reference types enabled. For discussion, see GitHub issue [dotnet/aspnetcore#27564](https://github.com/dotnet/aspnetcore/issues/27564). diff --git a/docs/core/compatibility/code-analysis/5.0/ca1416-platform-compatibility-analyzer.md b/docs/core/compatibility/code-analysis/5.0/ca1416-platform-compatibility-analyzer.md index 3942519b861ca..1457e71e38265 100644 --- a/docs/core/compatibility/code-analysis/5.0/ca1416-platform-compatibility-analyzer.md +++ b/docs/core/compatibility/code-analysis/5.0/ca1416-platform-compatibility-analyzer.md @@ -105,7 +105,7 @@ If you don't want to fix all your call sites, you can choose one of the followin For Windows platform: -- All APIs listed at . +- All APIs listed at . - - - diff --git a/docs/core/compatibility/msbuild/5.0/publishdepsfilepath-behavior-change.md b/docs/core/compatibility/msbuild/5.0/publishdepsfilepath-behavior-change.md index 262ac3cd8aeeb..6b6066c7ae528 100644 --- a/docs/core/compatibility/msbuild/5.0/publishdepsfilepath-behavior-change.md +++ b/docs/core/compatibility/msbuild/5.0/publishdepsfilepath-behavior-change.md @@ -21,7 +21,7 @@ Starting in .NET 5, `PublishDepsFilePath` is empty for single-file applications This change was made for a couple of reasons: -- Due to a refactoring of the publish logic in order to support [improved single-file apps](https://github.com/dotnet/designs/blob/master/accepted/2020/single-file/design.md) in .NET 5. +- Due to a refactoring of the publish logic in order to support [improved single-file apps](https://github.com/dotnet/designs/blob/main/accepted/2020/single-file/design.md) in .NET 5. - In single-file apps, to help guard against targets that try to rewrite the *deps.json* file after *deps.json* has already been bundled, thus silently not affecting the app. For this reason, `PublishDepsFilePath` is empty for single-file applications. diff --git a/docs/core/dependency-loading/collect-details.md b/docs/core/dependency-loading/collect-details.md index 2c6d8a64f32c3..0ef2095c63270 100644 --- a/docs/core/dependency-loading/collect-details.md +++ b/docs/core/dependency-loading/collect-details.md @@ -30,7 +30,7 @@ The collected trace file can be viewed on Windows using the Events view in [Perf ## Example (on Windows) -This example uses the [assembly loading extension points sample](https://github.com/dotnet/samples/tree/master/core/extensions/AssemblyLoading). The application attempts to load an assembly `MyLibrary` - an assembly that is not referenced by the application and thus requires handling in an assembly loading extension point to be successfully loaded. +This example uses the [assembly loading extension points sample](https://github.com/dotnet/samples/tree/main/core/extensions/AssemblyLoading). The application attempts to load an assembly `MyLibrary` - an assembly that is not referenced by the application and thus requires handling in an assembly loading extension point to be successfully loaded. ### Collect the trace diff --git a/docs/core/deploying/deploy-with-cli.md b/docs/core/deploying/deploy-with-cli.md index 1e45c64e8e3b4..6abda7f4c53af 100644 --- a/docs/core/deploying/deploy-with-cli.md +++ b/docs/core/deploying/deploy-with-cli.md @@ -146,11 +146,11 @@ Whenever you use the `-r` switch, the output folder path changes to: `./bin/ [!NOTE] -> You can reduce the total size of your deployment by enabling **globalization invariant mode**. This mode is useful for applications that are not globally aware and that can use the formatting conventions, casing conventions, and string comparison and sort order of the [invariant culture](xref:System.Globalization.CultureInfo.InvariantCulture). For more information about **globalization invariant mode** and how to enable it, see [.NET Globalization Invariant Mode](https://github.com/dotnet/runtime/blob/master/docs/design/features/globalization-invariant-mode.md). +> You can reduce the total size of your deployment by enabling **globalization invariant mode**. This mode is useful for applications that are not globally aware and that can use the formatting conventions, casing conventions, and string comparison and sort order of the [invariant culture](xref:System.Globalization.CultureInfo.InvariantCulture). For more information about **globalization invariant mode** and how to enable it, see [.NET Globalization Invariant Mode](https://github.com/dotnet/runtime/blob/main/docs/design/features/globalization-invariant-mode.md). ## Self-contained deployment -When you publish a self-contained deployment (SCD), the .NET SDK creates a platform-specific executable. Publishing an SCD includes all required .NET files to run your app but it doesn't include the [native dependencies of .NET](https://github.com/dotnet/core/blob/master/Documentation/prereqs.md). These dependencies must be present on the system before the app runs. +When you publish a self-contained deployment (SCD), the .NET SDK creates a platform-specific executable. Publishing an SCD includes all required .NET files to run your app but it doesn't include the [native dependencies of .NET](https://github.com/dotnet/core/blob/main/Documentation/prereqs.md). These dependencies must be present on the system before the app runs. Publishing an SCD creates an app that doesn't roll forward to the latest available .NET security patch. For more information on version binding at compile time, see [Select the .NET version to use](../versions/selection.md#self-contained-deployments-include-the-selected-runtime). @@ -169,7 +169,7 @@ You must use the following switches with the `dotnet publish` command to publish | | 5.0 | `dotnet publish -c Release -r --self-contained true` | > [!NOTE] -> You can reduce the total size of your deployment by enabling **globalization invariant mode**. This mode is useful for applications that are not globally aware and that can use the formatting conventions, casing conventions, and string comparison and sort order of the [invariant culture](xref:System.Globalization.CultureInfo.InvariantCulture). For more information about **globalization invariant mode** and how to enable it, see [.NET Core Globalization Invariant Mode](https://github.com/dotnet/runtime/blob/master/docs/design/features/globalization-invariant-mode.md). +> You can reduce the total size of your deployment by enabling **globalization invariant mode**. This mode is useful for applications that are not globally aware and that can use the formatting conventions, casing conventions, and string comparison and sort order of the [invariant culture](xref:System.Globalization.CultureInfo.InvariantCulture). For more information about **globalization invariant mode** and how to enable it, see [.NET Core Globalization Invariant Mode](https://github.com/dotnet/runtime/blob/main/docs/design/features/globalization-invariant-mode.md). ## See also diff --git a/docs/core/deploying/deploy-with-vs.md b/docs/core/deploying/deploy-with-vs.md index c78f81ca78d9d..36e448fa8c2e5 100644 --- a/docs/core/deploying/deploy-with-vs.md +++ b/docs/core/deploying/deploy-with-vs.md @@ -88,7 +88,7 @@ Deploying a self-contained deployment with no third-party dependencies involves 1. Determine whether you want to use globalization invariant mode. - Particularly if your app targets Linux, you can reduce the total size of your deployment by taking advantage of [globalization invariant mode](https://github.com/dotnet/runtime/blob/master/docs/design/features/globalization-invariant-mode.md). Globalization invariant mode is useful for applications that are not globally aware and that can use the formatting conventions, casing conventions, and string comparison and sort order of the [invariant culture](xref:System.Globalization.CultureInfo.InvariantCulture). + Particularly if your app targets Linux, you can reduce the total size of your deployment by taking advantage of [globalization invariant mode](https://github.com/dotnet/runtime/blob/main/docs/design/features/globalization-invariant-mode.md). Globalization invariant mode is useful for applications that are not globally aware and that can use the formatting conventions, casing conventions, and string comparison and sort order of the [invariant culture](xref:System.Globalization.CultureInfo.InvariantCulture). To enable invariant mode, right-click on your project (not the solution) in **Solution Explorer**, and select **Edit SCD.csproj** or **Edit SCD.vbproj**. Then add the following highlighted lines to the file: diff --git a/docs/core/deploying/index.md b/docs/core/deploying/index.md index e763cce9db417..6bf4a99273735 100644 --- a/docs/core/deploying/index.md +++ b/docs/core/deploying/index.md @@ -123,7 +123,7 @@ Because you have to publish your app for each platform, you know where your app Because your app includes the .NET runtime and all of your app dependencies, the download size and hard drive space required is greater than a [framework-dependent](#publish-framework-dependent) version. > [!TIP] - > You can reduce the size of your deployment on Linux systems by approximately 28 MB by using .NET [*globalization invariant mode*](https://github.com/dotnet/runtime/blob/master/docs/design/features/globalization-invariant-mode.md). This forces your app to treat all cultures like the [invariant culture](xref:System.Globalization.CultureInfo.InvariantCulture?displayProperty=nameWithType). + > You can reduce the size of your deployment on Linux systems by approximately 28 MB by using .NET [*globalization invariant mode*](https://github.com/dotnet/runtime/blob/main/docs/design/features/globalization-invariant-mode.md). This forces your app to treat all cultures like the [invariant culture](xref:System.Globalization.CultureInfo.InvariantCulture?displayProperty=nameWithType). > [!TIP] > There is a [preview Trim feature](trim-self-contained.md) that can further reduce the size of your deployment. diff --git a/docs/core/deploying/trim-self-contained.md b/docs/core/deploying/trim-self-contained.md index 6d3d1b11ae857..0be64b7ef1679 100644 --- a/docs/core/deploying/trim-self-contained.md +++ b/docs/core/deploying/trim-self-contained.md @@ -13,7 +13,7 @@ The trim-self-contained deployment model is a specialized version of the self-co However, there is a risk that the build time analysis of the application can cause failures at runtime, due to not being able to reliably analyze various problematic code patterns (largely centered on reflection use). Because reliability can't be guaranteed, this deployment model is offered as a preview feature. -The build time analysis engine provides warnings to the developer of code patterns that are problematic to detect which other code is required. Code can be annotated with attributes to tell the trimmer what else to include. Many reflection patterns can be replaced with build-time code generation using [Source Generators](https://github.com/dotnet/roslyn/blob/master/docs/features/source-generators.md). +The build time analysis engine provides warnings to the developer of code patterns that are problematic to detect which other code is required. Code can be annotated with attributes to tell the trimmer what else to include. Many reflection patterns can be replaced with build-time code generation using [Source Generators](https://github.com/dotnet/roslyn/blob/main/docs/features/source-generators.md). The trim mode for the applications is configured with the `TrimMode` setting. The default value is `copyused` and bundles referenced assemblies with the application. The `link` value is used with Blazor WebAssembly applications and trims unused code within assemblies. Trim analysis warnings give information on code patterns where a full dependency analysis was not possible. These warnings are suppressed by default and can be turned on by setting the flag `SuppressTrimAnalysisWarnings` to `false`. For more information about the trim options available, see [Trimming options](trimming-options.md). diff --git a/docs/core/deploying/trimming-options.md b/docs/core/deploying/trimming-options.md index 438ea0d450684..53f453e7238b4 100644 --- a/docs/core/deploying/trimming-options.md +++ b/docs/core/deploying/trimming-options.md @@ -156,4 +156,4 @@ Several feature areas of the framework libraries come with linker directives tha Strip exception messages for `System.*` assemblies. When an exception is thrown from a `System.*` assembly, the message will be a simplified resource ID instead of the full message. - These properties will cause the related code to be trimmed and will also disable features via the [runtimeconfig](../run-time-config/index.md) file. For more information about these properties, including the corresponding runtimeconfig options, see [feature switches](https://github.com/dotnet/runtime/blob/master/docs/workflow/trimming/feature-switches.md). Some SDKs may have default values for these properties. + These properties will cause the related code to be trimmed and will also disable features via the [runtimeconfig](../run-time-config/index.md) file. For more information about these properties, including the corresponding runtimeconfig options, see [feature switches](https://github.com/dotnet/runtime/blob/main/docs/workflow/trimming/feature-switches.md). Some SDKs may have default values for these properties. diff --git a/docs/core/diagnostics/available-counters.md b/docs/core/diagnostics/available-counters.md index 9209713d56c68..22f58fa06b301 100644 --- a/docs/core/diagnostics/available-counters.md +++ b/docs/core/diagnostics/available-counters.md @@ -41,7 +41,7 @@ The following counters are published as part of .NET runtime (CoreCLR) and are m ## "Microsoft.AspNetCore.Hosting" counters -The following counters are published as part of [ASP.NET Core](/aspnet/core) and are maintained in [`HostingEventSource.cs`](https://github.com/dotnet/aspnetcore/blob/master/src/Hosting/Hosting/src/Internal/HostingEventSource.cs). +The following counters are published as part of [ASP.NET Core](/aspnet/core) and are maintained in [`HostingEventSource.cs`](https://github.com/dotnet/aspnetcore/blob/main/src/Hosting/Hosting/src/Internal/HostingEventSource.cs). | Counter | Description | |--|--| @@ -52,7 +52,7 @@ The following counters are published as part of [ASP.NET Core](/aspnet/core) and ## "Microsoft.AspNetCore.Http.Connections" counters -The following counters are published as part of [ASP.NET Core SignalR](/aspnet/core/signalr/introduction) and are maintained in [`HttpConnectionsEventSource.cs`](https://github.com/dotnet/aspnetcore/blob/master/src/SignalR/common/Http.Connections/src/Internal/HttpConnectionsEventSource.cs). +The following counters are published as part of [ASP.NET Core SignalR](/aspnet/core/signalr/introduction) and are maintained in [`HttpConnectionsEventSource.cs`](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/common/Http.Connections/src/Internal/HttpConnectionsEventSource.cs). | Counter | Description | |--|--| @@ -64,7 +64,7 @@ The following counters are published as part of [ASP.NET Core SignalR](/aspnet/c ## "Microsoft-AspNetCore-Server-Kestrel" counters -The following counters are published as part of the [ASP.NET Core Kestrel web server](/aspnet/core/fundamentals/servers/kestrel) and are maintained in [`KestrelEventSource.cs`](https://github.com/dotnet/aspnetcore/blob/master/src/Servers/Kestrel/Core/src/Internal/Infrastructure/KestrelEventSource.cs). +The following counters are published as part of the [ASP.NET Core Kestrel web server](/aspnet/core/fundamentals/servers/kestrel) and are maintained in [`KestrelEventSource.cs`](https://github.com/dotnet/aspnetcore/blob/main/src/Servers/Kestrel/Core/src/Internal/Infrastructure/KestrelEventSource.cs). | Counter | Description | |--|--| diff --git a/docs/core/diagnostics/debug-deadlock.md b/docs/core/diagnostics/debug-deadlock.md index fe69aac577c25..374cb9b012061 100644 --- a/docs/core/diagnostics/debug-deadlock.md +++ b/docs/core/diagnostics/debug-deadlock.md @@ -262,7 +262,7 @@ The second thread is similar. It's also trying to acquire a lock that it already - [dotnet-trace](dotnet-trace.md) to list processes - [dotnet-counters](dotnet-counters.md) to check managed memory usage - [dotnet-dump](dotnet-dump.md) to collect and analyze a dump file -- [dotnet/diagnostics](https://github.com/dotnet/diagnostics/tree/master/documentation/tutorial) +- [dotnet/diagnostics](https://github.com/dotnet/diagnostics/tree/main/documentation/tutorial) ## Next steps diff --git a/docs/core/diagnostics/debug-highcpu.md b/docs/core/diagnostics/debug-highcpu.md index 3ec619451635b..426153fe616ba 100644 --- a/docs/core/diagnostics/debug-highcpu.md +++ b/docs/core/diagnostics/debug-highcpu.md @@ -166,7 +166,7 @@ Open the `nettrace` with [`PerfView`](https://github.com/microsoft/perfview/blob - [dotnet-trace](dotnet-trace.md) to list processes - [dotnet-counters](dotnet-counters.md) to check managed memory usage - [dotnet-dump](dotnet-dump.md) to collect and analyze a dump file -- [dotnet/diagnostics](https://github.com/dotnet/diagnostics/tree/master/documentation/tutorial) +- [dotnet/diagnostics](https://github.com/dotnet/diagnostics/tree/main/documentation/tutorial) ## Next steps diff --git a/docs/core/diagnostics/debug-linux-dumps.md b/docs/core/diagnostics/debug-linux-dumps.md index 9af591f4b68b7..798b90413cb17 100644 --- a/docs/core/diagnostics/debug-linux-dumps.md +++ b/docs/core/diagnostics/debug-linux-dumps.md @@ -21,7 +21,7 @@ The [`dotnet-dump`](dotnet-dump.md) tool is simple to use, and does not have a d ### Core dumps with `createdump` -As an alternative to `dotnet-dump`, which creates managed-only dumps, [`createdump`](https://github.com/dotnet/runtime/blob/master/docs/design/coreclr/botr/xplat-minidump-generation.md) is the recommended tool for creating core dumps on Linux containing both native and managed information. Other tools like gdb or gcore can also be used to create core dumps but may miss state needed for managed debugging, resulting in "UNKNOWN" type or function names during analysis. +As an alternative to `dotnet-dump`, which creates managed-only dumps, [`createdump`](https://github.com/dotnet/runtime/blob/main/docs/design/coreclr/botr/xplat-minidump-generation.md) is the recommended tool for creating core dumps on Linux containing both native and managed information. Other tools like gdb or gcore can also be used to create core dumps but may miss state needed for managed debugging, resulting in "UNKNOWN" type or function names during analysis. The `createdump` tool is installed with the .NET Core runtime and can be found next to libcoreclr.so (typically in "/usr/share/dotnet/shared/Microsoft.NETCore.App/[version]"). The tool takes a process ID to collect a dump from as its primary argument and can also take optional parameters specifying what kind of dump to collect (a minidump with heap is the default). Options include: @@ -61,7 +61,7 @@ Collecting core dumps requires either the `SYS_PTRACE` capability or that `creat Both managed dumps collected with `dotnet-dump` and core dumps collected with `createdump` can be analyzed with the `dotnet-dump` tool using the `dotnet-dump analyze` command. The `dotnet dump` requires that the environment analyzing the dump has the same OS and architecture as the environment the dump was captured in. -Alternatively, [LLDB](https://lldb.llvm.org/) can be used to analyze core dumps on Linux, which allows analysis of both managed and native frames. LLDB uses the SOS extension to debug managed code. The [`dotnet-sos`](dotnet-sos.md) CLI tool can be used to install SOS, which has [many useful commands](https://github.com/dotnet/diagnostics/blob/master/documentation/sos-debugging-extension.md) for debugging managed code. In order to analyze .NET Core dumps, LLDB and SOS require the following .NET Core binaries from the environment the dump was created in: +Alternatively, [LLDB](https://lldb.llvm.org/) can be used to analyze core dumps on Linux, which allows analysis of both managed and native frames. LLDB uses the SOS extension to debug managed code. The [`dotnet-sos`](dotnet-sos.md) CLI tool can be used to install SOS, which has [many useful commands](https://github.com/dotnet/diagnostics/blob/main/documentation/sos-debugging-extension.md) for debugging managed code. In order to analyze .NET Core dumps, LLDB and SOS require the following .NET Core binaries from the environment the dump was created in: 1. libmscordaccore.so 2. libcoreclr.so @@ -77,11 +77,11 @@ lldb --core In the above command line, `` is the path of the dump to analyze and `` is the native program that started the .NET Core application. This is typically the `dotnet` binary unless the app is self-contained, in which case it is the name of the application without the dll extension. -Once LLDB starts, it may be necessary to use the `setsymbolserver` command to point at the correct symbol location (`setsymbolserver -ms` to use Microsoft's symbol server or `setsymbolserver -directory ` to specify a local path). Native symbols can be loaded by running `loadsymbols`. At this point, [SOS commands](https://github.com/dotnet/diagnostics/blob/master/documentation/sos-debugging-extension.md) can be used to analyze the dump. +Once LLDB starts, it may be necessary to use the `setsymbolserver` command to point at the correct symbol location (`setsymbolserver -ms` to use Microsoft's symbol server or `setsymbolserver -directory ` to specify a local path). Native symbols can be loaded by running `loadsymbols`. At this point, [SOS commands](https://github.com/dotnet/diagnostics/blob/main/documentation/sos-debugging-extension.md) can be used to analyze the dump. ## See also - [dotnet-sos](dotnet-sos.md) for more details on installing the SOS extension. - [dotnet-symbol](dotnet-symbol.md) for more details on installing and using the symbol download tool. -- [.NET Core diagnostics repo](https://github.com/dotnet/diagnostics/blob/master/documentation/) for more details on debugging, including a useful FAQ. -- [Installing LLDB](https://github.com/dotnet/diagnostics/blob/master/documentation/sos.md#getting-lldb) for instructions on installing LLDB on Linux or Mac. +- [.NET Core diagnostics repo](https://github.com/dotnet/diagnostics/blob/main/documentation/) for more details on debugging, including a useful FAQ. +- [Installing LLDB](https://github.com/dotnet/diagnostics/blob/main/documentation/sos.md#getting-lldb) for instructions on installing LLDB on Linux or Mac. diff --git a/docs/core/diagnostics/debug-memory-leak.md b/docs/core/diagnostics/debug-memory-leak.md index 15099323e39b0..9f0a523cb6ae8 100644 --- a/docs/core/diagnostics/debug-memory-leak.md +++ b/docs/core/diagnostics/debug-memory-leak.md @@ -233,7 +233,7 @@ You can also delete the dump file that was created. - [dotnet-trace](dotnet-trace.md) to list processes - [dotnet-counters](dotnet-counters.md) to check managed memory usage - [dotnet-dump](dotnet-dump.md) to collect and analyze a dump file -- [dotnet/diagnostics](https://github.com/dotnet/diagnostics/tree/master/documentation/tutorial) +- [dotnet/diagnostics](https://github.com/dotnet/diagnostics/tree/main/documentation/tutorial) - [Use Visual Studio to debug memory leaks](/visualstudio/profiling/memory-usage) ## Next steps diff --git a/docs/core/diagnostics/diagnostics-in-containers.md b/docs/core/diagnostics/diagnostics-in-containers.md index 5f0e1c48abd7a..a3c52757802d9 100644 --- a/docs/core/diagnostics/diagnostics-in-containers.md +++ b/docs/core/diagnostics/diagnostics-in-containers.md @@ -63,7 +63,7 @@ If you would like to run `PerfCollect` in one container to profile a .NET Core p **This tool applies to: ✔️** .NET Core 2.1 and later versions -An alternative to `dotnet-dump`, [`createdump`](https://github.com/dotnet/runtime/blob/master/docs/design/coreclr/botr/xplat-minidump-generation.md) can be used for creating core dumps on Linux containing both native and managed information. The `createdump` tool is installed with the .NET Core runtime and can be found next to libcoreclr.so (typically in "/usr/share/dotnet/shared/Microsoft.NETCore.App/[version]"). The tool works the same in a container as it does in non-containerized Linux environments with the single exception that the tool requires the [`SYS_PTRACE` capability](https://man7.org/linux/man-pages/man7/capabilities.7.html), so the Docker container must be [started with that capability](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities). +An alternative to `dotnet-dump`, [`createdump`](https://github.com/dotnet/runtime/blob/main/docs/design/coreclr/botr/xplat-minidump-generation.md) can be used for creating core dumps on Linux containing both native and managed information. The `createdump` tool is installed with the .NET Core runtime and can be found next to libcoreclr.so (typically in "/usr/share/dotnet/shared/Microsoft.NETCore.App/[version]"). The tool works the same in a container as it does in non-containerized Linux environments with the single exception that the tool requires the [`SYS_PTRACE` capability](https://man7.org/linux/man-pages/man7/capabilities.7.html), so the Docker container must be [started with that capability](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities). ### Using `createdump` in a sidecar container diff --git a/docs/core/diagnostics/dotnet-dump.md b/docs/core/diagnostics/dotnet-dump.md index fbf2da0f866da..3b46609b72b81 100644 --- a/docs/core/diagnostics/dotnet-dump.md +++ b/docs/core/diagnostics/dotnet-dump.md @@ -183,7 +183,7 @@ dotnet-dump analyze [-h|--help] [-c|--command] ## Using `dotnet-dump` -The first step is to collect a dump. This step can be skipped if a core dump has already been generated. The operating system or the .NET Core runtime's built-in [dump generation feature](https://github.com/dotnet/runtime/blob/master/docs/design/coreclr/botr/xplat-minidump-generation.md) can each create core dumps. +The first step is to collect a dump. This step can be skipped if a core dump has already been generated. The operating system or the .NET Core runtime's built-in [dump generation feature](https://github.com/dotnet/runtime/blob/main/docs/design/coreclr/botr/xplat-minidump-generation.md) can each create core dumps. ```console $ dotnet-dump collect --process-id 1902 diff --git a/docs/core/diagnostics/event-counters.md b/docs/core/diagnostics/event-counters.md index c84cbbda870e4..a68c1f9666b02 100644 --- a/docs/core/diagnostics/event-counters.md +++ b/docs/core/diagnostics/event-counters.md @@ -122,7 +122,7 @@ The uses the [!NOTE] > The is _not_ used by [dotnet-counters](dotnet-counters.md), and event listeners are not required to use it. -There are more counter implementations to use as a reference in the [.NET runtime](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Private.CoreLib/src/System/Diagnostics/Tracing/RuntimeEventSource.cs) repo. +There are more counter implementations to use as a reference in the [.NET runtime](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.CoreLib/src/System/Diagnostics/Tracing/RuntimeEventSource.cs) repo. ## Concurrency @@ -154,7 +154,7 @@ _requestRateCounter = new IncrementingPollingCounter("request-rate", this, () => There are two primary ways of consuming EventCounters, either in-proc, or out-of-proc. The consumption of EventCounters can be distinguished into three layers of various consuming technologies. - Transporting events in a raw stream via ETW or EventPipe: - - ETW APIs come with the Windows OS, and EventPipe is accessible as a [.NET API](https://github.com/dotnet/diagnostics/blob/master/documentation/design-docs/diagnostics-client-library.md#1-attaching-to-a-process-and-dumping-out-all-the-runtime-gc-events-in-real-time-to-the-console), or the diagnostic [IPC protocol](https://github.com/dotnet/diagnostics/blob/master/documentation/design-docs/ipc-protocol.md). + - ETW APIs come with the Windows OS, and EventPipe is accessible as a [.NET API](https://github.com/dotnet/diagnostics/blob/master/documentation/design-docs/diagnostics-client-library.md#1-attaching-to-a-process-and-dumping-out-all-the-runtime-gc-events-in-real-time-to-the-console), or the diagnostic [IPC protocol](https://github.com/dotnet/diagnostics/blob/main/documentation/design-docs/ipc-protocol.md). - Decoding the binary event stream into events: - The [TraceEvent library](https://www.nuget.org/packages/Microsoft.Diagnostics.Tracing.TraceEvent) handles both ETW and EventPipe stream formats. - Command-line and GUI tools: diff --git a/docs/core/diagnostics/eventpipe.md b/docs/core/diagnostics/eventpipe.md index 1e9249dfeaa5d..18f640b7509c6 100644 --- a/docs/core/diagnostics/eventpipe.md +++ b/docs/core/diagnostics/eventpipe.md @@ -17,7 +17,7 @@ This article is a high-level overview of EventPipe describing when and how to us EventPipe aggregates events emitted by runtime components - for example, the Just-In-Time compiler or the garbage collector - and events written from [EventSource](xref:System.Diagnostics.Tracing.EventSource) instances in the libraries and user code. -The events are then serialized and can be written directly to a file or consumed through a Diagnostics Port from out-of-proces. On Windows, Diagnostic Ports are implemented as `NamedPipe`s. On non-Windows platforms, such as Linux or macOS, it is implemented using Unix Domain Sockets. For more information about the Diagnostics Port and how to interact with it via its custom inter-process communication protocol, see the [diagnostics IPC protocol documentation](https://github.com/dotnet/diagnostics/blob/master/documentation/design-docs/ipc-protocol.md). +The events are then serialized and can be written directly to a file or consumed through a Diagnostics Port from out-of-proces. On Windows, Diagnostic Ports are implemented as `NamedPipe`s. On non-Windows platforms, such as Linux or macOS, it is implemented using Unix Domain Sockets. For more information about the Diagnostics Port and how to interact with it via its custom inter-process communication protocol, see the [diagnostics IPC protocol documentation](https://github.com/dotnet/diagnostics/blob/main/documentation/design-docs/ipc-protocol.md). EventPipe then writes the serialized events in the `.nettrace` file format, either as a stream via Diagnostic Ports or directly to a file. To learn more about the EventPipe serialization format, refer to the [EventPipe format documentation](https://github.com/microsoft/perfview/blob/master/src/TraceEvent/EventPipe/EventPipeFormat.md). @@ -44,7 +44,7 @@ You can use EventPipe to trace your .NET application in many ways: * Use one of the [diagnostics tools](#tools-that-use-eventpipe) that are built on top of EventPipe. -* Use [Microsoft.Diagnostics.NETCore.Client](https://github.com/dotnet/diagnostics/blob/master/documentation/diagnostics-client-library-instructions.md) library to write your own tool to configure and start EventPipe sessions yourself. +* Use [Microsoft.Diagnostics.NETCore.Client](https://github.com/dotnet/diagnostics/blob/main/documentation/diagnostics-client-library-instructions.md) library to write your own tool to configure and start EventPipe sessions yourself. * Use [environment variables](#trace-using-environment-variables) to start EventPipe. diff --git a/docs/core/diagnostics/trace-perfcollect-lttng.md b/docs/core/diagnostics/trace-perfcollect-lttng.md index e1be735270288..62640541a23db 100644 --- a/docs/core/diagnostics/trace-perfcollect-lttng.md +++ b/docs/core/diagnostics/trace-perfcollect-lttng.md @@ -220,7 +220,7 @@ With this change, you should get the symbols for all .NET code. Most of the time you are interested in your own code, which `perfcollect` resolves by default. Sometimes it is useful to see what is going on inside the .NET DLLs (which is what the last section was about), but sometimes what is going on in the native runtime dlls (typically libcoreclr.so), is interesting. `perfcollect` will resolve the symbols for these when it converts its data, but only if the symbols for these native DLLs are present (and are beside the library they are for). -There is a global command called [dotnet-symbol](https://github.com/dotnet/symstore/blob/master/src/dotnet-symbol/README.md#symbol-downloader-dotnet-cli-extension) that does this. To use dotnet-symbol to get native runtime symbols: +There is a global command called [dotnet-symbol](https://github.com/dotnet/symstore/blob/main/src/dotnet-symbol/README.md#symbol-downloader-dotnet-cli-extension) that does this. To use dotnet-symbol to get native runtime symbols: 1. Install `dotnet-symbol`: diff --git a/docs/core/extensions/console-log-formatter.md b/docs/core/extensions/console-log-formatter.md index 977eaa76ca26f..799981f489865 100644 --- a/docs/core/extensions/console-log-formatter.md +++ b/docs/core/extensions/console-log-formatter.md @@ -125,9 +125,9 @@ The preceding `CustomFormatter.Write` API dictates what text gets wrappe For inspiration on further customizing formatting, see the existing implementations in the `Microsoft.Extensions.Logging.Console` namespace: -- [SimpleConsoleFormatter](https://github.com/dotnet/runtime/blob/master/src/libraries/Microsoft.Extensions.Logging.Console/src/SimpleConsoleFormatter.cs). -- [SystemdConsoleFormatter](https://github.com/dotnet/runtime/blob/master/src/libraries/Microsoft.Extensions.Logging.Console/src/SystemdConsoleFormatter.cs) -- [JsonConsoleFormatter](https://github.com/dotnet/runtime/blob/master/src/libraries/Microsoft.Extensions.Logging.Console/src/JsonConsoleFormatter.cs) +- [SimpleConsoleFormatter](https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.Extensions.Logging.Console/src/SimpleConsoleFormatter.cs). +- [SystemdConsoleFormatter](https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.Extensions.Logging.Console/src/SystemdConsoleFormatter.cs) +- [JsonConsoleFormatter](https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.Extensions.Logging.Console/src/JsonConsoleFormatter.cs) ## Implement custom color formatting diff --git a/docs/core/install/includes/linux-rpm-install-dependencies.md b/docs/core/install/includes/linux-rpm-install-dependencies.md index e4dd8791f97e5..be83d2045bbc1 100644 --- a/docs/core/install/includes/linux-rpm-install-dependencies.md +++ b/docs/core/install/includes/linux-rpm-install-dependencies.md @@ -8,7 +8,7 @@ When you install with a package manager, these libraries are installed for you. If the target runtime environment's OpenSSL version is 1.1 or newer, you'll need to install **compat-openssl10**. -For more information about the dependencies, see [Self-contained Linux apps](https://github.com/dotnet/core/blob/master/Documentation/self-contained-linux-apps.md). +For more information about the dependencies, see [Self-contained Linux apps](https://github.com/dotnet/core/blob/main/Documentation/self-contained-linux-apps.md). For .NET Core apps that use the *System.Drawing.Common* assembly, you'll also need the following dependency: diff --git a/docs/core/install/linux-opensuse.md b/docs/core/install/linux-opensuse.md index 5651f976371c3..33747907c01b4 100644 --- a/docs/core/install/linux-opensuse.md +++ b/docs/core/install/linux-opensuse.md @@ -76,7 +76,7 @@ When you install with a package manager, these libraries are installed for you. If the target runtime environment's OpenSSL version is 1.1 or newer, you'll need to install **compat-openssl10**. -For more information about the dependencies, see [Self-contained Linux apps](https://github.com/dotnet/core/blob/master/Documentation/self-contained-linux-apps.md). +For more information about the dependencies, see [Self-contained Linux apps](https://github.com/dotnet/core/blob/main/Documentation/self-contained-linux-apps.md). For .NET apps that use the *System.Drawing.Common* assembly, you'll also need the following dependency: diff --git a/docs/core/install/linux-scripted-manual.md b/docs/core/install/linux-scripted-manual.md index 8d7643f3dcbf5..9bc3fa285ea78 100644 --- a/docs/core/install/linux-scripted-manual.md +++ b/docs/core/install/linux-scripted-manual.md @@ -40,7 +40,7 @@ It's possible that when you install .NET, specific dependencies may not be insta - [SLES](linux-sles.md#dependencies) - [Ubuntu](linux-ubuntu.md#dependencies) -For generic information about the dependencies, see [Self-contained Linux apps](https://github.com/dotnet/core/blob/master/Documentation/self-contained-linux-apps.md). +For generic information about the dependencies, see [Self-contained Linux apps](https://github.com/dotnet/core/blob/main/Documentation/self-contained-linux-apps.md). ### RPM dependencies diff --git a/docs/core/install/linux-sles.md b/docs/core/install/linux-sles.md index 4fe66f9a7744a..da39ff5c9a4b3 100644 --- a/docs/core/install/linux-sles.md +++ b/docs/core/install/linux-sles.md @@ -85,7 +85,7 @@ When you install with a package manager, these libraries are installed for you. If the target runtime environment's OpenSSL version is 1.1 or newer, you'll need to install **compat-openssl10**. -For more information about the dependencies, see [Self-contained Linux apps](https://github.com/dotnet/core/blob/master/Documentation/self-contained-linux-apps.md). +For more information about the dependencies, see [Self-contained Linux apps](https://github.com/dotnet/core/blob/main/Documentation/self-contained-linux-apps.md). For .NET apps that use the *System.Drawing.Common* assembly, you'll also need the following dependency: diff --git a/docs/core/install/macos.md b/docs/core/install/macos.md index 0fa5808b5af76..f406bbb206db2 100644 --- a/docs/core/install/macos.md +++ b/docs/core/install/macos.md @@ -72,11 +72,11 @@ The SDK is used to build and publish .NET apps and libraries. Installing the SDK | .NET Core Version | macOS | Architectures | More information | | ----------------- | --------------------- | --------------| --- | -| 5.0 | High Sierra (10.13+) | x64 | [More information](https://github.com/dotnet/core/blob/master/release-notes/5.0/5.0-supported-os.md) | -| 3.1 | High Sierra (10.13+) | x64 | [More information](https://github.com/dotnet/core/blob/master/release-notes/3.1/3.1-supported-os.md) | -| 3.0 | High Sierra (10.13+) | x64 | [More information](https://github.com/dotnet/core/blob/master/release-notes/3.0/3.0-supported-os.md) | -| 2.2 | Sierra (10.12+) | x64 | [More information](https://github.com/dotnet/core/blob/master/release-notes/2.2/2.2-supported-os.md) | -| 2.1 | Sierra (10.12+) | x64 | [More information](https://github.com/dotnet/core/blob/master/release-notes/2.1/2.1-supported-os.md) | +| 5.0 | High Sierra (10.13+) | x64 | [More information](https://github.com/dotnet/core/blob/main/release-notes/5.0/5.0-supported-os.md) | +| 3.1 | High Sierra (10.13+) | x64 | [More information](https://github.com/dotnet/core/blob/main/release-notes/3.1/3.1-supported-os.md) | +| 3.0 | High Sierra (10.13+) | x64 | [More information](https://github.com/dotnet/core/blob/main/release-notes/3.0/3.0-supported-os.md) | +| 2.2 | Sierra (10.12+) | x64 | [More information](https://github.com/dotnet/core/blob/main/release-notes/2.2/2.2-supported-os.md) | +| 2.1 | Sierra (10.12+) | x64 | [More information](https://github.com/dotnet/core/blob/main/release-notes/2.1/2.1-supported-os.md) | Beginning with macOS Catalina (version 10.15), all software built after June 1, 2019 that is distributed with Developer ID, must be notarized. This requirement applies to the .NET runtime, .NET SDK, and software created with .NET. @@ -189,7 +189,7 @@ Containers provide a lightweight way to isolate your application from the rest o Microsoft provides images that are tailored for specific scenarios. For example, the [ASP.NET Core repository](https://hub.docker.com/_/microsoft-dotnet-aspnet) provides images that are built for running ASP.NET Core apps in production. -For more information about using .NET Core in a Docker container, see [Introduction to .NET and Docker](../docker/introduction.md) and [Samples](https://github.com/dotnet/dotnet-docker/blob/master/samples/README.md). +For more information about using .NET Core in a Docker container, see [Introduction to .NET and Docker](../docker/introduction.md) and [Samples](https://github.com/dotnet/dotnet-docker/blob/main/samples/README.md). ## Next steps @@ -199,9 +199,9 @@ For more information about using .NET Core in a Docker container, see [Introduct - [Tutorial: Create a new app with Visual Studio Code](../tutorials/with-visual-studio-code.md). - [Tutorial: Containerize a .NET Core app](../docker/build-container.md). -[release-notes-21]: https://github.com/dotnet/core/blob/master/release-notes/2.1/2.1-supported-os.md -[release-notes-31]: https://github.com/dotnet/core/blob/master/release-notes/3.1/3.1-supported-os.md -[release-notes-50]: https://github.com/dotnet/core/blob/master/release-notes/5.0/5.0-supported-os.md -[release-notes-20]: https://github.com/dotnet/core/blob/master/release-notes/2.0/2.0-supported-os.md -[release-notes-22]: https://github.com/dotnet/core/blob/master/release-notes/2.2/2.2-supported-os.md -[release-notes-30]: https://github.com/dotnet/core/blob/master/release-notes/3.0/3.0-supported-os.md +[release-notes-21]: https://github.com/dotnet/core/blob/main/release-notes/2.1/2.1-supported-os.md +[release-notes-31]: https://github.com/dotnet/core/blob/main/release-notes/3.1/3.1-supported-os.md +[release-notes-50]: https://github.com/dotnet/core/blob/main/release-notes/5.0/5.0-supported-os.md +[release-notes-20]: https://github.com/dotnet/core/blob/main/release-notes/2.0/2.0-supported-os.md +[release-notes-22]: https://github.com/dotnet/core/blob/main/release-notes/2.2/2.2-supported-os.md +[release-notes-30]: https://github.com/dotnet/core/blob/main/release-notes/3.0/3.0-supported-os.md diff --git a/docs/core/install/windows.md b/docs/core/install/windows.md index 29b8afa896056..7337a9a9bf50b 100644 --- a/docs/core/install/windows.md +++ b/docs/core/install/windows.md @@ -97,7 +97,7 @@ The following Windows versions are supported with .NET 5.0: | Windows Server Core | 2012 R2+ | x64, x86 | | Nano Server | Version 1809+ | x64 | -For more information about .NET 5.0 supported operating systems, distributions, and lifecycle policy, see [.NET 5.0 Supported OS Versions](https://github.com/dotnet/core/blob/master/release-notes/5.0/5.0-supported-os.md). +For more information about .NET 5.0 supported operating systems, distributions, and lifecycle policy, see [.NET 5.0 Supported OS Versions](https://github.com/dotnet/core/blob/main/release-notes/5.0/5.0-supported-os.md). # [.NET Core 3.1](#tab/netcore31) @@ -113,7 +113,7 @@ The following Windows versions are supported with .NET Core 3.1: | Windows Server | 2012 R2+ | x64, x86 | | Nano Server | Version 1803+ | x64, ARM32 | -For more information about .NET Core 3.1 supported operating systems, distributions, and lifecycle policy, see [.NET Core 3.1 Supported OS Versions](https://github.com/dotnet/core/blob/master/release-notes/3.1/3.1-supported-os.md). +For more information about .NET Core 3.1 supported operating systems, distributions, and lifecycle policy, see [.NET Core 3.1 Supported OS Versions](https://github.com/dotnet/core/blob/main/release-notes/3.1/3.1-supported-os.md). # [.NET Core 3.0](#tab/netcore30) @@ -131,7 +131,7 @@ The following Windows versions are supported with .NET Core 3.0: | Windows Server | 2012 R2+ | x64, x86 | | Nano Server | Version 1803+ | x64, ARM32 | -For more information about .NET Core 3.0 supported operating systems, distributions, and lifecycle policy, see [.NET Core 3.0 Supported OS Versions](https://github.com/dotnet/core/blob/master/release-notes/3.0/3.0-supported-os.md). +For more information about .NET Core 3.0 supported operating systems, distributions, and lifecycle policy, see [.NET Core 3.0 Supported OS Versions](https://github.com/dotnet/core/blob/main/release-notes/3.0/3.0-supported-os.md). # [.NET Core 2.2](#tab/netcore22) @@ -149,7 +149,7 @@ The following Windows versions are supported with .NET Core 2.2: | Windows Server | 2008 R2 SP1+ | x64, x86 | | Nano Server | Version 1803+ | x64, ARM32 | -For more information about .NET Core 2.2 supported operating systems, distributions, and lifecycle policy, see [.NET Core 2.2 Supported OS Versions](https://github.com/dotnet/core/blob/master/release-notes/2.2/2.2-supported-os.md). +For more information about .NET Core 2.2 supported operating systems, distributions, and lifecycle policy, see [.NET Core 2.2 Supported OS Versions](https://github.com/dotnet/core/blob/main/release-notes/2.2/2.2-supported-os.md). # [.NET Core 2.1](#tab/netcore21) @@ -165,7 +165,7 @@ The following Windows versions are supported with .NET Core 2.1: | Windows Server | 2008 R2 SP1+ | x64, x86 | | Nano Server | Version 1803+ | x64, | -For more information about .NET Core 2.1 supported operating systems, distributions, and lifecycle policy, see [.NET Core 2.1 Supported OS Versions](https://github.com/dotnet/core/blob/master/release-notes/2.1/2.1-supported-os.md). +For more information about .NET Core 2.1 supported operating systems, distributions, and lifecycle policy, see [.NET Core 2.1 Supported OS Versions](https://github.com/dotnet/core/blob/main/release-notes/2.1/2.1-supported-os.md). ### Offline install for Windows 7 @@ -324,7 +324,7 @@ Containers provide a lightweight way to isolate your application from the rest o Microsoft provides images that are tailored for specific scenarios. For example, the [ASP.NET Core repository](https://hub.docker.com/_/microsoft-dotnet-aspnet) provides images that are built for running ASP.NET Core apps in production. -For more information about using .NET in a Docker container, see [Introduction to .NET and Docker](../docker/introduction.md) and [Samples](https://github.com/dotnet/dotnet-docker/blob/master/samples/README.md). +For more information about using .NET in a Docker container, see [Introduction to .NET and Docker](../docker/introduction.md) and [Samples](https://github.com/dotnet/dotnet-docker/blob/main/samples/README.md). ## Next steps diff --git a/docs/core/introduction.md b/docs/core/introduction.md index 7cf9e89b1f2eb..e3be30a3e42ab 100644 --- a/docs/core/introduction.md +++ b/docs/core/introduction.md @@ -48,13 +48,13 @@ Supported processor architectures include: .NET lets you use platform-specific capabilities, such as operating system APIs. Examples are Windows Forms and WPF on Windows and the native bindings to each mobile platform from Xamarin. -For more information, see [Supported OS lifecycle policy](https://github.com/dotnet/core/blob/master/os-lifecycle-policy.md) and [.NET RID Catalog](rid-catalog.md). +For more information, see [Supported OS lifecycle policy](https://github.com/dotnet/core/blob/main/os-lifecycle-policy.md) and [.NET RID Catalog](rid-catalog.md). ## Open source -.NET is open source, using [MIT and Apache 2 licenses](https://github.com/dotnet/runtime/blob/master/LICENSE.TXT). .NET is a project of the [.NET Foundation](https://dotnetfoundation.org/). +.NET is open source, using [MIT and Apache 2 licenses](https://github.com/dotnet/runtime/blob/main/LICENSE.TXT). .NET is a project of the [.NET Foundation](https://dotnetfoundation.org/). -For more information, see the [list of project repositories on GitHub.com](https://github.com/dotnet/core/blob/master/Documentation/core-repos.md). +For more information, see the [list of project repositories on GitHub.com](https://github.com/dotnet/core/blob/main/Documentation/core-repos.md). ## Support @@ -277,7 +277,7 @@ Here are some examples of types defined in the .NET runtime libraries: * [Serialization](../standard/serialization/index.md) utility types, such as and . * High-performance types, such as , , and [Pipelines](../standard/io/pipelines.md). -For more information, see the [Runtime libraries overview](../standard/runtime-libraries-overview.md). The source code for the libraries is in [the GitHub dotnet/runtime repository](https://github.com/dotnet/runtime/tree/master/src/libraries). +For more information, see the [Runtime libraries overview](../standard/runtime-libraries-overview.md). The source code for the libraries is in [the GitHub dotnet/runtime repository](https://github.com/dotnet/runtime/tree/main/src/libraries). ### Extensions to the runtime libraries diff --git a/docs/core/native-interop/expose-components-to-com.md b/docs/core/native-interop/expose-components-to-com.md index 0a67b5b3c3a09..85fcd25319090 100644 --- a/docs/core/native-interop/expose-components-to-com.md +++ b/docs/core/native-interop/expose-components-to-com.md @@ -82,7 +82,7 @@ The resulting output will now also have a `ProjectName.X.manifest` file. This fi ## Sample -There is a fully functional [COM server sample](https://github.com/dotnet/samples/tree/master/core/extensions/COMServerDemo) in the dotnet/samples repository on GitHub. +There is a fully functional [COM server sample](https://github.com/dotnet/samples/tree/main/core/extensions/COMServerDemo) in the dotnet/samples repository on GitHub. ## Additional notes diff --git a/docs/core/porting/cpp-cli.md b/docs/core/porting/cpp-cli.md index c50e76397930d..05bad25798d03 100644 --- a/docs/core/porting/cpp-cli.md +++ b/docs/core/porting/cpp-cli.md @@ -64,14 +64,14 @@ It's also possible to build C++/CLI projects without using MSBuild. Follow these 2. Reference necessary .NET Core reference assemblies. 3. When linking, provide the .NET Core app host directory as a `LibPath` (so that *ijwhost.lib* can be found). 4. Copy *ijwhost.dll* (from the .NET Core app host directory) to the project's output directory. -5. Make sure a [runtimeconfig.json](https://github.com/dotnet/cli/blob/master/Documentation/specs/runtime-configuration-file.md) file exists for the first component of the application that will run managed code. If the application has a managed entry point, a `runtime.config` file will be created and copied automatically. If the application has a native entry point, though, you need to create a `runtimeconfig.json` file for the first C++/CLI library to use the .NET Core runtime. +5. Make sure a [runtimeconfig.json](https://github.com/dotnet/cli/blob/main/Documentation/specs/runtime-configuration-file.md) file exists for the first component of the application that will run managed code. If the application has a managed entry point, a `runtime.config` file will be created and copied automatically. If the application has a native entry point, though, you need to create a `runtimeconfig.json` file for the first C++/CLI library to use the .NET Core runtime. ## Known issues There are a couple known issues to look out for when working with C++/CLI projects targeting .NET Core. * A WPF framework reference in .NET Core C++/CLI projects currently causes some extraneous warnings about being unable to import symbols. These warnings can be safely ignored and should be fixed soon. -* If the application has a native entry point, the C++/CLI library that first executes managed code needs a [runtimeconfig.json](https://github.com/dotnet/cli/blob/master/Documentation/specs/runtime-configuration-file.md) file. This config file is used when the .NET Core runtime starts. C++/CLI projects don't create `runtimeconfig.json` files automatically at build time yet, so the file must be generated manually. If a C++/CLI library is called from a managed entry point, then the C++/CLI library doesn't need a `runtimeconfig.json` file (since the entry point assembly will have one that is used when starting the runtime). A simple sample `runtimeconfig.json` file is shown below. For more information, see the [spec on GitHub](https://github.com/dotnet/cli/blob/master/Documentation/specs/runtime-configuration-file.md). +* If the application has a native entry point, the C++/CLI library that first executes managed code needs a [runtimeconfig.json](https://github.com/dotnet/cli/blob/master/Documentation/specs/runtime-configuration-file.md) file. This config file is used when the .NET Core runtime starts. C++/CLI projects don't create `runtimeconfig.json` files automatically at build time yet, so the file must be generated manually. If a C++/CLI library is called from a managed entry point, then the C++/CLI library doesn't need a `runtimeconfig.json` file (since the entry point assembly will have one that is used when starting the runtime). A simple sample `runtimeconfig.json` file is shown below. For more information, see the [spec on GitHub](https://github.com/dotnet/cli/blob/main/Documentation/specs/runtime-configuration-file.md). ```json { diff --git a/docs/core/porting/libraries.md b/docs/core/porting/libraries.md index 3167f2bd83856..f4067334a5961 100644 --- a/docs/core/porting/libraries.md +++ b/docs/core/porting/libraries.md @@ -111,7 +111,7 @@ The best way to make sure everything works when you've ported your code is to te - [xUnit](https://xunit.net/) - [Getting Started](https://xunit.net/docs/getting-started/netcore/cmdline) - - [Tool to convert an MSTest project to xUnit](https://github.com/dotnet/codeformatter/tree/master/src/XUnitConverter) + - [Tool to convert an MSTest project to xUnit](https://github.com/dotnet/codeformatter/tree/main/src/XUnitConverter) - [NUnit](https://nunit.org/) - [Getting Started](https://github.com/nunit/docs/wiki/Installation) - [Blog post about migrating from MSTest to NUnit](https://www.florian-rappl.de/News/Page/275/convert-mstest-to-nunit) diff --git a/docs/core/porting/net-framework-tech-unavailable.md b/docs/core/porting/net-framework-tech-unavailable.md index 6a2951160f61b..6dc77307f086a 100644 --- a/docs/core/porting/net-framework-tech-unavailable.md +++ b/docs/core/porting/net-framework-tech-unavailable.md @@ -15,7 +15,7 @@ For more information on API compatibility, see [Breaking changes in .NET](../com Application domains (AppDomains) isolate apps from one another. AppDomains require runtime support and are resource-expensive. Creating more app domains isn't supported, and there are no plans to add this capability in the future. For code isolation, use separate processes or containers as an alternative. To dynamically load assemblies, use the class. -To make code migration from .NET Framework easier, .NET 5+ exposes some of the API surface. Some of the APIs function normally (for example, ), some members do nothing (for example, ), and some of them throw (for example, ). Check the types you use against the [`System.AppDomain` reference source](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Private.CoreLib/src/System/AppDomain.cs) in the [dotnet/runtime GitHub repository](https://github.com/dotnet/runtime). Make sure to select the branch that matches your implemented version. +To make code migration from .NET Framework easier, .NET 5+ exposes some of the API surface. Some of the APIs function normally (for example, ), some members do nothing (for example, ), and some of them throw (for example, ). Check the types you use against the [`System.AppDomain` reference source](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.CoreLib/src/System/AppDomain.cs) in the [dotnet/runtime GitHub repository](https://github.com/dotnet/runtime). Make sure to select the branch that matches your implemented version. ## Remoting diff --git a/docs/core/porting/project-structure.md b/docs/core/porting/project-structure.md index b176329f3b444..9a3e9574119fe 100644 --- a/docs/core/porting/project-structure.md +++ b/docs/core/porting/project-structure.md @@ -31,7 +31,7 @@ Consider the repository below: ![Existing project](./media/project-structure/existing-project-structure.png) -[**Source Code**](https://github.com/dotnet/samples/tree/master/framework/libraries/migrate-library/) +[**Source Code**](https://github.com/dotnet/samples/tree/main/framework/libraries/migrate-library/) The following describes several ways to add support for .NET Core for this repository depending on the constraints and complexity of the existing projects. @@ -41,11 +41,11 @@ Reorganize the repository so that any existing *\*.csproj* files are removed and ![Create a csproj that targets multiple frameworks](./media/project-structure/multi-targeted-project.png) -[**Source Code**](https://github.com/dotnet/samples/tree/master/framework/libraries/migrate-library-csproj/) +[**Source Code**](https://github.com/dotnet/samples/tree/main/framework/libraries/migrate-library-csproj/) Changes to note are: -- Replacement of *packages.config* and *\*.csproj* with a new [.NET Core *\*.csproj*](https://github.com/dotnet/samples/tree/master/framework/libraries/migrate-library-csproj/src/Car/Car.csproj). NuGet packages are specified with ` ItemGroup`. +- Replacement of *packages.config* and *\*.csproj* with a new [.NET Core *\*.csproj*](https://github.com/dotnet/samples/tree/main/framework/libraries/migrate-library-csproj/src/Car/Car.csproj). NuGet packages are specified with ` ItemGroup`. ## Keep existing projects and create a .NET Core project @@ -53,7 +53,7 @@ If there are existing projects that target older frameworks, you may want to lea ![.NET Core project with existing project in different folder](./media/project-structure/separate-projects-same-source.png) -[**Source Code**](https://github.com/dotnet/samples/tree/master/framework/libraries/migrate-library-csproj-keep-existing/) +[**Source Code**](https://github.com/dotnet/samples/tree/main/framework/libraries/migrate-library-csproj-keep-existing/) The .NET Core and existing projects are kept in separate folders. Keeping projects in separate folders avoids forcing you to have Visual Studio 2017 or later versions. You can create a separate solution that only opens the old projects. diff --git a/docs/core/porting/windows-compat-pack.md b/docs/core/porting/windows-compat-pack.md index 770f59a51dfc4..2a240260c7521 100644 --- a/docs/core/porting/windows-compat-pack.md +++ b/docs/core/porting/windows-compat-pack.md @@ -34,7 +34,7 @@ It provides about 20,000 APIs, including Windows-only and cross-platform APIs fr - Windows Runtime Caching - Windows Services -For more information, see the [specification of the compatibility pack](https://github.com/dotnet/designs/blob/master/accepted/2018/compat-pack/compat-pack.md). +For more information, see the [specification of the compatibility pack](https://github.com/dotnet/designs/blob/main/accepted/2018/compat-pack/compat-pack.md). ## Get started diff --git a/docs/core/project-sdk/overview.md b/docs/core/project-sdk/overview.md index 0a9d56a6bbdb7..17582e9293bd0 100644 --- a/docs/core/project-sdk/overview.md +++ b/docs/core/project-sdk/overview.md @@ -220,7 +220,7 @@ The following XML is a snippet from a *.csproj* file that instructs the [`dotnet To consume a custom target in your project, add a `PackageReference` element that points to the package and its version. Unlike the tools, the custom targets package is included in the consuming project's dependency closure. -You can configure how to use the custom target. Since it's an MSBuild target, it can depend on a given target, run after another target, or be manually invoked by using the `dotnet msbuild -t:` command. However, to provide a better user experience, you can combine per-project tools and custom targets. In this scenario, the per-project tool accepts whatever parameters are needed and translates that into the required [`dotnet msbuild`](../tools/dotnet-msbuild.md) invocation that executes the target. You can see a sample of this kind of synergy on the [MVP Summit 2016 Hackathon samples](https://github.com/dotnet/MVPSummitHackathon2016) repo in the [`dotnet-packer`](https://github.com/dotnet/MVPSummitHackathon2016/tree/master/dotnet-packer) project. +You can configure how to use the custom target. Since it's an MSBuild target, it can depend on a given target, run after another target, or be manually invoked by using the `dotnet msbuild -t:` command. However, to provide a better user experience, you can combine per-project tools and custom targets. In this scenario, the per-project tool accepts whatever parameters are needed and translates that into the required [`dotnet msbuild`](../tools/dotnet-msbuild.md) invocation that executes the target. You can see a sample of this kind of synergy on the [MVP Summit 2016 Hackathon samples](https://github.com/dotnet/MVPSummitHackathon2016) repo in the [`dotnet-packer`](https://github.com/dotnet/MVPSummitHackathon2016/tree/main/dotnet-packer) project. ## See also diff --git a/docs/core/releases-and-support.md b/docs/core/releases-and-support.md index ad0677da26ca5..5e455b1646867 100644 --- a/docs/core/releases-and-support.md +++ b/docs/core/releases-and-support.md @@ -99,7 +99,7 @@ End of support refers to the date after which Microsoft no longer provides fixes When an operating system version goes out of support, we stop testing that version and providing support for that version. Users need to move forward to a supported operating system version to get support. -For more information, see the [.NET OS Lifecycle Policy](https://github.com/dotnet/core/blob/master/os-lifecycle-policy.md). +For more information, see the [.NET OS Lifecycle Policy](https://github.com/dotnet/core/blob/main/os-lifecycle-policy.md). ## Get support diff --git a/docs/core/rid-catalog.md b/docs/core/rid-catalog.md index b9a269016b70b..338234dd5e91e 100644 --- a/docs/core/rid-catalog.md +++ b/docs/core/rid-catalog.md @@ -33,7 +33,7 @@ RIDs that represent concrete operating systems usually follow this pattern: `[os ## RID graph -The RID graph or runtime fallback graph is a list of RIDs that are compatible with each other. The RIDs are defined in the [Microsoft.NETCore.Platforms](https://www.nuget.org/packages/Microsoft.NETCore.Platforms/) package. You can see the list of supported RIDs and the RID graph in the [*runtime.json*](https://github.com/dotnet/runtime/blob/master/src/libraries/Microsoft.NETCore.Platforms/pkg/runtime.json) file, which is located in the `dotnet/runtime` repository. In this file, you can see that all RIDs, except for the base one, contain an `"#import"` statement. These statements indicate compatible RIDs. +The RID graph or runtime fallback graph is a list of RIDs that are compatible with each other. The RIDs are defined in the [Microsoft.NETCore.Platforms](https://www.nuget.org/packages/Microsoft.NETCore.Platforms/) package. You can see the list of supported RIDs and the RID graph in the [*runtime.json*](https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.NETCore.Platforms/pkg/runtime.json) file, which is located in the `dotnet/runtime` repository. In this file, you can see that all RIDs, except for the base one, contain an `"#import"` statement. These statements indicate compatible RIDs. When NuGet restores packages, it tries to find an exact match for the specified runtime. If an exact match is not found, NuGet walks back the graph until it finds the closest compatible system according to the RID graph. @@ -74,7 +74,7 @@ There are some considerations about RIDs that you have to keep in mind when work ## Using RIDs To be able to use RIDs, you have to know which RIDs exist. New values are added regularly to the platform. -For the latest and complete version, see the [runtime.json](https://github.com/dotnet/runtime/blob/master/src/libraries/Microsoft.NETCore.Platforms/pkg/runtime.json) file in the `dotnet/runtime` repository. +For the latest and complete version, see the [runtime.json](https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.NETCore.Platforms/pkg/runtime.json) file in the `dotnet/runtime` repository. Portable RIDs are values added to the RID graph that aren't tied to a specific version or OS distribution. They are the preferred choice, especially when dealing with multiple Linux distros since most distribution RIDs are mapped to the portable RIDs. @@ -82,7 +82,7 @@ The following list shows a small subset of the most common RIDs used for each OS ## Windows RIDs -Only common values are listed. For the latest and complete version, see the [runtime.json](https://github.com/dotnet/runtime/blob/master/src/libraries/Microsoft.NETCore.Platforms/pkg/runtime.json) file in the `dotnet/runtime` repository. +Only common values are listed. For the latest and complete version, see the [runtime.json](https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.NETCore.Platforms/pkg/runtime.json) file in the `dotnet/runtime` repository. - Portable - `win-x64` @@ -106,7 +106,7 @@ For more information, see [.NET dependencies and requirements](./install/windows ## Linux RIDs -Only common values are listed. For the latest and complete version, see the [runtime.json](https://github.com/dotnet/runtime/blob/master/src/libraries/Microsoft.NETCore.Platforms/pkg/runtime.json) file in the `dotnet/runtime` repository. Devices running a distribution not listed below may work with one of the Portable RIDs. For example, Raspberry Pi devices running a Linux distribution not listed can be targeted with `linux-arm`. +Only common values are listed. For the latest and complete version, see the [runtime.json](https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.NETCore.Platforms/pkg/runtime.json) file in the `dotnet/runtime` repository. Devices running a distribution not listed below may work with one of the Portable RIDs. For example, Raspberry Pi devices running a Linux distribution not listed can be targeted with `linux-arm`. - Portable - `linux-x64` (Most desktop distributions like CentOS, Debian, Fedora, Ubuntu, and derivatives) @@ -125,7 +125,7 @@ For more information, see [.NET dependencies and requirements](./install/linux.m ## macOS RIDs -macOS RIDs use the older "OSX" branding. Only common values are listed. For the latest and complete version, see the [runtime.json](https://github.com/dotnet/runtime/blob/master/src/libraries/Microsoft.NETCore.Platforms/pkg/runtime.json) file in the `dotnet/runtime` repository. +macOS RIDs use the older "OSX" branding. Only common values are listed. For the latest and complete version, see the [runtime.json](https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.NETCore.Platforms/pkg/runtime.json) file in the `dotnet/runtime` repository. - Portable - `osx-x64` (Minimum OS version is macOS 10.12 Sierra) @@ -149,4 +149,4 @@ For more information, see [.NET dependencies and requirements](./install/macos.m ## See also -- [Runtime IDs](https://github.com/dotnet/runtime/blob/master/src/libraries/Microsoft.NETCore.Platforms/readme.md) +- [Runtime IDs](https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.NETCore.Platforms/readme.md) diff --git a/docs/core/run-time-config/compilation.md b/docs/core/run-time-config/compilation.md index 65b8894e71a70..03560ded1148f 100644 --- a/docs/core/run-time-config/compilation.md +++ b/docs/core/run-time-config/compilation.md @@ -13,7 +13,7 @@ ms.topic: reference - The second tier generates optimized code in the background ("optimizing JIT"). - In .NET Core 3.0 and later, tiered compilation is enabled by default. - In .NET Core 2.1 and 2.2, tiered compilation is disabled by default. -- For more information, see the [Tiered compilation guide](https://github.com/dotnet/runtime/blob/master/docs/design/features/tiered-compilation.md). +- For more information, see the [Tiered compilation guide](https://github.com/dotnet/runtime/blob/main/docs/design/features/tiered-compilation.md). | | Setting name | Values | | - | - | - | diff --git a/docs/core/run-time-config/debugging-profiling.md b/docs/core/run-time-config/debugging-profiling.md index a23ff66259c6c..38fee6d079452 100644 --- a/docs/core/run-time-config/debugging-profiling.md +++ b/docs/core/run-time-config/debugging-profiling.md @@ -39,7 +39,7 @@ ms.topic: reference - Specifies the path to the profiler DLL to load into the currently running process (or 32-bit or 64-bit process). - If more than one variable is set, the bitness-specific variables take precedence. They specify which bitness of profiler to load. -- For more information, see [Finding the profiler library](https://github.com/dotnet/runtime/blob/master/docs/design/coreclr/profiling/Profiler%20Loading.md). +- For more information, see [Finding the profiler library](https://github.com/dotnet/runtime/blob/main/docs/design/coreclr/profiling/Profiler%20Loading.md). | | Setting name | Values | | - | - | - | diff --git a/docs/core/run-time-config/garbage-collector.md b/docs/core/run-time-config/garbage-collector.md index 48920901e371d..040da57b001a7 100644 --- a/docs/core/run-time-config/garbage-collector.md +++ b/docs/core/run-time-config/garbage-collector.md @@ -466,7 +466,7 @@ Example: ## Standalone GC - Specifies a path to the library containing the garbage collector that the runtime intends to load. -- For more information, see [Standalone GC loader design](https://github.com/dotnet/runtime/blob/master/docs/design/features/standalone-gc-loading.md). +- For more information, see [Standalone GC loader design](https://github.com/dotnet/runtime/blob/main/docs/design/features/standalone-gc-loading.md). | | Setting name | Values | Version introduced | | - | - | - | - | diff --git a/docs/core/run-time-config/globalization.md b/docs/core/run-time-config/globalization.md index 3421536d48825..f04968fa8d01c 100644 --- a/docs/core/run-time-config/globalization.md +++ b/docs/core/run-time-config/globalization.md @@ -10,7 +10,7 @@ ms.topic: reference - Determines whether a .NET Core app runs in globalization-invariant mode without access to culture-specific data and behavior. - If you omit this setting, the app runs with access to cultural data. This is equivalent to setting the value to `false`. -- For more information, see [.NET Core globalization invariant mode](https://github.com/dotnet/runtime/blob/master/docs/design/features/globalization-invariant-mode.md). +- For more information, see [.NET Core globalization invariant mode](https://github.com/dotnet/runtime/blob/main/docs/design/features/globalization-invariant-mode.md). | | Setting name | Values | | - | - | - | diff --git a/docs/core/testing/unit-testing-fsharp-with-dotnet-test.md b/docs/core/testing/unit-testing-fsharp-with-dotnet-test.md index 5396e0f76936d..1fc72be04b8b2 100644 --- a/docs/core/testing/unit-testing-fsharp-with-dotnet-test.md +++ b/docs/core/testing/unit-testing-fsharp-with-dotnet-test.md @@ -7,7 +7,7 @@ ms.date: 08/30/2017 --- # Unit testing F# libraries in .NET Core using dotnet test and xUnit -This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/master/core/getting-started/unit-testing-with-fsharp/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). +This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/main/core/getting-started/unit-testing-with-fsharp/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). [!INCLUDE [testing an ASP.NET Core project from .NET Core](../../../includes/core-testing-note-aspnet.md)] @@ -62,7 +62,7 @@ The test project requires other packages to create and run unit tests. `dotnet n dotnet add reference ../MathService/MathService.fsproj ``` -You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-with-fsharp/MathService.Tests/MathService.Tests.fsproj) on GitHub. +You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-with-fsharp/MathService.Tests/MathService.Tests.fsproj) on GitHub. You have the following final solution layout: diff --git a/docs/core/testing/unit-testing-fsharp-with-mstest.md b/docs/core/testing/unit-testing-fsharp-with-mstest.md index 98bc00145808c..52dcde1bf9f10 100644 --- a/docs/core/testing/unit-testing-fsharp-with-mstest.md +++ b/docs/core/testing/unit-testing-fsharp-with-mstest.md @@ -7,7 +7,7 @@ ms.date: 08/30/2017 --- # Unit testing F# libraries in .NET Core using dotnet test and MSTest -This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/master/core/getting-started/unit-testing-with-fsharp-mstest/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). +This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/main/core/getting-started/unit-testing-with-fsharp-mstest/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). [!INCLUDE [testing an ASP.NET Core project from .NET Core](../../../includes/core-testing-note-aspnet.md)] @@ -62,7 +62,7 @@ The test project requires other packages to create and run unit tests. `dotnet n dotnet add reference ../MathService/MathService.fsproj ``` -You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-with-fsharp/MathService.Tests/MathService.Tests.fsproj) on GitHub. +You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-with-fsharp/MathService.Tests/MathService.Tests.fsproj) on GitHub. You have the following final solution layout: diff --git a/docs/core/testing/unit-testing-fsharp-with-nunit.md b/docs/core/testing/unit-testing-fsharp-with-nunit.md index 3026b9adcd059..0fed4070d20a2 100644 --- a/docs/core/testing/unit-testing-fsharp-with-nunit.md +++ b/docs/core/testing/unit-testing-fsharp-with-nunit.md @@ -8,7 +8,7 @@ dev_langs: --- # Unit testing F# libraries in .NET Core using dotnet test and NUnit -This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/master/core/getting-started/unit-testing-with-fsharp-nunit/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). +This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/main/core/getting-started/unit-testing-with-fsharp-nunit/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). [!INCLUDE [testing an ASP.NET Core project from .NET Core](../../../includes/core-testing-note-aspnet.md)] @@ -88,7 +88,7 @@ The test project requires other packages to create and run unit tests. `dotnet n dotnet add reference ../MathService/MathService.fsproj ``` -You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-with-fsharp/MathService.Tests/MathService.Tests.fsproj) on GitHub. +You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-with-fsharp/MathService.Tests/MathService.Tests.fsproj) on GitHub. You have the following final solution layout: diff --git a/docs/core/testing/unit-testing-visual-basic-with-dotnet-test.md b/docs/core/testing/unit-testing-visual-basic-with-dotnet-test.md index a04f1c18ee893..eb58de11574d7 100644 --- a/docs/core/testing/unit-testing-visual-basic-with-dotnet-test.md +++ b/docs/core/testing/unit-testing-visual-basic-with-dotnet-test.md @@ -7,7 +7,7 @@ ms.date: 05/18/2020 --- # Unit testing Visual Basic .NET Core libraries using dotnet test and xUnit -This tutorial shows how to build a solution containing a unit test project and library project. To follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/master/core/getting-started/unit-testing-using-dotnet-test/). For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). +This tutorial shows how to build a solution containing a unit test project and library project. To follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/main/core/getting-started/unit-testing-using-dotnet-test/). For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). ## Create the solution @@ -216,7 +216,7 @@ Public Function IsPrime(candidate As Integer) As Boolean End Function ``` -Following the TDD approach, add more failing tests, then update the target code. See the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-dotnet-test/PrimeService.Tests/PrimeService_IsPrimeShould.vb) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-dotnet-test/PrimeService/PrimeService.vb). +Following the TDD approach, add more failing tests, then update the target code. See the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-dotnet-test/PrimeService.Tests/PrimeService_IsPrimeShould.vb) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-dotnet-test/PrimeService/PrimeService.vb). The completed `IsPrime` method is not an efficient algorithm for testing primality. diff --git a/docs/core/testing/unit-testing-visual-basic-with-mstest.md b/docs/core/testing/unit-testing-visual-basic-with-mstest.md index 1fa36600c6855..f14f7281907a7 100644 --- a/docs/core/testing/unit-testing-visual-basic-with-mstest.md +++ b/docs/core/testing/unit-testing-visual-basic-with-mstest.md @@ -7,7 +7,7 @@ ms.date: 09/01/2017 --- # Unit testing Visual Basic .NET Core libraries using dotnet test and MSTest -This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/master/core/getting-started/unit-testing-vb-mstest/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). +This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/main/core/getting-started/unit-testing-vb-mstest/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). [!INCLUDE [testing an ASP.NET Core project from .NET Core](../../../includes/core-testing-note-aspnet.md)] @@ -67,7 +67,7 @@ The test project requires other packages to create and run unit tests. `dotnet n dotnet add reference ../PrimeService/PrimeService.vbproj ``` -You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-mstest/PrimeService.Tests/PrimeService.Tests.vbproj) on GitHub. +You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-mstest/PrimeService.Tests/PrimeService.Tests.vbproj) on GitHub. You have the following final solution layout: @@ -136,6 +136,6 @@ Run `dotnet test`, and two of these tests fail. To make all of the tests pass, c if candidate < 2 ``` -Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-mstest/PrimeService.Tests/PrimeService_IsPrimeShould.vb) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-mstest/PrimeService/PrimeService.vb). +Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-mstest/PrimeService.Tests/PrimeService_IsPrimeShould.vb) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-mstest/PrimeService/PrimeService.vb). You've built a small library and a set of unit tests for that library. You've structured the solution so that adding new packages and tests is part of the normal workflow. You've concentrated most of your time and effort on solving the goals of the application. diff --git a/docs/core/testing/unit-testing-visual-basic-with-nunit.md b/docs/core/testing/unit-testing-visual-basic-with-nunit.md index 836aac644e1fc..5db9435bb1b85 100644 --- a/docs/core/testing/unit-testing-visual-basic-with-nunit.md +++ b/docs/core/testing/unit-testing-visual-basic-with-nunit.md @@ -6,7 +6,7 @@ ms.date: 10/04/2018 --- # Unit testing Visual Basic .NET Core libraries using dotnet test and NUnit -This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/master/core/getting-started/unit-testing-vb-nunit/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). +This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/main/core/getting-started/unit-testing-vb-nunit/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). [!INCLUDE [testing an ASP.NET Core project from .NET Core](../../../includes/core-testing-note-aspnet.md)] @@ -84,7 +84,7 @@ The test project requires other packages to create and run unit tests. `dotnet n dotnet add reference ../PrimeService/PrimeService.vbproj ``` -You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-nunit/PrimeService.Tests/PrimeService.Tests.vbproj) on GitHub. +You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-nunit/PrimeService.Tests/PrimeService.Tests.vbproj) on GitHub. You have the following final solution layout: @@ -157,6 +157,6 @@ Run `dotnet test`, and two of these tests fail. To make all of the tests pass, c if candidate < 2 ``` -Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-nunit/PrimeService.Tests/PrimeService_IsPrimeShould.vb) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-nunit/PrimeService/PrimeService.vb). +Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-nunit/PrimeService.Tests/PrimeService_IsPrimeShould.vb) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-nunit/PrimeService/PrimeService.vb). You've built a small library and a set of unit tests for that library. You've structured the solution so that adding new packages and tests is part of the normal workflow. You've concentrated most of your time and effort on solving the goals of the application. diff --git a/docs/core/testing/unit-testing-with-dotnet-test.md b/docs/core/testing/unit-testing-with-dotnet-test.md index 99b7e7ea8f107..c7459f58f0a4a 100644 --- a/docs/core/testing/unit-testing-with-dotnet-test.md +++ b/docs/core/testing/unit-testing-with-dotnet-test.md @@ -7,7 +7,7 @@ ms.date: 10/21/2020 --- # Unit testing C# in .NET Core using dotnet test and xUnit -This tutorial shows how to build a solution containing a unit test project and source code project. To follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/master/core/getting-started/unit-testing-using-dotnet-test/). For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). +This tutorial shows how to build a solution containing a unit test project and source code project. To follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/tree/main/core/getting-started/unit-testing-using-dotnet-test/). For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). ## Create the solution @@ -213,7 +213,7 @@ public bool IsPrime(int candidate) } ``` -Following the TDD approach, add more failing tests, then update the target code. See the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-dotnet-test/PrimeService.Tests/PrimeService_IsPrimeShould.cs) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-dotnet-test/PrimeService/PrimeService.cs). +Following the TDD approach, add more failing tests, then update the target code. See the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-dotnet-test/PrimeService.Tests/PrimeService_IsPrimeShould.cs) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-dotnet-test/PrimeService/PrimeService.cs). The completed `IsPrime` method is not an efficient algorithm for testing primality. diff --git a/docs/core/testing/unit-testing-with-mstest.md b/docs/core/testing/unit-testing-with-mstest.md index 6f38f12999b88..36850eed809a3 100644 --- a/docs/core/testing/unit-testing-with-mstest.md +++ b/docs/core/testing/unit-testing-with-mstest.md @@ -7,7 +7,7 @@ ms.date: 10/21/2020 --- # Unit testing C# with MSTest and .NET Core -This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-mstest/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). +This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-mstest/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). [!INCLUDE [testing an ASP.NET Core project from .NET Core](../../../includes/core-testing-note-aspnet.md)] @@ -70,7 +70,7 @@ The test project requires other packages to create and run unit tests. `dotnet n dotnet add reference ../PrimeService/PrimeService.csproj ``` -You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-mstest/PrimeService.Tests/PrimeService.Tests.csproj) on GitHub. +You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-mstest/PrimeService.Tests/PrimeService.Tests.csproj) on GitHub. The following outline shows the final solution layout: @@ -145,7 +145,7 @@ Run `dotnet test`, and two of these tests fail. To make all of the tests pass, c if (candidate < 2) ``` -Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-mstest/PrimeService.Tests/PrimeService_IsPrimeShould.cs) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-mstest/PrimeService/PrimeService.cs). +Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-mstest/PrimeService.Tests/PrimeService_IsPrimeShould.cs) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-mstest/PrimeService/PrimeService.cs). You've built a small library and a set of unit tests for that library. You've structured the solution so that adding new packages and tests is part of the normal workflow. You've concentrated most of your time and effort on solving the goals of the application. diff --git a/docs/core/testing/unit-testing-with-nunit.md b/docs/core/testing/unit-testing-with-nunit.md index 8b3017249ce58..31a560eb75d2e 100644 --- a/docs/core/testing/unit-testing-with-nunit.md +++ b/docs/core/testing/unit-testing-with-nunit.md @@ -6,7 +6,7 @@ ms.date: 08/31/2018 --- # Unit testing C# with NUnit and .NET Core -This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-nunit/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). +This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-nunit/) before you begin. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). [!INCLUDE [testing an ASP.NET Core project from .NET Core](../../../includes/core-testing-note-aspnet.md)] @@ -89,7 +89,7 @@ The test project requires other packages to create and run unit tests. `dotnet n dotnet add reference ../PrimeService/PrimeService.csproj ``` -You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-nunit/PrimeService.Tests/PrimeService.Tests.csproj) on GitHub. +You can see the entire file in the [samples repository](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-nunit/PrimeService.Tests/PrimeService.Tests.csproj) on GitHub. The following outline shows the final solution layout: @@ -175,6 +175,6 @@ Run `dotnet test`, and two of these tests fail. To make all of the tests pass, c if (candidate < 2) ``` -Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-nunit/PrimeService.Tests/PrimeService_IsPrimeShould.cs) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-nunit/PrimeService/PrimeService.cs). +Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-nunit/PrimeService.Tests/PrimeService_IsPrimeShould.cs) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-nunit/PrimeService/PrimeService.cs). You've built a small library and a set of unit tests for that library. You've structured the solution so that adding new packages and tests is part of the normal workflow. You've concentrated most of your time and effort on solving the goals of the application. diff --git a/docs/core/tools/dotnet-install-script.md b/docs/core/tools/dotnet-install-script.md index 762674fe25c1a..85080c796a218 100644 --- a/docs/core/tools/dotnet-install-script.md +++ b/docs/core/tools/dotnet-install-script.md @@ -261,4 +261,4 @@ The install scripts do not update the registry on Windows. They just download th ## See also - [.NET releases](https://github.com/dotnet/core/releases) -- [.NET Runtime and SDK download archive](https://github.com/dotnet/core/blob/master/release-notes/download-archive.md) +- [.NET Runtime and SDK download archive](https://github.com/dotnet/core/blob/main/release-notes/download-archive.md) diff --git a/docs/core/tools/dotnet-list-package.md b/docs/core/tools/dotnet-list-package.md index b4774046715bc..57b293fa6b5a3 100644 --- a/docs/core/tools/dotnet-list-package.md +++ b/docs/core/tools/dotnet-list-package.md @@ -25,7 +25,7 @@ dotnet list package -h|--help ## Description -The `dotnet list package` command provides a convenient option to list all NuGet package references for a specific project or a solution. You first need to build the project in order to have the assets needed for this command to process. The following example shows the output of the `dotnet list package` command for the [SentimentAnalysis](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/SentimentAnalysis) project: +The `dotnet list package` command provides a convenient option to list all NuGet package references for a specific project or a solution. You first need to build the project in order to have the assets needed for this command to process. The following example shows the output of the `dotnet list package` command for the [SentimentAnalysis](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/SentimentAnalysis) project: ```output Project 'SentimentAnalysis' has the following package references @@ -52,7 +52,7 @@ Project `SentimentAnalysis` has the following updates to its packages > Microsoft.ML 1.4.0 1.4.0 1.5.0-preview ``` -If you need to find out whether your project has transitive dependencies, use the `--include-transitive` option. Transitive dependencies occur when you add a package to your project that in turn relies on another package. The following example shows the output from running the `dotnet list package --include-transitive` command for the [HelloPlugin](https://github.com/dotnet/samples/tree/master/core/extensions/AppWithPlugin/HelloPlugin) project, which displays top-level packages and the packages they depend on: +If you need to find out whether your project has transitive dependencies, use the `--include-transitive` option. Transitive dependencies occur when you add a package to your project that in turn relies on another package. The following example shows the output from running the `dotnet list package --include-transitive` command for the [HelloPlugin](https://github.com/dotnet/samples/tree/main/core/extensions/AppWithPlugin/HelloPlugin) project, which displays top-level packages and the packages they depend on: ```output Project 'HelloPlugin' has the following package references diff --git a/docs/core/tools/dotnet-publish.md b/docs/core/tools/dotnet-publish.md index b9d15e3a27d23..427a186e6c58d 100644 --- a/docs/core/tools/dotnet-publish.md +++ b/docs/core/tools/dotnet-publish.md @@ -149,7 +149,7 @@ For more information, see the following resources: Packages the app into a platform-specific single-file executable. The executable is self-extracting and contains all dependencies (including native) that are required to run the app. When the app is first run, the application is extracted to a directory based on the app name and build identifier. Startup is faster when the application is run again. The application doesn't need to extract itself a second time unless a new version is used. Available since .NET Core 3.0 SDK. - For more information about single-file publishing, see the [single-file bundler design document](https://github.com/dotnet/designs/blob/master/accepted/2020/single-file/design.md). + For more information about single-file publishing, see the [single-file bundler design document](https://github.com/dotnet/designs/blob/main/accepted/2020/single-file/design.md). We recommend that you specify this option in a publish profile rather than on the command line. For more information, see [MSBuild](#msbuild). diff --git a/docs/core/tools/dotnet.md b/docs/core/tools/dotnet.md index ba9981d3eed3b..7b652cf417382 100644 --- a/docs/core/tools/dotnet.md +++ b/docs/core/tools/dotnet.md @@ -112,7 +112,7 @@ The following options are available when `dotnet` runs an application. For examp - **`--additional-deps `** - Path to an additional *.deps.json* file. A *deps.json* file contains a list of dependencies, compilation dependencies, and version information used to address assembly conflicts. For more information, see [Runtime Configuration Files](https://github.com/dotnet/cli/blob/master/Documentation/specs/runtime-configuration-file.md) on GitHub. + Path to an additional *.deps.json* file. A *deps.json* file contains a list of dependencies, compilation dependencies, and version information used to address assembly conflicts. For more information, see [Runtime Configuration Files](https://github.com/dotnet/cli/blob/main/Documentation/specs/runtime-configuration-file.md) on GitHub. - **`--depsfile `** @@ -275,7 +275,7 @@ dotnet myapp.dll - `DOTNET_MULTILEVEL_LOOKUP` - Specifies whether .NET runtime, shared framework, or SDK are resolved from the global location. If not set, it defaults to 1 (logical `true`). Set to 0 (logical `false`) to not resolve from the global location and have isolated .NET installations. For more information about multi-level lookup, see [Multi-level SharedFX Lookup](https://github.com/dotnet/core-setup/blob/master/Documentation/design-docs/multilevel-sharedfx-lookup.md). + Specifies whether .NET runtime, shared framework, or SDK are resolved from the global location. If not set, it defaults to 1 (logical `true`). Set to 0 (logical `false`) to not resolve from the global location and have isolated .NET installations. For more information about multi-level lookup, see [Multi-level SharedFX Lookup](https://github.com/dotnet/core-setup/blob/main/Documentation/design-docs/multilevel-sharedfx-lookup.md). - `DOTNET_ROLL_FORWARD` **Available starting with .NET Core 3.x.** @@ -339,5 +339,5 @@ dotnet myapp.dll ## See also -- [Runtime Configuration Files](https://github.com/dotnet/cli/blob/master/Documentation/specs/runtime-configuration-file.md) +- [Runtime Configuration Files](https://github.com/dotnet/cli/blob/main/Documentation/specs/runtime-configuration-file.md) - [.NET run-time configuration settings](../run-time-config/index.md) diff --git a/docs/core/tools/global-tools.md b/docs/core/tools/global-tools.md index 2f338cd113f54..1b5eebf571311 100644 --- a/docs/core/tools/global-tools.md +++ b/docs/core/tools/global-tools.md @@ -34,7 +34,7 @@ Here are some ways to find tools: * Use the [dotnet tool search](dotnet-tool-search.md) command to find a tool that is published to NuGet.org. * Search the [NuGet](https://www.nuget.org) website by using the ".NET tool" package type filter. For more information, see [Finding and choosing packages](/nuget/consume-packages/finding-and-choosing-packages). -* See the source code for the tools created by the ASP.NET Core team in the [Tools directory of the dotnet/aspnetcore GitHub repository](https://github.com/dotnet/aspnetcore/tree/master/src/Tools). +* See the source code for the tools created by the ASP.NET Core team in the [Tools directory of the dotnet/aspnetcore GitHub repository](https://github.com/dotnet/aspnetcore/tree/main/src/Tools). * Learn about diagnostic tools at [.NET diagnostic tools](../diagnostics/index.md#net-core-diagnostic-global-tools). ## Check the author and statistics diff --git a/docs/core/tools/telemetry.md b/docs/core/tools/telemetry.md index fb053f0e9b3dc..ee5a2cf0ff99d 100644 --- a/docs/core/tools/telemetry.md +++ b/docs/core/tools/telemetry.md @@ -136,4 +136,4 @@ Because of this, custom builds of the .NET SDK shouldn't be located in directori ## See also - [.NET CLI Telemetry Data](https://dotnet.microsoft.com/platform/telemetry) -- [Telemetry reference source (dotnet/sdk repository)](https://github.com/dotnet/sdk/tree/master/src/Cli/dotnet/Telemetry) +- [Telemetry reference source (dotnet/sdk repository)](https://github.com/dotnet/sdk/tree/main/src/Cli/dotnet/Telemetry) diff --git a/docs/core/tutorials/creating-app-with-plugin-support.md b/docs/core/tutorials/creating-app-with-plugin-support.md index 30b78dd0b711d..7ef830e25ece6 100644 --- a/docs/core/tutorials/creating-app-with-plugin-support.md +++ b/docs/core/tutorials/creating-app-with-plugin-support.md @@ -267,7 +267,7 @@ Almost all plugins are more complex than a simple "Hello World", and many plugin ## Other examples in the sample -The complete source code for this tutorial can be found in [the dotnet/samples repository](https://github.com/dotnet/samples/tree/master/core/extensions/AppWithPlugin). The completed sample includes a few other examples of `AssemblyDependencyResolver` behavior. For example, the `AssemblyDependencyResolver` object can also resolve native libraries as well as localized satellite assemblies included in NuGet packages. The `UVPlugin` and `FrenchPlugin` in the samples repository demonstrate these scenarios. +The complete source code for this tutorial can be found in [the dotnet/samples repository](https://github.com/dotnet/samples/tree/main/core/extensions/AppWithPlugin). The completed sample includes a few other examples of `AssemblyDependencyResolver` behavior. For example, the `AssemblyDependencyResolver` object can also resolve native libraries as well as localized satellite assemblies included in NuGet packages. The `UVPlugin` and `FrenchPlugin` in the samples repository demonstrate these scenarios. ## Reference a plugin interface from a NuGet package diff --git a/docs/core/tutorials/netcore-hosting.md b/docs/core/tutorials/netcore-hosting.md index cabc989fb3204..cdbeda5fe878b 100644 --- a/docs/core/tutorials/netcore-hosting.md +++ b/docs/core/tutorials/netcore-hosting.md @@ -21,24 +21,24 @@ You will also want a simple .NET Core application to test the host with, so you ## Hosting APIs -There are two different APIs that can be used to host .NET Core. This article (and its associated [samples](https://github.com/dotnet/samples/tree/master/core/hosting)) covers these 2 options. +There are two different APIs that can be used to host .NET Core. This article (and its associated [samples](https://github.com/dotnet/samples/tree/main/core/hosting)) covers these 2 options. * The preferred method of hosting the .NET Core runtime in .NET Core 3.0 and above is with the `nethost` and `hostfxr` libraries' APIs. These entry points handle the complexity of finding and setting up the runtime for initialization and allow both launching a managed application and calling into a static managed method. -* The preferred method of hosting the .NET Core runtime prior to .NET Core 3.0 is with the [`coreclrhost.h`](https://github.com/dotnet/runtime/blob/master/src/coreclr/hosts/inc/coreclrhost.h) API. This API exposes functions for easily starting and stopping the runtime and invoking managed code (either by launching a managed exe or by calling static managed methods). +* The preferred method of hosting the .NET Core runtime prior to .NET Core 3.0 is with the [`coreclrhost.h`](https://github.com/dotnet/runtime/blob/main/src/coreclr/hosts/inc/coreclrhost.h) API. This API exposes functions for easily starting and stopping the runtime and invoking managed code (either by launching a managed exe or by calling static managed methods). ## Sample Hosts -[Sample hosts](https://github.com/dotnet/samples/tree/master/core/hosting) demonstrating the steps outlined in the tutorials below are available in the dotnet/samples GitHub repository. Comments in the samples clearly associate the numbered steps from these tutorials with where they're performed in the sample. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). +[Sample hosts](https://github.com/dotnet/samples/tree/main/core/hosting) demonstrating the steps outlined in the tutorials below are available in the dotnet/samples GitHub repository. Comments in the samples clearly associate the numbered steps from these tutorials with where they're performed in the sample. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). Keep in mind that the sample hosts are meant to be used for learning purposes, so they are light on error checking and are designed to emphasize readability over efficiency. ## Create a host using `nethost.h` and `hostfxr.h` -The following steps detail how to use the `nethost` and `hostfxr` libraries to start the .NET Core runtime in a native application and call into a managed static method. The [sample](https://github.com/dotnet/samples/tree/master/core/hosting/HostWithHostFxr) uses the `nethost` header and library installed with the .NET SDK and copies of the [`coreclr_delegates.h`](https://github.com/dotnet/runtime/blob/main/src/native/corehost/coreclr_delegates.h) and [`hostfxr.h`](https://github.com/dotnet/runtime/blob/master/src/native/corehost/hostfxr.h) files from the [dotnet/runtime](https://github.com/dotnet/runtime) repository. +The following steps detail how to use the `nethost` and `hostfxr` libraries to start the .NET Core runtime in a native application and call into a managed static method. The [sample](https://github.com/dotnet/samples/tree/master/core/hosting/HostWithHostFxr) uses the `nethost` header and library installed with the .NET SDK and copies of the [`coreclr_delegates.h`](https://github.com/dotnet/runtime/blob/main/src/native/corehost/coreclr_delegates.h) and [`hostfxr.h`](https://github.com/dotnet/runtime/blob/main/src/native/corehost/hostfxr.h) files from the [dotnet/runtime](https://github.com/dotnet/runtime) repository. ### Step 1 - Load `hostfxr` and get exported hosting functions -The `nethost` library provides the `get_hostfxr_path` function for locating the `hostfxr` library. The `hostfxr` library exposes functions for hosting the .NET Core runtime. The full list of functions can be found in [`hostfxr.h`](https://github.com/dotnet/runtime/blob/master/src/native/corehost/hostfxr.h) and the [native hosting design document](https://github.com/dotnet/runtime/blob/master/docs/design/features/native-hosting.md). The sample and this tutorial use the following: +The `nethost` library provides the `get_hostfxr_path` function for locating the `hostfxr` library. The `hostfxr` library exposes functions for hosting the .NET Core runtime. The full list of functions can be found in [`hostfxr.h`](https://github.com/dotnet/runtime/blob/master/src/native/corehost/hostfxr.h) and the [native hosting design document](https://github.com/dotnet/runtime/blob/main/docs/design/features/native-hosting.md). The sample and this tutorial use the following: * `hostfxr_initialize_for_runtime_config`: Initializes a host context and prepares for initialization of the .NET Core runtime using the specified runtime configuration. * `hostfxr_get_runtime_delegate`: Gets a delegate for runtime functionality. @@ -76,7 +76,7 @@ The native host can now call the managed method and pass it the desired paramete ## Create a host using `coreclrhost.h` -The following steps detail how to use the `coreclrhost.h` API to start the .NET Core runtime in a native application and call into a managed static method. The code snippets in this document use some Windows-specific APIs, but the [full sample host](https://github.com/dotnet/samples/tree/master/core/hosting/HostWithCoreClrHost) shows both Windows and Linux code paths. +The following steps detail how to use the `coreclrhost.h` API to start the .NET Core runtime in a native application and call into a managed static method. The code snippets in this document use some Windows-specific APIs, but the [full sample host](https://github.com/dotnet/samples/tree/main/core/hosting/HostWithCoreClrHost) shows both Windows and Linux code paths. The [corerun host](https://github.com/dotnet/runtime/tree/main/src/coreclr/hosts/corerun) shows a more complex, real-world, cross-platform example of hosting using `coreclrhost.h`. diff --git a/docs/core/tutorials/testing-with-cli.md b/docs/core/tutorials/testing-with-cli.md index f7c582498c4b8..829c974be983f 100644 --- a/docs/core/tutorials/testing-with-cli.md +++ b/docs/core/tutorials/testing-with-cli.md @@ -44,7 +44,7 @@ Projects that logically group files into folders are easy to navigate and mainta ### Building the sample -For the following steps, you can either follow along using the [NewTypes Pets Sample](https://github.com/dotnet/samples/tree/master/core/console-apps/NewTypesMsBuild) or create your own files and folders. The types are logically organized into a folder structure that permits the addition of more types later, and tests are also logically placed in folders permitting the addition of more tests later. +For the following steps, you can either follow along using the [NewTypes Pets Sample](https://github.com/dotnet/samples/tree/main/core/console-apps/NewTypesMsBuild) or create your own files and folders. The types are logically organized into a folder structure that permits the addition of more types later, and tests are also logically placed in folders permitting the addition of more tests later. The sample contains two types, `Dog` and `Cat`, and has them implement a common interface, `IPet`. For the `NewTypes` project, your goal is to organize the pet-related types into a *Pets* folder. If another set of types is added later, *WildAnimals* for example, they're placed in the *NewTypes* folder alongside the *Pets* folder. The *WildAnimals* folder may contain types for animals that aren't pets, such as `Squirrel` and `Rabbit` types. In this way as types are added, the project remains well organized. diff --git a/docs/core/whats-new/dotnet-core-2-0.md b/docs/core/whats-new/dotnet-core-2-0.md index ed09d427bcf05..fde7214032837 100644 --- a/docs/core/whats-new/dotnet-core-2-0.md +++ b/docs/core/whats-new/dotnet-core-2-0.md @@ -104,7 +104,7 @@ You can also develop apps that target Linux as a single operating system. .NET C .NET Standard 2.0 class libraries can also reference .NET Framework class libraries, provided that they call APIs that are present in .NET Standard 2.0. No recompilation of the .NET Framework libraries is required. -For a list of the APIs that have been added to .NET Standard since its last version, .NET Standard 1.6, see [.NET Standard 2.0 vs. 1.6](https://raw.githubusercontent.com/dotnet/standard/master/docs/versions/netstandard2.0_diff.md). +For a list of the APIs that have been added to .NET Standard since its last version, .NET Standard 1.6, see [.NET Standard 2.0 vs. 1.6](https://raw.githubusercontent.com/dotnet/standard/main/docs/versions/netstandard2.0_diff.md). ### Expanded surface area diff --git a/docs/core/whats-new/dotnet-core-2-2.md b/docs/core/whats-new/dotnet-core-2-2.md index 253b54a214160..cde3cafbaa06b 100644 --- a/docs/core/whats-new/dotnet-core-2-2.md +++ b/docs/core/whats-new/dotnet-core-2-2.md @@ -87,7 +87,7 @@ Starting with .NET Core 2.2, you can use a startup hook to inject code prior to We expect hosting providers to define custom configuration and policy, including settings that potentially influence the load behavior of the main entry point, such as the  behavior. The hook can be used to set up tracing or telemetry injection, to set up callbacks for handling, or to define other environment-dependent behavior. The hook is separate from the entry point, so that user code doesn't need to be modified. -See [Host startup hook](https://github.com/dotnet/core-setup/blob/master/Documentation/design-docs/host-startup-hook.md) for more information. +See [Host startup hook](https://github.com/dotnet/core-setup/blob/main/Documentation/design-docs/host-startup-hook.md) for more information. ## See also diff --git a/docs/core/whats-new/dotnet-core-3-0.md b/docs/core/whats-new/dotnet-core-3-0.md index 48216d65260ef..0fc8368ff6963 100644 --- a/docs/core/whats-new/dotnet-core-3-0.md +++ b/docs/core/whats-new/dotnet-core-3-0.md @@ -109,7 +109,7 @@ To publish a single-file executable, set the `PublishSingleFile` in your project dotnet publish -r win10-x64 -p:PublishSingleFile=true ``` -For more information about single-file publishing, see the [single-file bundler design document](https://github.com/dotnet/designs/blob/master/accepted/2020/single-file/design.md). +For more information about single-file publishing, see the [single-file bundler design document](https://github.com/dotnet/designs/blob/main/accepted/2020/single-file/design.md). ### Assembly linking @@ -141,7 +141,7 @@ For more information about the IL Linker tool, see the [documentation](../deploy ### Tiered compilation -[Tiered compilation](https://github.com/dotnet/runtime/blob/master/docs/design/features/tiered-compilation.md) (TC) is on by default with .NET Core 3.0. This feature enables the runtime to more adaptively use the just-in-time (JIT) compiler to achieve better performance. +[Tiered compilation](https://github.com/dotnet/runtime/blob/main/docs/design/features/tiered-compilation.md) (TC) is on by default with .NET Core 3.0. This feature enables the runtime to more adaptively use the just-in-time (JIT) compiler to achieve better performance. The main benefit of tiered compilation is to provide two ways of jitting methods: in a lower-quality-but-faster tier or a higher-quality-but-slower tier. The quality refers to how well the method is optimized. TC helps to improve the performance of an application as it goes through various stages of execution, from startup through steady state. When tiered compilation is disabled, every method is compiled in a single way that's biased to steady-state performance over startup performance. @@ -324,11 +324,11 @@ On Windows, you can now create COM-callable managed components. This capability Unlike .NET Framework where the *mscoree.dll* was used as the COM server, .NET Core will add a native launcher dll to the *bin* directory when you build your COM component. -For an example of how to create a COM component and consume it, see the [COM Demo](https://github.com/dotnet/samples/tree/master/core/extensions/COMServerDemo). +For an example of how to create a COM component and consume it, see the [COM Demo](https://github.com/dotnet/samples/tree/main/core/extensions/COMServerDemo). ### Windows Native Interop -Windows offers a rich native API in the form of flat C APIs, COM, and WinRT. While .NET Core supports **P/Invoke**, .NET Core 3.0 adds the ability to **CoCreate COM APIs** and **Activate WinRT APIs**. For a code example, see the [Excel Demo](https://github.com/dotnet/samples/tree/master/core/extensions/ExcelDemo). +Windows offers a rich native API in the form of flat C APIs, COM, and WinRT. While .NET Core supports **P/Invoke**, .NET Core 3.0 adds the ability to **CoCreate COM APIs** and **Activate WinRT APIs**. For a code example, see the [Excel Demo](https://github.com/dotnet/samples/tree/main/core/extensions/ExcelDemo). ### MSIX Deployment @@ -367,7 +367,7 @@ Two packages have been released to NuGet that you can use for GPIO programming: - [System.Device.Gpio](https://www.nuget.org/packages/System.Device.Gpio) - [Iot.Device.Bindings](https://www.nuget.org/packages/Iot.Device.Bindings) -The GPIO packages include APIs for *GPIO*, *SPI*, *I2C*, and *PWM* devices. The IoT bindings package includes device bindings. For more information, see the [devices GitHub repo](https://github.com/dotnet/iot/blob/master/src/devices/). +The GPIO packages include APIs for *GPIO*, *SPI*, *I2C*, and *PWM* devices. The IoT bindings package includes device bindings. For more information, see the [devices GitHub repo](https://github.com/dotnet/iot/blob/main/src/devices/). ### ARM64 Linux support @@ -511,7 +511,7 @@ APIs have been added that allow access to certain perf-oriented CPU instructions Where appropriate, the .NET libraries have begun using these instructions to improve performance. -For more information, see [.NET Platform-Dependent Intrinsics](https://github.com/dotnet/designs/blob/master/accepted/2018/platform-intrinsics.md). +For more information, see [.NET Platform-Dependent Intrinsics](https://github.com/dotnet/designs/blob/main/accepted/2018/platform-intrinsics.md). ### Improved .NET Core Version APIs diff --git a/docs/csharp/expression-trees-building.md b/docs/csharp/expression-trees-building.md index 676a68b3a84af..7577736524f0e 100644 --- a/docs/csharp/expression-trees-building.md +++ b/docs/csharp/expression-trees-building.md @@ -195,7 +195,7 @@ The code to build the expression tree for the factorial function is quite a bit more complicated, and it's riddled with labels and break statements and other elements we'd like to avoid in our everyday coding tasks. -For this section, I've also updated the visitor code to visit every node in this expression tree and write out information about the nodes that are created in this sample. You can [view or download the sample code](https://github.com/dotnet/samples/tree/master/csharp/expression-trees) at the dotnet/docs GitHub repository. Experiment for yourself by building and running the samples. For download instructions, see [Samples and Tutorials](../samples-and-tutorials/index.md#view-and-download-samples). +For this section, I've also updated the visitor code to visit every node in this expression tree and write out information about the nodes that are created in this sample. You can [view or download the sample code](https://github.com/dotnet/samples/tree/main/csharp/expression-trees) at the dotnet/docs GitHub repository. Experiment for yourself by building and running the samples. For download instructions, see [Samples and Tutorials](../samples-and-tutorials/index.md#view-and-download-samples). ## Examining the APIs diff --git a/docs/csharp/indexers.md b/docs/csharp/indexers.md index f340147d3a589..60160e9547ea6 100644 --- a/docs/csharp/indexers.md +++ b/docs/csharp/indexers.md @@ -66,7 +66,7 @@ Indexers enable you to provide the API that matches your type's abstraction without exposing the inner details of how the values for that abstraction are stored or computed. -Let's walk through some of the common scenarios for using *indexers*. You can access the [sample folder for indexers](https://github.com/dotnet/samples/tree/master/csharp/indexers). For download instructions, see [Samples and Tutorials](../samples-and-tutorials/index.md#view-and-download-samples). +Let's walk through some of the common scenarios for using *indexers*. You can access the [sample folder for indexers](https://github.com/dotnet/samples/tree/main/csharp/indexers). For download instructions, see [Samples and Tutorials](../samples-and-tutorials/index.md#view-and-download-samples). ### Arrays and Vectors diff --git a/docs/csharp/iterators.md b/docs/csharp/iterators.md index f4d4e5fc0e0bc..e63d69da945a6 100644 --- a/docs/csharp/iterators.md +++ b/docs/csharp/iterators.md @@ -25,7 +25,7 @@ The C# language provides features for both these scenarios. This article provides an overview of those features. -This tutorial has multiple steps. After each step, you can run the application and see the progress. You can also [view or download the completed sample](https://github.com/dotnet/samples/blob/master/csharp/iterators) for this topic. For download instructions, see [Samples and Tutorials](../samples-and-tutorials/index.md#view-and-download-samples). +This tutorial has multiple steps. After each step, you can run the application and see the progress. You can also [view or download the completed sample](https://github.com/dotnet/samples/blob/main/csharp/iterators) for this topic. For download instructions, see [Samples and Tutorials](../samples-and-tutorials/index.md#view-and-download-samples). ## Iterating with foreach diff --git a/docs/csharp/programming-guide/concepts/expression-trees/how-to-use-expression-trees-to-build-dynamic-queries.md b/docs/csharp/programming-guide/concepts/expression-trees/how-to-use-expression-trees-to-build-dynamic-queries.md index 014b0fa0d464d..85edef45bc6a3 100644 --- a/docs/csharp/programming-guide/concepts/expression-trees/how-to-use-expression-trees-to-build-dynamic-queries.md +++ b/docs/csharp/programming-guide/concepts/expression-trees/how-to-use-expression-trees-to-build-dynamic-queries.md @@ -42,7 +42,7 @@ The internal expression tree—and thus the query—haven't been modifie ## Call additional LINQ methods -Generally, the [built-in LINQ methods](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Linq.Queryable/src/System/Linq/Queryable.cs) at perform two steps: +Generally, the [built-in LINQ methods](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Linq.Queryable/src/System/Linq/Queryable.cs) at perform two steps: * Wrap the current expression tree in a representing the method call. * Pass the wrapped expression tree back to the provider, either to return a value via the provider's method; or to return a translated query object via the method. diff --git a/docs/csharp/programming-guide/concepts/serialization/walkthrough-persisting-an-object-in-visual-studio.md b/docs/csharp/programming-guide/concepts/serialization/walkthrough-persisting-an-object-in-visual-studio.md index b85d60dc1364c..9e53fd3151e5e 100644 --- a/docs/csharp/programming-guide/concepts/serialization/walkthrough-persisting-an-object-in-visual-studio.md +++ b/docs/csharp/programming-guide/concepts/serialization/walkthrough-persisting-an-object-in-visual-studio.md @@ -26,7 +26,7 @@ In this walkthrough, you will create a basic `Loan` object and persist its data - The example requires C# 7.3. See [Select the C# language version](../../../language-reference/configure-language-version.md) -You can examine the sample code online [at the .NET samples GitHub repository](https://github.com/dotnet/samples/tree/master/csharp/serialization). +You can examine the sample code online [at the .NET samples GitHub repository](https://github.com/dotnet/samples/tree/main/csharp/serialization). ## Creating the loan object diff --git a/docs/csharp/roslyn-sdk/get-started/semantic-analysis.md b/docs/csharp/roslyn-sdk/get-started/semantic-analysis.md index f189462d97eab..95219d26b316a 100644 --- a/docs/csharp/roslyn-sdk/get-started/semantic-analysis.md +++ b/docs/csharp/roslyn-sdk/get-started/semantic-analysis.md @@ -27,7 +27,7 @@ Like , [!NOTE] > The Syntax Tree types use inheritance to describe the different syntax elements that are valid at different locations in the program. Using these APIs often means casting properties or collection members to specific derived types. In the following examples, the assignment and the casts are separate statements, using explicitly typed variables. You can read the code to see the return types of the API and the runtime type of the objects returned. In practice, it's more common to use implicitly typed variables and rely on API names to describe the type of objects being examined. diff --git a/docs/csharp/roslyn-sdk/get-started/syntax-analysis.md b/docs/csharp/roslyn-sdk/get-started/syntax-analysis.md index b5fd9c97144fe..cea3f24d3685e 100644 --- a/docs/csharp/roslyn-sdk/get-started/syntax-analysis.md +++ b/docs/csharp/roslyn-sdk/get-started/syntax-analysis.md @@ -65,7 +65,7 @@ You can examine the nodes in a syntax tree in two ways. You can traverse the tre ### Manual traversal -You can see the finished code for this sample in [our GitHub repository](https://github.com/dotnet/samples/tree/master/csharp/roslyn-sdk/SyntaxQuickStart). +You can see the finished code for this sample in [our GitHub repository](https://github.com/dotnet/samples/tree/main/csharp/roslyn-sdk/SyntaxQuickStart). > [!NOTE] > The Syntax Tree types use inheritance to describe the different syntax elements that are valid at different locations in the program. Using these APIs often means casting properties or collection members to specific derived types. In the following examples, the assignment and the casts are separate statements, using explicitly typed variables. You can read the code to see the return types of the API and the runtime type of the objects returned. In practice, it's more common to use implicitly typed variables and rely on API names to describe the type of objects being examined. @@ -155,7 +155,7 @@ This example implements a [!TIP] > The testing library supports a special markup syntax, including the following: @@ -424,7 +424,7 @@ int k = i + j; After these changes, you get red squiggles only on the first two variables. Add `const` to both `i` and `j`, and you get a new warning on `k` because it can now be `const`. -Congratulations! You've created your first .NET Compiler Platform extension that performs on-the-fly code analysis to detect an issue and provides a quick fix to correct it. Along the way, you've learned many of the code APIs that are part of the .NET Compiler Platform SDK (Roslyn APIs). You can check your work against the [completed sample](https://github.com/dotnet/samples/tree/master/csharp/roslyn-sdk/Tutorials/MakeConst) in our samples GitHub repository. +Congratulations! You've created your first .NET Compiler Platform extension that performs on-the-fly code analysis to detect an issue and provides a quick fix to correct it. Along the way, you've learned many of the code APIs that are part of the .NET Compiler Platform SDK (Roslyn APIs). You can check your work against the [completed sample](https://github.com/dotnet/samples/tree/main/csharp/roslyn-sdk/Tutorials/MakeConst) in our samples GitHub repository. ## Other resources diff --git a/docs/csharp/tour-of-csharp/tutorials/arrays-and-collections.md b/docs/csharp/tour-of-csharp/tutorials/arrays-and-collections.md index 2594ca2c300b7..4ce2e920e6c7d 100644 --- a/docs/csharp/tour-of-csharp/tutorials/arrays-and-collections.md +++ b/docs/csharp/tour-of-csharp/tutorials/arrays-and-collections.md @@ -201,7 +201,7 @@ See if you can put together some of the concepts from this and earlier lessons. ## Complete challenge -You can see an example solution by [looking at the finished sample code on GitHub](https://github.com/dotnet/samples/tree/master/csharp/list-quickstart/Program.cs#L8-L16). +You can see an example solution by [looking at the finished sample code on GitHub](https://github.com/dotnet/samples/tree/main/csharp/list-quickstart/Program.cs#L8-L16). With each iteration of the loop, you're taking the last two integers in the list, summing them, and adding that value to the list. The loop repeats until you've added 20 items to the list. diff --git a/docs/csharp/tour-of-csharp/tutorials/branches-and-loops-local.md b/docs/csharp/tour-of-csharp/tutorials/branches-and-loops-local.md index 41c386269a669..a448393c9f98d 100644 --- a/docs/csharp/tour-of-csharp/tutorials/branches-and-loops-local.md +++ b/docs/csharp/tour-of-csharp/tutorials/branches-and-loops-local.md @@ -277,7 +277,7 @@ by 3. Here are a few hints: - The `for` loop can help you repeat a series of steps for all the numbers 1 through 20. Try it yourself. Then check how you did. You should get 63 for an answer. You can see one possible answer by -[viewing the completed code on GitHub](https://github.com/dotnet/samples/tree/master/csharp/branches-quickstart/Program.cs#L46-L54). +[viewing the completed code on GitHub](https://github.com/dotnet/samples/tree/main/csharp/branches-quickstart/Program.cs#L46-L54). You've completed the "branches and loops" tutorial. diff --git a/docs/csharp/tour-of-csharp/tutorials/index.md b/docs/csharp/tour-of-csharp/tutorials/index.md index 7ca0c113a02c0..6199bd86ae6ae 100644 --- a/docs/csharp/tour-of-csharp/tutorials/index.md +++ b/docs/csharp/tour-of-csharp/tutorials/index.md @@ -67,6 +67,6 @@ available [to run locally on your machine](arrays-and-collections.md). This tutorial assumes that you've finished the lessons listed above. -## [101 Linq Samples](https://github.com/dotnet/try-samples/tree/master/101-linq-samples) +## [101 Linq Samples](https://github.com/dotnet/try-samples/tree/main/101-linq-samples) This sample requires the [dotnet-try](https://github.com/dotnet/try/blob/main/README.md#setup) global tool. Once you install the tool, and clone the [try-samples](https://github.com/dotnet/try-samples) repo, you can learn Language Integrated Query (LINQ) through a set of 101 samples you can run interactively. You can explore different ways to query, explore, and transform data sequences. diff --git a/docs/csharp/tour-of-csharp/tutorials/numbers-in-csharp-local.md b/docs/csharp/tour-of-csharp/tutorials/numbers-in-csharp-local.md index 42708081974f5..b6af2b1b28d7d 100644 --- a/docs/csharp/tour-of-csharp/tutorials/numbers-in-csharp-local.md +++ b/docs/csharp/tour-of-csharp/tutorials/numbers-in-csharp-local.md @@ -303,7 +303,7 @@ Notice that the math using the decimal type has more digits to the right of the Now that you've seen the different numeric types, write code that calculates the area of a circle whose radius is 2.50 centimeters. Remember that the area of a circle is the radius squared multiplied by PI. One hint: .NET contains a constant for PI, that you can use for that value. , like all constants declared in the `System.Math` namespace, is a `double` value. For that reason, you should use `double` instead of `decimal` values for this challenge. -You should get an answer between 19 and 20. You can check your answer by [looking at the finished sample code on GitHub](https://github.com/dotnet/samples/tree/master/csharp/numbers-quickstart/Program.cs#L104-L106). +You should get an answer between 19 and 20. You can check your answer by [looking at the finished sample code on GitHub](https://github.com/dotnet/samples/tree/main/csharp/numbers-quickstart/Program.cs#L104-L106). Try some other formulas if you'd like. diff --git a/docs/csharp/tutorials/console-teleprompter.md b/docs/csharp/tutorials/console-teleprompter.md index a0585ef3b6377..cf73b2d256d77 100644 --- a/docs/csharp/tutorials/console-teleprompter.md +++ b/docs/csharp/tutorials/console-teleprompter.md @@ -50,7 +50,7 @@ namespace TeleprompterConsole ## Reading and Echoing the File -The first feature to add is the ability to read a text file and display all that text to the console. First, let's add a text file. Copy the [sampleQuotes.txt](https://github.com/dotnet/samples/raw/main/csharp/getting-started/console-teleprompter/sampleQuotes.txt) file from the GitHub repository for this [sample](https://github.com/dotnet/samples/tree/master/csharp/getting-started/console-teleprompter) into your project directory. This will serve as the script for your application. If you would like information on how to download the sample app for this topic, see the instructions in the [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples) topic. +The first feature to add is the ability to read a text file and display all that text to the console. First, let's add a text file. Copy the [sampleQuotes.txt](https://github.com/dotnet/samples/raw/main/csharp/getting-started/console-teleprompter/sampleQuotes.txt) file from the GitHub repository for this [sample](https://github.com/dotnet/samples/tree/main/csharp/getting-started/console-teleprompter) into your project directory. This will serve as the script for your application. If you would like information on how to download the sample app for this topic, see the instructions in the [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples) topic. Next, add the following method in your `Program` class (right below the `Main` method): diff --git a/docs/csharp/tutorials/console-webapiclient.md b/docs/csharp/tutorials/console-webapiclient.md index a39159343c981..be3c82d20cef9 100644 --- a/docs/csharp/tutorials/console-webapiclient.md +++ b/docs/csharp/tutorials/console-webapiclient.md @@ -23,7 +23,7 @@ C# objects. There are many features in this tutorial. Let's build them one by one. -If you prefer to follow along with the [final sample](https://github.com/dotnet/samples/tree/master/csharp/getting-started/console-webapiclient) for this article, you can download it. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). +If you prefer to follow along with the [final sample](https://github.com/dotnet/samples/tree/main/csharp/getting-started/console-webapiclient) for this article, you can download it. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). ## Prerequisites @@ -375,7 +375,7 @@ again: Console.WriteLine(repo.LastPush); ``` -Your version should now match the [finished sample](https://github.com/dotnet/samples/tree/master/csharp/getting-started/console-webapiclient). +Your version should now match the [finished sample](https://github.com/dotnet/samples/tree/main/csharp/getting-started/console-webapiclient). ## Conclusion diff --git a/docs/csharp/tutorials/default-interface-methods-versions.md b/docs/csharp/tutorials/default-interface-methods-versions.md index 15f34bad9eecf..d3cc57e75c070 100644 --- a/docs/csharp/tutorials/default-interface-methods-versions.md +++ b/docs/csharp/tutorials/default-interface-methods-versions.md @@ -23,7 +23,7 @@ You’ll need to set up your machine to run .NET Core, including the C# 8.0 comp ## Scenario overview -This tutorial starts with version 1 of a customer relationship library. You can get the starter application on our [samples repo on GitHub](https://github.com/dotnet/samples/tree/master/csharp/tutorials/default-interface-members-versions/starter/customer-relationship). The company that built this library intended customers with existing applications to adopt their library. They provided minimal interface definitions for users of their library to implement. Here's the interface definition for a customer: +This tutorial starts with version 1 of a customer relationship library. You can get the starter application on our [samples repo on GitHub](https://github.com/dotnet/samples/tree/main/csharp/tutorials/default-interface-members-versions/starter/customer-relationship). The company that built this library intended customers with existing applications to adopt their library. They provided minimal interface definitions for users of their library to implement. Here's the interface definition for a customer: [!code-csharp[InitialCustomerInterface](~/samples/snippets/csharp/tutorials/default-interface-members-versions/starter/customer-relationship/ICustomer.cs?name=SnippetICustomerVersion1)] @@ -83,6 +83,6 @@ In an implementation of a class that implements this interface, the override can [!code-csharp[VersionTwoImplementation](~/samples/snippets/csharp/tutorials/default-interface-members-versions/finished/customer-relationship/SampleCustomer.cs?name=SnippetOverrideAndExtend)] -You can see the entire finished code in our [samples repo on GitHub](https://github.com/dotnet/samples/tree/master/csharp/tutorials/default-interface-members-versions/finished/customer-relationship). You can get the starter application on our [samples repo on GitHub](https://github.com/dotnet/samples/tree/master/csharp/tutorials/default-interface-members-versions/starter/customer-relationship). +You can see the entire finished code in our [samples repo on GitHub](https://github.com/dotnet/samples/tree/master/csharp/tutorials/default-interface-members-versions/finished/customer-relationship). You can get the starter application on our [samples repo on GitHub](https://github.com/dotnet/samples/tree/main/csharp/tutorials/default-interface-members-versions/starter/customer-relationship). These new features mean that interfaces can be updated safely when there's a reasonable default implementation for those new members. Carefully design interfaces to express single functional ideas that can be implemented by multiple classes. That makes it easier to upgrade those interface definitions when new requirements are discovered for that same functional idea. diff --git a/docs/csharp/tutorials/nullable-reference-types.md b/docs/csharp/tutorials/nullable-reference-types.md index c5bf617945e8d..1bb2240f3a9b3 100644 --- a/docs/csharp/tutorials/nullable-reference-types.md +++ b/docs/csharp/tutorials/nullable-reference-types.md @@ -206,7 +206,7 @@ You don't need any `null` checks in this code because you've designed the underl ## Get the code -You can get the code for the finished tutorial from our [samples](https://github.com/dotnet/samples) repository in the [csharp/NullableIntroduction](https://github.com/dotnet/samples/tree/master/csharp/NullableIntroduction) folder. +You can get the code for the finished tutorial from our [samples](https://github.com/dotnet/samples) repository in the [csharp/NullableIntroduction](https://github.com/dotnet/samples/tree/main/csharp/NullableIntroduction) folder. Experiment by changing the type declarations between nullable and non-nullable reference types. See how that generates different warnings to ensure you don't accidentally dereference a `null`. diff --git a/docs/csharp/tutorials/pattern-matching.md b/docs/csharp/tutorials/pattern-matching.md index 31b320d967e76..1ddb64efd95a0 100644 --- a/docs/csharp/tutorials/pattern-matching.md +++ b/docs/csharp/tutorials/pattern-matching.md @@ -37,7 +37,7 @@ From that brief description, you may have quickly sketched out an object hierarc [!code-csharp[ExternalSystems](~/samples/snippets/csharp/tutorials/patterns/start/toll-calculator/ExternalSystems.cs)] -You can download the starter code from the [dotnet/samples](https://github.com/dotnet/samples/tree/master/csharp/tutorials/patterns/start) GitHub repository. You can see that the vehicle classes are from different systems, and are in different namespaces. No common base class, other than `System.Object` can be leveraged. +You can download the starter code from the [dotnet/samples](https://github.com/dotnet/samples/tree/main/csharp/tutorials/patterns/start) GitHub repository. You can see that the vehicle classes are from different systems, and are in different namespaces. No common base class, other than `System.Object` can be leveraged. ## Pattern matching designs @@ -384,4 +384,4 @@ Pattern matching makes some types of code more readable and offers an alternativ ## Next steps -You can download the finished code from the [dotnet/samples](https://github.com/dotnet/samples/tree/master/csharp/tutorials/patterns/finished) GitHub repository. Explore patterns on your own and add this technique into your regular coding activities. Learning these techniques gives you another way to approach problems and create new functionality. +You can download the finished code from the [dotnet/samples](https://github.com/dotnet/samples/tree/main/csharp/tutorials/patterns/finished) GitHub repository. Explore patterns on your own and add this technique into your regular coding activities. Learning these techniques gives you another way to approach problems and create new functionality. diff --git a/docs/csharp/tutorials/upgrade-to-nullable-references.md b/docs/csharp/tutorials/upgrade-to-nullable-references.md index fa5baaf3438a2..fe3f9310901be 100644 --- a/docs/csharp/tutorials/upgrade-to-nullable-references.md +++ b/docs/csharp/tutorials/upgrade-to-nullable-references.md @@ -28,7 +28,7 @@ This tutorial assumes you're familiar with C# and .NET, including either Visual The sample application that you'll migrate is an RSS feed reader web app. It reads from a single RSS feed and displays summaries for the most recent articles. You can select any of the articles to visit the site. The application is relatively new but was written before nullable reference types were available. The design decisions for the application represented sound principles, but don't take advantage of this important language feature. -The sample application includes a unit test library that validates the major functionality of the app. That project will make it easier to upgrade safely, if you change any of the implementation based on the warnings generated. You can download the starter code from the [dotnet/samples](https://github.com/dotnet/samples/tree/master/csharp/tutorials/nullable-reference-migration/start) GitHub repository. +The sample application includes a unit test library that validates the major functionality of the app. That project will make it easier to upgrade safely, if you change any of the implementation based on the warnings generated. You can download the starter code from the [dotnet/samples](https://github.com/dotnet/samples/tree/main/csharp/tutorials/nullable-reference-migration/start) GitHub repository. Your goal migrating a project should be to leverage the new language features so that you clearly express your intent on the nullability of variables, and do so in such a way that the compiler doesn't generate warnings when you have the nullable annotation context and nullable warning context set to `enabled`. @@ -159,6 +159,6 @@ The `IMapper` parameter is typed as a nonnullable reference. It's called by ASP. ## Get the code -You've fixed the warnings you identified in the initial test compile, so now you can turn on the nullable annotation context for both projects. Rebuild the projects; the compiler reports no warnings. You can get the code for the finished project in the [dotnet/samples](https://github.com/dotnet/samples/tree/master/csharp/tutorials/nullable-reference-migration/finished) GitHub repository. +You've fixed the warnings you identified in the initial test compile, so now you can turn on the nullable annotation context for both projects. Rebuild the projects; the compiler reports no warnings. You can get the code for the finished project in the [dotnet/samples](https://github.com/dotnet/samples/tree/main/csharp/tutorials/nullable-reference-migration/finished) GitHub repository. The new features that support nullable reference types help you find and fix potential errors in how you handle `null` values in your code. Enabling the nullable annotation context allows you to express your design intent: some variables should never be null, other variables may contain null values. These features make it easier for you to declare your design intent. Similarly, the nullable warning context instructs the compiler to issue warnings when you have violated that intent. Those warnings guide you to make updates that make your code more resilient and less likely to throw a `NullReferenceException` during execution. You can control the scope of these contexts so that you can focus on local areas of code to migrate while the remaining codebase is untouched. In practice, you can make this migration task a part of regular maintenance to your classes. This tutorial demonstrated the process to migrate an application to use nullable reference types. You can explore a larger real-world example of this process by examining the PR [Jon Skeet](https://github.com/jskeet) made to incorporate nullable reference types into [NodaTime](https://github.com/nodatime/nodatime/pull/1240/commits). Or just In addition, you can learn techniques for using nullable reference types with Entity Framework Core in [Entity Framework Core - Working with nullable reference types](/ef/core/miscellaneous/nullable-reference-types). diff --git a/docs/csharp/tutorials/working-with-linq.md b/docs/csharp/tutorials/working-with-linq.md index 58846c75e5559..03af41a356f3d 100644 --- a/docs/csharp/tutorials/working-with-linq.md +++ b/docs/csharp/tutorials/working-with-linq.md @@ -22,7 +22,7 @@ Magicians use this technique because every card is in a known location after eac For your purposes, it is a light hearted look at manipulating sequences of data. The application you'll build constructs a card deck and then performs a sequence of shuffles, writing the sequence out each time. You'll also compare the updated order to the original order. -This tutorial has multiple steps. After each step, you can run the application and see the progress. You can also see the [completed sample](https://github.com/dotnet/samples/blob/master/csharp/getting-started/console-linq) in the dotnet/samples GitHub repository. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). +This tutorial has multiple steps. After each step, you can run the application and see the progress. You can also see the [completed sample](https://github.com/dotnet/samples/blob/main/csharp/getting-started/console-linq) in the dotnet/samples GitHub repository. For download instructions, see [Samples and Tutorials](../../samples-and-tutorials/index.md#view-and-download-samples). ## Prerequisites diff --git a/docs/csharp/whats-new/csharp-7.md b/docs/csharp/whats-new/csharp-7.md index c611211d1f8b5..51ef21c63bf16 100644 --- a/docs/csharp/whats-new/csharp-7.md +++ b/docs/csharp/whats-new/csharp-7.md @@ -49,7 +49,7 @@ Finally, the compiler has new options: The remainder of this article provides an overview of each feature. For each feature, you'll learn the reasoning behind it and the syntax. You can explore these features in your environment using the `dotnet try` global tool: -1. Install the [dotnet-try](https://github.com/dotnet/try/blob/master/README.md#setup) global tool. +1. Install the [dotnet-try](https://github.com/dotnet/try/blob/main/README.md#setup) global tool. 1. Clone the [dotnet/try-samples](https://github.com/dotnet/try-samples) repository. 1. Set the current directory to the *csharp7* subdirectory for the *try-samples* repository. 1. Run `dotnet try`. diff --git a/docs/csharp/whats-new/csharp-8.md b/docs/csharp/whats-new/csharp-8.md index 6f69cc9369bef..78d46cf710c8f 100644 --- a/docs/csharp/whats-new/csharp-8.md +++ b/docs/csharp/whats-new/csharp-8.md @@ -30,7 +30,7 @@ C# 8.0 is supported on **.NET Core 3.x** and **.NET Standard 2.1**. For more inf The remainder of this article briefly describes these features. Where in-depth articles are available, links to those tutorials and overviews are provided. You can explore these features in your environment using the `dotnet try` global tool: -1. Install the [dotnet-try](https://github.com/dotnet/try/blob/master/README.md#setup) global tool. +1. Install the [dotnet-try](https://github.com/dotnet/try/blob/main/README.md#setup) global tool. 1. Clone the [dotnet/try-samples](https://github.com/dotnet/try-samples) repository. 1. Set the current directory to the *csharp8* subdirectory for the *try-samples* repository. 1. Run `dotnet try`. diff --git a/docs/csharp/whats-new/csharp-version-history.md b/docs/csharp/whats-new/csharp-version-history.md index f0246d8aa88e0..dc88947fba697 100644 --- a/docs/csharp/whats-new/csharp-version-history.md +++ b/docs/csharp/whats-new/csharp-version-history.md @@ -7,7 +7,7 @@ ms.date: 04/08/2020 # The history of C\# -This article provides a history of each major release of the C# language. The C# team is continuing to innovate and add new features. Detailed language feature status, including features considered for upcoming releases can be found [on the dotnet/roslyn repository](https://github.com/dotnet/roslyn/blob/master/docs/Language%20Feature%20Status.md) on GitHub. +This article provides a history of each major release of the C# language. The C# team is continuing to innovate and add new features. Detailed language feature status, including features considered for upcoming releases can be found [on the dotnet/roslyn repository](https://github.com/dotnet/roslyn/blob/main/docs/Language%20Feature%20Status.md) on GitHub. > [!IMPORTANT] > The C# language relies on types and methods in what the C# specification defines as a *standard library* for some of the features. The .NET platform delivers those types and methods in a number of packages. One example is exception processing. Every `throw` statement or expression is checked to ensure the object being thrown is derived from . Similarly, every `catch` is checked to ensure that the type being caught is derived from . Each version may add new requirements. To use the latest language features in older environments, you may need to install specific libraries. These dependencies are documented in the page for each specific version. You can learn more about the [relationships between language and library](relationships-between-language-and-library.md) for background on this dependency. diff --git a/docs/csharp/write-safe-efficient-code.md b/docs/csharp/write-safe-efficient-code.md index dd98a2688b720..87bb3c26be269 100644 --- a/docs/csharp/write-safe-efficient-code.md +++ b/docs/csharp/write-safe-efficient-code.md @@ -277,7 +277,7 @@ saves copying when you use a `readonly struct` as an `in` argument. You shouldn't pass a nullable value type as an `in` argument. The type isn't declared as a read-only struct. That means the compiler must generate defensive copies for any nullable value type argument passed to a method using the `in` modifier on the parameter declaration. -You can see an example program that demonstrates the performance differences using [BenchmarkDotNet](https://www.nuget.org/packages/BenchmarkDotNet/) in our [samples repository](https://github.com/dotnet/samples/tree/master/csharp/safe-efficient-code/benchmark) on GitHub. It compares passing a mutable struct by value and by reference with passing an immutable struct by value and by reference. The use of the immutable struct and pass by reference is fastest. +You can see an example program that demonstrates the performance differences using [BenchmarkDotNet](https://www.nuget.org/packages/BenchmarkDotNet/) in our [samples repository](https://github.com/dotnet/samples/tree/main/csharp/safe-efficient-code/benchmark) on GitHub. It compares passing a mutable struct by value and by reference with passing an immutable struct by value and by reference. The use of the immutable struct and pass by reference is fastest. ## Use `ref struct` types to work with blocks or memory on a single stack frame diff --git a/docs/framework/additional-apis/coreresponsedata.md b/docs/framework/additional-apis/coreresponsedata.md index 96b873724d4d9..e1c0b4ffa02f3 100644 --- a/docs/framework/additional-apis/coreresponsedata.md +++ b/docs/framework/additional-apis/coreresponsedata.md @@ -24,7 +24,7 @@ internal class CoreResponseData ``` > [!WARNING] -> This API is internal, and it is not meant to be used directly in your code. Instead, you should use a to hook networking code. See [DiagnosticSource User's Guide](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md). +> This API is internal, and it is not meant to be used directly in your code. Instead, you should use a to hook networking code. See [DiagnosticSource User's Guide](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md). > > Microsoft does not support the use of this class in a production application under any circumstance. diff --git a/docs/framework/additional-apis/coreresponsedata_m_responseheaders.md b/docs/framework/additional-apis/coreresponsedata_m_responseheaders.md index 90a43eebdd78d..209f0e96c09c5 100644 --- a/docs/framework/additional-apis/coreresponsedata_m_responseheaders.md +++ b/docs/framework/additional-apis/coreresponsedata_m_responseheaders.md @@ -24,7 +24,7 @@ public WebHeaderCollection m_ResponseHeaders ``` > [!WARNING] -> This API is not meant to be used directly in your code. Instead, you should use a to hook networking code. See [DiagnosticSource User's Guide](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md). +> This API is not meant to be used directly in your code. Instead, you should use a to hook networking code. See [DiagnosticSource User's Guide](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md). > > Microsoft does not support the use of this class in a production application under any circumstance. diff --git a/docs/framework/additional-apis/coreresponsedata_m_statuscode.md b/docs/framework/additional-apis/coreresponsedata_m_statuscode.md index d5935700a940c..014f380bc1956 100644 --- a/docs/framework/additional-apis/coreresponsedata_m_statuscode.md +++ b/docs/framework/additional-apis/coreresponsedata_m_statuscode.md @@ -24,7 +24,7 @@ public HttpStatusCode m_StatusCode ``` > [!WARNING] -> This API is not meant to be used directly in your code. Instead, you should use a to hook networking code. See [DiagnosticSource User's Guide](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md). +> This API is not meant to be used directly in your code. Instead, you should use a to hook networking code. See [DiagnosticSource User's Guide](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md). > > Microsoft does not support the use of this class in a production application under any circumstance. diff --git a/docs/framework/additional-apis/httpwebrequest__coreresponse.md b/docs/framework/additional-apis/httpwebrequest__coreresponse.md index 51eabb1c45ff7..f3d0fe2debf28 100644 --- a/docs/framework/additional-apis/httpwebrequest__coreresponse.md +++ b/docs/framework/additional-apis/httpwebrequest__coreresponse.md @@ -24,7 +24,7 @@ private object _CoreResponse ``` > [!WARNING] -> This API is not meant to be used directly in your code. Instead, you should use a to hook networking code. See [DiagnosticSource User's Guide](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md). +> This API is not meant to be used directly in your code. Instead, you should use a to hook networking code. See [DiagnosticSource User's Guide](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md). > > Microsoft does not support the use of this class in a production application under any circumstance. diff --git a/docs/framework/interop/how-to-map-hresults-and-exceptions.md b/docs/framework/interop/how-to-map-hresults-and-exceptions.md index 24efe91b34957..ed660506feaa0 100644 --- a/docs/framework/interop/how-to-map-hresults-and-exceptions.md +++ b/docs/framework/interop/how-to-map-hresults-and-exceptions.md @@ -49,7 +49,7 @@ CMyClass::MethodThatThrows } ``` - The following table provides the common mappings from HRESULT to its comparable exception class in .NET. HRESULT values without explicit mappings are mapped to `COMException`. The complete up-to-date mapping can be found in the [dotnet/runtime repository](https://github.com/dotnet/runtime/blob/master/src/coreclr/vm/rexcep.h). + The following table provides the common mappings from HRESULT to its comparable exception class in .NET. HRESULT values without explicit mappings are mapped to `COMException`. The complete up-to-date mapping can be found in the [dotnet/runtime repository](https://github.com/dotnet/runtime/blob/main/src/coreclr/vm/rexcep.h). |HRESULT|.NET exception| |-------------|--------------------| diff --git a/docs/framework/tools/ngen-exe-native-image-generator.md b/docs/framework/tools/ngen-exe-native-image-generator.md index 52cac68e93f18..c57e0e6566d90 100644 --- a/docs/framework/tools/ngen-exe-native-image-generator.md +++ b/docs/framework/tools/ngen-exe-native-image-generator.md @@ -25,7 +25,7 @@ ms.assetid: 44bf97aa-a9a4-4eba-9a0d-cfaa6fc53a66 The Native Image Generator (Ngen.exe) is a tool that improves the performance of managed applications. Ngen.exe creates native images, which are files containing compiled processor-specific machine code, and installs them into the native image cache on the local computer. The runtime can use native images from the cache instead of using the just-in-time (JIT) compiler to compile the original assembly. > [!NOTE] -> Ngen.exe compiles native images for assemblies that target the .NET Framework only. The equivalent native image generator for .NET Core is [CrossGen](https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/crossgen.md). +> Ngen.exe compiles native images for assemblies that target the .NET Framework only. The equivalent native image generator for .NET Core is [CrossGen](https://github.com/dotnet/runtime/blob/main/docs/workflow/building/coreclr/crossgen.md). Changes to Ngen.exe in the .NET Framework 4: diff --git a/docs/framework/whats-new/index.md b/docs/framework/whats-new/index.md index b389d80e9b2aa..32242f7d7d7fe 100644 --- a/docs/framework/whats-new/index.md +++ b/docs/framework/whats-new/index.md @@ -597,7 +597,7 @@ In addition, a major focus in .NET Framework 4.7.1 is improved accessibility, wh **Support for .NET Standard 2.0** -[.NET Standard](../../standard/net-standard.md) defines a set of APIs that must be available on each .NET implementation that supports that version of the standard. .NET Framework 4.7.1 fully supports .NET Standard 2.0 and adds [about 200 APIs](https://github.com/dotnet/standard/blob/master/src/netstandard/src/ApiCompatBaseline.net461.txt) that are defined in .NET Standard 2.0 and are missing from .NET Framework 4.6.1, 4.6.2, and 4.7. (Note that these versions of .NET Framework support .NET Standard 2.0 only if additional .NET Standard support files are also deployed on the target system.) For more information, see "BCL - .NET Standard 2.0 Support" in the [.NET Framework 4.7.1 Runtime and Compiler Features](https://devblogs.microsoft.com/dotnet/net-framework-4-7-1-runtime-and-compiler-features/) blog post. +[.NET Standard](../../standard/net-standard.md) defines a set of APIs that must be available on each .NET implementation that supports that version of the standard. .NET Framework 4.7.1 fully supports .NET Standard 2.0 and adds [about 200 APIs](https://github.com/dotnet/standard/blob/main/src/netstandard/src/ApiCompatBaseline.net461.txt) that are defined in .NET Standard 2.0 and are missing from .NET Framework 4.6.1, 4.6.2, and 4.7. (Note that these versions of .NET Framework support .NET Standard 2.0 only if additional .NET Standard support files are also deployed on the target system.) For more information, see "BCL - .NET Standard 2.0 Support" in the [.NET Framework 4.7.1 Runtime and Compiler Features](https://devblogs.microsoft.com/dotnet/net-framework-4-7-1-runtime-and-compiler-features/) blog post. **Support for configuration builders** diff --git a/docs/fsharp/using-fsharp-on-azure/index.md b/docs/fsharp/using-fsharp-on-azure/index.md index 0788083bc22f2..f170288caba5d 100644 --- a/docs/fsharp/using-fsharp-on-azure/index.md +++ b/docs/fsharp/using-fsharp-on-azure/index.md @@ -55,7 +55,7 @@ Azure Storage can also be used in conjunction with Azure Functions through decla [Apache Spark for Azure HDInsight](/azure/hdinsight/spark/apache-spark-overview) is an open source processing framework that runs large-scale data analytics applications. [Azure Databricks](/azure/databricks/scenarios/what-is-azure-databricks) is an Apache Spark-based analytics platform optimized for the Microsoft Azure cloud services platform. Azure makes Apache Spark easy and cost effective to deploy. Develop your Spark application in F# using [.NET for Apache Spark](../../spark/what-is-apache-spark-dotnet.md), a set of .NET bindings for Apache Spark. -* [.NET for Apache Spark F# samples](https://github.com/dotnet/spark/tree/master/examples/Microsoft.Spark.FSharp.Examples) +* [.NET for Apache Spark F# samples](https://github.com/dotnet/spark/tree/main/examples/Microsoft.Spark.FSharp.Examples) * [Install .NET Interactive Jupyter notebooks in Azure HDInsight](../../spark/how-to-guides/hdinsight-notebook-installation.md) * [Submit Apache Spark jobs to Azure HDInsight](../../spark/how-to-guides/hdinsight-deploy-methods.md) * [Submit Apache Spark jobs to Azure Databricks](../../spark/how-to-guides/databricks-deploy-methods.md) diff --git a/docs/fundamentals/code-analysis/code-quality-rule-options.md b/docs/fundamentals/code-analysis/code-quality-rule-options.md index f8e4de24e5654..1c8d701ebb6af 100644 --- a/docs/fundamentals/code-analysis/code-quality-rule-options.md +++ b/docs/fundamentals/code-analysis/code-quality-rule-options.md @@ -39,7 +39,7 @@ The syntax for configuring an option for a *specific* rule is as follows: ## Options -This section lists some of the available options. To see the full list of available options, see [Analyzer configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md). +This section lists some of the available options. To see the full list of available options, see [Analyzer configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md). ### api_surface @@ -100,7 +100,7 @@ This section lists some of the available options. To see the full list of availa | Description | Allowable values | Default value | Configurable rules | | - | - | - | - | -| Names of null-check validation methods that validate that arguments passed to the method are non-null | Allowed method name formats (separated by `|`):
- Method name only (includes all methods with the name, regardless of the containing type or namespace)
- Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format), with an optional `M:` prefix | None | [CA1062](quality-rules/ca1062.md) | +| Names of null-check validation methods that validate that arguments passed to the method are non-null | Allowed method name formats (separated by `|`):
- Method name only (includes all methods with the name, regardless of the containing type or namespace)
- Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/main/spec/documentation-comments.md#id-string-format), with an optional `M:` prefix | None | [CA1062](quality-rules/ca1062.md) | ### additional_string_formatting_methods diff --git a/docs/fundamentals/code-analysis/code-style-rule-options.md b/docs/fundamentals/code-analysis/code-style-rule-options.md index 371f278be902a..b07fe053326bc 100644 --- a/docs/fundamentals/code-analysis/code-style-rule-options.md +++ b/docs/fundamentals/code-analysis/code-style-rule-options.md @@ -251,5 +251,5 @@ dotnet_naming_style.begins_with_i.capitalization = pascal_case - [Enforce code style on build](overview.md#code-style-analysis) - [Quick Actions in Visual Studio](/visualstudio/ide/quick-actions) - [Create portable custom editor options in Visual Studio](/visualstudio/ide/create-portable-custom-editor-options) -- [.NET Compiler Platform "Roslyn" .editorconfig file](https://github.com/dotnet/roslyn/blob/master/.editorconfig) -- [.NET Compiler Platform Runtime .editorconfig file](https://github.com/dotnet/runtime/blob/master/.editorconfig) +- [.NET Compiler Platform "Roslyn" .editorconfig file](https://github.com/dotnet/roslyn/blob/main/.editorconfig) +- [.NET Compiler Platform Runtime .editorconfig file](https://github.com/dotnet/runtime/blob/main/.editorconfig) diff --git a/docs/fundamentals/code-analysis/configuration-options.md b/docs/fundamentals/code-analysis/configuration-options.md index 5a26a128b9e54..8f44900a358ae 100644 --- a/docs/fundamentals/code-analysis/configuration-options.md +++ b/docs/fundamentals/code-analysis/configuration-options.md @@ -60,7 +60,7 @@ The following table shows the different rule severities that you can configure f | `suggestion` | Violations appear as build *messages* and as suggestions in the Visual Studio IDE. | | `silent` | Violations aren't visible to the user. | | `none` | Rule is suppressed completely. | -| `default` | The default severity of the rule is used. The default severities for each .NET release are listed in the [roslyn-analyzers repo](https://github.com/dotnet/roslyn-analyzers/blob/master/src/NetAnalyzers/Core/AnalyzerReleases.Shipped.md). In that table, "Disabled" corresponds to `none`, "Hidden" corresponds to `silent`, and "Info" corresponds to `suggestion`. | +| `default` | The default severity of the rule is used. The default severities for each .NET release are listed in the [roslyn-analyzers repo](https://github.com/dotnet/roslyn-analyzers/blob/main/src/NetAnalyzers/Core/AnalyzerReleases.Shipped.md). In that table, "Disabled" corresponds to `none`, "Hidden" corresponds to `silent`, and "Info" corresponds to `suggestion`. | > [!TIP] > For information about how rule severities surface in Visual Studio, see [Severity levels](/visualstudio/ide/editorconfig-language-conventions#severity-levels). @@ -86,7 +86,7 @@ dotnet_analyzer_diagnostic.severity = ``` > [!IMPORTANT] -> When you configure the severity level for multiple rules with a single entry, either for a *category* of rules or for *all* rules, the severity only applies to rules that are [enabled by default](https://github.com/dotnet/roslyn-analyzers/blob/master/src/NetAnalyzers/Core/AnalyzerReleases.Shipped.md). To enable rules that are disabled by default, you must either: +> When you configure the severity level for multiple rules with a single entry, either for a *category* of rules or for *all* rules, the severity only applies to rules that are [enabled by default](https://github.com/dotnet/roslyn-analyzers/blob/main/src/NetAnalyzers/Core/AnalyzerReleases.Shipped.md). To enable rules that are disabled by default, you must either: > > - Add an explicit `dotnet_diagnostic..severity = ` configuration entry for each rule. > - Enable *all* rules by setting [\](../../core/project-sdk/msbuild-props.md#analysismode) to `AllEnabledByDefault`. diff --git a/docs/fundamentals/code-analysis/overview.md b/docs/fundamentals/code-analysis/overview.md index dee4bd483523d..c225af2793089 100644 --- a/docs/fundamentals/code-analysis/overview.md +++ b/docs/fundamentals/code-analysis/overview.md @@ -47,7 +47,7 @@ The following rules are enabled, by default, in .NET 5.0. You can change the severity of these rules to disable them or elevate them to errors. You can also [enable more rules](#enable-additional-rules). -- For a list of rules that are included with each .NET SDK version, see [Analyzer releases](https://github.com/dotnet/roslyn-analyzers/blob/master/src/NetAnalyzers/Core/AnalyzerReleases.Shipped.md). +- For a list of rules that are included with each .NET SDK version, see [Analyzer releases](https://github.com/dotnet/roslyn-analyzers/blob/main/src/NetAnalyzers/Core/AnalyzerReleases.Shipped.md). - For a list of all the code quality rules, see [Code quality rules](quality-rules/index.md). ### Enable additional rules @@ -60,7 +60,7 @@ You can change the severity of these rules to disable them or elevate them to er | `AllEnabledByDefault` | This is the most aggressive mode. All rules are enabled as build warnings. You can selectively [opt out of](configuration-options.md) individual rules to disable them.

`AllEnabledByDefault` | | `Default` | The default mode, where a handful of rules are enabled as warnings, others are enabled only as Visual Studio IDE suggestions with corresponding code fixes, and the rest are disabled completely. You can selectively [opt into or out of](configuration-options.md) individual rules to disable them.

`Default` | -To find the default severity for each available rule and whether or not the rule is enabled in the default analysis mode, see the [full list of rules](https://github.com/dotnet/roslyn-analyzers/blob/master/src/NetAnalyzers/Core/AnalyzerReleases.Shipped.md). +To find the default severity for each available rule and whether or not the rule is enabled in the default analysis mode, see the [full list of rules](https://github.com/dotnet/roslyn-analyzers/blob/main/src/NetAnalyzers/Core/AnalyzerReleases.Shipped.md). ### Treat warnings as errors diff --git a/docs/fundamentals/code-analysis/predefined-configurations.md b/docs/fundamentals/code-analysis/predefined-configurations.md index e979b01cee0ed..52a3b46383380 100644 --- a/docs/fundamentals/code-analysis/predefined-configurations.md +++ b/docs/fundamentals/code-analysis/predefined-configurations.md @@ -44,5 +44,5 @@ The predefined rule set files for the Microsoft.CodeAnalysis.NetAnalyzers analyz ## See also -- [Analyzer configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md) +- [Analyzer configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md) - [.NET code style rule options for EditorConfig](code-style-rule-options.md) diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1416.md b/docs/fundamentals/code-analysis/quality-rules/ca1416.md index df6f1bc2ae562..4f996b1a2b0d4 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1416.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1416.md @@ -268,7 +268,7 @@ dotnet_code_quality.enable_platform_analyzer_on_pre_net5_target=true ## See also -- [Annotating platform-specific APIs and detecting its use](https://github.com/dotnet/designs/blob/master/accepted/2020/platform-checks/platform-checks.md) -- [Annotating APIs as unsupported on specific platforms](https://github.com/dotnet/designs/blob/master/accepted/2020/platform-exclusion/platform-exclusion.md) -- [Target Framework Names in .NET 5](https://github.com/dotnet/designs/blob/master/accepted/2020/net5/net5.md) +- [Annotating platform-specific APIs and detecting its use](https://github.com/dotnet/designs/blob/main/accepted/2020/platform-checks/platform-checks.md) +- [Annotating APIs as unsupported on specific platforms](https://github.com/dotnet/designs/blob/main/accepted/2020/platform-exclusion/platform-exclusion.md) +- [Target Framework Names in .NET 5](https://github.com/dotnet/designs/blob/main/accepted/2020/net5/net5.md) - [Interoperability rules](../../../framework/interop/index.md) diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3001.md b/docs/fundamentals/code-analysis/quality-rules/ca3001.md index 45882773a5d60..2a144e5cf4835 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3001.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3001.md @@ -33,7 +33,7 @@ This rule attempts to find input from HTTP requests reaching an SQL command's te > This rule can't track data across assemblies. For example, if one assembly reads the HTTP request input and then passes it to another assembly that executes the SQL command, this rule won't produce a warning. > [!NOTE] -> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. +> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. ## How to fix violations diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3002.md b/docs/fundamentals/code-analysis/quality-rules/ca3002.md index 162c5edd5dd42..c3a3e5d6027ee 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3002.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3002.md @@ -33,7 +33,7 @@ This rule attempts to find input from HTTP requests reaching raw HTML output. > This rule can't track data across assemblies. For example, if one assembly reads the HTTP request input and then passes it to another assembly that outputs raw HTML, this rule won't produce a warning. > [!NOTE] -> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. +> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. ## How to fix violations diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3003.md b/docs/fundamentals/code-analysis/quality-rules/ca3003.md index cc29221ec6c22..3ff85f50f978f 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3003.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3003.md @@ -33,7 +33,7 @@ This rule attempts to find input from HTTP requests reaching a path in a file op > This rule can't track data across assemblies. For example, if one assembly reads the HTTP request input and then passes it to another assembly that writes to a file, this rule won't produce a warning. > [!NOTE] -> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. +> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. ## How to fix violations diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3004.md b/docs/fundamentals/code-analysis/quality-rules/ca3004.md index 7e2657a9d7ff6..1261c459c3a63 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3004.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3004.md @@ -33,7 +33,7 @@ This rule attempts to find an exception message, stack trace, or string represen > This rule can't track data across assemblies. For example, if one assembly catches an exception and then passes it to another assembly that outputs the exception, this rule won't produce a warning. > [!NOTE] -> There is a configurable limit to how deep this rule will analyze data flow across method calls. For information about how to configure the limit in an EditorConfig file, see [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md#dataflow-analysis). +> There is a configurable limit to how deep this rule will analyze data flow across method calls. For information about how to configure the limit in an EditorConfig file, see [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md#dataflow-analysis). ## How to fix violations diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3005.md b/docs/fundamentals/code-analysis/quality-rules/ca3005.md index 9dbbb5c5464eb..e8303c3bacad4 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3005.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3005.md @@ -33,7 +33,7 @@ This rule attempts to find input from HTTP requests reaching an LDAP statement. > This rule can't track data across assemblies. For example, if one assembly reads the HTTP request input and then passes it to another assembly that executes an LDAP statement, this rule won't produce a warning. > [!NOTE] -> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. +> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. ## How to fix violations diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3006.md b/docs/fundamentals/code-analysis/quality-rules/ca3006.md index 95bf0710516ab..7f92b2239cb0f 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3006.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3006.md @@ -33,7 +33,7 @@ This rule attempts to find input from HTTP requests reaching a process command. > This rule can't track data across assemblies. For example, if one assembly reads the HTTP request input and then passes it to another assembly that starts a process, this rule won't produce a warning. > [!NOTE] -> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. +> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. ## How to fix violations diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3007.md b/docs/fundamentals/code-analysis/quality-rules/ca3007.md index fbe59b91f26e7..8ffb969a8cb96 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3007.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3007.md @@ -33,7 +33,7 @@ This rule attempts to find input from HTTP requests reaching an HTTP redirect UR > This rule can't track data across assemblies. For example, if one assembly reads the HTTP request input and then passes it to another assembly that responds with an HTTP redirect, this rule won't produce a warning. > [!NOTE] -> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. +> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. ## How to fix violations diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3008.md b/docs/fundamentals/code-analysis/quality-rules/ca3008.md index f4c87e0cd7f9d..28507df43985d 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3008.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3008.md @@ -33,7 +33,7 @@ This rule attempts to find input from HTTP requests reaching an XPath expression > This rule can't track data across assemblies. For example, if one assembly reads the HTTP request input and then passes it to another assembly that performs an XPath query, this rule won't produce a warning. > [!NOTE] -> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. +> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. ## How to fix violations diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3009.md b/docs/fundamentals/code-analysis/quality-rules/ca3009.md index c4b82f3585e67..1991f0527d71a 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3009.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3009.md @@ -33,7 +33,7 @@ This rule attempts to find input from HTTP requests reaching a raw XML write. > This rule can't track data across assemblies. For example, if one assembly reads the HTTP request input and then passes it to another assembly that writes raw XML, this rule won't produce a warning. > [!NOTE] -> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. +> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. ## How to fix violations diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3010.md b/docs/fundamentals/code-analysis/quality-rules/ca3010.md index 25a653a995c9b..358302396daed 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3010.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3010.md @@ -33,7 +33,7 @@ This rule attempts to find input from HTTP requests that reaches a This rule can't track data across assemblies. For example, if one assembly reads the HTTP request input and then passes it to another assembly that loads XAML, this rule won't produce a warning. > [!NOTE] -> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. +> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. ## How to fix violations diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3011.md b/docs/fundamentals/code-analysis/quality-rules/ca3011.md index abbf8a7188c87..eb80ebeb326bf 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3011.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3011.md @@ -33,7 +33,7 @@ This rule attempts to find input from an HTTP request that reaches a method that > This rule can't track data across assemblies. For example, if one assembly reads the HTTP request input and then passes it to another assembly that loads an assembly, this rule won't produce a warning. > [!NOTE] -> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. +> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. ## How to fix violations diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3012.md b/docs/fundamentals/code-analysis/quality-rules/ca3012.md index fff1b7a7cf8e5..1ac819b681245 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3012.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3012.md @@ -33,7 +33,7 @@ This rule attempts to find input from HTTP requests reaching a regular expressio > This rule can't track data across assemblies. For example, if one assembly reads the HTTP request input and then passes it to another assembly that creates a regular expression, this rule won't produce a warning. > [!NOTE] -> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/master/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. +> There is a configurable limit to how deep this rule will analyze data flow across method calls. See [Analyzer Configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md#dataflow-analysis) for how to configure the limit in an EditorConfig file. ## How to fix violations diff --git a/docs/fundamentals/code-analysis/style-rules/naming-rules.md b/docs/fundamentals/code-analysis/style-rules/naming-rules.md index 1556a8b69c8cd..fe3d871501785 100644 --- a/docs/fundamentals/code-analysis/style-rules/naming-rules.md +++ b/docs/fundamentals/code-analysis/style-rules/naming-rules.md @@ -170,5 +170,5 @@ dotnet_naming_rule.public_members_must_be_capitalized.severity = suggestion - [Language rules](language-rules.md) - [Formatting rules](formatting-rules.md) -- [Roslyn naming rules](https://github.com/dotnet/roslyn/blob/master/.editorconfig#L63) +- [Roslyn naming rules](https://github.com/dotnet/roslyn/blob/main/.editorconfig#L63) - [.NET code style rules reference](index.md) diff --git a/docs/iot/intro.md b/docs/iot/intro.md index cdb92853a7045..a303615f663fb 100644 --- a/docs/iot/intro.md +++ b/docs/iot/intro.md @@ -38,16 +38,16 @@ The .NET IoT Libraries are composed of two NuGet packages: The `Iot.Device.Bindings` package: -* Contains [device bindings](https://github.com/dotnet/iot/blob/master/src/devices/README.md) to streamline app development by wrapping System.Device.Gpio. +* Contains [device bindings](https://github.com/dotnet/iot/blob/main/src/devices/README.md) to streamline app development by wrapping System.Device.Gpio. * Is community-supported, and additional bindings are added continually. Commonly used device bindings include: -- [CharacterLcd - LCD character display](https://github.com/dotnet/iot/tree/master/src/devices/CharacterLcd) -- [SN74HC595 - 8-bit shift register](https://github.com/dotnet/iot/tree/master/src/devices/Sn74hc595) -- [BrickPi3](https://github.com/dotnet/iot/tree/master/src/devices/BrickPi3) -- [Max7219 - LED Matrix driver](https://github.com/dotnet/iot/tree/master/src/devices/Max7219) -- [RGBLedMatrix - RGB LED Matrix](https://github.com/dotnet/iot/tree/master/src/devices/RGBLedMatrix) +- [CharacterLcd - LCD character display](https://github.com/dotnet/iot/tree/main/src/devices/CharacterLcd) +- [SN74HC595 - 8-bit shift register](https://github.com/dotnet/iot/tree/main/src/devices/Sn74hc595) +- [BrickPi3](https://github.com/dotnet/iot/tree/main/src/devices/BrickPi3) +- [Max7219 - LED Matrix driver](https://github.com/dotnet/iot/tree/main/src/devices/Max7219) +- [RGBLedMatrix - RGB LED Matrix](https://github.com/dotnet/iot/tree/main/src/devices/RGBLedMatrix) ## Supported operating systems diff --git a/docs/machine-learning/automate-training-with-model-builder.md b/docs/machine-learning/automate-training-with-model-builder.md index ebedc749574c6..62c110b9a7887 100644 --- a/docs/machine-learning/automate-training-with-model-builder.md +++ b/docs/machine-learning/automate-training-with-model-builder.md @@ -127,11 +127,11 @@ If you don't have your own data yet, try out one of these datasets: |Scenario|Example|Data|Label|Features| |-|-|-|-|-| -|Classification|Predict sales anomalies|[product sales data](https://github.com/dotnet/machinelearning-samples/blob/master/samples/csharp/getting-started/AnomalyDetection_Sales/SpikeDetection/Data/product-sales.csv)|Product Sales|Month| -||Predict sentiment of website comments|[website comment data](https://raw.githubusercontent.com/dotnet/machinelearning/master/test/data/wikipedia-detox-250-line-data.tsv)|Label (0 when negative sentiment, 1 when positive)|Comment, Year| -||Predict fraudulent credit card transactions|[credit card data](https://github.com/dotnet/machinelearning-samples/blob/master/samples/csharp/getting-started/BinaryClassification_CreditCardFraudDetection/CCFraudDetection.Trainer/assets/input/creditcardfraud-dataset.zip)|Class (1 when fraudulent, 0 otherwise)|Amount, V1-V28 (anonymized features)| -||Predict the type of issue in a GitHub repository|[GitHub issue data](https://github.com/dotnet/machinelearning-samples/blob/master/samples/csharp/end-to-end-apps/MulticlassClassification-GitHubLabeler/GitHubLabeler/Data/corefx-issues-train.tsv)|Area|Title, Description| -|Value prediction|Predict taxi fare price|[taxi fare data](https://github.com/dotnet/machinelearning-samples/blob/master/datasets/taxi-fare-train.csv)|Fare|Trip time, distance| +|Classification|Predict sales anomalies|[product sales data](https://github.com/dotnet/machinelearning-samples/blob/main/samples/csharp/getting-started/AnomalyDetection_Sales/SpikeDetection/Data/product-sales.csv)|Product Sales|Month| +||Predict sentiment of website comments|[website comment data](https://raw.githubusercontent.com/dotnet/machinelearning/main/test/data/wikipedia-detox-250-line-data.tsv)|Label (0 when negative sentiment, 1 when positive)|Comment, Year| +||Predict fraudulent credit card transactions|[credit card data](https://github.com/dotnet/machinelearning-samples/blob/main/samples/csharp/getting-started/BinaryClassification_CreditCardFraudDetection/CCFraudDetection.Trainer/assets/input/creditcardfraud-dataset.zip)|Class (1 when fraudulent, 0 otherwise)|Amount, V1-V28 (anonymized features)| +||Predict the type of issue in a GitHub repository|[GitHub issue data](https://github.com/dotnet/machinelearning-samples/blob/main/samples/csharp/end-to-end-apps/MulticlassClassification-GitHubLabeler/GitHubLabeler/Data/corefx-issues-train.tsv)|Area|Title, Description| +|Value prediction|Predict taxi fare price|[taxi fare data](https://github.com/dotnet/machinelearning-samples/blob/main/datasets/taxi-fare-train.csv)|Fare|Trip time, distance| |Image classification|Predict the category of a flower |[flower images](http://download.tensorflow.org/example_images/flower_photos.tgz)|The type of flower: daisy, dandelion, roses, sunflowers, tulips|The image data itself| |Recommendation|Predict movies that someone will like|[movie ratings](http://files.grouplens.org/datasets/movielens/ml-latest-small.zip)|Users, Movies|Ratings| diff --git a/docs/machine-learning/how-to-guides/how-to-use-the-automl-api.md b/docs/machine-learning/how-to-guides/how-to-use-the-automl-api.md index bb974343a02fc..9defa251fb96f 100644 --- a/docs/machine-learning/how-to-guides/how-to-use-the-automl-api.md +++ b/docs/machine-learning/how-to-guides/how-to-use-the-automl-api.md @@ -226,4 +226,4 @@ The following are all the available metrics per ML task: ## See also -For full code samples and more visit the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/master#automate-mlnet-models-generation-preview-state) GitHub repository. +For full code samples and more visit the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/main#automate-mlnet-models-generation-preview-state) GitHub repository. diff --git a/docs/machine-learning/how-to-guides/install-ml-net-cli.md b/docs/machine-learning/how-to-guides/install-ml-net-cli.md index 56e719ba1c578..4c86284568959 100644 --- a/docs/machine-learning/how-to-guides/install-ml-net-cli.md +++ b/docs/machine-learning/how-to-guides/install-ml-net-cli.md @@ -103,9 +103,9 @@ On the machine where you'd like to enable completion, you'll need to do two thin 2. Add the appropriate shim script to your shell profile. You may have to create a shell profile file. The shim script will forward completion requests from your shell to the `dotnet-suggest` tool, which delegates to the appropriate `System.CommandLine`-based app. - - For bash, add the contents of [dotnet-suggest-shim.bash](https://github.com/dotnet/System.CommandLine/blob/master/src/System.CommandLine.Suggest/dotnet-suggest-shim.bash) to `~/.bash_profile`. + - For bash, add the contents of [dotnet-suggest-shim.bash](https://github.com/dotnet/System.CommandLine/blob/main/src/System.CommandLine.Suggest/dotnet-suggest-shim.bash) to `~/.bash_profile`. - - For PowerShell, add the contents of [dotnet-suggest-shim.ps1](https://github.com/dotnet/System.CommandLine/blob/master/src/System.CommandLine.Suggest/dotnet-suggest-shim.ps1) to your PowerShell profile. You can find the expected path to your PowerShell profile by running the following command in your console: + - For PowerShell, add the contents of [dotnet-suggest-shim.ps1](https://github.com/dotnet/System.CommandLine/blob/main/src/System.CommandLine.Suggest/dotnet-suggest-shim.ps1) to your PowerShell profile. You can find the expected path to your PowerShell profile by running the following command in your console: ```console echo $profile diff --git a/docs/machine-learning/how-to-guides/serve-model-serverless-azure-functions-ml-net.md b/docs/machine-learning/how-to-guides/serve-model-serverless-azure-functions-ml-net.md index dac51c88ec27c..2277bad0ae9e7 100644 --- a/docs/machine-learning/how-to-guides/serve-model-serverless-azure-functions-ml-net.md +++ b/docs/machine-learning/how-to-guides/serve-model-serverless-azure-functions-ml-net.md @@ -20,11 +20,11 @@ Learn how to deploy a pre-trained ML.NET machine learning model for predictions - [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/?utm_medium=microsoft&utm_source=docs.microsoft.com&utm_campaign=inline+link&utm_content=download+vs2019) or later or Visual Studio 2017 version 15.6 or later with the ".NET Core cross-platform development" and "Azure development" workloads installed. - [Azure Functions Tools](/azure/azure-functions/functions-develop-vs#check-your-tools-version) - PowerShell -- Pre-trained model. Use the [ML.NET Sentiment Analysis tutorial](../tutorials/sentiment-analysis.md) to build your own model or download this [pre-trained sentiment analysis machine learning model](https://github.com/dotnet/samples/blob/master/machine-learning/models/sentimentanalysis/sentiment_model.zip) +- Pre-trained model. Use the [ML.NET Sentiment Analysis tutorial](../tutorials/sentiment-analysis.md) to build your own model or download this [pre-trained sentiment analysis machine learning model](https://github.com/dotnet/samples/blob/main/machine-learning/models/sentimentanalysis/sentiment_model.zip) ## Azure Functions sample overview -This sample is a **C# HTTP Trigger Azure Functions application** that uses a pretrained binary classification model to categorize the sentiment of text as positive or negative. Azure Functions provides an easy way to run small pieces of code at scale on a managed serverless environment in the cloud. The code for this sample can be found on the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/master/samples/csharp/end-to-end-apps/ScalableMLModelOnAzureFunction) repository on GitHub. +This sample is a **C# HTTP Trigger Azure Functions application** that uses a pretrained binary classification model to categorize the sentiment of text as positive or negative. Azure Functions provides an easy way to run small pieces of code at scale on a managed serverless environment in the cloud. The code for this sample can be found on the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/main/samples/csharp/end-to-end-apps/ScalableMLModelOnAzureFunction) repository on GitHub. ## Create Azure Functions project @@ -158,7 +158,7 @@ The model is identified by the `modelName` parameter so that more than one model >builder.Services.AddPredictionEnginePool() > .FromUri( > modelName: "SentimentAnalysisModel", -> uri:"https://github.com/dotnet/samples/raw/master/machine-learning/models/sentimentanalysis/sentiment_model.zip", +> uri:"https://github.com/dotnet/samples/raw/main/machine-learning/models/sentimentanalysis/sentiment_model.zip", > period: TimeSpan.FromMinutes(1)); >``` diff --git a/docs/machine-learning/how-to-guides/serve-model-web-api-ml-net.md b/docs/machine-learning/how-to-guides/serve-model-web-api-ml-net.md index c3f3df9cbfe73..c98f1d6a3d955 100644 --- a/docs/machine-learning/how-to-guides/serve-model-web-api-ml-net.md +++ b/docs/machine-learning/how-to-guides/serve-model-web-api-ml-net.md @@ -16,7 +16,7 @@ Learn how to serve a pre-trained ML.NET machine learning model on the web using - [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/?utm_medium=microsoft&utm_source=docs.microsoft.com&utm_campaign=inline+link&utm_content=download+vs2019) or later or Visual Studio 2017 version 15.6 or later with the ".NET Core cross-platform development" workload installed. - PowerShell. -- Pre-trained model. Use the [ML.NET Sentiment Analysis tutorial](../tutorials/sentiment-analysis.md) to build your own model or download this [pre-trained sentiment analysis machine learning model](https://github.com/dotnet/samples/blob/master/machine-learning/models/sentimentanalysis/sentiment_model.zip) +- Pre-trained model. Use the [ML.NET Sentiment Analysis tutorial](../tutorials/sentiment-analysis.md) to build your own model or download this [pre-trained sentiment analysis machine learning model](https://github.com/dotnet/samples/blob/main/machine-learning/models/sentimentanalysis/sentiment_model.zip) ## Create ASP.NET Core Web API project @@ -134,7 +134,7 @@ The model is identified by the `modelName` parameter so that more than one model >services.AddPredictionEnginePool() > .FromUri( > modelName: "SentimentAnalysisModel", -> uri:"https://github.com/dotnet/samples/raw/master/machine-learning/models/sentimentanalysis/sentiment_model.zip", +> uri:"https://github.com/dotnet/samples/raw/main/machine-learning/models/sentimentanalysis/sentiment_model.zip", > period: TimeSpan.FromMinutes(1)); >``` diff --git a/docs/machine-learning/tutorials/github-issue-classification.md b/docs/machine-learning/tutorials/github-issue-classification.md index 52b79a1823969..04f613f77e0e8 100644 --- a/docs/machine-learning/tutorials/github-issue-classification.md +++ b/docs/machine-learning/tutorials/github-issue-classification.md @@ -20,13 +20,13 @@ In this tutorial, you learn how to: > * Predict with the trained model > * Deploy and Predict with a loaded model -You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/GitHubIssueClassification) repository. +You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/GitHubIssueClassification) repository. ## Prerequisites * [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/?utm_medium=microsoft&utm_source=docs.microsoft.com&utm_campaign=inline+link&utm_content=download+vs2019) or later or Visual Studio 2017 version 15.6 or later with the ".NET Core cross-platform development" workload installed. -* The [GitHub issues tab separated file (issues_train.tsv)](https://raw.githubusercontent.com/dotnet/samples/master/machine-learning/tutorials/GitHubIssueClassification/Data/issues_train.tsv). -* The [GitHub issues test tab separated file (issues_test.tsv)](https://raw.githubusercontent.com/dotnet/samples/master/machine-learning/tutorials/GitHubIssueClassification/Data/issues_test.tsv). +* The [GitHub issues tab separated file (issues_train.tsv)](https://raw.githubusercontent.com/dotnet/samples/main/machine-learning/tutorials/GitHubIssueClassification/Data/issues_train.tsv). +* The [GitHub issues test tab separated file (issues_test.tsv)](https://raw.githubusercontent.com/dotnet/samples/main/machine-learning/tutorials/GitHubIssueClassification/Data/issues_test.tsv). ## Create a console application @@ -50,7 +50,7 @@ You can find the source code for this tutorial at the [dotnet/samples](https://g ### Prepare your data -1. Download the [issues_train.tsv](https://raw.githubusercontent.com/dotnet/samples/master/machine-learning/tutorials/GitHubIssueClassification/Data/issues_train.tsv) and the [issues_test.tsv](https://raw.githubusercontent.com/dotnet/samples/master/machine-learning/tutorials/GitHubIssueClassification/Data/issues_test.tsv) data sets and save them to the *Data* folder previously created. The first dataset trains the machine learning model and the second can be used to evaluate how accurate your model is. +1. Download the [issues_train.tsv](https://raw.githubusercontent.com/dotnet/samples/master/machine-learning/tutorials/GitHubIssueClassification/Data/issues_train.tsv) and the [issues_test.tsv](https://raw.githubusercontent.com/dotnet/samples/main/machine-learning/tutorials/GitHubIssueClassification/Data/issues_test.tsv) data sets and save them to the *Data* folder previously created. The first dataset trains the machine learning model and the second can be used to evaluate how accurate your model is. 2. In Solution Explorer, right-click each of the \*.tsv files and select **Properties**. Under **Advanced**, change the value of **Copy to Output Directory** to **Copy if newer**. @@ -368,7 +368,7 @@ Your results should be similar to the following. As the pipeline processes, it d =============== Single Prediction - Result: area-System.Data =============== ``` -Congratulations! You've now successfully built a machine learning model for classifying and predicting an Area label for a GitHub issue. You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/GitHubIssueClassification) repository. +Congratulations! You've now successfully built a machine learning model for classifying and predicting an Area label for a GitHub issue. You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/GitHubIssueClassification) repository. ## Next steps diff --git a/docs/machine-learning/tutorials/health-violation-classification-model-builder.md b/docs/machine-learning/tutorials/health-violation-classification-model-builder.md index bc5f1af164589..671abeab76eca 100644 --- a/docs/machine-learning/tutorials/health-violation-classification-model-builder.md +++ b/docs/machine-learning/tutorials/health-violation-classification-model-builder.md @@ -33,7 +33,7 @@ For a list of prerequisites and installation instructions, visit the [Model Buil ## Model Builder multiclass classification overview -This sample creates a C# .NET Core console application that categorizes the risk of health violations using a machine learning model built with Model Builder. You can find the source code for this tutorial at the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/master/samples/modelbuilder/MulticlassClassification_RestaurantViolations) GitHub repository. +This sample creates a C# .NET Core console application that categorizes the risk of health violations using a machine learning model built with Model Builder. You can find the source code for this tutorial at the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/main/samples/modelbuilder/MulticlassClassification_RestaurantViolations) GitHub repository. ## Create a console application @@ -140,7 +140,7 @@ Two projects are created as a result of the training process. If you need to reference the generated projects at a later time inside of another solution, you can find them inside the `C:\Users\%USERNAME%\AppData\Local\Temp\MLVSTools` directory. -Congratulations! You've successfully built a machine learning model to categorize the risk of health violations using Model Builder. You can find the source code for this tutorial at the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/master/samples/modelbuilder/MulticlassClassification_RestaurantViolations) GitHub repository. +Congratulations! You've successfully built a machine learning model to categorize the risk of health violations using Model Builder. You can find the source code for this tutorial at the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/main/samples/modelbuilder/MulticlassClassification_RestaurantViolations) GitHub repository. ## Additional resources diff --git a/docs/machine-learning/tutorials/image-classification-api-transfer-learning.md b/docs/machine-learning/tutorials/image-classification-api-transfer-learning.md index 6f5f9d4c115ac..d93bdb1008898 100644 --- a/docs/machine-learning/tutorials/image-classification-api-transfer-learning.md +++ b/docs/machine-learning/tutorials/image-classification-api-transfer-learning.md @@ -112,7 +112,7 @@ Each of these subdirectories contains two additional prefixed subdirectories: In this tutorial, only bridge deck images are used. -1. Download the [dataset](https://github.com/dotnet/machinelearning-samples/tree/master/samples/csharp/getting-started/DeepLearning_ImageClassification_Binary/DeepLearning_ImageClassification/assets.zip) and unzip. +1. Download the [dataset](https://github.com/dotnet/machinelearning-samples/tree/main/samples/csharp/getting-started/DeepLearning_ImageClassification_Binary/DeepLearning_ImageClassification/assets.zip) and unzip. 1. Create a directory named "assets" in your project to save your dataset files. 1. Copy the *CD* and *UD* subdirectories from the recently unzipped directory to the *assets* directory. diff --git a/docs/machine-learning/tutorials/image-classification.md b/docs/machine-learning/tutorials/image-classification.md index daecf6217bdd7..e05019e78182e 100644 --- a/docs/machine-learning/tutorials/image-classification.md +++ b/docs/machine-learning/tutorials/image-classification.md @@ -22,7 +22,7 @@ In this tutorial, you learn how to: > * Train and evaluate the ML.NET model > * Classify a test image -You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/TransferLearningTF) repository. Note that by default, the .NET project configuration for this tutorial targets .NET core 2.2. +You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/TransferLearningTF) repository. Note that by default, the .NET project configuration for this tutorial targets .NET core 2.2. ## What is transfer learning? @@ -33,7 +33,7 @@ For this tutorial, you use part of a TensorFlow model - trained to classify imag ## Prerequisites * [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/?utm_medium=microsoft&utm_source=docs.microsoft.com&utm_campaign=inline+link&utm_content=download+vs2019) or later or Visual Studio 2017 version 15.6 or later with the ".NET Core cross-platform development" workload installed. -* [The tutorial assets directory .ZIP file](https://github.com/dotnet/samples/blob/master/machine-learning/tutorials/TransferLearningTF/image-classifier-assets.zip) +* [The tutorial assets directory .ZIP file](https://github.com/dotnet/samples/blob/main/machine-learning/tutorials/TransferLearningTF/image-classifier-assets.zip) * [The InceptionV1 machine learning model](https://storage.googleapis.com/download.tensorflow.org/models/inception5h.zip) ## Select the right machine learning task @@ -129,7 +129,7 @@ The training and testing images are located in the assets folders that you'll do ### Download assets -1. Download [The project assets directory zip file](https://github.com/dotnet/samples/blob/master/machine-learning/tutorials/TransferLearningTF/image-classifier-assets.zip), and unzip. +1. Download [The project assets directory zip file](https://github.com/dotnet/samples/blob/main/machine-learning/tutorials/TransferLearningTF/image-classifier-assets.zip), and unzip. 1. Copy the `assets` directory into your *TransferLearningTF* project directory. This directory and its subdirectories contain the data and support files (except for the Inception model, which you'll download and add in the next step) needed for this tutorial. @@ -366,7 +366,7 @@ An ML.NET model pipeline is a chain of estimators. Note that no execution happen Congratulations! You've now successfully built a machine learning model for image classification by applying transfer learning to a `TensorFlow` model in ML.NET. -You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/TransferLearningTF) repository. +You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/TransferLearningTF) repository. In this tutorial, you learned how to: > [!div class="checklist"] diff --git a/docs/machine-learning/tutorials/iris-clustering.md b/docs/machine-learning/tutorials/iris-clustering.md index 2dd2c73fe1200..e7746ec9a9f07 100644 --- a/docs/machine-learning/tutorials/iris-clustering.md +++ b/docs/machine-learning/tutorials/iris-clustering.md @@ -50,7 +50,7 @@ As you don't know to which group each flower belongs to, you choose the [unsuper ## Prepare the data -1. Download the [iris.data](https://github.com/dotnet/machinelearning/blob/master/test/data/iris.data) data set and save it to the *Data* folder you've created at the previous step. For more information about the iris data set, see the [Iris flower data set](https://en.wikipedia.org/wiki/Iris_flower_data_set) Wikipedia page and the [Iris Data Set](http://archive.ics.uci.edu/ml/datasets/Iris) page, which is the source of the data set. +1. Download the [iris.data](https://github.com/dotnet/machinelearning/blob/main/test/data/iris.data) data set and save it to the *Data* folder you've created at the previous step. For more information about the iris data set, see the [Iris flower data set](https://en.wikipedia.org/wiki/Iris_flower_data_set) Wikipedia page and the [Iris Data Set](http://archive.ics.uci.edu/ml/datasets/Iris) page, which is the source of the data set. 1. In **Solution Explorer**, right-click the *iris.data* file and select **Properties**. Under **Advanced**, change the value of **Copy to Output Directory** to **Copy if newer**. @@ -182,7 +182,7 @@ Cluster: 2 Distances: 11.69127 0.02159119 25.59896 ``` -Congratulations! You've now successfully built a machine learning model for iris clustering and used it to make predictions. You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/IrisFlowerClustering) GitHub repository. +Congratulations! You've now successfully built a machine learning model for iris clustering and used it to make predictions. You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/IrisFlowerClustering) GitHub repository. ## Next steps diff --git a/docs/machine-learning/tutorials/movie-recommendation.md b/docs/machine-learning/tutorials/movie-recommendation.md index 0f31c81396eee..d13b430632051 100644 --- a/docs/machine-learning/tutorials/movie-recommendation.md +++ b/docs/machine-learning/tutorials/movie-recommendation.md @@ -21,7 +21,7 @@ In this tutorial, you learn how to: > * Evaluate a model > * Deploy and consume a model -You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/MovieRecommendation) repository. +You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/MovieRecommendation) repository. ## Machine learning workflow @@ -64,8 +64,8 @@ There are several ways to approach recommendation problems, such as recommending 1. Download the two datasets and save them to the *Data* folder you previously created: - * Right click on [*recommendation-ratings-train.csv*](https://raw.githubusercontent.com/dotnet/machinelearning-samples/master/samples/csharp/getting-started/MatrixFactorization_MovieRecommendation/Data/recommendation-ratings-train.csv) and select "Save Link (or Target) As..." - * Right click on [*recommendation-ratings-test.csv*](https://raw.githubusercontent.com/dotnet/machinelearning-samples/master/samples/csharp/getting-started/MatrixFactorization_MovieRecommendation/Data/recommendation-ratings-test.csv) and select "Save Link (or Target) As..." + * Right click on [*recommendation-ratings-train.csv*](https://raw.githubusercontent.com/dotnet/machinelearning-samples/main/samples/csharp/getting-started/MatrixFactorization_MovieRecommendation/Data/recommendation-ratings-train.csv) and select "Save Link (or Target) As..." + * Right click on [*recommendation-ratings-test.csv*](https://raw.githubusercontent.com/dotnet/machinelearning-samples/main/samples/csharp/getting-started/MatrixFactorization_MovieRecommendation/Data/recommendation-ratings-test.csv) and select "Save Link (or Target) As..." Make sure you either save the \*.csv files to the *Data* folder, or after you save it elsewhere, move the \*.csv files to the *Data* folder. @@ -396,7 +396,7 @@ Movie 10 is recommended for user 6 =============== Saving the model to a file =============== ``` -Congratulations! You've now successfully built a machine learning model for recommending movies. You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/MovieRecommendation) repository. +Congratulations! You've now successfully built a machine learning model for recommending movies. You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/MovieRecommendation) repository. ## Improve your model @@ -441,8 +441,8 @@ The matrix factorization algorithm with collaborative filtering is only one appr | Algorithm | Scenario | Sample | | ------------- |:-------------:| -----:| -| One Class Matrix Factorization | Use this when you only have userId and movieId. This style of recommendation is based upon the co-purchase scenario, or products frequently bought together, which means it will recommend to customers a set of products based upon their own purchase order history. | [>Try it out](https://github.com/dotnet/machinelearning-samples/tree/master/samples/csharp/getting-started/MatrixFactorization_ProductRecommendation) | -| Field Aware Factorization Machines | Use this to make recommendations when you have more Features beyond userId, productId, and rating (such as product description or product price). This method also uses a collaborative filtering approach. | [>Try it out](https://github.com/dotnet/machinelearning-samples/tree/master/samples/csharp/end-to-end-apps/Recommendation-MovieRecommender) | +| One Class Matrix Factorization | Use this when you only have userId and movieId. This style of recommendation is based upon the co-purchase scenario, or products frequently bought together, which means it will recommend to customers a set of products based upon their own purchase order history. | [>Try it out](https://github.com/dotnet/machinelearning-samples/tree/main/samples/csharp/getting-started/MatrixFactorization_ProductRecommendation) | +| Field Aware Factorization Machines | Use this to make recommendations when you have more Features beyond userId, productId, and rating (such as product description or product price). This method also uses a collaborative filtering approach. | [>Try it out](https://github.com/dotnet/machinelearning-samples/tree/main/samples/csharp/end-to-end-apps/Recommendation-MovieRecommender) | ### New user scenario diff --git a/docs/machine-learning/tutorials/object-detection-model-builder.md b/docs/machine-learning/tutorials/object-detection-model-builder.md index 309c803ed33f3..1b4382755599a 100644 --- a/docs/machine-learning/tutorials/object-detection-model-builder.md +++ b/docs/machine-learning/tutorials/object-detection-model-builder.md @@ -47,7 +47,7 @@ Some use cases for object detection include: - Object Counting - Activity Recognition -This sample creates a C# .NET Core console application that detects stop signs in images using a machine learning model built with Model Builder. You can find the source code for this tutorial at the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/master/samples/modelbuilder/ObjectDetection_StopSigns) GitHub repository. +This sample creates a C# .NET Core console application that detects stop signs in images using a machine learning model built with Model Builder. You can find the source code for this tutorial at the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/main/samples/modelbuilder/ObjectDetection_StopSigns) GitHub repository. ## Prepare and understand the data @@ -253,7 +253,7 @@ Two projects are created as a result of the training process. Top: 89.453415, Left: 481.95343, Right: 724.8073, Bottom: 388.32385, Label: Stop-Sign, Score: 0.99539465 ``` -Congratulations! You've successfully built a machine learning model to detect stop signs in images using Model Builder. You can find the source code for this tutorial at the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/master/samples/modelbuilder/ObjectDetection_StopSigns) GitHub repository. +Congratulations! You've successfully built a machine learning model to detect stop signs in images using Model Builder. You can find the source code for this tutorial at the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/main/samples/modelbuilder/ObjectDetection_StopSigns) GitHub repository. ## Additional resources diff --git a/docs/machine-learning/tutorials/phone-calls-anomaly-detection.md b/docs/machine-learning/tutorials/phone-calls-anomaly-detection.md index 5ca333e6c6712..d887811685f69 100644 --- a/docs/machine-learning/tutorials/phone-calls-anomaly-detection.md +++ b/docs/machine-learning/tutorials/phone-calls-anomaly-detection.md @@ -17,13 +17,13 @@ In this tutorial, you learn how to: > * Detect period for a time series > * Detect anomaly for a periodical time series -You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/PhoneCallsAnomalyDetection) repository. +You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/PhoneCallsAnomalyDetection) repository. ## Prerequisites * [Visual Studio 2019 version 16.7.8 or later](https://visualstudio.microsoft.com/downloads/?utm_medium=microsoft&utm_source=docs.microsoft.com&utm_campaign=inline+link&utm_content=download+vs2019) with the ".NET Core cross-platform development" workload installed. -* [The phone-calls.csv dataset](https://github.com/dotnet/machinelearning-samples/blob/master/samples/csharp/getting-started/AnomalyDetection_PhoneCalls/SrEntireDetection/Data/phone-calls.csv). +* [The phone-calls.csv dataset](https://github.com/dotnet/machinelearning-samples/blob/main/samples/csharp/getting-started/AnomalyDetection_PhoneCalls/SrEntireDetection/Data/phone-calls.csv). ## Create a console application @@ -45,7 +45,7 @@ You can find the source code for this tutorial at the [dotnet/samples](https://g 1. Download the dataset and save it to the *Data* folder you previously created: - Right click on [*phone-calls.csv*](https://raw.githubusercontent.com/dotnet/machinelearning-samples/master/samples/csharp/getting-started/AnomalyDetection_PhoneCalls/SrEntireDetection/Data/phone-calls.csv) and select "Save Link (or Target) As..." + Right click on [*phone-calls.csv*](https://raw.githubusercontent.com/dotnet/machinelearning-samples/main/samples/csharp/getting-started/AnomalyDetection_PhoneCalls/SrEntireDetection/Data/phone-calls.csv) and select "Save Link (or Target) As..." Make sure you either save the \*.csv file to the *Data* folder, or after you save it elsewhere, move the \*.csv file to the *Data* folder. @@ -244,7 +244,7 @@ Index Data Anomaly AnomalyScore Mag ExpectedValue BoundaryUnit Congratulations! You've now successfully built machine learning models for detecting period and anomaly on a periodical series. -You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/PhoneCallsAnomalyDetection) repository. +You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/PhoneCallsAnomalyDetection) repository. In this tutorial, you learned how to: > [!div class="checklist"] @@ -257,4 +257,4 @@ In this tutorial, you learned how to: Check out the Machine Learning samples GitHub repository to explore a Power Consumption Anomaly Detection sample. > [!div class="nextstepaction"] -> [dotnet/machinelearning-samples GitHub repository](https://github.com/dotnet/machinelearning-samples/tree/master/samples/csharp/getting-started/AnomalyDetection_PowerMeterReadings) +> [dotnet/machinelearning-samples GitHub repository](https://github.com/dotnet/machinelearning-samples/tree/main/samples/csharp/getting-started/AnomalyDetection_PowerMeterReadings) diff --git a/docs/machine-learning/tutorials/predict-prices-with-model-builder.md b/docs/machine-learning/tutorials/predict-prices-with-model-builder.md index 4c73094f14b29..c65bd05e24260 100644 --- a/docs/machine-learning/tutorials/predict-prices-with-model-builder.md +++ b/docs/machine-learning/tutorials/predict-prices-with-model-builder.md @@ -42,7 +42,7 @@ For a list of pre-requisites and installation instructions, visit the [Model Bui 1. The data set used to train and evaluate the machine learning model is originally from the NYC TLC Taxi Trip data set. - 1. To download the data set, navigate to the [taxi-fare-train.csv download link](https://raw.githubusercontent.com/dotnet/machinelearning/master/test/data/taxi-fare-train.csv). + 1. To download the data set, navigate to the [taxi-fare-train.csv download link](https://raw.githubusercontent.com/dotnet/machinelearning/main/test/data/taxi-fare-train.csv). 1. When the page loads, right-click anywhere on the page and select **Save as**. diff --git a/docs/machine-learning/tutorials/predict-prices.md b/docs/machine-learning/tutorials/predict-prices.md index a27685bca6874..b644f2c951cd3 100644 --- a/docs/machine-learning/tutorials/predict-prices.md +++ b/docs/machine-learning/tutorials/predict-prices.md @@ -38,7 +38,7 @@ In this tutorial, you learn how to: ## Prepare and understand the data -1. Download the [taxi-fare-train.csv](https://github.com/dotnet/machinelearning/blob/master/test/data/taxi-fare-train.csv) and the [taxi-fare-test.csv](https://github.com/dotnet/machinelearning/blob/master/test/data/taxi-fare-test.csv) data sets and save them to the *Data* folder you've created at the previous step. We use these data sets to train the machine learning model and then evaluate how accurate the model is. These data sets are originally from the [NYC TLC Taxi Trip data set](https://www1.nyc.gov/site/tlc/about/tlc-trip-record-data.page). +1. Download the [taxi-fare-train.csv](https://github.com/dotnet/machinelearning/blob/master/test/data/taxi-fare-train.csv) and the [taxi-fare-test.csv](https://github.com/dotnet/machinelearning/blob/main/test/data/taxi-fare-test.csv) data sets and save them to the *Data* folder you've created at the previous step. We use these data sets to train the machine learning model and then evaluate how accurate the model is. These data sets are originally from the [NYC TLC Taxi Trip data set](https://www1.nyc.gov/site/tlc/about/tlc-trip-record-data.page). 1. In **Solution Explorer**, right-click each of the \*.csv files and select **Properties**. Under **Advanced**, change the value of **Copy to Output Directory** to **Copy if newer**. @@ -263,7 +263,7 @@ To display the predicted fare of the specified trip, add the following code into Run the program to see the predicted taxi fare for your test case. -Congratulations! You've now successfully built a machine learning model for predicting taxi trip fares, evaluated its accuracy, and used it to make predictions. You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/TaxiFarePrediction) GitHub repository. +Congratulations! You've now successfully built a machine learning model for predicting taxi trip fares, evaluated its accuracy, and used it to make predictions. You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/TaxiFarePrediction) GitHub repository. ## Next steps diff --git a/docs/machine-learning/tutorials/sales-anomaly-detection.md b/docs/machine-learning/tutorials/sales-anomaly-detection.md index e00e4e20d27d9..6649e4924644f 100644 --- a/docs/machine-learning/tutorials/sales-anomaly-detection.md +++ b/docs/machine-learning/tutorials/sales-anomaly-detection.md @@ -19,13 +19,13 @@ In this tutorial, you learn how to: > * Create a transform for change point anomaly detection > * Detect change point anomalies with the transform -You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/ProductSalesAnomalyDetection) repository. +You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/ProductSalesAnomalyDetection) repository. ## Prerequisites * [Visual Studio 2017 version 15.6 or later](https://visualstudio.microsoft.com/downloads/?utm_medium=microsoft&utm_source=docs.microsoft.com&utm_campaign=inline+link&utm_content=download+vs2019) with the ".NET Core cross-platform development" workload installed. -* [The product-sales.csv dataset](https://raw.githubusercontent.com/dotnet/machinelearning-samples/master/samples/csharp/getting-started/AnomalyDetection_Sales/SpikeDetection/Data/product-sales.csv) +* [The product-sales.csv dataset](https://raw.githubusercontent.com/dotnet/machinelearning-samples/main/samples/csharp/getting-started/AnomalyDetection_Sales/SpikeDetection/Data/product-sales.csv) >[!NOTE] > The data format in `product-sales.csv` is based on the dataset “Shampoo Sales Over a Three Year Period” originally sourced from DataMarket and provided by Time Series Data Library (TSDL), created by Rob Hyndman. @@ -51,7 +51,7 @@ You can find the source code for this tutorial at the [dotnet/samples](https://g 1. Download the dataset and save it to the *Data* folder you previously created: - * Right click on [*product-sales.csv*](https://raw.githubusercontent.com/dotnet/machinelearning-samples/master/samples/csharp/getting-started/AnomalyDetection_Sales/SpikeDetection/Data/product-sales.csv) and select "Save Link (or Target) As..." + * Right click on [*product-sales.csv*](https://raw.githubusercontent.com/dotnet/machinelearning-samples/main/samples/csharp/getting-started/AnomalyDetection_Sales/SpikeDetection/Data/product-sales.csv) and select "Save Link (or Target) As..." Make sure you either save the \*.csv file to the *Data* folder, or after you save it elsewhere, move the \*.csv file to the *Data* folder. @@ -366,7 +366,7 @@ Alert Score P-Value Martingale value Congratulations! You've now successfully built machine learning models for detecting spikes and change point anomalies in sales data. -You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/ProductSalesAnomalyDetection) repository. +You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/ProductSalesAnomalyDetection) repository. In this tutorial, you learned how to: > [!div class="checklist"] @@ -381,4 +381,4 @@ In this tutorial, you learned how to: Check out the Machine Learning samples GitHub repository to explore a seasonality data anomaly detection sample. > [!div class="nextstepaction"] -> [dotnet/machinelearning-samples GitHub repository](https://github.com/dotnet/machinelearning-samples/tree/master/samples/csharp/getting-started/AnomalyDetection_PhoneCalls) +> [dotnet/machinelearning-samples GitHub repository](https://github.com/dotnet/machinelearning-samples/tree/main/samples/csharp/getting-started/AnomalyDetection_PhoneCalls) diff --git a/docs/machine-learning/tutorials/sentiment-analysis-model-builder.md b/docs/machine-learning/tutorials/sentiment-analysis-model-builder.md index dac78e9274e04..bda2e9d966ae8 100644 --- a/docs/machine-learning/tutorials/sentiment-analysis-model-builder.md +++ b/docs/machine-learning/tutorials/sentiment-analysis-model-builder.md @@ -50,7 +50,7 @@ For a list of pre-requisites and installation instructions, visit the [Model Bui ## Prepare and understand the data -Download [Wikipedia detox dataset](https://raw.githubusercontent.com/dotnet/machinelearning/master/test/data/wikipedia-detox-250-line-data.tsv). When the webpage opens, right-click on the page, select **Save As** and save the file anywhere on your computer. +Download [Wikipedia detox dataset](https://raw.githubusercontent.com/dotnet/machinelearning/main/test/data/wikipedia-detox-250-line-data.tsv). When the webpage opens, right-click on the page, select **Save As** and save the file anywhere on your computer. Each row in the *wikipedia-detox-250-line-data.tsv* dataset represents a different review left by a user on Wikipedia. The first column represents the sentiment of the text (0 is non-toxic, 1 is toxic), and the second column represents the comment left by the user. The columns are separated by tabs. The data looks like the following: diff --git a/docs/machine-learning/tutorials/sentiment-analysis.md b/docs/machine-learning/tutorials/sentiment-analysis.md index 94d5399b1ff21..2a8cfde8fc096 100644 --- a/docs/machine-learning/tutorials/sentiment-analysis.md +++ b/docs/machine-learning/tutorials/sentiment-analysis.md @@ -21,7 +21,7 @@ In this tutorial, you learn how to: > - Use the model to make a prediction > - See the results -You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/SentimentAnalysis) repository. +You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/SentimentAnalysis) repository. ## Prerequisites @@ -375,7 +375,7 @@ Congratulations! You've now successfully built a machine learning model for clas Building successful models is an iterative process. This model has initial lower quality as the tutorial uses small datasets to provide quick model training. If you aren't satisfied with the model quality, you can try to improve it by providing larger training datasets or by choosing different training algorithms with different [hyper-parameters](../resources/glossary.md#hyperparameter) for each algorithm. -You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/SentimentAnalysis) repository. +You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/SentimentAnalysis) repository. ## Next steps diff --git a/docs/machine-learning/tutorials/text-classification-tf.md b/docs/machine-learning/tutorials/text-classification-tf.md index fb90e2c2e7a92..14b9f81430207 100644 --- a/docs/machine-learning/tutorials/text-classification-tf.md +++ b/docs/machine-learning/tutorials/text-classification-tf.md @@ -19,7 +19,7 @@ In this tutorial, you learn how to: > * Transform website comment text into features suitable for the model > * Use the model to make a prediction -You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/TextClassificationTF) repository. +You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/TextClassificationTF) repository. ## Prerequisites @@ -42,9 +42,9 @@ You can find the source code for this tutorial at the [dotnet/samples](https://g ### Add the TensorFlow model to the project > [!NOTE] -> The model for this tutorial is from the [dotnet/machinelearning-testdata](https://github.com/dotnet/machinelearning-testdata/tree/master/Microsoft.ML.TensorFlow.TestModels/sentiment_model) GitHub repo. The model is in TensorFlow SavedModel format. +> The model for this tutorial is from the [dotnet/machinelearning-testdata](https://github.com/dotnet/machinelearning-testdata/tree/main/Microsoft.ML.TensorFlow.TestModels/sentiment_model) GitHub repo. The model is in TensorFlow SavedModel format. -1. Download the [sentiment_model zip file](https://github.com/dotnet/samples/blob/master/machine-learning/models/textclassificationtf/sentiment_model.zip?raw=true), and unzip. +1. Download the [sentiment_model zip file](https://github.com/dotnet/samples/blob/main/machine-learning/models/textclassificationtf/sentiment_model.zip?raw=true), and unzip. The zip file contains: @@ -246,7 +246,7 @@ Is sentiment/review positive ? Yes Congratulations! You've now successfully built a machine learning model for classifying and predicting messages sentiment by reusing a pre-trained `TensorFlow` model in ML.NET. -You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/master/machine-learning/tutorials/TextClassificationTF) repository. +You can find the source code for this tutorial at the [dotnet/samples](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/TextClassificationTF) repository. In this tutorial, you learned how to: > [!div class="checklist"] diff --git a/docs/machine-learning/tutorials/time-series-demand-forecasting.md b/docs/machine-learning/tutorials/time-series-demand-forecasting.md index 093b322a7031e..4118cc377f85f 100644 --- a/docs/machine-learning/tutorials/time-series-demand-forecasting.md +++ b/docs/machine-learning/tutorials/time-series-demand-forecasting.md @@ -29,7 +29,7 @@ In this tutorial, you learn how to: ## Time series forecasting sample overview -This sample is a **C# .NET Core console application** that forecasts demand for bike rentals using a univariate time series analysis algorithm known as Singular Spectrum Analysis. The code for this sample can be found on the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/master/samples/csharp/getting-started/Forecasting_BikeSharingDemand) repository on GitHub. +This sample is a **C# .NET Core console application** that forecasts demand for bike rentals using a univariate time series analysis algorithm known as Singular Spectrum Analysis. The code for this sample can be found on the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/main/samples/csharp/getting-started/Forecasting_BikeSharingDemand) repository on GitHub. ## Understand the problem @@ -56,7 +56,7 @@ The algorithm used in this tutorial is [Singular Spectrum Analysis(SSA)](http:// ### Prepare and understand the data 1. Create a directory called *Data*. -1. Download the [*DailyDemand.mdf* database file](https://github.com/dotnet/machinelearning-samples/raw/master/samples/csharp/getting-started/Forecasting_BikeSharingDemand/BikeDemandForecasting/Data/DailyDemand.mdf) and save it to the *Data* directory. +1. Download the [*DailyDemand.mdf* database file](https://github.com/dotnet/machinelearning-samples/raw/main/samples/csharp/getting-started/Forecasting_BikeSharingDemand/BikeDemandForecasting/Data/DailyDemand.mdf) and save it to the *Data* directory. > [!NOTE] > The data used in this tutorial comes from the [UCI Bike Sharing Dataset](http://archive.ics.uci.edu/ml/datasets/bike+sharing+dataset). Fanaee-T, Hadi, and Gama, Joao, 'Event labeling combining ensemble detectors and background knowledge', Progress in Artificial Intelligence (2013): pp. 1-15, Springer Berlin Heidelberg, [Web Link](https://link.springer.com/article/10.1007%2Fs13748-013-0040-3). @@ -281,7 +281,7 @@ While the forecasted values are not predicting the exact number of rentals, they Congratulations! You've now successfully built a time series machine learning model to forecast bike rental demand. -You can find the source code for this tutorial at the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/master/samples/csharp/getting-started/Forecasting_BikeSharingDemand) repository. +You can find the source code for this tutorial at the [dotnet/machinelearning-samples](https://github.com/dotnet/machinelearning-samples/tree/main/samples/csharp/getting-started/Forecasting_BikeSharingDemand) repository. ## Next steps diff --git a/docs/samples-and-tutorials/index.md b/docs/samples-and-tutorials/index.md index ecae73adc20be..6bad6b091cc90 100644 --- a/docs/samples-and-tutorials/index.md +++ b/docs/samples-and-tutorials/index.md @@ -16,7 +16,7 @@ The .NET documentation contains a set of samples and tutorials that teach you ab **[Unit Testing in .NET Core using dotnet test](../core/testing/unit-testing-with-dotnet-test.md)** -This guide shows you how to create an ASP.NET Core web app and associated unit tests. It starts by creating a simple web service app and then adds tests. It continues with creating more tests to guide implementing new features. The [completed sample](https://github.com/dotnet/samples/tree/master/core/getting-started/unit-testing-using-dotnet-test) is available in the dotnet/samples repository on GitHub. +This guide shows you how to create an ASP.NET Core web app and associated unit tests. It starts by creating a simple web service app and then adds tests. It continues with creating more tests to guide implementing new features. The [completed sample](https://github.com/dotnet/samples/tree/main/core/getting-started/unit-testing-using-dotnet-test) is available in the dotnet/samples repository on GitHub. ### Tutorials @@ -40,45 +40,45 @@ See the [ASP.NET Core tutorials](/aspnet/core/tutorials/). Many articles in the **[Iterators](../csharp/iterators.md)** -This sample demonstrates the syntax and features for creating and consuming C# iterators. The [completed sample](https://github.com/dotnet/samples/tree/master/csharp/iterators) is available in the dotnet/samples repository on GitHub. +This sample demonstrates the syntax and features for creating and consuming C# iterators. The [completed sample](https://github.com/dotnet/samples/tree/main/csharp/iterators) is available in the dotnet/samples repository on GitHub. **[Indexers](../csharp/indexers.md)** -This sample demonstrates the syntax and features for C# indexers. The [completed sample](https://github.com/dotnet/samples/tree/master/csharp/indexers) is available in the dotnet/samples repository on GitHub. +This sample demonstrates the syntax and features for C# indexers. The [completed sample](https://github.com/dotnet/samples/tree/main/csharp/indexers) is available in the dotnet/samples repository on GitHub. **[Delegates and Events](../csharp/delegates-overview.md)** -This sample demonstrates the syntax and features for C# delegates and events. The [completed sample](https://github.com/dotnet/samples/tree/master/csharp/delegates-and-events) is available in the dotnet/samples repository on GitHub. A [second sample](https://github.com/dotnet/samples/tree/master/csharp/events) focused on events is also in the same repository. +This sample demonstrates the syntax and features for C# delegates and events. The [completed sample](https://github.com/dotnet/samples/tree/master/csharp/delegates-and-events) is available in the dotnet/samples repository on GitHub. A [second sample](https://github.com/dotnet/samples/tree/main/csharp/events) focused on events is also in the same repository. **[Expression Trees](../csharp/expression-trees.md)** -This sample demonstrates many of the problems that can be solved by using Expression Trees. The [completed sample](https://github.com/dotnet/samples/tree/master/csharp/expression-trees) is available in the dotnet/samples repository on GitHub. +This sample demonstrates many of the problems that can be solved by using Expression Trees. The [completed sample](https://github.com/dotnet/samples/tree/main/csharp/expression-trees) is available in the dotnet/samples repository on GitHub. **LINQ Samples** -This series of samples demonstrate many of the features of Language Integrated Query (LINQ). The [completed sample](https://github.com/dotnet/samples/tree/master/core/linq/csharp) is available in the dotnet/samples repository on GitHub. +This series of samples demonstrate many of the features of Language Integrated Query (LINQ). The [completed sample](https://github.com/dotnet/samples/tree/main/core/linq/csharp) is available in the dotnet/samples repository on GitHub. **Managed COM server Sample** -The [COM server](https://github.com/dotnet/samples/tree/master/core/extensions/COMServerDemo) sample demonstrates the creation of a managed COM server and how it can be globally registered or consumed via RegFree COM. +The [COM server](https://github.com/dotnet/samples/tree/main/core/extensions/COMServerDemo) sample demonstrates the creation of a managed COM server and how it can be globally registered or consumed via RegFree COM. **Microsoft Office PIA Sample** -The [ExcelDemo](https://github.com/dotnet/samples/tree/master/core/extensions/ExcelDemo) sample demonstrates the consumption of [Microsoft Office PIAs](/visualstudio/vsto/office-primary-interop-assemblies) in .NET Core. +The [ExcelDemo](https://github.com/dotnet/samples/tree/main/core/extensions/ExcelDemo) sample demonstrates the consumption of [Microsoft Office PIAs](/visualstudio/vsto/office-primary-interop-assemblies) in .NET Core. ### Tutorials **[Console Application](../csharp/tutorials/console-teleprompter.md)** -This tutorial demonstrates Console I/O, the structure of a console app, and the basics of the task-based asynchronous programming model. The [completed sample](https://github.com/dotnet/samples/tree/master/csharp/getting-started/console-teleprompter) is available in the dotnet/samples repository on GitHub. +This tutorial demonstrates Console I/O, the structure of a console app, and the basics of the task-based asynchronous programming model. The [completed sample](https://github.com/dotnet/samples/tree/main/csharp/getting-started/console-teleprompter) is available in the dotnet/samples repository on GitHub. **[REST Client](../csharp/tutorials/console-webapiclient.md)** -This tutorial demonstrates web communications, JSON serialization, and object-oriented features of the C# language. The [completed sample](https://github.com/dotnet/samples/tree/master/csharp/getting-started/console-webapiclient) is available in the dotnet/samples repository on GitHub. +This tutorial demonstrates web communications, JSON serialization, and object-oriented features of the C# language. The [completed sample](https://github.com/dotnet/samples/tree/main/csharp/getting-started/console-webapiclient) is available in the dotnet/samples repository on GitHub. **[Working with LINQ](../csharp/tutorials/working-with-linq.md)** -This tutorial demonstrates many of the features of LINQ and the language elements that support it. The [completed sample](https://github.com/dotnet/samples/tree/master/csharp/getting-started/console-linq) is available in the dotnet/samples repository on GitHub. +This tutorial demonstrates many of the features of LINQ and the language elements that support it. The [completed sample](https://github.com/dotnet/samples/tree/main/csharp/getting-started/console-linq) is available in the dotnet/samples repository on GitHub. **[Tutorial: Create a .NET console application using Visual Studio for Mac](../core/tutorials/with-visual-studio-mac.md)** @@ -90,7 +90,7 @@ This tutorial shows you how to build a .NET class library using Visual Studio fo **[Creating a .NET Core application that supports plugins](../core/tutorials/creating-app-with-plugin-support.md)** -This tutorial shows you how to build a simple application on .NET Core that supports a plugin architecture. The [completed sample](https://github.com/dotnet/samples/tree/master/core/extensions/AppWithPlugin) is available in the dotnet/samples repository on GitHub. +This tutorial shows you how to build a simple application on .NET Core that supports a plugin architecture. The [completed sample](https://github.com/dotnet/samples/tree/main/core/extensions/AppWithPlugin) is available in the dotnet/samples repository on GitHub. ## Deploy to containers @@ -104,7 +104,7 @@ Many topics show source code and samples that are available for viewing or downl 1. Download the repository that contains the sample code by performing one of the following procedures: * Download a ZIP of the repository to your local system. Un-ZIP the compressed archive. - * [Fork](https://help.github.com/articles/fork-a-repo/) the repository and [clone](https://help.github.com/articles/cloning-a-repository/) the fork to your local system. Forking and cloning permits you to make contributions to the documentation by committing changes to your fork and then creating a pull request for the official docs repository. For more information, see the [.NET Documentation Contributing Guide](/contribute/dotnet/dotnet-contribute) and the [ASP.NET Core Docs Contributing Guide](https://github.com/dotnet/AspNetCore.Docs/blob/master/CONTRIBUTING.md). + * [Fork](https://help.github.com/articles/fork-a-repo/) the repository and [clone](https://help.github.com/articles/cloning-a-repository/) the fork to your local system. Forking and cloning permits you to make contributions to the documentation by committing changes to your fork and then creating a pull request for the official docs repository. For more information, see the [.NET Documentation Contributing Guide](/contribute/dotnet/dotnet-contribute) and the [ASP.NET Core Docs Contributing Guide](https://github.com/dotnet/AspNetCore.Docs/blob/main/CONTRIBUTING.md). * Clone the repository locally. If you clone a docs repository directly to your local system, you won't be able to make commits directly against the official repository, so you won't be able to make documentation contributions later. Use the fork and clone procedure previously described if you want to preserve the opportunity to contribute to the documentation later. 1. Navigate within the repository's folders to the sample's location. The relative path to the sample's location appears in your browser's address bar when you follow the link to the sample. 1. To run a sample, you have several options: diff --git a/docs/spark/how-to-guides/databricks-deploy-methods.md b/docs/spark/how-to-guides/databricks-deploy-methods.md index 3fde30b43f955..f2912d4fd2db7 100644 --- a/docs/spark/how-to-guides/databricks-deploy-methods.md +++ b/docs/spark/how-to-guides/databricks-deploy-methods.md @@ -66,7 +66,7 @@ Alternatively, you can use [Set Jar](/azure/databricks/jobs#--create-a-job) in y databricks fs cp .dll dbfs:/apps/dependencies ``` - Uncomment and modify the app dependencies section in [db-init.sh](https://github.com/dotnet/spark/blob/master/deployment/db-init.sh) to point to your app dependencies path. Then, upload the updated *db-init.sh* to your cluster: + Uncomment and modify the app dependencies section in [db-init.sh](https://github.com/dotnet/spark/blob/main/deployment/db-init.sh) to point to your app dependencies path. Then, upload the updated *db-init.sh* to your cluster: ```console cd diff --git a/docs/spark/how-to-guides/deploy-worker-udf-binaries.md b/docs/spark/how-to-guides/deploy-worker-udf-binaries.md index a2914775f33ba..bc5d893fe35b7 100644 --- a/docs/spark/how-to-guides/deploy-worker-udf-binaries.md +++ b/docs/spark/how-to-guides/deploy-worker-udf-binaries.md @@ -22,7 +22,7 @@ When deploying workers and writing UDFs, there are a few commonly used environme | :--------------------------- | :---------- | DOTNET_WORKER_DIR | Path where the Microsoft.Spark.Worker binary has been generated.
It's used by the Spark driver and will be passed to Spark executors. If this variable is not set up, the Spark executors will search the path specified in the PATH environment variable.
_e.g. "C:\bin\Microsoft.Spark.Worker"_ | DOTNET_ASSEMBLY_SEARCH_PATHS | Comma-separated paths where Microsoft.Spark.Worker will load assemblies.
Note that if a path starts with ".", the working directory will be prepended. If in **yarn mode**, "." would represent the container's working directory.
_e.g. "C:\Users\\<user name>\\<mysparkapp>\bin\Debug\\<dotnet version>"_ -| DOTNET_WORKER_DEBUG | If you want to debug a UDF, then set this environment variable to 1 before running spark-submit. +| DOTNET_WORKER_DEBUG | If you want to debug a UDF, then set this environment variable to 1 before running spark-submit. ### Parameter options diff --git a/docs/spark/how-to-guides/dotnet-interactive-udf-issue.md b/docs/spark/how-to-guides/dotnet-interactive-udf-issue.md index 37b8c0b2b6989..581c4a97b6824 100644 --- a/docs/spark/how-to-guides/dotnet-interactive-udf-issue.md +++ b/docs/spark/how-to-guides/dotnet-interactive-udf-issue.md @@ -64,8 +64,8 @@ These are a few important things to keep in mind while implementing UDFs in .NET ![Broadcast Variables fail](./media/dotnet-interactive/broadcast-fails.png) - As recommended in the previous sections, we define both the UDF and the object it is referencing (broadcast variable in this case) in the same cell, but we still see the `SerializationException` error complaining about `Microsoft.Spark.Sql.Session` not being marked as serializable. This is because when the compiler tries to serialize the broadcast variable object `bv`, it finds its name to be appended with [`SparkSession`](https://github.com/dotnet/spark/blob/master/src/csharp/Microsoft.Spark/Sql/SparkSession.cs#L20) object `spark`, which it requires to be marked as serializable. This can be demonstrated with more ease by taking a peek at the decompiled assembly of this cell submission: + As recommended in the previous sections, we define both the UDF and the object it is referencing (broadcast variable in this case) in the same cell, but we still see the `SerializationException` error complaining about `Microsoft.Spark.Sql.Session` not being marked as serializable. This is because when the compiler tries to serialize the broadcast variable object `bv`, it finds its name to be appended with [`SparkSession`](https://github.com/dotnet/spark/blob/main/src/csharp/Microsoft.Spark/Sql/SparkSession.cs#L20) object `spark`, which it requires to be marked as serializable. This can be demonstrated with more ease by taking a peek at the decompiled assembly of this cell submission: ![Decompiled Assembly code](./media/dotnet-interactive/decompiledAssembly.png) - If we mark the [`SparkSession`](https://github.com/dotnet/spark/blob/master/src/csharp/Microsoft.Spark/Sql/SparkSession.cs#L20) class as `[Serializable]`, we can get this to work, but this is not an ideal solution as we don't want to give the user the ability to serialize a SparkSession object, as that could lead to some weird, undesirable behavior. This is a [known issue](https://github.com/dotnet/spark/issues/619) and will be resolved in future versions. + If we mark the [`SparkSession`](https://github.com/dotnet/spark/blob/main/src/csharp/Microsoft.Spark/Sql/SparkSession.cs#L20) class as `[Serializable]`, we can get this to work, but this is not an ideal solution as we don't want to give the user the ability to serialize a SparkSession object, as that could lead to some weird, undesirable behavior. This is a [known issue](https://github.com/dotnet/spark/issues/619) and will be resolved in future versions. diff --git a/docs/spark/how-to-guides/hdinsight-notebook-installation.md b/docs/spark/how-to-guides/hdinsight-notebook-installation.md index 8ef1d2d19e07b..820de6e4bd14f 100644 --- a/docs/spark/how-to-guides/hdinsight-notebook-installation.md +++ b/docs/spark/how-to-guides/hdinsight-notebook-installation.md @@ -54,7 +54,7 @@ In the Azure portal, select the **HDInsight Spark cluster** you created in the p 1. The `install-interactive-notebook.sh` is a script that installs .NET for Apache Spark and makes changes to Apache Livy and sparkmagic. Before you submit a script action to HDInsight, you need to create and upload `install-interactive-notebook.sh`. - Create a new file named **install-interactive-notebook.sh** in your local computer and paste the contents of [install-interactive-notebook.sh contents](https://raw.githubusercontent.com/dotnet/spark/master/deployment/HDI-Spark/Notebooks/install-interactive-notebook.sh). + Create a new file named **install-interactive-notebook.sh** in your local computer and paste the contents of [install-interactive-notebook.sh contents](https://raw.githubusercontent.com/dotnet/spark/main/deployment/HDI-Spark/Notebooks/install-interactive-notebook.sh). Upload the script to a [URI](/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux#understand-script-actions) that's accessible from the HDInsight cluster. For example, `https://.blob.core.windows.net///install-interactive-notebook.sh`. diff --git a/docs/spark/how-to-guides/java-udf-from-dotnet.md b/docs/spark/how-to-guides/java-udf-from-dotnet.md index bf0ab29ae7a3b..835649edecdc9 100644 --- a/docs/spark/how-to-guides/java-udf-from-dotnet.md +++ b/docs/spark/how-to-guides/java-udf-from-dotnet.md @@ -40,7 +40,7 @@ In this article, you learn how to call a Java User-Defined Function (UDF) from y ## Register and call Java UDFs in .NET for Apache Spark 1. Use the [`RegisterJava`](https://github.com/dotnet/spark/blob/8dcdcdc7c60d5f42cba5a90f1346d854ab5bf7bb/src/csharp/Microsoft.Spark/Sql/UDFRegistration.cs#L424) API to register your Java UDF with Spark SQL. -2. Register the `DataFrame` on which you want to call your UDF as an SQL Table using the [`CreateOrReplaceTempView`](https://github.com/dotnet/spark/blob/master/src/csharp/Microsoft.Spark/Sql/DataFrame.cs#L982) function. +2. Register the `DataFrame` on which you want to call your UDF as an SQL Table using the [`CreateOrReplaceTempView`](https://github.com/dotnet/spark/blob/main/src/csharp/Microsoft.Spark/Sql/DataFrame.cs#L982) function. 3. Use `SparkSession.Sql` to call the UDF on the table view using Spark SQL. A basic example to illustrate the above steps: diff --git a/docs/spark/how-to-guides/ubuntu-instructions.md b/docs/spark/how-to-guides/ubuntu-instructions.md index f43e244065078..3caceee4d4cd3 100644 --- a/docs/spark/how-to-guides/ubuntu-instructions.md +++ b/docs/spark/how-to-guides/ubuntu-instructions.md @@ -119,7 +119,7 @@ git clone https://github.com/dotnet/spark.git ~/dotnet.spark ### Build .NET for Spark Scala extensions layer -When you submit a .NET application, .NET for Apache Spark has the necessary logic written in Scala that informs Apache Spark how to handle your requests (e.g., request to create a new Spark Session, request to transfer data from .NET side to JVM side etc.). This logic can be found in the [.NET for Apache Spark Scala Source Code](https://github.com/dotnet/spark/tree/master/src/scala). +When you submit a .NET application, .NET for Apache Spark has the necessary logic written in Scala that informs Apache Spark how to handle your requests (e.g., request to create a new Spark Session, request to transfer data from .NET side to JVM side etc.). This logic can be found in the [.NET for Apache Spark Scala Source Code](https://github.com/dotnet/spark/tree/main/src/scala). The next step is to build the .NET for Apache Spark Scala extension layer: @@ -136,7 +136,7 @@ You should see JARs created for the supported Spark versions: ### Build .NET sample applications using .NET Core CLI -This section explains how to build the [sample applications](https://github.com/dotnet/spark/tree/master/examples) for .NET for Apache Spark. These steps will help in understanding the overall building process for any .NET for Spark application. +This section explains how to build the [sample applications](https://github.com/dotnet/spark/tree/main/examples) for .NET for Apache Spark. These steps will help in understanding the overall building process for any .NET for Spark application. 1. Build the worker: @@ -209,7 +209,7 @@ Once you build the samples, you can use `spark-submit` to submit your .NET Core Here are some examples you can run: - * **[Microsoft.Spark.Examples.Sql.Batch.Basic](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Batch/Basic.cs)** + * **[Microsoft.Spark.Examples.Sql.Batch.Basic](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Batch/Basic.cs)** ```bash spark-submit \ @@ -219,7 +219,7 @@ Once you build the samples, you can use `spark-submit` to submit your .NET Core Microsoft.Spark.CSharp.Examples Sql.Batch.Basic $SPARK_HOME/examples/src/main/resources/people.json ``` - * **[Microsoft.Spark.Examples.Sql.Streaming.StructuredNetworkWordCount](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredNetworkWordCount.cs)** + * **[Microsoft.Spark.Examples.Sql.Streaming.StructuredNetworkWordCount](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredNetworkWordCount.cs)** ```bash spark-submit \ @@ -229,7 +229,7 @@ Once you build the samples, you can use `spark-submit` to submit your .NET Core Microsoft.Spark.CSharp.Examples Sql.Streaming.StructuredNetworkWordCount localhost 9999 ``` - * **[Microsoft.Spark.Examples.Sql.Streaming.StructuredKafkaWordCount (maven accessible)](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredKafkaWordCount.cs)** + * **[Microsoft.Spark.Examples.Sql.Streaming.StructuredKafkaWordCount (maven accessible)](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredKafkaWordCount.cs)** ```bash spark-submit \ @@ -240,7 +240,7 @@ Once you build the samples, you can use `spark-submit` to submit your .NET Core Microsoft.Spark.CSharp.Examples Sql.Streaming.StructuredKafkaWordCount localhost:9092 subscribe test ``` - * **[Microsoft.Spark.Examples.Sql.Streaming.StructuredKafkaWordCount (jars provided)](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredKafkaWordCount.cs)** + * **[Microsoft.Spark.Examples.Sql.Streaming.StructuredKafkaWordCount (jars provided)](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredKafkaWordCount.cs)** ```bash spark-submit \ diff --git a/docs/spark/how-to-guides/udf-guide.md b/docs/spark/how-to-guides/udf-guide.md index 4367ed8624239..0c09dc32ca03c 100644 --- a/docs/spark/how-to-guides/udf-guide.md +++ b/docs/spark/how-to-guides/udf-guide.md @@ -22,7 +22,7 @@ Func udf = Udf( str => $"{s1} {str}"); ``` -The UDF takes a `string` as an input in the form of a [Column](https://github.com/dotnet/spark/blob/master/src/csharp/Microsoft.Spark/Sql/Column.cs#L14) of a [Dataframe](https://github.com/dotnet/spark/blob/master/src/csharp/Microsoft.Spark/Sql/DataFrame.cs#L24)) and returns a `string` with `hello` appended in front of the input. +The UDF takes a `string` as an input in the form of a [Column](https://github.com/dotnet/spark/blob/master/src/csharp/Microsoft.Spark/Sql/Column.cs#L14) of a [Dataframe](https://github.com/dotnet/spark/blob/main/src/csharp/Microsoft.Spark/Sql/DataFrame.cs#L24)) and returns a `string` with `hello` appended in front of the input. The following DataFrame `df` contains a list of names: @@ -54,11 +54,11 @@ The following DataFrame `udfResult` is the result of the UDF: +-------------+ ``` -To better understand how to implement UDFs, review the [UDF helper functions](https://github.com/dotnet/spark/blob/master/src/csharp/Microsoft.Spark/Sql/Functions.cs#L3616) and [examples](https://github.com/dotnet/spark/blob/master/src/csharp/Microsoft.Spark.E2ETest/UdfTests/UdfSimpleTypesTests.cs#L49) on GitHub. +To better understand how to implement UDFs, review the [UDF helper functions](https://github.com/dotnet/spark/blob/master/src/csharp/Microsoft.Spark/Sql/Functions.cs#L3616) and [examples](https://github.com/dotnet/spark/blob/main/src/csharp/Microsoft.Spark.E2ETest/UdfTests/UdfSimpleTypesTests.cs#L49) on GitHub. ## UDF serialization -Because UDFs are functions that need to be executed on workers, they have to be serialized and sent to the workers as part of the payload from the driver. The [delegate](../../csharp/programming-guide/delegates/index.md), which is a reference to the method, needs to be serialized as well as its [target](xref:System.Delegate.Target%2A), which is the class instance on which the current delegate invokes the instance method. Review this [code example in GitHub](https://github.com/dotnet/spark/blob/master/src/csharp/Microsoft.Spark/Utils/CommandSerDe.cs#L149) to get a better understanding of how UDF serialization is being done. +Because UDFs are functions that need to be executed on workers, they have to be serialized and sent to the workers as part of the payload from the driver. The [delegate](../../csharp/programming-guide/delegates/index.md), which is a reference to the method, needs to be serialized as well as its [target](xref:System.Delegate.Target%2A), which is the class instance on which the current delegate invokes the instance method. Review this [code example in GitHub](https://github.com/dotnet/spark/blob/main/src/csharp/Microsoft.Spark/Utils/CommandSerDe.cs#L149) to get a better understanding of how UDF serialization is being done. .NET for Apache Spark uses .NET Core, which doesn't support serializing delegates. Instead, reflection is used to serialize the target where the delegate is defined. When multiple delegates are defined in a common scope, they have a shared closure that becomes the target of reflection for serialization. diff --git a/docs/spark/how-to-guides/windows-instructions.md b/docs/spark/how-to-guides/windows-instructions.md index 93e6d003f6144..69f25687f2329 100644 --- a/docs/spark/how-to-guides/windows-instructions.md +++ b/docs/spark/how-to-guides/windows-instructions.md @@ -94,7 +94,7 @@ git clone https://github.com/dotnet/spark.git C:\github\dotnet-spark ### Build .NET for Apache Spark Scala extensions layer -When you submit a .NET application, .NET for Apache Spark has the necessary logic written in Scala that informs Apache Spark how to handle your requests (for example, request to create a new Spark Session, request to transfer data from .NET side to JVM side etc.). This logic can be found in the [.NET for Spark Scala Source Code](https://github.com/dotnet/spark/tree/master/src/scala). +When you submit a .NET application, .NET for Apache Spark has the necessary logic written in Scala that informs Apache Spark how to handle your requests (for example, request to create a new Spark Session, request to transfer data from .NET side to JVM side etc.). This logic can be found in the [.NET for Spark Scala Source Code](https://github.com/dotnet/spark/tree/main/src/scala). Regardless of whether you are using .NET Framework or .NET Core, you will need to build the .NET for Apache Spark Scala extension layer: @@ -111,7 +111,7 @@ You should see JARs created for the supported Spark versions: ### Build the .NET for Spark sample applications -This section explains how to build the [sample applications](https://github.com/dotnet/spark/tree/master/examples) for .NET for Apache Spark. These steps will help in understanding the overall building process for any .NET for Spark application. +This section explains how to build the [sample applications](https://github.com/dotnet/spark/tree/main/examples) for .NET for Apache Spark. These steps will help in understanding the overall building process for any .NET for Spark application. #### Using Visual Studio for .NET Framework @@ -233,7 +233,7 @@ Once you build the samples, running them will be through `spark-submit` regardle Here are some examples you can run: - - **[Microsoft.Spark.Examples.Sql.Batch.Basic](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Batch/Basic.cs)** + - **[Microsoft.Spark.Examples.Sql.Batch.Basic](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Batch/Basic.cs)** ```powershell spark-submit.cmd ` @@ -243,7 +243,7 @@ Once you build the samples, running them will be through `spark-submit` regardle Microsoft.Spark.CSharp.Examples.exe Sql.Batch.Basic %SPARK_HOME%\examples\src\main\resources\people.json ``` - - **[Microsoft.Spark.Examples.Sql.Streaming.StructuredNetworkWordCount](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredNetworkWordCount.cs)** + - **[Microsoft.Spark.Examples.Sql.Streaming.StructuredNetworkWordCount](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredNetworkWordCount.cs)** ```powershell spark-submit.cmd ` @@ -253,7 +253,7 @@ Once you build the samples, running them will be through `spark-submit` regardle Microsoft.Spark.CSharp.Examples.exe Sql.Streaming.StructuredNetworkWordCount localhost 9999 ``` - - **[Microsoft.Spark.Examples.Sql.Streaming.StructuredKafkaWordCount (maven accessible)](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredKafkaWordCount.cs)** + - **[Microsoft.Spark.Examples.Sql.Streaming.StructuredKafkaWordCount (maven accessible)](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredKafkaWordCount.cs)** ```powershell spark-submit.cmd ` @@ -264,7 +264,7 @@ Once you build the samples, running them will be through `spark-submit` regardle Microsoft.Spark.CSharp.Examples.exe Sql.Streaming.StructuredKafkaWordCount localhost:9092 subscribe test ``` - - **[Microsoft.Spark.Examples.Sql.Streaming.StructuredKafkaWordCount (jars provided)](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredKafkaWordCount.cs)** + - **[Microsoft.Spark.Examples.Sql.Streaming.StructuredKafkaWordCount (jars provided)](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredKafkaWordCount.cs)** ```powershell spark-submit.cmd diff --git a/docs/spark/resources/index.md b/docs/spark/resources/index.md index 87c427357dd3e..2684b93d9804d 100644 --- a/docs/spark/resources/index.md +++ b/docs/spark/resources/index.md @@ -15,4 +15,4 @@ The following [.NET for Apache Spark](../index.yml) resources may be helpful for ### How to engage, contribute and provide feedback -The .NET for Apache Spark team encourages [contributions](https://github.com/dotnet/spark/blob/master/docs/contributing.md), both in the form of issues and pull requests. The first step is to find an existing [issue](https://github.com/dotnet/spark/issues) you want to contribute to. If your issue does not exist, open a [new issue](https://github.com/dotnet/spark/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+). +The .NET for Apache Spark team encourages [contributions](https://github.com/dotnet/spark/blob/main/docs/contributing.md), both in the form of issues and pull requests. The first step is to find an existing [issue](https://github.com/dotnet/spark/issues) you want to contribute to. If your issue does not exist, open a [new issue](https://github.com/dotnet/spark/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+). diff --git a/docs/spark/tutorials/amazon-emr-spark-deployment.md b/docs/spark/tutorials/amazon-emr-spark-deployment.md index f6e7556eb1262..dd85e07934124 100644 --- a/docs/spark/tutorials/amazon-emr-spark-deployment.md +++ b/docs/spark/tutorials/amazon-emr-spark-deployment.md @@ -28,7 +28,7 @@ In this tutorial, you learn how to: Before you start, do the following: * Download the [AWS CLI](https://aws.amazon.com/cli/). -* Download [install-worker.sh](https://github.com/dotnet/spark/blob/master/deployment/install-worker.sh) to your local machine. This is a helper script that you use later to copy .NET for Apache Spark dependent files into your Spark cluster's worker nodes. +* Download [install-worker.sh](https://github.com/dotnet/spark/blob/main/deployment/install-worker.sh) to your local machine. This is a helper script that you use later to copy .NET for Apache Spark dependent files into your Spark cluster's worker nodes. ## Prepare worker dependencies @@ -38,7 +38,7 @@ Before you start, do the following: For example, if you want `.NET for Apache Spark v1.0.0` using `netcoreapp3.1`, you'd download [Microsoft.Spark.Worker.netcoreapp3.1.linux-x64-1.0.0.tar.gz](https://github.com/dotnet/spark/releases/download/v1.0.0/Microsoft.Spark.Worker.netcoreapp3.1.linux-x64-1.0.0.tar.gz). -2. Upload `Microsoft.Spark.Worker..tar.gz` and [install-worker.sh](https://github.com/dotnet/spark/blob/master/deployment/install-worker.sh) to a distributed file system (e.g., S3) that your cluster has access to. +2. Upload `Microsoft.Spark.Worker..tar.gz` and [install-worker.sh](https://github.com/dotnet/spark/blob/main/deployment/install-worker.sh) to a distributed file system (e.g., S3) that your cluster has access to. ## Prepare your .NET for Apache Spark app @@ -131,4 +131,4 @@ aws emr add-steps \ In this tutorial, you deployed your .NET for Apache Spark application to Amazon EMR Spark. For .NET for Apache Spark example projects, continue to GitHub. > [!div class="nextstepaction"] -> [.NET for Apache Spark samples](https://github.com/dotnet/spark/tree/master/examples) +> [.NET for Apache Spark samples](https://github.com/dotnet/spark/tree/main/examples) diff --git a/docs/spark/tutorials/batch-processing.md b/docs/spark/tutorials/batch-processing.md index eadc630f5b7d8..a708e2eed2352 100644 --- a/docs/spark/tutorials/batch-processing.md +++ b/docs/spark/tutorials/batch-processing.md @@ -27,7 +27,7 @@ If this is your first time using .NET for Apache Spark, check out the [Get start ## Download the sample data -[GHTorrent](http://ghtorrent.org/) monitors all public GitHub events, such as info about projects, commits, and watchers, and stores the events and their structure in databases. Data collected over different time periods is available as downloadable archives. Because the dump files are very large, this guide uses a [truncated version of the dump file](https://github.com/dotnet/spark/tree/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Batch/projects_smaller.csv) that can be downloaded from GitHub. +[GHTorrent](http://ghtorrent.org/) monitors all public GitHub events, such as info about projects, commits, and watchers, and stores the events and their structure in databases. Data collected over different time periods is available as downloadable archives. Because the dump files are very large, this guide uses a [truncated version of the dump file](https://github.com/dotnet/spark/tree/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Batch/projects_smaller.csv) that can be downloaded from GitHub. > [!NOTE] > The GHTorrent dataset is distributed under a dual licensing scheme ([Creative Commons +](https://wiki.creativecommons.org/wiki/CCPlus)). For non-commercial uses (including, but not limited to, educational, research or personal uses), the dataset is distributed under the [CC-BY-SA license](https://creativecommons.org/licenses/by-sa/4.0/). @@ -158,7 +158,7 @@ The goal of this app is to gain some insights about the GitHub projects data. Ad ## Get the code -You can see the [full solution](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Batch/GitHubProjects.cs) on GitHub. +You can see the [full solution](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Batch/GitHubProjects.cs) on GitHub. ## Next steps diff --git a/docs/spark/tutorials/databricks-deployment.md b/docs/spark/tutorials/databricks-deployment.md index eb988fc863b92..d180693c63815 100644 --- a/docs/spark/tutorials/databricks-deployment.md +++ b/docs/spark/tutorials/databricks-deployment.md @@ -109,11 +109,11 @@ You should now be able to access any Azure Databricks clusters you create and up 2. The *install-worker.sh* is a script that lets you copy .NET for Apache Spark dependent files into the nodes of your cluster. - Create a new file named **install-worker.sh** on your local computer, and paste the [install-worker.sh contents](https://raw.githubusercontent.com/dotnet/spark/master/deployment/install-worker.sh) located on GitHub. + Create a new file named **install-worker.sh** on your local computer, and paste the [install-worker.sh contents](https://raw.githubusercontent.com/dotnet/spark/main/deployment/install-worker.sh) located on GitHub. 3. The *db-init.sh* is a script that installs dependencies onto your Databricks Spark cluster. - Create a new file named **db-init.sh** on your local computer, and paste the [db-init.sh contents](https://github.com/dotnet/spark/blob/master/deployment/db-init.sh) located on GitHub. + Create a new file named **db-init.sh** on your local computer, and paste the [db-init.sh contents](https://github.com/dotnet/spark/blob/main/deployment/db-init.sh) located on GitHub. In the file you just created, set the `DOTNET_SPARK_RELEASE` variable to `https://github.com/dotnet/spark/releases/download/v1.0.0/Microsoft.Spark.Worker.netcoreapp3.1.linux-x64-1.0.0.tar.gz`. Leave the rest of the *db-init.sh* file as-is. diff --git a/docs/spark/tutorials/hdinsight-deployment.md b/docs/spark/tutorials/hdinsight-deployment.md index f3d8db2a483bf..2e15f810bb7e9 100644 --- a/docs/spark/tutorials/hdinsight-deployment.md +++ b/docs/spark/tutorials/hdinsight-deployment.md @@ -126,7 +126,7 @@ Next, you use the Azure Storage Explorer to upload the following five files to t 3. The *install-worker.sh* is a script that lets you copy .NET for Apache Spark dependent files into the nodes of your cluster. - Create a new file named **install-worker.sh** in your local computer, and paste the [install-worker.sh contents](https://raw.githubusercontent.com/dotnet/spark/master/deployment/install-worker.sh) located on GitHub. Then, upload *install-worker.sh* to your blob container. + Create a new file named **install-worker.sh** in your local computer, and paste the [install-worker.sh contents](https://raw.githubusercontent.com/dotnet/spark/main/deployment/install-worker.sh) located on GitHub. Then, upload *install-worker.sh* to your blob container. 4. Your cluster needs the *publish.zip* file that contains your app's published files. Navigate to your published folder, **mySparkApp/bin/Release/netcoreapp3.1/ubuntu.16.04-x64**, and locate **publish.zip**. Then upload *publish.zip* to your blob container. diff --git a/docs/spark/tutorials/ml-sentiment-analysis.md b/docs/spark/tutorials/ml-sentiment-analysis.md index 5b6bb3907969c..0dd420ccf1ff4 100644 --- a/docs/spark/tutorials/ml-sentiment-analysis.md +++ b/docs/spark/tutorials/ml-sentiment-analysis.md @@ -28,11 +28,11 @@ In this tutorial, you learn how to: * [Download and install](https://marketplace.visualstudio.com/items?itemName=MLNET.07) ML.NET Model Builder (preview). -* Download the [yelptest.csv](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/MachineLearning/Sentiment/Resources/yelptest.csv) and [yelptrain.csv](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/MachineLearning/Sentiment/Resources/yelptrain.csv) Yelp review datasets. +* Download the [yelptest.csv](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/MachineLearning/Sentiment/Resources/yelptest.csv) and [yelptrain.csv](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/MachineLearning/Sentiment/Resources/yelptrain.csv) Yelp review datasets. ## Review the data -The Yelp reviews dataset contains online Yelp reviews about various services. Open [yelptrain.csv](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/MachineLearning/Sentiment/Resources/yelptrain.csv) and notice the structure of the data. The first column contains review text, and the second column contains sentiment scores. If the sentiment score is 1, the review is positive, and if the sentiment score is 0, the review is negative. +The Yelp reviews dataset contains online Yelp reviews about various services. Open [yelptrain.csv](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/MachineLearning/Sentiment/Resources/yelptrain.csv) and notice the structure of the data. The first column contains review text, and the second column contains sentiment scores. If the sentiment score is 1, the review is positive, and if the sentiment score is 0, the review is negative. The following table contains sample data: @@ -198,7 +198,7 @@ Then navigate to the console app's publish folder and run the following `spark-s ## Get the code -This tutorial is similar to the code from the [Sentiment Analysis with Big Data](https://github.com/dotnet/spark/tree/master/examples/Microsoft.Spark.CSharp.Examples/MachineLearning/Sentiment) example. +This tutorial is similar to the code from the [Sentiment Analysis with Big Data](https://github.com/dotnet/spark/tree/main/examples/Microsoft.Spark.CSharp.Examples/MachineLearning/Sentiment) example. ## Next steps diff --git a/docs/spark/tutorials/streaming.md b/docs/spark/tutorials/streaming.md index 313b04c870843..2975c0fb840c2 100644 --- a/docs/spark/tutorials/streaming.md +++ b/docs/spark/tutorials/streaming.md @@ -155,11 +155,11 @@ spark-submit --class org.apache.spark.deploy.dotnet.DotnetRunner --master local ## Get the code -This tutorial uses the [StructuredNetworkCharacterCount.cs](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredNetworkCharacterCount.cs) example, but there are three other full stream processing examples on GitHub: +This tutorial uses the [StructuredNetworkCharacterCount.cs](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredNetworkCharacterCount.cs) example, but there are three other full stream processing examples on GitHub: -* [StructuredNetworkWordCount.cs](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredNetworkWordCount.cs): word count on data streamed from any source -* [StructuredNetworkWordCountWindowed.cs](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredNetworkWordCountWindowed.cs): word count on data with windowing logic -* [StructuredKafkaWordCount.cs](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredKafkaWordCount.cs): word count on data streamed from Kafka +* [StructuredNetworkWordCount.cs](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredNetworkWordCount.cs): word count on data streamed from any source +* [StructuredNetworkWordCountWindowed.cs](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredNetworkWordCountWindowed.cs): word count on data with windowing logic +* [StructuredKafkaWordCount.cs](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/Sql/Streaming/StructuredKafkaWordCount.cs): word count on data streamed from Kafka ## Next steps diff --git a/docs/spark/what-is-apache-spark-dotnet.md b/docs/spark/what-is-apache-spark-dotnet.md index 55ada88def8bf..45cf0c91179ee 100644 --- a/docs/spark/what-is-apache-spark-dotnet.md +++ b/docs/spark/what-is-apache-spark-dotnet.md @@ -36,11 +36,11 @@ You can learn about interop support for Spark language extensions from [the prop When compared against Python and Scala using the [TPC-H benchmark](http://www.tpc.org/tpch/), .NET for Apache Spark performs well in most cases and is 2x faster than Python when user-defined function performance is critical. There is an ongoing effort to improve and benchmark performance. -To do your own benchmarking, see the benchmarks available on the [.NET for Apache Spark GitHub](https://github.com/dotnet/spark/tree/master/benchmark). +To do your own benchmarking, see the benchmarks available on the [.NET for Apache Spark GitHub](https://github.com/dotnet/spark/tree/main/benchmark). ## .NET for Apache Spark roadmap -Learn about short term and long term plans from the official [.NET for Apache Spark roadmap](https://github.com/dotnet/spark/blob/master/ROADMAP.md). +Learn about short term and long term plans from the official [.NET for Apache Spark roadmap](https://github.com/dotnet/spark/blob/main/ROADMAP.md). ## .NET Foundation diff --git a/docs/standard/analyzers/platform-compat-analyzer.md b/docs/standard/analyzers/platform-compat-analyzer.md index 957f3fef10ba0..fdb0c448fff7a 100644 --- a/docs/standard/analyzers/platform-compat-analyzer.md +++ b/docs/standard/analyzers/platform-compat-analyzer.md @@ -38,7 +38,7 @@ The platform compatibility analyzer is one of the Roslyn code quality analyzers. - The attribute can be applied multiple times with different platforms, for example, `[UnsupportedOSPlatform("iOS"), UnsupportedOSPlatform("Android6.0")]`. - The analyzer produces a **warning** only if the `platform` is effective for the call site: - **Warns** if the project targets the platform that's attributed as unsupported (for example, if the API is attributed with `[UnsupportedOSPlatform("windows")]` and the call site targets `net5.0-windows`). - - **Warns** if the project is multi-targeted and the `platform` is included in the default [MSBuild ``](https://github.com/dotnet/sdk/blob/master/src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.SupportedPlatforms.props) items group, or the `platform` is manually included within the `MSBuild` \ items group: + - **Warns** if the project is multi-targeted and the `platform` is included in the default [MSBuild ``](https://github.com/dotnet/sdk/blob/main/src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.SupportedPlatforms.props) items group, or the `platform` is manually included within the `MSBuild` \ items group: ```XML @@ -46,7 +46,7 @@ The platform compatibility analyzer is one of the Roslyn code quality analyzers. ``` - - **Doesn't warn** if you're building an app that doesn't target the unsupported platform or is multi-targeted and the platform is not included in the default [MSBuild ``](https://github.com/dotnet/sdk/blob/master/src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.SupportedPlatforms.props) items group. + - **Doesn't warn** if you're building an app that doesn't target the unsupported platform or is multi-targeted and the platform is not included in the default [MSBuild ``](https://github.com/dotnet/sdk/blob/main/src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.SupportedPlatforms.props) items group. - Both attributes can be instantiated with or without version numbers as part of the platform name. - Version numbers are in the format of `major.minor[.build[.revision]]`; `major.minor` is required and the `build` and `revision` parts are optional. For example, "Windows7.0" indicates Windows version 7.0, but "Windows" is interpreted as Windows 0.0. @@ -377,8 +377,8 @@ All the conditional checks used in the [platform guard examples](#guard-platform ## See also -- [Target Framework Names in .NET 5](https://github.com/dotnet/designs/blob/master/accepted/2020/net5/net5.md) -- [Annotating platform-specific APIs and detecting its use](https://github.com/dotnet/designs/blob/master/accepted/2020/platform-checks/platform-checks.md) -- [Annotating APIs as unsupported on specific platforms](https://github.com/dotnet/designs/blob/master/accepted/2020/platform-exclusion/platform-exclusion.md) +- [Target Framework Names in .NET 5](https://github.com/dotnet/designs/blob/main/accepted/2020/net5/net5.md) +- [Annotating platform-specific APIs and detecting its use](https://github.com/dotnet/designs/blob/main/accepted/2020/platform-checks/platform-checks.md) +- [Annotating APIs as unsupported on specific platforms](https://github.com/dotnet/designs/blob/main/accepted/2020/platform-exclusion/platform-exclusion.md) - [CA1416 Platform compatibility analyzer](../../fundamentals/code-analysis/quality-rules/ca1416.md) - [.NET API analyzer](../../standard/analyzers/api-analyzer.md) diff --git a/docs/standard/assembly/create-use-strong-named.md b/docs/standard/assembly/create-use-strong-named.md index d5528c984b604..91f06adf4a733 100644 --- a/docs/standard/assembly/create-use-strong-named.md +++ b/docs/standard/assembly/create-use-strong-named.md @@ -24,7 +24,7 @@ A strong name consists of the assembly's identity—its simple text name, versio A strong-named assembly can only use types from other strong-named assemblies. Otherwise, the integrity of the strong-named assembly would be compromised. > [!NOTE] -> Although .NET Core supports strong-named assemblies, and all assemblies in the .NET Core library are signed, the majority of third-party assemblies do not need strong names. For more information, see [Strong Name Signing](https://github.com/dotnet/runtime/blob/master/docs/project/strong-name-signing.md) on GitHub. +> Although .NET Core supports strong-named assemblies, and all assemblies in the .NET Core library are signed, the majority of third-party assemblies do not need strong names. For more information, see [Strong Name Signing](https://github.com/dotnet/runtime/blob/main/docs/project/strong-name-signing.md) on GitHub. ## Strong name scenario diff --git a/docs/standard/assembly/sign-strong-name.md b/docs/standard/assembly/sign-strong-name.md index 9dc27e974dc6f..19075e9b942b8 100644 --- a/docs/standard/assembly/sign-strong-name.md +++ b/docs/standard/assembly/sign-strong-name.md @@ -16,7 +16,7 @@ dev_langs: # How to: Sign an assembly with a strong name > [!NOTE] -> Although .NET Core supports strong-named assemblies, and all assemblies in the .NET Core library are signed, the majority of third-party assemblies do not need strong names. For more information, see [Strong Name Signing](https://github.com/dotnet/runtime/blob/master/docs/project/strong-name-signing.md) on GitHub. +> Although .NET Core supports strong-named assemblies, and all assemblies in the .NET Core library are signed, the majority of third-party assemblies do not need strong names. For more information, see [Strong Name Signing](https://github.com/dotnet/runtime/blob/main/docs/project/strong-name-signing.md) on GitHub. There are a number of ways to sign an assembly with a strong name: diff --git a/docs/standard/assembly/unloadability.md b/docs/standard/assembly/unloadability.md index eee4cbad061ee..2047b1016543a 100644 --- a/docs/standard/assembly/unloadability.md +++ b/docs/standard/assembly/unloadability.md @@ -20,7 +20,7 @@ There's one noteworthy difference between the unloading using `AssemblyLoadConte ## Use collectible AssemblyLoadContext -This section contains a detailed step-by-step tutorial that shows a simple way to load a .NET Core application into a collectible `AssemblyLoadContext`, execute its entry point, and then unload it. You can find a complete sample at [https://github.com/dotnet/samples/tree/master/core/tutorials/Unloading](https://github.com/dotnet/samples/tree/master/core/tutorials/Unloading). +This section contains a detailed step-by-step tutorial that shows a simple way to load a .NET Core application into a collectible `AssemblyLoadContext`, execute its entry point, and then unload it. You can find a complete sample at [https://github.com/dotnet/samples/tree/master/core/tutorials/Unloading](https://github.com/dotnet/samples/tree/main/core/tutorials/Unloading). ### Create a collectible AssemblyLoadContext diff --git a/docs/standard/base-types/string-comparison-net-5-plus.md b/docs/standard/base-types/string-comparison-net-5-plus.md index 81c39abe75bf9..51349b7f48d05 100644 --- a/docs/standard/base-types/string-comparison-net-5-plus.md +++ b/docs/standard/base-types/string-comparison-net-5-plus.md @@ -235,7 +235,7 @@ Console.WriteLine("endz".EndsWith("z")); // Prints 'True' > - Behavior: Linguistic and culture-aware comparers can undergo behavioral adjustments from time to time. Both ICU and the older Windows NLS facility are updated to account for how world languages change. For more information, see the blog post [Locale (culture) data churn](/archive/blogs/shawnste/locale-culture-data-churn). The *Ordinal* comparer's behavior will never change since it performs exact bitwise searching and comparison. However, the *OrdinalIgnoreCase* comparer's behavior may change as Unicode grows to encompass more character sets and corrects omissions in existing casing data. > - Usage: The comparers `StringComparison.InvariantCulture` and `StringComparison.InvariantCultureIgnoreCase` are linguistic comparers that are not culture-aware. That is, these comparers understand concepts such as the accented character é having multiple possible underlying representations, and that all such representations should be treated equal. But non-culture-aware linguistic comparers won't contain special handling for \ as distinct from \ or \, as shown above. They also won't special-case characters like the German Eszett (ß). -.NET also offers the *invariant globalization mode*. This opt-in mode disables code paths that deal with linguistic search and comparison routines. In this mode, all operations use *Ordinal* or *OrdinalIgnoreCase* behaviors, regardless of what `CultureInfo` or `StringComparison` argument the caller provides. For more information, see [Run-time configuration options for globalization](../../core/run-time-config/globalization.md) and [.NET Core Globalization Invariant Mode](https://github.com/dotnet/runtime/blob/master/docs/design/features/globalization-invariant-mode.md). +.NET also offers the *invariant globalization mode*. This opt-in mode disables code paths that deal with linguistic search and comparison routines. In this mode, all operations use *Ordinal* or *OrdinalIgnoreCase* behaviors, regardless of what `CultureInfo` or `StringComparison` argument the caller provides. For more information, see [Run-time configuration options for globalization](../../core/run-time-config/globalization.md) and [.NET Core Globalization Invariant Mode](https://github.com/dotnet/runtime/blob/main/docs/design/features/globalization-invariant-mode.md). For more information, see [Best practices for comparing strings in .NET](best-practices-strings.md). diff --git a/docs/standard/exceptions/index.md b/docs/standard/exceptions/index.md index 0df5e3ec5a290..f83bef3e930a6 100644 --- a/docs/standard/exceptions/index.md +++ b/docs/standard/exceptions/index.md @@ -61,4 +61,4 @@ The following table lists some common exceptions with examples of what can cause - [How to: Use Finally Blocks](how-to-use-finally-blocks.md) - [Handling COM Interop Exceptions](handling-com-interop-exceptions.md) - [Best Practices for Exceptions](best-practices-for-exceptions.md) -- [What Every Dev needs to Know About Exceptions in the Runtime](https://github.com/dotnet/runtime/blob/master/docs/design/coreclr/botr/exceptions.md) +- [What Every Dev needs to Know About Exceptions in the Runtime](https://github.com/dotnet/runtime/blob/main/docs/design/coreclr/botr/exceptions.md) diff --git a/docs/standard/frameworks.md b/docs/standard/frameworks.md index 9b87cd55b970d..7768c92792690 100644 --- a/docs/standard/frameworks.md +++ b/docs/standard/frameworks.md @@ -178,7 +178,7 @@ The following target frameworks are deprecated. Packages that target these targe ## See also -- [Target framework names in .NET 5](https://github.com/dotnet/designs/blob/master/accepted/2020/net5/net5.md) +- [Target framework names in .NET 5](https://github.com/dotnet/designs/blob/main/accepted/2020/net5/net5.md) - [Call Windows Runtime APIs in desktop apps](/windows/apps/desktop/modernize/desktop-to-uwp-enhance) - [Developing Libraries with Cross Platform Tools](../core/tutorials/libraries.md) - [.NET Standard](net-standard.md) diff --git a/docs/standard/glossary.md b/docs/standard/glossary.md index 8c44c0a9ab2b4..a2497b66b3b06 100644 --- a/docs/standard/glossary.md +++ b/docs/standard/glossary.md @@ -86,7 +86,7 @@ See [CLR](#clr) In contrast to the [CLR](#clr), CoreRT is not a virtual machine, which means it doesn't include the facilities to generate and run code on-the-fly because it doesn't include a [JIT](#jit). It does, however, include the [GC](#gc) and the ability for run-time type identification (RTTI) and reflection. However, its type system is designed so that metadata for reflection isn't required. Not requiring metadata enables having an [AOT](#aot) tool chain that can link away superfluous metadata and (more importantly) identify code that the app doesn't use. CoreRT is in development. -See [Intro to .NET Native and CoreRT](https://github.com/dotnet/corert/blob/master/Documentation/intro-to-corert.md). +See [Intro to .NET Native and CoreRT](https://github.com/dotnet/corert/blob/main/Documentation/intro-to-corert.md). ## cross-platform @@ -213,7 +213,7 @@ Compilation happens on the developer's machine similar to the way a C++ compiler UWP was the first application framework supported by .NET Native. Now, we support building native console apps for Windows, macOS, and Linux. -See [Intro to .NET Native and CoreRT](https://github.com/dotnet/corert/blob/master/Documentation/intro-to-corert.md) +See [Intro to .NET Native and CoreRT](https://github.com/dotnet/corert/blob/main/Documentation/intro-to-corert.md) ## .NET SDK diff --git a/docs/standard/library-guidance/breaking-changes.md b/docs/standard/library-guidance/breaking-changes.md index 104dc02b6d0c4..2408ce72fc508 100644 --- a/docs/standard/library-guidance/breaking-changes.md +++ b/docs/standard/library-guidance/breaking-changes.md @@ -94,7 +94,7 @@ public class Document - [Version and update considerations for C# developers](../../csharp/whats-new/version-update-considerations.md) - [A definitive guide to API-breaking changes in .NET](https://stackoverflow.com/questions/1456785/a-definitive-guide-to-api-breaking-changes-in-net) -- [.NET breaking change rules](https://github.com/dotnet/runtime/blob/master/docs/coding-guidelines/breaking-change-rules.md) +- [.NET breaking change rules](https://github.com/dotnet/runtime/blob/main/docs/coding-guidelines/breaking-change-rules.md) >[!div class="step-by-step"] >[Previous](versioning.md) diff --git a/docs/standard/library-guidance/nuget.md b/docs/standard/library-guidance/nuget.md index 53d742adf152c..97d7272fa2d26 100644 --- a/docs/standard/library-guidance/nuget.md +++ b/docs/standard/library-guidance/nuget.md @@ -89,7 +89,7 @@ Symbol files (`*.pdb`) are produced by the .NET compiler alongside assemblies. S NuGet.org hosts its own [symbols server repository](/nuget/create-packages/symbol-packages-snupkg#nugetorg-symbol-server). Developers can use the symbols published to the NuGet.org symbol server by adding `https://symbols.nuget.org/download/symbols` to their [symbol sources in Visual Studio](/visualstudio/debugger/specify-symbol-dot-pdb-and-source-files-in-the-visual-studio-debugger). > [!IMPORTANT] -> The NuGet.org symbol server only supports the new [portable symbol files](https://github.com/dotnet/core/blob/master/Documentation/diagnostics/portable_pdb.md) (`*.pdb`) created by SDK-style projects. +> The NuGet.org symbol server only supports the new [portable symbol files](https://github.com/dotnet/core/blob/main/Documentation/diagnostics/portable_pdb.md) (`*.pdb`) created by SDK-style projects. > > To use the NuGet.org symbol server when debugging a .NET library, developers must have Visual Studio 2017 version 15.9 or later. diff --git a/docs/standard/library-guidance/sourcelink.md b/docs/standard/library-guidance/sourcelink.md index c8e3d9dfa1251..e82a84e217d80 100644 --- a/docs/standard/library-guidance/sourcelink.md +++ b/docs/standard/library-guidance/sourcelink.md @@ -14,7 +14,7 @@ Source Link is a technology that enables source code debugging of .NET assemblie ## Using Source Link -Instructions for using Source Link can be found on the [dotnet/sourcelink](https://github.com/dotnet/sourcelink/blob/master/README.md) GitHub repository. +Instructions for using Source Link can be found on the [dotnet/sourcelink](https://github.com/dotnet/sourcelink/blob/main/README.md) GitHub repository. You can use [NuGet Package Explorer](https://github.com/NuGetPackageExplorer/NuGetPackageExplorer) to confirm that the Source Link metadata has been successfully embedded in the package. Check the `Repository` metadata is present with a commit identifier and that .pdb files are located with each target's .dll. diff --git a/docs/standard/net-standard.md b/docs/standard/net-standard.md index ef932a1719aba..ef95ec9326a03 100644 --- a/docs/standard/net-standard.md +++ b/docs/standard/net-standard.md @@ -55,9 +55,9 @@ The .NET Standard specification is a standardized set of APIs. The specification ### Official artifacts -The official specification is a set of *.cs* files that define the APIs that are part of the standard. The [ref directory](https://github.com/dotnet/standard/tree/master/src/netstandard/ref) in the [dotnet/standard repository](https://github.com/dotnet/standard) defines the .NET Standard APIs. +The official specification is a set of *.cs* files that define the APIs that are part of the standard. The [ref directory](https://github.com/dotnet/standard/tree/main/src/netstandard/ref) in the [dotnet/standard repository](https://github.com/dotnet/standard) defines the .NET Standard APIs. -The [NETStandard.Library](https://www.nuget.org/packages/NETStandard.Library) metapackage ([source](https://github.com/dotnet/standard/blob/master/src/netstandard/pkg/NETStandard.Library.dependencies.props)) describes the set of libraries that define (in part) one or more .NET Standard versions. +The [NETStandard.Library](https://www.nuget.org/packages/NETStandard.Library) metapackage ([source](https://github.com/dotnet/standard/blob/main/src/netstandard/pkg/NETStandard.Library.dependencies.props)) describes the set of libraries that define (in part) one or more .NET Standard versions. A given component, like `System.Runtime`, describes: @@ -66,7 +66,7 @@ A given component, like `System.Runtime`, describes: Derivative artifacts are provided to enable more convenient reading and to enable certain developer scenarios (for example, using a compiler). -- [API list in markdown](https://github.com/dotnet/standard/tree/master/docs/versions) +- [API list in markdown](https://github.com/dotnet/standard/tree/main/docs/versions) - Reference assemblies, distributed as NuGet packages and referenced by the [NETStandard.Library](https://www.nuget.org/packages/NETStandard.Library/) metapackage. ### Package representation @@ -160,7 +160,7 @@ Here are some problems with .NET Standard that help explain why .NET 5 is the be ## See also -- [.NET Standard versions (source)](https://github.com/dotnet/standard/blob/master/docs/versions.md) +- [.NET Standard versions (source)](https://github.com/dotnet/standard/blob/main/docs/versions.md) - [.NET Standard versions (interactive UI)](https://dotnet.microsoft.com/platform/dotnet-standard#versions) - [Build a .NET Standard library](../core/tutorials/library-with-visual-studio.md) - [Cross-platform targeting](./library-guidance/cross-platform-targeting.md) diff --git a/docs/standard/whats-new/whats-new-in-dotnet-standard.md b/docs/standard/whats-new/whats-new-in-dotnet-standard.md index b91a18568af13..47eb60eb62736 100644 --- a/docs/standard/whats-new/whats-new-in-dotnet-standard.md +++ b/docs/standard/whats-new/whats-new-in-dotnet-standard.md @@ -29,7 +29,7 @@ ms.prod: dotnet-whatsnew ### A vastly expanded set of APIs -Through version 1.6, .NET Standard included a comparatively small subset of APIs. Among those excluded were many APIs that were commonly used in .NET Framework or Xamarin. This complicates development, since it requires that developers find suitable replacements for familiar APIs when they develop applications and libraries that target multiple .NET implementations. .NET Standard 2.0 addresses this limitation by adding over 20,000 more APIs than were available in .NET Standard 1.6, the previous version of the standard. For a list of the APIs that have been added to .NET Standard 2.0, see [.NET Standard 2.0 vs 1.6](https://raw.githubusercontent.com/dotnet/standard/master/docs/versions/netstandard2.0_diff.md). +Through version 1.6, .NET Standard included a comparatively small subset of APIs. Among those excluded were many APIs that were commonly used in .NET Framework or Xamarin. This complicates development, since it requires that developers find suitable replacements for familiar APIs when they develop applications and libraries that target multiple .NET implementations. .NET Standard 2.0 addresses this limitation by adding over 20,000 more APIs than were available in .NET Standard 1.6, the previous version of the standard. For a list of the APIs that have been added to .NET Standard 2.0, see [.NET Standard 2.0 vs 1.6](https://raw.githubusercontent.com/dotnet/standard/main/docs/versions/netstandard2.0_diff.md). Some of the additions to the namespace in .NET Standard 2.0 include: @@ -47,7 +47,7 @@ Some of the additions to the namespace in .NET Standard 2.0 includ ### Support for .NET Framework libraries -Many libraries target .NET Framework rather than .NET Standard. However, most of the calls in those libraries are to APIs that are included in .NET Standard 2.0. Starting with .NET Standard 2.0, you can access .NET Framework libraries from a .NET Standard library by using a [compatibility shim](https://github.com/dotnet/standard/blob/master/docs/planning/netstandard-2.0/README.md#assembly-unification). This compatibility layer is transparent to developers; you don't have to do anything to take advantage of .NET Framework libraries. +Many libraries target .NET Framework rather than .NET Standard. However, most of the calls in those libraries are to APIs that are included in .NET Standard 2.0. Starting with .NET Standard 2.0, you can access .NET Framework libraries from a .NET Standard library by using a [compatibility shim](https://github.com/dotnet/standard/blob/main/docs/planning/netstandard-2.0/README.md#assembly-unification). This compatibility layer is transparent to developers; you don't have to do anything to take advantage of .NET Framework libraries. The single requirement is that the APIs called by the .NET Framework class library must be included in .NET Standard 2.0. diff --git a/docs/visual-basic/programming-guide/concepts/expression-trees/how-to-use-expression-trees-to-build-dynamic-queries.md b/docs/visual-basic/programming-guide/concepts/expression-trees/how-to-use-expression-trees-to-build-dynamic-queries.md index 004faf689a36d..827969f6f5c74 100644 --- a/docs/visual-basic/programming-guide/concepts/expression-trees/how-to-use-expression-trees-to-build-dynamic-queries.md +++ b/docs/visual-basic/programming-guide/concepts/expression-trees/how-to-use-expression-trees-to-build-dynamic-queries.md @@ -42,7 +42,7 @@ The internal expression tree—and thus the query—haven't been modifie ## Call additional LINQ methods -Generally, the [built-in LINQ methods](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Linq.Queryable/src/System/Linq/Queryable.cs) at perform two steps: +Generally, the [built-in LINQ methods](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Linq.Queryable/src/System/Linq/Queryable.cs) at perform two steps: * Wrap the current expression tree in a representing the method call. * Pass the wrapped expression tree back to the provider, either to return a value via the provider's method; or to return a translated query object via the method. diff --git a/docs/visual-basic/reference/language-specification/index.md b/docs/visual-basic/reference/language-specification/index.md index 1bfae9252b352..735c907c1a59d 100644 --- a/docs/visual-basic/reference/language-specification/index.md +++ b/docs/visual-basic/reference/language-specification/index.md @@ -14,7 +14,7 @@ The Visual Basic Language Specification is the authoritative source for answers The specification is available on the [Microsoft Download Center](https://go.microsoft.com/fwlink/?LinkId=188623). -This site contains the [Visual Basic 11 specification](../../../../_vblang/spec/introduction.md). It's built from the Markdown files contained in [the dotnet/vblang GitHub repository](https://github.com/dotnet/vblang/blob/master/spec/README.md). +This site contains the [Visual Basic 11 specification](../../../../_vblang/spec/introduction.md). It's built from the Markdown files contained in [the dotnet/vblang GitHub repository](https://github.com/dotnet/vblang/blob/main/spec/README.md). Issues on the specification should be created in the [dotnet/vblang](https://github.com/dotnet/vblang/issues) repository. Or, if you're interested in fixing any errors you find, you can submit a [Pull request](https://github.com/dotnet/vblang/pulls) to the same repository. diff --git a/docs/visual-basic/whats-new/breaking-changes.md b/docs/visual-basic/whats-new/breaking-changes.md index 64d58ecbfbd98..3238348f43ad8 100644 --- a/docs/visual-basic/whats-new/breaking-changes.md +++ b/docs/visual-basic/whats-new/breaking-changes.md @@ -10,8 +10,8 @@ ms.date: 08/18/2020 The [Roslyn](https://github.com/dotnet/roslyn) team maintains a list of breaking changes in the C# and Visual Basic compilers. You can find information on those changes at these links on their GitHub repository: -- [Breaking changes in VS2019 Update 1 and beyond compared to VS2019](https://github.com/dotnet/roslyn/blob/master/docs/compilers/Visual%20Basic/Compiler%20Breaking%20Changes%20-%20post%20VS2019.md) -- [Breaking changes since VS2017 (VB 15)](https://github.com/dotnet/roslyn/blob/master/docs/compilers/Visual%20Basic/Compiler%20Breaking%20Changes%20-%20post%20VS2017.md) -- [Breaking changes in Roslyn 3.0 (VS2019) from Roslyn 2.* (VS2017)](https://github.com/dotnet/roslyn/blob/master/docs/compilers/Visual%20Basic/Compiler%20Breaking%20Changes%20-%20VS2019.md) -- [Breaking changes in Roslyn 1.0 (VS2015) from the native C# compiler (VS2013 and previous).](https://github.com/dotnet/roslyn/blob/master/docs/compilers/Visual%20Basic/Compiler%20Breaking%20Changes%20-%20VS2015.md) -- [Clashing enum members](https://github.com/dotnet/roslyn/blob/master/docs/compilers/Visual%20Basic/Clashing%20Enum%20Members.md) +- [Breaking changes in VS2019 Update 1 and beyond compared to VS2019](https://github.com/dotnet/roslyn/blob/main/docs/compilers/Visual%20Basic/Compiler%20Breaking%20Changes%20-%20post%20VS2019.md) +- [Breaking changes since VS2017 (VB 15)](https://github.com/dotnet/roslyn/blob/main/docs/compilers/Visual%20Basic/Compiler%20Breaking%20Changes%20-%20post%20VS2017.md) +- [Breaking changes in Roslyn 3.0 (VS2019) from Roslyn 2.* (VS2017)](https://github.com/dotnet/roslyn/blob/main/docs/compilers/Visual%20Basic/Compiler%20Breaking%20Changes%20-%20VS2019.md) +- [Breaking changes in Roslyn 1.0 (VS2015) from the native C# compiler (VS2013 and previous).](https://github.com/dotnet/roslyn/blob/main/docs/compilers/Visual%20Basic/Compiler%20Breaking%20Changes%20-%20VS2015.md) +- [Clashing enum members](https://github.com/dotnet/roslyn/blob/main/docs/compilers/Visual%20Basic/Clashing%20Enum%20Members.md) diff --git a/includes/core-changes/msbuild/2.1/dotnetclitoolreference.md b/includes/core-changes/msbuild/2.1/dotnetclitoolreference.md index f04a88340372c..8f048503f49bc 100644 --- a/includes/core-changes/msbuild/2.1/dotnetclitoolreference.md +++ b/includes/core-changes/msbuild/2.1/dotnetclitoolreference.md @@ -11,8 +11,8 @@ Tools now included in .NET Core 2.1 SDK: | \ value | Tool | |------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| | `Microsoft.DotNet.Watcher.Tools` | `dotnet-watch` | -| `Microsoft.Extensions.SecretManager.Tools` | [dotnet-user-secrets](https://github.com/dotnet/aspnetcore/blob/master/src/Tools/dotnet-user-secrets/README.md) | -| `Microsoft.Extensions.Caching.SqlConfig.Tools` | [dotnet-sql-cache](https://github.com/dotnet/aspnetcore/blob/master/src/Tools/dotnet-sql-cache/README.md) | +| `Microsoft.Extensions.SecretManager.Tools` | [dotnet-user-secrets](https://github.com/dotnet/aspnetcore/blob/main/src/Tools/dotnet-user-secrets/README.md) | +| `Microsoft.Extensions.Caching.SqlConfig.Tools` | [dotnet-sql-cache](https://github.com/dotnet/aspnetcore/blob/main/src/Tools/dotnet-sql-cache/README.md) | | `Microsoft.EntityFrameworkCore.Tools.DotNet` | [dotnet-ef](/ef/core/miscellaneous/cli/dotnet) | #### Version introduced diff --git a/includes/net-standard-table.md b/includes/net-standard-table.md index cc7b501207ee9..7f8de986d2b57 100644 --- a/includes/net-standard-table.md +++ b/includes/net-standard-table.md @@ -10,7 +10,7 @@ | Universal Windows Platform | 10.0 | 10.0 | 10.0 | 10.0 | 10.0 | 10.0.16299 | 10.0.16299 | 10.0.16299 | TBD | | Unity | 2018.1 | 2018.1 | 2018.1| 2018.1| 2018.1| 2018.1 | 2018.1 | 2018.1 | TBD | -1 The versions listed for .NET Framework apply to .NET Core 2.0 SDK and later versions of the tooling. Older versions used a different mapping for .NET Standard 1.5 and higher. You can [download tooling for .NET Core tools for Visual Studio 2015](https://github.com/dotnet/core/blob/master/release-notes/download-archive.md) if you cannot upgrade to Visual Studio 2017 or a later version. +1 The versions listed for .NET Framework apply to .NET Core 2.0 SDK and later versions of the tooling. Older versions used a different mapping for .NET Standard 1.5 and higher. You can [download tooling for .NET Core tools for Visual Studio 2015](https://github.com/dotnet/core/blob/main/release-notes/download-archive.md) if you cannot upgrade to Visual Studio 2017 or a later version. 2 The versions listed here represent the rules that NuGet uses to determine whether a given .NET Standard library is applicable. While NuGet considers .NET Framework 4.6.1 as supporting .NET Standard 1.5 through 2.0, there are several issues with consuming .NET Standard libraries that were built for those versions from .NET Framework 4.6.1 projects. For .NET Framework projects that need to use such libraries, we recommend that you upgrade the project to target .NET Framework 4.7.2 or higher. @@ -21,12 +21,12 @@ - The version number in each cell indicates the *minimum* version of the implementation you'll need in order to target that .NET Standard version. - For an interactive table, see [.NET Standard versions](https://dotnet.microsoft.com/platform/dotnet-standard#versions). -[1.0]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.0.md -[1.1]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.1.md -[1.2]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.2.md -[1.3]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.3.md -[1.4]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.4.md -[1.5]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.5.md -[1.6]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.6.md -[2.0]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard2.0.md -[2.1]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard2.1.md +[1.0]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.0.md +[1.1]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.1.md +[1.2]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.2.md +[1.3]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.3.md +[1.4]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.4.md +[1.5]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.5.md +[1.6]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.6.md +[2.0]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard2.0.md +[2.1]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard2.1.md diff --git a/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithCoreClrHost/README.md b/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithCoreClrHost/README.md index 727baacbf0acc..2f0d1b8257143 100644 --- a/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithCoreClrHost/README.md +++ b/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithCoreClrHost/README.md @@ -1,7 +1,7 @@ .NET Core Hosting Sample ======================== -This sample demonstrates a simple .NET Core host using the hosting APIs from [`coreclrhost.h`](https://github.com/dotnet/coreclr/blob/master/src/coreclr/hosts/inc/coreclrhost.h). The sample host loads and starts the .NET runtime, loads managed code, calls into a managed method, and provides a function pointer for the managed code to call back into the host. +This sample demonstrates a simple .NET Core host using the hosting APIs from [`coreclrhost.h`](https://github.com/dotnet/coreclr/blob/main/src/coreclr/hosts/inc/coreclrhost.h). The sample host loads and starts the .NET runtime, loads managed code, calls into a managed method, and provides a function pointer for the managed code to call back into the host. This sample is part of the [.NET Core hosting tutorial](https://docs.microsoft.com/dotnet/core/tutorials/netcore-hosting). See that topic for a more detailed explanation of this sample. @@ -10,7 +10,7 @@ About .NET Core Hosts .NET Core applications are always run by a host. In most cases, the default dotnet.exe host is used. -It is possible to create your own host, though, to enable starting and running .NET Core code from a native application, or to enable a high degree of control over how the runtime operates. More complex, real-world hosts can be found in the [dotnet/coreclr](https://github.com/dotnet/coreclr/tree/master/src/coreclr/hosts) repository. +It is possible to create your own host, though, to enable starting and running .NET Core code from a native application, or to enable a high degree of control over how the runtime operates. More complex, real-world hosts can be found in the [dotnet/coreclr](https://github.com/dotnet/coreclr/tree/main/src/coreclr/hosts) repository. Build and Run ------------- diff --git a/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithHostFxr/readme.md b/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithHostFxr/readme.md index 3fa24b3775b42..d435b847c3888 100644 --- a/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithHostFxr/readme.md +++ b/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithHostFxr/readme.md @@ -1,6 +1,6 @@ # .NET Core Hosting Sample -This project demonstrates a way for a native process to host .NET Core using the `nethost` and `hostfxr` libraries. Documentation on the `nethost` and `hostfxr` APIs can be found [here](https://github.com/dotnet/core-setup/blob/master/Documentation/design-docs/native-hosting.md). +This project demonstrates a way for a native process to host .NET Core using the `nethost` and `hostfxr` libraries. Documentation on the `nethost` and `hostfxr` APIs can be found [here](https://github.com/dotnet/core-setup/blob/main/Documentation/design-docs/native-hosting.md). ## Key Features diff --git a/samples/snippets/core/tutorials/netcore-hosting/csharp/README.md b/samples/snippets/core/tutorials/netcore-hosting/csharp/README.md index 1ad7db05f7d0f..7a915740664a1 100644 --- a/samples/snippets/core/tutorials/netcore-hosting/csharp/README.md +++ b/samples/snippets/core/tutorials/netcore-hosting/csharp/README.md @@ -7,6 +7,6 @@ There are three samples demonstrating three different hosting interfaces for .NE 1. The [HostWithHostFxr](HostWithHostFxr) folder demonstrates how to host the .NET Core runtime using the `nethost` and `hostfxr` libraries' APIs. These APIs were introduced in .NET Core 3.0 and are the recommended method of hosting .NET Core 3.0 and above. These entry points handle the complexity of finding and setting up the runtime for initialization. This host demonstrates calling from native code into a static managed method and passing it a message to display. 1. The [HostWithCoreClrHost](HostWithCoreClrHost) folder demonstrates how to host the .NET Core runtime using the newer `coreclrhost.h` API. This API is the preferred method of hosting .NET Core 2.2 and below. This host demonstrates calling from native code into a static managed method and supplying a function pointer for the managed code to use to call back into the host. -These hosts are small and bypass a lot of complexity (probing for assemblies in multiple locations, thorough error checking, etc.) that a real host would have. Hopefully by remaining simple, though, they will be useful for demonstrating the core concepts of hosting managed .NET Core code in a native process. Other (more real-world) hosts which may be useful as a guide can be found in .NET Core product source in the [dotnet/runtime](https://github.com/dotnet/runtime/tree/master/src/coreclr/src/hosts) repository. +These hosts are small and bypass a lot of complexity (probing for assemblies in multiple locations, thorough error checking, etc.) that a real host would have. Hopefully by remaining simple, though, they will be useful for demonstrating the core concepts of hosting managed .NET Core code in a native process. Other (more real-world) hosts which may be useful as a guide can be found in .NET Core product source in the [dotnet/runtime](https://github.com/dotnet/runtime/tree/main/src/coreclr/src/hosts) repository. These samples are part of the [.NET Core hosting tutorial](https://docs.microsoft.com/dotnet/core/tutorials/netcore-hosting). Please see that topic for a more detailed explanation of the samples and the steps necessary to host .NET Core. From 96adc8877893765476b68e3878d3e2922c7a893e Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Sat, 20 Mar 2021 06:25:59 +0200 Subject: [PATCH 02/16] Keep dotnet/standard as master --- .../net-framework-container-scenarios.md | 2 +- docs/framework/whats-new/index.md | 2 +- docs/standard/net-standard.md | 8 ++++---- .../whats-new/whats-new-in-dotnet-standard.md | 2 +- includes/net-standard-table.md | 18 +++++++++--------- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/architecture/microservices/net-core-net-framework-containers/net-framework-container-scenarios.md b/docs/architecture/microservices/net-core-net-framework-containers/net-framework-container-scenarios.md index 386303af68f1c..112e80c22d8fd 100644 --- a/docs/architecture/microservices/net-core-net-framework-containers/net-framework-container-scenarios.md +++ b/docs/architecture/microservices/net-core-net-framework-containers/net-framework-container-scenarios.md @@ -15,7 +15,7 @@ In most cases for this scenario, you will not need to migrate your existing appl ## Using third-party .NET libraries or NuGet packages not available for .NET 5 -Third-party libraries are quickly embracing [.NET Standard](../../../standard/net-standard.md), which enables code sharing across all .NET flavors, including .NET 5. With .NET Standard 2.0 and later, the API surface compatibility across different frameworks has become significantly larger. Even more, .NET Core 2.x and newer applications can also directly reference existing .NET Framework libraries (see [.NET Framework 4.6.1 supporting .NET Standard 2.0](https://github.com/dotnet/standard/blob/main/docs/planning/netstandard-2.0/README.md#net-framework-461-supporting-net-standard-20)). +Third-party libraries are quickly embracing [.NET Standard](../../../standard/net-standard.md), which enables code sharing across all .NET flavors, including .NET 5. With .NET Standard 2.0 and later, the API surface compatibility across different frameworks has become significantly larger. Even more, .NET Core 2.x and newer applications can also directly reference existing .NET Framework libraries (see [.NET Framework 4.6.1 supporting .NET Standard 2.0](https://github.com/dotnet/standard/blob/master/docs/planning/netstandard-2.0/README.md#net-framework-461-supporting-net-standard-20)). In addition, the [Windows Compatibility Pack](../../../core/porting/windows-compat-pack.md) extends the API surface available for .NET Standard 2.0 on Windows. This pack allows recompiling most existing code to .NET Standard 2.x with little or no modification, to run on Windows. diff --git a/docs/framework/whats-new/index.md b/docs/framework/whats-new/index.md index 32242f7d7d7fe..b389d80e9b2aa 100644 --- a/docs/framework/whats-new/index.md +++ b/docs/framework/whats-new/index.md @@ -597,7 +597,7 @@ In addition, a major focus in .NET Framework 4.7.1 is improved accessibility, wh **Support for .NET Standard 2.0** -[.NET Standard](../../standard/net-standard.md) defines a set of APIs that must be available on each .NET implementation that supports that version of the standard. .NET Framework 4.7.1 fully supports .NET Standard 2.0 and adds [about 200 APIs](https://github.com/dotnet/standard/blob/main/src/netstandard/src/ApiCompatBaseline.net461.txt) that are defined in .NET Standard 2.0 and are missing from .NET Framework 4.6.1, 4.6.2, and 4.7. (Note that these versions of .NET Framework support .NET Standard 2.0 only if additional .NET Standard support files are also deployed on the target system.) For more information, see "BCL - .NET Standard 2.0 Support" in the [.NET Framework 4.7.1 Runtime and Compiler Features](https://devblogs.microsoft.com/dotnet/net-framework-4-7-1-runtime-and-compiler-features/) blog post. +[.NET Standard](../../standard/net-standard.md) defines a set of APIs that must be available on each .NET implementation that supports that version of the standard. .NET Framework 4.7.1 fully supports .NET Standard 2.0 and adds [about 200 APIs](https://github.com/dotnet/standard/blob/master/src/netstandard/src/ApiCompatBaseline.net461.txt) that are defined in .NET Standard 2.0 and are missing from .NET Framework 4.6.1, 4.6.2, and 4.7. (Note that these versions of .NET Framework support .NET Standard 2.0 only if additional .NET Standard support files are also deployed on the target system.) For more information, see "BCL - .NET Standard 2.0 Support" in the [.NET Framework 4.7.1 Runtime and Compiler Features](https://devblogs.microsoft.com/dotnet/net-framework-4-7-1-runtime-and-compiler-features/) blog post. **Support for configuration builders** diff --git a/docs/standard/net-standard.md b/docs/standard/net-standard.md index ef95ec9326a03..ef932a1719aba 100644 --- a/docs/standard/net-standard.md +++ b/docs/standard/net-standard.md @@ -55,9 +55,9 @@ The .NET Standard specification is a standardized set of APIs. The specification ### Official artifacts -The official specification is a set of *.cs* files that define the APIs that are part of the standard. The [ref directory](https://github.com/dotnet/standard/tree/main/src/netstandard/ref) in the [dotnet/standard repository](https://github.com/dotnet/standard) defines the .NET Standard APIs. +The official specification is a set of *.cs* files that define the APIs that are part of the standard. The [ref directory](https://github.com/dotnet/standard/tree/master/src/netstandard/ref) in the [dotnet/standard repository](https://github.com/dotnet/standard) defines the .NET Standard APIs. -The [NETStandard.Library](https://www.nuget.org/packages/NETStandard.Library) metapackage ([source](https://github.com/dotnet/standard/blob/main/src/netstandard/pkg/NETStandard.Library.dependencies.props)) describes the set of libraries that define (in part) one or more .NET Standard versions. +The [NETStandard.Library](https://www.nuget.org/packages/NETStandard.Library) metapackage ([source](https://github.com/dotnet/standard/blob/master/src/netstandard/pkg/NETStandard.Library.dependencies.props)) describes the set of libraries that define (in part) one or more .NET Standard versions. A given component, like `System.Runtime`, describes: @@ -66,7 +66,7 @@ A given component, like `System.Runtime`, describes: Derivative artifacts are provided to enable more convenient reading and to enable certain developer scenarios (for example, using a compiler). -- [API list in markdown](https://github.com/dotnet/standard/tree/main/docs/versions) +- [API list in markdown](https://github.com/dotnet/standard/tree/master/docs/versions) - Reference assemblies, distributed as NuGet packages and referenced by the [NETStandard.Library](https://www.nuget.org/packages/NETStandard.Library/) metapackage. ### Package representation @@ -160,7 +160,7 @@ Here are some problems with .NET Standard that help explain why .NET 5 is the be ## See also -- [.NET Standard versions (source)](https://github.com/dotnet/standard/blob/main/docs/versions.md) +- [.NET Standard versions (source)](https://github.com/dotnet/standard/blob/master/docs/versions.md) - [.NET Standard versions (interactive UI)](https://dotnet.microsoft.com/platform/dotnet-standard#versions) - [Build a .NET Standard library](../core/tutorials/library-with-visual-studio.md) - [Cross-platform targeting](./library-guidance/cross-platform-targeting.md) diff --git a/docs/standard/whats-new/whats-new-in-dotnet-standard.md b/docs/standard/whats-new/whats-new-in-dotnet-standard.md index 47eb60eb62736..89277c2a27be3 100644 --- a/docs/standard/whats-new/whats-new-in-dotnet-standard.md +++ b/docs/standard/whats-new/whats-new-in-dotnet-standard.md @@ -47,7 +47,7 @@ Some of the additions to the namespace in .NET Standard 2.0 includ ### Support for .NET Framework libraries -Many libraries target .NET Framework rather than .NET Standard. However, most of the calls in those libraries are to APIs that are included in .NET Standard 2.0. Starting with .NET Standard 2.0, you can access .NET Framework libraries from a .NET Standard library by using a [compatibility shim](https://github.com/dotnet/standard/blob/main/docs/planning/netstandard-2.0/README.md#assembly-unification). This compatibility layer is transparent to developers; you don't have to do anything to take advantage of .NET Framework libraries. +Many libraries target .NET Framework rather than .NET Standard. However, most of the calls in those libraries are to APIs that are included in .NET Standard 2.0. Starting with .NET Standard 2.0, you can access .NET Framework libraries from a .NET Standard library by using a [compatibility shim](https://github.com/dotnet/standard/blob/master/docs/planning/netstandard-2.0/README.md#assembly-unification). This compatibility layer is transparent to developers; you don't have to do anything to take advantage of .NET Framework libraries. The single requirement is that the APIs called by the .NET Framework class library must be included in .NET Standard 2.0. diff --git a/includes/net-standard-table.md b/includes/net-standard-table.md index 7f8de986d2b57..644437fae373a 100644 --- a/includes/net-standard-table.md +++ b/includes/net-standard-table.md @@ -21,12 +21,12 @@ - The version number in each cell indicates the *minimum* version of the implementation you'll need in order to target that .NET Standard version. - For an interactive table, see [.NET Standard versions](https://dotnet.microsoft.com/platform/dotnet-standard#versions). -[1.0]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.0.md -[1.1]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.1.md -[1.2]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.2.md -[1.3]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.3.md -[1.4]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.4.md -[1.5]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.5.md -[1.6]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard1.6.md -[2.0]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard2.0.md -[2.1]: https://github.com/dotnet/standard/blob/main/docs/versions/netstandard2.1.md +[1.0]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.0.md +[1.1]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.1.md +[1.2]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.2.md +[1.3]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.3.md +[1.4]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.4.md +[1.5]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.5.md +[1.6]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard1.6.md +[2.0]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard2.0.md +[2.1]: https://github.com/dotnet/standard/blob/master/docs/versions/netstandard2.1.md From 956507a258267c3a143a3a41b568b6024fddb5d6 Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Sat, 20 Mar 2021 06:30:45 +0200 Subject: [PATCH 03/16] Use samples browser link --- docs/core/dependency-loading/collect-details.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/core/dependency-loading/collect-details.md b/docs/core/dependency-loading/collect-details.md index 0ef2095c63270..3529b04ee8496 100644 --- a/docs/core/dependency-loading/collect-details.md +++ b/docs/core/dependency-loading/collect-details.md @@ -30,7 +30,7 @@ The collected trace file can be viewed on Windows using the Events view in [Perf ## Example (on Windows) -This example uses the [assembly loading extension points sample](https://github.com/dotnet/samples/tree/main/core/extensions/AssemblyLoading). The application attempts to load an assembly `MyLibrary` - an assembly that is not referenced by the application and thus requires handling in an assembly loading extension point to be successfully loaded. +This example uses the [assembly loading extension points sample](https://docs.microsoft.com/samples/dotnet/samples/assembly-loading-extension-points/). The application attempts to load an assembly `MyLibrary` - an assembly that is not referenced by the application and thus requires handling in an assembly loading extension point to be successfully loaded. ### Collect the trace From 10c0c1aa6240ea87d75fb17f8658ea41bc9dde85 Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Sat, 20 Mar 2021 06:42:11 +0200 Subject: [PATCH 04/16] Manually fix links --- docs/core/porting/cpp-cli.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/core/porting/cpp-cli.md b/docs/core/porting/cpp-cli.md index 05bad25798d03..e0a3826a28e1e 100644 --- a/docs/core/porting/cpp-cli.md +++ b/docs/core/porting/cpp-cli.md @@ -64,14 +64,14 @@ It's also possible to build C++/CLI projects without using MSBuild. Follow these 2. Reference necessary .NET Core reference assemblies. 3. When linking, provide the .NET Core app host directory as a `LibPath` (so that *ijwhost.lib* can be found). 4. Copy *ijwhost.dll* (from the .NET Core app host directory) to the project's output directory. -5. Make sure a [runtimeconfig.json](https://github.com/dotnet/cli/blob/main/Documentation/specs/runtime-configuration-file.md) file exists for the first component of the application that will run managed code. If the application has a managed entry point, a `runtime.config` file will be created and copied automatically. If the application has a native entry point, though, you need to create a `runtimeconfig.json` file for the first C++/CLI library to use the .NET Core runtime. +5. Make sure a [runtimeconfig.json](https://github.com/dotnet/sdk/blob/main/documentation/specs/runtime-configuration-file.md) file exists for the first component of the application that will run managed code. If the application has a managed entry point, a `runtime.config` file will be created and copied automatically. If the application has a native entry point, though, you need to create a `runtimeconfig.json` file for the first C++/CLI library to use the .NET Core runtime. ## Known issues There are a couple known issues to look out for when working with C++/CLI projects targeting .NET Core. * A WPF framework reference in .NET Core C++/CLI projects currently causes some extraneous warnings about being unable to import symbols. These warnings can be safely ignored and should be fixed soon. -* If the application has a native entry point, the C++/CLI library that first executes managed code needs a [runtimeconfig.json](https://github.com/dotnet/cli/blob/master/Documentation/specs/runtime-configuration-file.md) file. This config file is used when the .NET Core runtime starts. C++/CLI projects don't create `runtimeconfig.json` files automatically at build time yet, so the file must be generated manually. If a C++/CLI library is called from a managed entry point, then the C++/CLI library doesn't need a `runtimeconfig.json` file (since the entry point assembly will have one that is used when starting the runtime). A simple sample `runtimeconfig.json` file is shown below. For more information, see the [spec on GitHub](https://github.com/dotnet/cli/blob/main/Documentation/specs/runtime-configuration-file.md). +* If the application has a native entry point, the C++/CLI library that first executes managed code needs a [runtimeconfig.json](https://github.com/dotnet/sdk/blob/main/documentation/specs/runtime-configuration-file.md) file. This config file is used when the .NET Core runtime starts. C++/CLI projects don't create `runtimeconfig.json` files automatically at build time yet, so the file must be generated manually. If a C++/CLI library is called from a managed entry point, then the C++/CLI library doesn't need a `runtimeconfig.json` file (since the entry point assembly will have one that is used when starting the runtime). A simple sample `runtimeconfig.json` file is shown below. For more information, see the [spec on GitHub](https://github.com/dotnet/sdk/blob/main/documentation/specs/runtime-configuration-file.md). ```json { From bd8a0a95be0f5796afd0c00f3d75466209027638 Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Sat, 20 Mar 2021 06:44:35 +0200 Subject: [PATCH 05/16] Back to master --- docs/core/project-sdk/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/core/project-sdk/overview.md b/docs/core/project-sdk/overview.md index 17582e9293bd0..0a9d56a6bbdb7 100644 --- a/docs/core/project-sdk/overview.md +++ b/docs/core/project-sdk/overview.md @@ -220,7 +220,7 @@ The following XML is a snippet from a *.csproj* file that instructs the [`dotnet To consume a custom target in your project, add a `PackageReference` element that points to the package and its version. Unlike the tools, the custom targets package is included in the consuming project's dependency closure. -You can configure how to use the custom target. Since it's an MSBuild target, it can depend on a given target, run after another target, or be manually invoked by using the `dotnet msbuild -t:` command. However, to provide a better user experience, you can combine per-project tools and custom targets. In this scenario, the per-project tool accepts whatever parameters are needed and translates that into the required [`dotnet msbuild`](../tools/dotnet-msbuild.md) invocation that executes the target. You can see a sample of this kind of synergy on the [MVP Summit 2016 Hackathon samples](https://github.com/dotnet/MVPSummitHackathon2016) repo in the [`dotnet-packer`](https://github.com/dotnet/MVPSummitHackathon2016/tree/main/dotnet-packer) project. +You can configure how to use the custom target. Since it's an MSBuild target, it can depend on a given target, run after another target, or be manually invoked by using the `dotnet msbuild -t:` command. However, to provide a better user experience, you can combine per-project tools and custom targets. In this scenario, the per-project tool accepts whatever parameters are needed and translates that into the required [`dotnet msbuild`](../tools/dotnet-msbuild.md) invocation that executes the target. You can see a sample of this kind of synergy on the [MVP Summit 2016 Hackathon samples](https://github.com/dotnet/MVPSummitHackathon2016) repo in the [`dotnet-packer`](https://github.com/dotnet/MVPSummitHackathon2016/tree/master/dotnet-packer) project. ## See also From d45000ce9e959fb26b4059345ce36ba5f65893bd Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Sat, 20 Mar 2021 06:53:06 +0200 Subject: [PATCH 06/16] Back to master --- docs/core/tools/dotnet.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/core/tools/dotnet.md b/docs/core/tools/dotnet.md index 7b652cf417382..1b86572ac3a30 100644 --- a/docs/core/tools/dotnet.md +++ b/docs/core/tools/dotnet.md @@ -112,7 +112,7 @@ The following options are available when `dotnet` runs an application. For examp - **`--additional-deps `** - Path to an additional *.deps.json* file. A *deps.json* file contains a list of dependencies, compilation dependencies, and version information used to address assembly conflicts. For more information, see [Runtime Configuration Files](https://github.com/dotnet/cli/blob/main/Documentation/specs/runtime-configuration-file.md) on GitHub. + Path to an additional *.deps.json* file. A *deps.json* file contains a list of dependencies, compilation dependencies, and version information used to address assembly conflicts. For more information, see [Runtime Configuration Files](https://github.com/dotnet/sdk/blob/main/documentation/specs/runtime-configuration-file.md) on GitHub. - **`--depsfile `** @@ -275,7 +275,7 @@ dotnet myapp.dll - `DOTNET_MULTILEVEL_LOOKUP` - Specifies whether .NET runtime, shared framework, or SDK are resolved from the global location. If not set, it defaults to 1 (logical `true`). Set to 0 (logical `false`) to not resolve from the global location and have isolated .NET installations. For more information about multi-level lookup, see [Multi-level SharedFX Lookup](https://github.com/dotnet/core-setup/blob/main/Documentation/design-docs/multilevel-sharedfx-lookup.md). + Specifies whether .NET runtime, shared framework, or SDK are resolved from the global location. If not set, it defaults to 1 (logical `true`). Set to 0 (logical `false`) to not resolve from the global location and have isolated .NET installations. For more information about multi-level lookup, see [Multi-level SharedFX Lookup](https://github.com/dotnet/core-setup/blob/master/Documentation/design-docs/multilevel-sharedfx-lookup.md). - `DOTNET_ROLL_FORWARD` **Available starting with .NET Core 3.x.** @@ -339,5 +339,5 @@ dotnet myapp.dll ## See also -- [Runtime Configuration Files](https://github.com/dotnet/cli/blob/main/Documentation/specs/runtime-configuration-file.md) +- [Runtime Configuration Files](https://github.com/dotnet/sdk/blob/main/documentation/specs/runtime-configuration-file.md) - [.NET run-time configuration settings](../run-time-config/index.md) From 035a96903a1076037009e31b6c8c167150406151 Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Sat, 20 Mar 2021 06:55:24 +0200 Subject: [PATCH 07/16] Back to master --- docs/core/whats-new/dotnet-core-2-0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/core/whats-new/dotnet-core-2-0.md b/docs/core/whats-new/dotnet-core-2-0.md index fde7214032837..ed09d427bcf05 100644 --- a/docs/core/whats-new/dotnet-core-2-0.md +++ b/docs/core/whats-new/dotnet-core-2-0.md @@ -104,7 +104,7 @@ You can also develop apps that target Linux as a single operating system. .NET C .NET Standard 2.0 class libraries can also reference .NET Framework class libraries, provided that they call APIs that are present in .NET Standard 2.0. No recompilation of the .NET Framework libraries is required. -For a list of the APIs that have been added to .NET Standard since its last version, .NET Standard 1.6, see [.NET Standard 2.0 vs. 1.6](https://raw.githubusercontent.com/dotnet/standard/main/docs/versions/netstandard2.0_diff.md). +For a list of the APIs that have been added to .NET Standard since its last version, .NET Standard 1.6, see [.NET Standard 2.0 vs. 1.6](https://raw.githubusercontent.com/dotnet/standard/master/docs/versions/netstandard2.0_diff.md). ### Expanded surface area From 19b62ff5cdf0bcdc221a60a6dbde3695c892d5b4 Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Sat, 20 Mar 2021 06:55:56 +0200 Subject: [PATCH 08/16] Back to master --- docs/core/whats-new/dotnet-core-2-2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/core/whats-new/dotnet-core-2-2.md b/docs/core/whats-new/dotnet-core-2-2.md index cde3cafbaa06b..253b54a214160 100644 --- a/docs/core/whats-new/dotnet-core-2-2.md +++ b/docs/core/whats-new/dotnet-core-2-2.md @@ -87,7 +87,7 @@ Starting with .NET Core 2.2, you can use a startup hook to inject code prior to We expect hosting providers to define custom configuration and policy, including settings that potentially influence the load behavior of the main entry point, such as the  behavior. The hook can be used to set up tracing or telemetry injection, to set up callbacks for handling, or to define other environment-dependent behavior. The hook is separate from the entry point, so that user code doesn't need to be modified. -See [Host startup hook](https://github.com/dotnet/core-setup/blob/main/Documentation/design-docs/host-startup-hook.md) for more information. +See [Host startup hook](https://github.com/dotnet/core-setup/blob/master/Documentation/design-docs/host-startup-hook.md) for more information. ## See also From f241724ef2172db251243b3d1f0e65746e828cac Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Sat, 20 Mar 2021 07:34:36 +0200 Subject: [PATCH 09/16] Back to master --- docs/standard/whats-new/whats-new-in-dotnet-standard.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/standard/whats-new/whats-new-in-dotnet-standard.md b/docs/standard/whats-new/whats-new-in-dotnet-standard.md index 89277c2a27be3..b91a18568af13 100644 --- a/docs/standard/whats-new/whats-new-in-dotnet-standard.md +++ b/docs/standard/whats-new/whats-new-in-dotnet-standard.md @@ -29,7 +29,7 @@ ms.prod: dotnet-whatsnew ### A vastly expanded set of APIs -Through version 1.6, .NET Standard included a comparatively small subset of APIs. Among those excluded were many APIs that were commonly used in .NET Framework or Xamarin. This complicates development, since it requires that developers find suitable replacements for familiar APIs when they develop applications and libraries that target multiple .NET implementations. .NET Standard 2.0 addresses this limitation by adding over 20,000 more APIs than were available in .NET Standard 1.6, the previous version of the standard. For a list of the APIs that have been added to .NET Standard 2.0, see [.NET Standard 2.0 vs 1.6](https://raw.githubusercontent.com/dotnet/standard/main/docs/versions/netstandard2.0_diff.md). +Through version 1.6, .NET Standard included a comparatively small subset of APIs. Among those excluded were many APIs that were commonly used in .NET Framework or Xamarin. This complicates development, since it requires that developers find suitable replacements for familiar APIs when they develop applications and libraries that target multiple .NET implementations. .NET Standard 2.0 addresses this limitation by adding over 20,000 more APIs than were available in .NET Standard 1.6, the previous version of the standard. For a list of the APIs that have been added to .NET Standard 2.0, see [.NET Standard 2.0 vs 1.6](https://raw.githubusercontent.com/dotnet/standard/master/docs/versions/netstandard2.0_diff.md). Some of the additions to the namespace in .NET Standard 2.0 include: From c91109970de3425f707fadbbe32f26dcf99f9a29 Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Sat, 20 Mar 2021 07:38:58 +0200 Subject: [PATCH 10/16] Fix link --- .../netcore-hosting/csharp/HostWithCoreClrHost/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithCoreClrHost/README.md b/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithCoreClrHost/README.md index 2f0d1b8257143..9a5ae68e43fd9 100644 --- a/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithCoreClrHost/README.md +++ b/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithCoreClrHost/README.md @@ -1,7 +1,7 @@ .NET Core Hosting Sample ======================== -This sample demonstrates a simple .NET Core host using the hosting APIs from [`coreclrhost.h`](https://github.com/dotnet/coreclr/blob/main/src/coreclr/hosts/inc/coreclrhost.h). The sample host loads and starts the .NET runtime, loads managed code, calls into a managed method, and provides a function pointer for the managed code to call back into the host. +This sample demonstrates a simple .NET Core host using the hosting APIs from [`coreclrhost.h`](https://github.com/dotnet/runtime/blob/main/src/coreclr/hosts/inc/coreclrhost.h). The sample host loads and starts the .NET runtime, loads managed code, calls into a managed method, and provides a function pointer for the managed code to call back into the host. This sample is part of the [.NET Core hosting tutorial](https://docs.microsoft.com/dotnet/core/tutorials/netcore-hosting). See that topic for a more detailed explanation of this sample. @@ -10,7 +10,7 @@ About .NET Core Hosts .NET Core applications are always run by a host. In most cases, the default dotnet.exe host is used. -It is possible to create your own host, though, to enable starting and running .NET Core code from a native application, or to enable a high degree of control over how the runtime operates. More complex, real-world hosts can be found in the [dotnet/coreclr](https://github.com/dotnet/coreclr/tree/main/src/coreclr/hosts) repository. +It is possible to create your own host, though, to enable starting and running .NET Core code from a native application, or to enable a high degree of control over how the runtime operates. More complex, real-world hosts can be found in the [dotnet/runtime](https://github.com/dotnet/runtime/tree/main/src/coreclr/hosts) repository. Build and Run ------------- From ff137098f6ba3b4558e0e11ffcd9af00e2cb85bf Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Sat, 20 Mar 2021 07:40:19 +0200 Subject: [PATCH 11/16] Back to master --- .../tutorials/netcore-hosting/csharp/HostWithHostFxr/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithHostFxr/readme.md b/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithHostFxr/readme.md index d435b847c3888..3fa24b3775b42 100644 --- a/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithHostFxr/readme.md +++ b/samples/snippets/core/tutorials/netcore-hosting/csharp/HostWithHostFxr/readme.md @@ -1,6 +1,6 @@ # .NET Core Hosting Sample -This project demonstrates a way for a native process to host .NET Core using the `nethost` and `hostfxr` libraries. Documentation on the `nethost` and `hostfxr` APIs can be found [here](https://github.com/dotnet/core-setup/blob/main/Documentation/design-docs/native-hosting.md). +This project demonstrates a way for a native process to host .NET Core using the `nethost` and `hostfxr` libraries. Documentation on the `nethost` and `hostfxr` APIs can be found [here](https://github.com/dotnet/core-setup/blob/master/Documentation/design-docs/native-hosting.md). ## Key Features From a23be734c2bf0ee78d933e61cdde02073d98cd8d Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Sat, 20 Mar 2021 07:42:45 +0200 Subject: [PATCH 12/16] Fix link --- .../snippets/core/tutorials/netcore-hosting/csharp/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/snippets/core/tutorials/netcore-hosting/csharp/README.md b/samples/snippets/core/tutorials/netcore-hosting/csharp/README.md index 7a915740664a1..929b0be5d87e0 100644 --- a/samples/snippets/core/tutorials/netcore-hosting/csharp/README.md +++ b/samples/snippets/core/tutorials/netcore-hosting/csharp/README.md @@ -7,6 +7,6 @@ There are three samples demonstrating three different hosting interfaces for .NE 1. The [HostWithHostFxr](HostWithHostFxr) folder demonstrates how to host the .NET Core runtime using the `nethost` and `hostfxr` libraries' APIs. These APIs were introduced in .NET Core 3.0 and are the recommended method of hosting .NET Core 3.0 and above. These entry points handle the complexity of finding and setting up the runtime for initialization. This host demonstrates calling from native code into a static managed method and passing it a message to display. 1. The [HostWithCoreClrHost](HostWithCoreClrHost) folder demonstrates how to host the .NET Core runtime using the newer `coreclrhost.h` API. This API is the preferred method of hosting .NET Core 2.2 and below. This host demonstrates calling from native code into a static managed method and supplying a function pointer for the managed code to use to call back into the host. -These hosts are small and bypass a lot of complexity (probing for assemblies in multiple locations, thorough error checking, etc.) that a real host would have. Hopefully by remaining simple, though, they will be useful for demonstrating the core concepts of hosting managed .NET Core code in a native process. Other (more real-world) hosts which may be useful as a guide can be found in .NET Core product source in the [dotnet/runtime](https://github.com/dotnet/runtime/tree/main/src/coreclr/src/hosts) repository. +These hosts are small and bypass a lot of complexity (probing for assemblies in multiple locations, thorough error checking, etc.) that a real host would have. Hopefully by remaining simple, though, they will be useful for demonstrating the core concepts of hosting managed .NET Core code in a native process. Other (more real-world) hosts which may be useful as a guide can be found in .NET Core product source in the [dotnet/runtime](https://github.com/dotnet/runtime/tree/main/src/coreclr/hosts) repository. These samples are part of the [.NET Core hosting tutorial](https://docs.microsoft.com/dotnet/core/tutorials/netcore-hosting). Please see that topic for a more detailed explanation of the samples and the steps necessary to host .NET Core. From 4246d49d6319adf238b216178562c623d60cd099 Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Sat, 20 Mar 2021 07:51:39 +0200 Subject: [PATCH 13/16] master -> main (missed links) --- .../application-performance-management.md | 4 ++-- docs/core/diagnostics/event-counters.md | 2 +- .../testing/unit-testing-visual-basic-with-dotnet-test.md | 2 +- docs/core/testing/unit-testing-visual-basic-with-mstest.md | 2 +- docs/core/testing/unit-testing-visual-basic-with-nunit.md | 2 +- docs/core/testing/unit-testing-with-dotnet-test.md | 2 +- docs/core/testing/unit-testing-with-mstest.md | 2 +- docs/core/testing/unit-testing-with-nunit.md | 2 +- docs/core/tutorials/netcore-hosting.md | 4 ++-- docs/csharp/tutorials/default-interface-methods-versions.md | 2 +- .../machine-learning/tutorials/github-issue-classification.md | 2 +- docs/machine-learning/tutorials/predict-prices.md | 2 +- docs/samples-and-tutorials/index.md | 2 +- docs/spark/how-to-guides/udf-guide.md | 4 ++-- docs/spark/tutorials/ml-sentiment-analysis.md | 2 +- docs/standard/assembly/unloadability.md | 2 +- 16 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/architecture/grpc-for-wcf-developers/application-performance-management.md b/docs/architecture/grpc-for-wcf-developers/application-performance-management.md index 6351d24d139b1..1dcbb8a5e1300 100644 --- a/docs/architecture/grpc-for-wcf-developers/application-performance-management.md +++ b/docs/architecture/grpc-for-wcf-developers/application-performance-management.md @@ -115,7 +115,7 @@ Distributed tracing is based on the concept of *spans*: named, timed operations ### Distributed tracing with `DiagnosticSource` -.NET has an internal module that maps well to distributed traces and spans: [DiagnosticSource](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md#diagnosticsource-users-guide). As well as providing a simple way to produce and consume diagnostics within a process, the `DiagnosticSource` module has the concept of an *activity*. An activity is effectively an implementation of a distributed trace, or a span within a trace. The internals of the module take care of parent/child activities, including allocating identifiers. For more information about using the `Activity` type, see the [Activity User Guide on GitHub](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Diagnostics.DiagnosticSource/src/ActivityUserGuide.md#activity-user-guide). +.NET has an internal module that maps well to distributed traces and spans: [DiagnosticSource](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md#diagnosticsource-users-guide). As well as providing a simple way to produce and consume diagnostics within a process, the `DiagnosticSource` module has the concept of an *activity*. An activity is effectively an implementation of a distributed trace, or a span within a trace. The internals of the module take care of parent/child activities, including allocating identifiers. For more information about using the `Activity` type, see the [Activity User Guide on GitHub](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Diagnostics.DiagnosticSource/src/ActivityUserGuide.md#activity-user-guide). Because `DiagnosticSource` is a part of the core framework and later, it's supported by several core components. These include , Entity Framework Core, and ASP.NET Core, including explicit support in the gRPC framework. When ASP.NET Core receives a request, it checks for a pair of HTTP headers matching the [W3C Trace Context](https://www.w3.org/TR/trace-context) standard. If the headers are found, an activity is started by using the identity values and context from the headers. If no headers are found, an activity is started with generated identity values that match the standard format. Any diagnostics generated by the framework or by application code during the lifetime of this activity can be tagged with the trace and span identifiers. The `HttpClient` support extends this functionality further by checking for a current activity on every request, and automatically adding the trace headers to the outgoing request. @@ -126,7 +126,7 @@ The ASP.NET Core gRPC client and server libraries include explicit support for ` ### Add your own `DiagnosticSource` and `Activity` -To add your own diagnostics or create explicit spans within your application code, see the [DiagnosticSource User Guide](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md#instrumenting-with-diagnosticsourcediagnosticlistener) and [Activity User Guide](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Diagnostics.DiagnosticSource/src/ActivityUserGuide.md#activity-usage). +To add your own diagnostics or create explicit spans within your application code, see the [DiagnosticSource User Guide](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md#instrumenting-with-diagnosticsourcediagnosticlistener) and [Activity User Guide](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Diagnostics.DiagnosticSource/src/ActivityUserGuide.md#activity-usage). ### Store distributed trace data diff --git a/docs/core/diagnostics/event-counters.md b/docs/core/diagnostics/event-counters.md index a68c1f9666b02..18a6e7e75908b 100644 --- a/docs/core/diagnostics/event-counters.md +++ b/docs/core/diagnostics/event-counters.md @@ -154,7 +154,7 @@ _requestRateCounter = new IncrementingPollingCounter("request-rate", this, () => There are two primary ways of consuming EventCounters, either in-proc, or out-of-proc. The consumption of EventCounters can be distinguished into three layers of various consuming technologies. - Transporting events in a raw stream via ETW or EventPipe: - - ETW APIs come with the Windows OS, and EventPipe is accessible as a [.NET API](https://github.com/dotnet/diagnostics/blob/master/documentation/design-docs/diagnostics-client-library.md#1-attaching-to-a-process-and-dumping-out-all-the-runtime-gc-events-in-real-time-to-the-console), or the diagnostic [IPC protocol](https://github.com/dotnet/diagnostics/blob/main/documentation/design-docs/ipc-protocol.md). + - ETW APIs come with the Windows OS, and EventPipe is accessible as a [.NET API](https://github.com/dotnet/diagnostics/blob/main/documentation/design-docs/diagnostics-client-library.md#1-attaching-to-a-process-and-dumping-out-all-the-runtime-gc-events-in-real-time-to-the-console), or the diagnostic [IPC protocol](https://github.com/dotnet/diagnostics/blob/main/documentation/design-docs/ipc-protocol.md). - Decoding the binary event stream into events: - The [TraceEvent library](https://www.nuget.org/packages/Microsoft.Diagnostics.Tracing.TraceEvent) handles both ETW and EventPipe stream formats. - Command-line and GUI tools: diff --git a/docs/core/testing/unit-testing-visual-basic-with-dotnet-test.md b/docs/core/testing/unit-testing-visual-basic-with-dotnet-test.md index eb58de11574d7..76eaa29e5a843 100644 --- a/docs/core/testing/unit-testing-visual-basic-with-dotnet-test.md +++ b/docs/core/testing/unit-testing-visual-basic-with-dotnet-test.md @@ -216,7 +216,7 @@ Public Function IsPrime(candidate As Integer) As Boolean End Function ``` -Following the TDD approach, add more failing tests, then update the target code. See the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-dotnet-test/PrimeService.Tests/PrimeService_IsPrimeShould.vb) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-dotnet-test/PrimeService/PrimeService.vb). +Following the TDD approach, add more failing tests, then update the target code. See the [finished version of the tests](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-dotnet-test/PrimeService.Tests/PrimeService_IsPrimeShould.vb) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-dotnet-test/PrimeService/PrimeService.vb). The completed `IsPrime` method is not an efficient algorithm for testing primality. diff --git a/docs/core/testing/unit-testing-visual-basic-with-mstest.md b/docs/core/testing/unit-testing-visual-basic-with-mstest.md index f14f7281907a7..0c225f7a54e23 100644 --- a/docs/core/testing/unit-testing-visual-basic-with-mstest.md +++ b/docs/core/testing/unit-testing-visual-basic-with-mstest.md @@ -136,6 +136,6 @@ Run `dotnet test`, and two of these tests fail. To make all of the tests pass, c if candidate < 2 ``` -Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-mstest/PrimeService.Tests/PrimeService_IsPrimeShould.vb) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-mstest/PrimeService/PrimeService.vb). +Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-mstest/PrimeService.Tests/PrimeService_IsPrimeShould.vb) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-mstest/PrimeService/PrimeService.vb). You've built a small library and a set of unit tests for that library. You've structured the solution so that adding new packages and tests is part of the normal workflow. You've concentrated most of your time and effort on solving the goals of the application. diff --git a/docs/core/testing/unit-testing-visual-basic-with-nunit.md b/docs/core/testing/unit-testing-visual-basic-with-nunit.md index 5db9435bb1b85..e9aa1366bea69 100644 --- a/docs/core/testing/unit-testing-visual-basic-with-nunit.md +++ b/docs/core/testing/unit-testing-visual-basic-with-nunit.md @@ -157,6 +157,6 @@ Run `dotnet test`, and two of these tests fail. To make all of the tests pass, c if candidate < 2 ``` -Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-vb-nunit/PrimeService.Tests/PrimeService_IsPrimeShould.vb) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-nunit/PrimeService/PrimeService.vb). +Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-nunit/PrimeService.Tests/PrimeService_IsPrimeShould.vb) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-vb-nunit/PrimeService/PrimeService.vb). You've built a small library and a set of unit tests for that library. You've structured the solution so that adding new packages and tests is part of the normal workflow. You've concentrated most of your time and effort on solving the goals of the application. diff --git a/docs/core/testing/unit-testing-with-dotnet-test.md b/docs/core/testing/unit-testing-with-dotnet-test.md index c7459f58f0a4a..7095819f88873 100644 --- a/docs/core/testing/unit-testing-with-dotnet-test.md +++ b/docs/core/testing/unit-testing-with-dotnet-test.md @@ -213,7 +213,7 @@ public bool IsPrime(int candidate) } ``` -Following the TDD approach, add more failing tests, then update the target code. See the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-dotnet-test/PrimeService.Tests/PrimeService_IsPrimeShould.cs) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-dotnet-test/PrimeService/PrimeService.cs). +Following the TDD approach, add more failing tests, then update the target code. See the [finished version of the tests](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-dotnet-test/PrimeService.Tests/PrimeService_IsPrimeShould.cs) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-dotnet-test/PrimeService/PrimeService.cs). The completed `IsPrime` method is not an efficient algorithm for testing primality. diff --git a/docs/core/testing/unit-testing-with-mstest.md b/docs/core/testing/unit-testing-with-mstest.md index 36850eed809a3..b3172990eb773 100644 --- a/docs/core/testing/unit-testing-with-mstest.md +++ b/docs/core/testing/unit-testing-with-mstest.md @@ -145,7 +145,7 @@ Run `dotnet test`, and two of these tests fail. To make all of the tests pass, c if (candidate < 2) ``` -Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-mstest/PrimeService.Tests/PrimeService_IsPrimeShould.cs) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-mstest/PrimeService/PrimeService.cs). +Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-mstest/PrimeService.Tests/PrimeService_IsPrimeShould.cs) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-mstest/PrimeService/PrimeService.cs). You've built a small library and a set of unit tests for that library. You've structured the solution so that adding new packages and tests is part of the normal workflow. You've concentrated most of your time and effort on solving the goals of the application. diff --git a/docs/core/testing/unit-testing-with-nunit.md b/docs/core/testing/unit-testing-with-nunit.md index 31a560eb75d2e..30540b51babf4 100644 --- a/docs/core/testing/unit-testing-with-nunit.md +++ b/docs/core/testing/unit-testing-with-nunit.md @@ -175,6 +175,6 @@ Run `dotnet test`, and two of these tests fail. To make all of the tests pass, c if (candidate < 2) ``` -Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/master/core/getting-started/unit-testing-using-nunit/PrimeService.Tests/PrimeService_IsPrimeShould.cs) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-nunit/PrimeService/PrimeService.cs). +Continue to iterate by adding more tests, more theories, and more code in the main library. You have the [finished version of the tests](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-nunit/PrimeService.Tests/PrimeService_IsPrimeShould.cs) and the [complete implementation of the library](https://github.com/dotnet/samples/blob/main/core/getting-started/unit-testing-using-nunit/PrimeService/PrimeService.cs). You've built a small library and a set of unit tests for that library. You've structured the solution so that adding new packages and tests is part of the normal workflow. You've concentrated most of your time and effort on solving the goals of the application. diff --git a/docs/core/tutorials/netcore-hosting.md b/docs/core/tutorials/netcore-hosting.md index cdbeda5fe878b..10b82179d6e6d 100644 --- a/docs/core/tutorials/netcore-hosting.md +++ b/docs/core/tutorials/netcore-hosting.md @@ -34,11 +34,11 @@ Keep in mind that the sample hosts are meant to be used for learning purposes, s ## Create a host using `nethost.h` and `hostfxr.h` -The following steps detail how to use the `nethost` and `hostfxr` libraries to start the .NET Core runtime in a native application and call into a managed static method. The [sample](https://github.com/dotnet/samples/tree/master/core/hosting/HostWithHostFxr) uses the `nethost` header and library installed with the .NET SDK and copies of the [`coreclr_delegates.h`](https://github.com/dotnet/runtime/blob/main/src/native/corehost/coreclr_delegates.h) and [`hostfxr.h`](https://github.com/dotnet/runtime/blob/main/src/native/corehost/hostfxr.h) files from the [dotnet/runtime](https://github.com/dotnet/runtime) repository. +The following steps detail how to use the `nethost` and `hostfxr` libraries to start the .NET Core runtime in a native application and call into a managed static method. The [sample](https://github.com/dotnet/samples/tree/main/core/hosting/HostWithHostFxr) uses the `nethost` header and library installed with the .NET SDK and copies of the [`coreclr_delegates.h`](https://github.com/dotnet/runtime/blob/main/src/native/corehost/coreclr_delegates.h) and [`hostfxr.h`](https://github.com/dotnet/runtime/blob/main/src/native/corehost/hostfxr.h) files from the [dotnet/runtime](https://github.com/dotnet/runtime) repository. ### Step 1 - Load `hostfxr` and get exported hosting functions -The `nethost` library provides the `get_hostfxr_path` function for locating the `hostfxr` library. The `hostfxr` library exposes functions for hosting the .NET Core runtime. The full list of functions can be found in [`hostfxr.h`](https://github.com/dotnet/runtime/blob/master/src/native/corehost/hostfxr.h) and the [native hosting design document](https://github.com/dotnet/runtime/blob/main/docs/design/features/native-hosting.md). The sample and this tutorial use the following: +The `nethost` library provides the `get_hostfxr_path` function for locating the `hostfxr` library. The `hostfxr` library exposes functions for hosting the .NET Core runtime. The full list of functions can be found in [`hostfxr.h`](https://github.com/dotnet/runtime/blob/main/src/native/corehost/hostfxr.h) and the [native hosting design document](https://github.com/dotnet/runtime/blob/main/docs/design/features/native-hosting.md). The sample and this tutorial use the following: * `hostfxr_initialize_for_runtime_config`: Initializes a host context and prepares for initialization of the .NET Core runtime using the specified runtime configuration. * `hostfxr_get_runtime_delegate`: Gets a delegate for runtime functionality. diff --git a/docs/csharp/tutorials/default-interface-methods-versions.md b/docs/csharp/tutorials/default-interface-methods-versions.md index d3cc57e75c070..fa1aa14085561 100644 --- a/docs/csharp/tutorials/default-interface-methods-versions.md +++ b/docs/csharp/tutorials/default-interface-methods-versions.md @@ -83,6 +83,6 @@ In an implementation of a class that implements this interface, the override can [!code-csharp[VersionTwoImplementation](~/samples/snippets/csharp/tutorials/default-interface-members-versions/finished/customer-relationship/SampleCustomer.cs?name=SnippetOverrideAndExtend)] -You can see the entire finished code in our [samples repo on GitHub](https://github.com/dotnet/samples/tree/master/csharp/tutorials/default-interface-members-versions/finished/customer-relationship). You can get the starter application on our [samples repo on GitHub](https://github.com/dotnet/samples/tree/main/csharp/tutorials/default-interface-members-versions/starter/customer-relationship). +You can see the entire finished code in our [samples repo on GitHub](https://github.com/dotnet/samples/tree/main/csharp/tutorials/default-interface-members-versions/finished/customer-relationship). You can get the starter application on our [samples repo on GitHub](https://github.com/dotnet/samples/tree/main/csharp/tutorials/default-interface-members-versions/starter/customer-relationship). These new features mean that interfaces can be updated safely when there's a reasonable default implementation for those new members. Carefully design interfaces to express single functional ideas that can be implemented by multiple classes. That makes it easier to upgrade those interface definitions when new requirements are discovered for that same functional idea. diff --git a/docs/machine-learning/tutorials/github-issue-classification.md b/docs/machine-learning/tutorials/github-issue-classification.md index 04f613f77e0e8..46b125f3a06a8 100644 --- a/docs/machine-learning/tutorials/github-issue-classification.md +++ b/docs/machine-learning/tutorials/github-issue-classification.md @@ -50,7 +50,7 @@ You can find the source code for this tutorial at the [dotnet/samples](https://g ### Prepare your data -1. Download the [issues_train.tsv](https://raw.githubusercontent.com/dotnet/samples/master/machine-learning/tutorials/GitHubIssueClassification/Data/issues_train.tsv) and the [issues_test.tsv](https://raw.githubusercontent.com/dotnet/samples/main/machine-learning/tutorials/GitHubIssueClassification/Data/issues_test.tsv) data sets and save them to the *Data* folder previously created. The first dataset trains the machine learning model and the second can be used to evaluate how accurate your model is. +1. Download the [issues_train.tsv](https://raw.githubusercontent.com/dotnet/samples/main/machine-learning/tutorials/GitHubIssueClassification/Data/issues_train.tsv) and the [issues_test.tsv](https://raw.githubusercontent.com/dotnet/samples/main/machine-learning/tutorials/GitHubIssueClassification/Data/issues_test.tsv) data sets and save them to the *Data* folder previously created. The first dataset trains the machine learning model and the second can be used to evaluate how accurate your model is. 2. In Solution Explorer, right-click each of the \*.tsv files and select **Properties**. Under **Advanced**, change the value of **Copy to Output Directory** to **Copy if newer**. diff --git a/docs/machine-learning/tutorials/predict-prices.md b/docs/machine-learning/tutorials/predict-prices.md index b644f2c951cd3..d10838cd0174d 100644 --- a/docs/machine-learning/tutorials/predict-prices.md +++ b/docs/machine-learning/tutorials/predict-prices.md @@ -38,7 +38,7 @@ In this tutorial, you learn how to: ## Prepare and understand the data -1. Download the [taxi-fare-train.csv](https://github.com/dotnet/machinelearning/blob/master/test/data/taxi-fare-train.csv) and the [taxi-fare-test.csv](https://github.com/dotnet/machinelearning/blob/main/test/data/taxi-fare-test.csv) data sets and save them to the *Data* folder you've created at the previous step. We use these data sets to train the machine learning model and then evaluate how accurate the model is. These data sets are originally from the [NYC TLC Taxi Trip data set](https://www1.nyc.gov/site/tlc/about/tlc-trip-record-data.page). +1. Download the [taxi-fare-train.csv](https://github.com/dotnet/machinelearning/blob/main/test/data/taxi-fare-train.csv) and the [taxi-fare-test.csv](https://github.com/dotnet/machinelearning/blob/main/test/data/taxi-fare-test.csv) data sets and save them to the *Data* folder you've created at the previous step. We use these data sets to train the machine learning model and then evaluate how accurate the model is. These data sets are originally from the [NYC TLC Taxi Trip data set](https://www1.nyc.gov/site/tlc/about/tlc-trip-record-data.page). 1. In **Solution Explorer**, right-click each of the \*.csv files and select **Properties**. Under **Advanced**, change the value of **Copy to Output Directory** to **Copy if newer**. diff --git a/docs/samples-and-tutorials/index.md b/docs/samples-and-tutorials/index.md index 6bad6b091cc90..ccb2a398d24ae 100644 --- a/docs/samples-and-tutorials/index.md +++ b/docs/samples-and-tutorials/index.md @@ -48,7 +48,7 @@ This sample demonstrates the syntax and features for C# indexers. The [completed **[Delegates and Events](../csharp/delegates-overview.md)** -This sample demonstrates the syntax and features for C# delegates and events. The [completed sample](https://github.com/dotnet/samples/tree/master/csharp/delegates-and-events) is available in the dotnet/samples repository on GitHub. A [second sample](https://github.com/dotnet/samples/tree/main/csharp/events) focused on events is also in the same repository. +This sample demonstrates the syntax and features for C# delegates and events. The [completed sample](https://github.com/dotnet/samples/tree/main/csharp/delegates-and-events) is available in the dotnet/samples repository on GitHub. A [second sample](https://github.com/dotnet/samples/tree/main/csharp/events) focused on events is also in the same repository. **[Expression Trees](../csharp/expression-trees.md)** diff --git a/docs/spark/how-to-guides/udf-guide.md b/docs/spark/how-to-guides/udf-guide.md index 0c09dc32ca03c..f7f265c90206b 100644 --- a/docs/spark/how-to-guides/udf-guide.md +++ b/docs/spark/how-to-guides/udf-guide.md @@ -22,7 +22,7 @@ Func udf = Udf( str => $"{s1} {str}"); ``` -The UDF takes a `string` as an input in the form of a [Column](https://github.com/dotnet/spark/blob/master/src/csharp/Microsoft.Spark/Sql/Column.cs#L14) of a [Dataframe](https://github.com/dotnet/spark/blob/main/src/csharp/Microsoft.Spark/Sql/DataFrame.cs#L24)) and returns a `string` with `hello` appended in front of the input. +The UDF takes a `string` as an input in the form of a [Column](https://github.com/dotnet/spark/blob/main/src/csharp/Microsoft.Spark/Sql/Column.cs#L14) of a [Dataframe](https://github.com/dotnet/spark/blob/main/src/csharp/Microsoft.Spark/Sql/DataFrame.cs#L24)) and returns a `string` with `hello` appended in front of the input. The following DataFrame `df` contains a list of names: @@ -54,7 +54,7 @@ The following DataFrame `udfResult` is the result of the UDF: +-------------+ ``` -To better understand how to implement UDFs, review the [UDF helper functions](https://github.com/dotnet/spark/blob/master/src/csharp/Microsoft.Spark/Sql/Functions.cs#L3616) and [examples](https://github.com/dotnet/spark/blob/main/src/csharp/Microsoft.Spark.E2ETest/UdfTests/UdfSimpleTypesTests.cs#L49) on GitHub. +To better understand how to implement UDFs, review the [UDF helper functions](https://github.com/dotnet/spark/blob/main/src/csharp/Microsoft.Spark/Sql/Functions.cs#L3616) and [examples](https://github.com/dotnet/spark/blob/main/src/csharp/Microsoft.Spark.E2ETest/UdfTests/UdfSimpleTypesTests.cs#L49) on GitHub. ## UDF serialization diff --git a/docs/spark/tutorials/ml-sentiment-analysis.md b/docs/spark/tutorials/ml-sentiment-analysis.md index 0dd420ccf1ff4..84b61434dbf2b 100644 --- a/docs/spark/tutorials/ml-sentiment-analysis.md +++ b/docs/spark/tutorials/ml-sentiment-analysis.md @@ -28,7 +28,7 @@ In this tutorial, you learn how to: * [Download and install](https://marketplace.visualstudio.com/items?itemName=MLNET.07) ML.NET Model Builder (preview). -* Download the [yelptest.csv](https://github.com/dotnet/spark/blob/master/examples/Microsoft.Spark.CSharp.Examples/MachineLearning/Sentiment/Resources/yelptest.csv) and [yelptrain.csv](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/MachineLearning/Sentiment/Resources/yelptrain.csv) Yelp review datasets. +* Download the [yelptest.csv](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/MachineLearning/Sentiment/Resources/yelptest.csv) and [yelptrain.csv](https://github.com/dotnet/spark/blob/main/examples/Microsoft.Spark.CSharp.Examples/MachineLearning/Sentiment/Resources/yelptrain.csv) Yelp review datasets. ## Review the data diff --git a/docs/standard/assembly/unloadability.md b/docs/standard/assembly/unloadability.md index 2047b1016543a..c52c4d20f1a9c 100644 --- a/docs/standard/assembly/unloadability.md +++ b/docs/standard/assembly/unloadability.md @@ -20,7 +20,7 @@ There's one noteworthy difference between the unloading using `AssemblyLoadConte ## Use collectible AssemblyLoadContext -This section contains a detailed step-by-step tutorial that shows a simple way to load a .NET Core application into a collectible `AssemblyLoadContext`, execute its entry point, and then unload it. You can find a complete sample at [https://github.com/dotnet/samples/tree/master/core/tutorials/Unloading](https://github.com/dotnet/samples/tree/main/core/tutorials/Unloading). +This section contains a detailed step-by-step tutorial that shows a simple way to load a .NET Core application into a collectible `AssemblyLoadContext`, execute its entry point, and then unload it. You can find a complete sample at [https://github.com/dotnet/samples/tree/main/core/tutorials/Unloading](https://github.com/dotnet/samples/tree/main/core/tutorials/Unloading). ### Create a collectible AssemblyLoadContext From 3a4b140f611bac6ffb0223f94d6df47bb0301577 Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Mon, 22 Mar 2021 22:17:25 +0200 Subject: [PATCH 14/16] Update docs/fundamentals/code-analysis/code-style-rule-options.md Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- docs/fundamentals/code-analysis/code-style-rule-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/fundamentals/code-analysis/code-style-rule-options.md b/docs/fundamentals/code-analysis/code-style-rule-options.md index b07fe053326bc..34af15e072e10 100644 --- a/docs/fundamentals/code-analysis/code-style-rule-options.md +++ b/docs/fundamentals/code-analysis/code-style-rule-options.md @@ -252,4 +252,4 @@ dotnet_naming_style.begins_with_i.capitalization = pascal_case - [Quick Actions in Visual Studio](/visualstudio/ide/quick-actions) - [Create portable custom editor options in Visual Studio](/visualstudio/ide/create-portable-custom-editor-options) - [.NET Compiler Platform "Roslyn" .editorconfig file](https://github.com/dotnet/roslyn/blob/main/.editorconfig) -- [.NET Compiler Platform Runtime .editorconfig file](https://github.com/dotnet/runtime/blob/main/.editorconfig) +- [.NET runtime .editorconfig file](https://github.com/dotnet/runtime/blob/main/.editorconfig) From e27ec85c04ddda766d3acfd9533ff5f2d72ea01e Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Mon, 22 Mar 2021 22:20:04 +0200 Subject: [PATCH 15/16] Update docs/csharp/whats-new/csharp-7.md --- docs/csharp/whats-new/csharp-7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csharp/whats-new/csharp-7.md b/docs/csharp/whats-new/csharp-7.md index 51ef21c63bf16..03e0629df8186 100644 --- a/docs/csharp/whats-new/csharp-7.md +++ b/docs/csharp/whats-new/csharp-7.md @@ -49,7 +49,7 @@ Finally, the compiler has new options: The remainder of this article provides an overview of each feature. For each feature, you'll learn the reasoning behind it and the syntax. You can explore these features in your environment using the `dotnet try` global tool: -1. Install the [dotnet-try](https://github.com/dotnet/try/blob/main/README.md#setup) global tool. +1. Install the [dotnet-try](https://github.com/dotnet/try/blob/main/DotNetTryLocal.md) global tool. 1. Clone the [dotnet/try-samples](https://github.com/dotnet/try-samples) repository. 1. Set the current directory to the *csharp7* subdirectory for the *try-samples* repository. 1. Run `dotnet try`. From 16bf3a28c5c71afc11cd7dacc37f629dd9390e13 Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Mon, 22 Mar 2021 22:20:14 +0200 Subject: [PATCH 16/16] Update docs/csharp/whats-new/csharp-8.md --- docs/csharp/whats-new/csharp-8.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csharp/whats-new/csharp-8.md b/docs/csharp/whats-new/csharp-8.md index 78d46cf710c8f..90329d56d4a68 100644 --- a/docs/csharp/whats-new/csharp-8.md +++ b/docs/csharp/whats-new/csharp-8.md @@ -30,7 +30,7 @@ C# 8.0 is supported on **.NET Core 3.x** and **.NET Standard 2.1**. For more inf The remainder of this article briefly describes these features. Where in-depth articles are available, links to those tutorials and overviews are provided. You can explore these features in your environment using the `dotnet try` global tool: -1. Install the [dotnet-try](https://github.com/dotnet/try/blob/main/README.md#setup) global tool. +1. Install the [dotnet-try](https://github.com/dotnet/try/blob/main/DotNetTryLocal.md) global tool. 1. Clone the [dotnet/try-samples](https://github.com/dotnet/try-samples) repository. 1. Set the current directory to the *csharp8* subdirectory for the *try-samples* repository. 1. Run `dotnet try`.