Skip to content

Commit 8ea2347

Browse files
danmoseleyahsonkhanwtgodbe
authored
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]>
1 parent 531f5cf commit 8ea2347

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

docs/BuildFromSource.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,13 @@ The steps you follow next depend on your preferred development environment:
4343
> 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:
4444

4545
```powershell
46-
./eng/scripts/InstallVisualStudio.ps1
46+
./eng/scripts/InstallVisualStudio.ps1 Enterprise
4747
```
4848

49+
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`.
50+
51+
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.
52+
4953
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:
5054

5155
```powershell
@@ -119,7 +123,7 @@ The steps you follow next depend on your preferred development environment:
119123
120124
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.
121125

122-
> :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.
126+
> :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.
123127

124128
```bash
125129
# Linux or Mac

docs/Submodules.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Updating all submodules to newer versions can be done like this.
6161
git submodule update --remote
6262
```
6363

64-
Updating just one subumodule.
64+
Updating just one submodule.
6565

6666
```bash
6767
git submodule update --remote modules/EntityFrameworkCore/
@@ -101,3 +101,9 @@ $GitPromptSettings.EnableFileStatus = $false
101101
```
102102

103103
You can disable this permanently by adding to your `$PROFILE` file. (`notepad $PROFILE`)
104+
105+
## Error messages
106+
107+
An error similar to this suggests that the submodules have not been initialized or need to be updated.
108+
109+
...\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::...]

0 commit comments

Comments
 (0)