From 8ea2347a3c13342e831a5f5ba9ba923341a745a7 Mon Sep 17 00:00:00 2001 From: Dan Moseley Date: Wed, 19 Apr 2023 12:58:00 -0700 Subject: [PATCH] small dev doc tweaks (#47782) * doc nits * Update docs/Submodules.md Co-authored-by: Ahson Khan * Update docs/BuildFromSource.md Co-authored-by: William Godbe * Update docs/BuildFromSource.md * tweak --------- Co-authored-by: Ahson Khan Co-authored-by: William Godbe --- docs/BuildFromSource.md | 8 ++++++-- docs/Submodules.md | 8 +++++++- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/BuildFromSource.md b/docs/BuildFromSource.md index 1817bd3dc33c..abaf44119e5c 100644 --- a/docs/BuildFromSource.md +++ b/docs/BuildFromSource.md @@ -43,9 +43,13 @@ The steps you follow next depend on your preferred development environment: > To modify an existing Visual Studio installation, [follow the instructions for installing from a configuration file](https://learn.microsoft.com/visualstudio/install/import-export-installation-configurations#import-a-configuration) and use the `.vsconfig` file located in the root of the repository: ```powershell - ./eng/scripts/InstallVisualStudio.ps1 + ./eng/scripts/InstallVisualStudio.ps1 Enterprise ``` + Replace `Enterprise` with `Community` if that is your preferred Visual Studio edition. If you use Visual Studio from a preview channel you can specify that also, for example `./eng/scripts/InstallVisualStudio.ps1 Enterprise Preview`. + + If you are seeing errors similar to `the imported project "....\aspnetcore.tools\msbuild\17.1.0\tools\MSBuild\Microsoft\VC\v170\Microsoft.Cpp.Default.props" was not found`, try installing/updating Visual Studio as above. + 1. Before you open project in Visual Studio, install the required dependencies and set up the repo by running the `restore.cmd` script in the root of the repo: ```powershell @@ -119,7 +123,7 @@ The steps you follow next depend on your preferred development environment: 1. Once you've opened the project in VS Code, you can build and test changes by running the `./build.sh` command in the terminal. - > :bulb: The `build.sh` or `build.cmd` script will be local to the directory of the project you opened. For example, the script located in the `src/Http` directory. + > :bulb: The `build.sh` or `build.cmd` script will be local to the directory of the project you opened. For example, the script located in the `src/Http` directory. If you want to build the whole tree, use the `build.sh` or `build.cmd` that is located in the `eng` directory. ```bash # Linux or Mac diff --git a/docs/Submodules.md b/docs/Submodules.md index 9814d5712efb..648c801a0a5a 100644 --- a/docs/Submodules.md +++ b/docs/Submodules.md @@ -61,7 +61,7 @@ Updating all submodules to newer versions can be done like this. git submodule update --remote ``` -Updating just one subumodule. +Updating just one submodule. ```bash git submodule update --remote modules/EntityFrameworkCore/ @@ -101,3 +101,9 @@ $GitPromptSettings.EnableFileStatus = $false ``` You can disable this permanently by adding to your `$PROFILE` file. (`notepad $PROFILE`) + +## Error messages + +An error similar to this suggests that the submodules have not been initialized or need to be updated. + +...\Microsoft.Build.Tasks.Git.targets(26,5): error : Could not find file '...\aspnetcore\src\submodules\...\.git'. The source code won't be available via Source Link. [...\aspnetcore\eng\tools\RepoTasks\RepoTasks.csproj::...] \ No newline at end of file