Remove build and doc references to Git submodules (#8177)

As of #7892, the PowerShell repository no longer uses Git submodules.
This is fantastic from a workflow standpoint, and so all the notes about
how to deal with submodules (and all the build steps explicitly
initializing and updating submodules) can be safely removed.
This commit is contained in:
Andrew Schwartzmeyer
2018-11-05 10:39:29 -08:00
committed by Travis Plunk
parent 3597d58432
commit 54874180ce
11 changed files with 4 additions and 118 deletions
-46
View File
@@ -102,49 +102,3 @@ Additionally, if you've just unzipped their binary drops (or used their obtain
scripts, which do essentially the same thing), you must manually delete the
folder, as the .NET CLI team re-engineered how their binaries are setup, such
that new packages' binaries get stomped on by old packages' binaries.
## Why is my submodule empty?
If a submodule (such as `src/libpsl-native/test/googletest`) is empty, that means it is
uninitialized.
If you've already cloned, you can do this with:
```sh
git submodule init
git submodule update
```
You can verify that the submodules were initialized properly with:
```sh
git submodule status
```
If they're initialized, it will look like this:
```output
c99458533a9b4c743ed51537e25989ea55944908 src/libpsl-native/test/googletest (release-1.7.0)
```
If they're not, there will be minuses in front (and the folders will be empty):
```output
-c99458533a9b4c743ed51537e25989ea55944908 src/libpsl-native/test/googletest (release-1.7.0)
```
Please note that the commit hashes for the submodules have likely changed since
this FAQ was written.
## Why does my submodule say "HEAD detached at" some commit?
When a submodule is first initialized and updated, it is not checked out to a
branch, but the very exact commit that the super-project (this PowerShell
repository) has recorded for the submodule.
This behavior is intended.
If you want to check out an actual branch, just do so with `git checkout <branch>`.
A submodule is just a Git repository; it just happens to be nested inside another repository.
Please read the Git Book chapter on [submodules][].
[submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules