small dev doc tweaks (#47782)

* doc nits * Update docs/Submodules.md Co-authored-by: Ahson Khan <[email protected]> * Update docs/BuildFromSource.md Co-authored-by: William Godbe <[email protected]> * Update docs/BuildFromSource.md * tweak --------- Co-authored-by: Ahson Khan <[email protected]> Co-authored-by: William Godbe <[email protected]>
dotnet · Apr 19, 2023 · 8ea2347 · 8ea2347
1 parent 531f5cf
commit 8ea2347
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git 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
@@ -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::...]