aboutsummaryrefslogtreecommitdiff
path: root/Documentation/submodules.md
diff options
context:
space:
mode:
authorPhilipp Deppenwiese <zaolin@das-labor.org>2018-05-13 15:47:18 +0200
committerPatrick Georgi <pgeorgi@google.com>2018-05-30 09:14:48 +0000
commit438b463a8f5f739eb02422a3d00b8dfcbeefc2e9 (patch)
treef281339a3f82297a8bb6df61f60331e9e5d45831 /Documentation/submodules.md
parente462585c9446cecb6f8cf06f62311c6ef18a4cbf (diff)
Documentation: Update index.md and move files
* Add more subdirectories and index.mds. * Move "getting started" and "lessons" into sub-directories. * Move "NativeRaminit" into northbridge/intel/sandybridge folder. * Move "MultiProcessorInit" into soc/intel/icelake folder. * Reference new files Change-Id: I78c3ec0e8bcc342686277ae141a88d0486680978 Signed-off-by: Philipp Deppenwiese <zaolin@das-labor.org> Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com> Reviewed-on: https://review.coreboot.org/26262 Reviewed-by: Patrick Georgi <pgeorgi@google.com> Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Diffstat (limited to 'Documentation/submodules.md')
-rw-r--r--Documentation/submodules.md46
1 files changed, 0 insertions, 46 deletions
diff --git a/Documentation/submodules.md b/Documentation/submodules.md
deleted file mode 100644
index 631e351303..0000000000
--- a/Documentation/submodules.md
+++ /dev/null
@@ -1,46 +0,0 @@
-Use of git submodules in coreboot
-=================================
-coreboot uses git submodules to keep certain parts of the tree separate,
-with two major use cases:
-
-First, we use a vendor tool by NVIDIA for systems based on their SoC
-and since they publish it through git, we can just import it into our
-tree using submodules.
-
-Second, lots of boards these days require binaries and we want to keep
-them separate from coreboot proper to clearly delineate shiny Open Source
-from ugly blobs.
-Since we don't want to impose blobs on users who really don't need them,
-that repository is only downloaded and checked out on explicit request.
-
-Handling submodules
--------------------
-For the most part, submodules should be automatically checked out on the
-first execution of the coreboot Makefile.
-
-To manually fetch all repositories (eg. when you want to prepare the tree
-for archiving, or to use it without network access), run
-
- $ git submodule update --init --checkout
-
-This also checks out the binaries below `3rdparty/`
-
-Mirroring coreboot
-------------------
-When running a coreboot mirror to checkout from, for full operation, you
-should also mirror the blobs and nvidia-cbootimage repository, and place
-them in the same directory as the coreboot repository mirror.
-
-That is, when residing in coreboot's repository, `cd ../blobs.git`
-should move you to the blobs repository.
-
-With that, no matter what the URL of your coreboot repository is, the
-git client (of a sufficiently new version) is able to pick up the other
-repositories transparently.
-
-Minimum requirements
---------------------
-git needs to be able to handle relative paths to submodule repositories,
-and it needs to know about non-automatic submodules.
-
-For these features, we require git version 1.7.6.1 or newer.