git: invert submodule depedency

This make micropython a submodule of pybricks-micropython
instead of the other way around. This makes it quite a bit
simpler to checkout the code and keep the submodules
in sync.

Author: dlech

.github/workflows/build.yml

@@ -22,29 +22,9 @@ jobs:
     - name: Checkout repo
       uses: actions/checkout@v2
       with:
-        path: tmp
-    - name: Get tag
-      id: get_tag
-      run: echo ::set-output name=micropython_tag::$(cat tmp/micropython-tag)
-    - name: Checkout MicroPython
-      uses: actions/checkout@v2
-      with:
-        repository: pybricks/micropython
-        ref: ${{ steps.get_tag.outputs.micropython_tag }}
-        path: micropython
+        submodules: true
         token: ${{ secrets.GITHUB_TOKEN2 }}
-    - name: Checkout Pybricks
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN2 }}
-      run: |
-        cd micropython
-        git config submodule.ports/pybricks.url https://${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
-        git submodule update --init --no-fetch ports/pybricks
-        cd ports/pybricks
-        git fetch --depth=1 origin $GITHUB_SHA
-        git checkout FETCH_HEAD
     - name: Run codeformat.py
       run: |
-        cd micropython/ports/pybricks
         ./tools/codeformat.py
         git diff --exit-code

.github/workflows/format.yml

@@ -2,6 +2,7 @@
 ###################
 *.o
 *.a
+*.P
 *.elf
 *.bin
 *.map
@@ -31,6 +32,10 @@ _build/
 tests/*.exp
 tests/*.out
 
+# Python virtual environment
+############################
+.venv/
+
 # Python cache files
 ######################
 __pycache__/

.gitignore

@@ -8,3 +8,8 @@
 [submodule "bricks/nxt/nxt-firmware-drivers"]
 	path = bricks/nxt/nxt-firmware-drivers
 	url = https://github.com/pybricks/nxt-firmware-drivers.git
+	update = none
+[submodule "micropython"]
+	path = micropython
+	url = https://github.com/pybricks/micropython
+	branch = master

.gitmodules

@@ -62,16 +62,12 @@ our site, [pybricks.com].
 
 But since you're reading this, you might be interested in building the code
 yourself, or start tweaking and hacking. We don't have step-by-step guides
-for installing all the developer tools just yet. But we build all targets
-from scratch using Travis CI, so you can get the complete recipes for each
-build in the [.travis file](.travis.yml).
+for installing all the developer tools just yet.
 
 ## Pybricks and Upstream MicroPython
 
 We are actively contributing to upstream MicroPython instead of forking it into
-a whole new project. We are adding Pybricks as a new family of ports. Similar
-to how MicroPython already has a `ports/stm32` folder with multiple
-`boards`, we add a `ports/pybricks` folder with multiple programmable `bricks`.
+a whole new project.
 
 To streamline development and releases, we do maintain a fork of `micropython`
 [here][pybricks/micropython]. It essentially just adds the repository that you
@@ -82,32 +78,20 @@ greatest that upstream [`micropython`][micropython/micropython] has to offer.
 Summing up:
 
 - [`pybricks/micropython`][pybricks/micropython]: fork of
-  [upstream MicroPython][micropython/micropython] that just adds the repo below
-  as a submodule at `ports/pybricks`. It does not have a continuous master
-  branch, just versioned tags. So, never do `git pull`, but do `git fetch` and
-  then check out the tag you want.
+  [upstream MicroPython][micropython/micropython] that is included as a
+  submodule in the main `pybricks/micropython` repository.
 - [`pybricks/pybricks-micropython`][pybricks-micropython]: Main repo for all
   Pybricks firmware. This has a continuous master branch that never breaks.
-  Always look at the [tag file](micropython-tag) to see which MicroPython tag
-  must be checked out to build successfully.
 
 
 ## Cloning
 
-As explained above, this
-repository ([`pybricks/pybricks-micropython`][pybricks-micropython])
-is a submodule to [our fork of MicroPython][pybricks/micropython]. So instead
-of cloning this repository directly, do this:
+This project uses submodules. However we don't recommend using the
+`--recursive` option of `git` since it will clone unnecessary dependencies.
+Instead, the required submodules will be automatically cloned the first time
+you run `make`.
 
-    git clone https://github.com/pybricks/micropython
-    cd micropython
-    git submodule update --init --remote ports/pybricks
-    cd ports/pybricks
-
-Then you will find this repo at `ports/pybricks` in the `micropython` directory
-that was just cloned. Almost all development is done in here.
-The [`micropython-tag`](micropython-tag) file tells you which tag to checkout
-in [`pybricks/micropython`][pybricks/micropython].
+    git clone https://github.com/pybricks/pybricks-micropython
 
 ## What about all the other repositories?
 Pybricks includes not just firmware for each LEGO hub, but also various tools,

README.md

@@ -1,27 +1,44 @@
 # SPDX-License-Identifier: MIT
 # Copyright (c) 2013, 2014 Damien P. George
-
-# Sanity check
-include ../check.mk
-
-# Environment
--include mpconfigport.mk
-include ../../../../py/mkenv.mk
+# Copyright (c) 2019-2020 The Pybricks Authors
 
 # ensure required git submodules checked out
-ifeq ("$(wildcard $(TOP)/lib/axtls/README)","")
+ifeq ("$(wildcard ../../micropython/README.md)","")
+$(info GIT cloning micropython submodule)
+$(info $(shell cd ../.. && git submodule update --init micropython))
+ifeq ("$(wildcard ../../micropython/README.md)","")
+$(error failed)
+endif
+endif
+ifeq ("$(wildcard ../../micropython/lib/axtls/README)","")
 $(info GIT cloning axtls submodule)
-$(shell cd $(TOP) && git submodule update --init lib/axtls)
+$(info $(shell cd ../../micropython && git submodule update --init lib/axtls))
+ifeq ("$(wildcard ../../micropython/lib/axtls/README)","")
+$(error failed)
+endif
 endif
-ifeq ("$(wildcard $(TOP)/lib/berkeley-db-1.xx/README)","")
+ifeq ("$(wildcard ../../micropython/lib/berkeley-db-1.xx/README)","")
 $(info GIT cloning berkeley-db-1.xx submodule)
-$(shell cd $(TOP) && git submodule update --init lib/berkeley-db-1.xx)
+$(info $(shell cd ../../micropython && git submodule update --init lib/berkeley-db-1.xx))
+ifeq ("$(wildcard ../../micropython/lib/berkeley-db-1.xx/README)","")
+$(error failed)
 endif
-ifeq ("$(wildcard $(TOP)/ports/pybricks/lib/libfixmath/README.md)","")
+endif
+ifeq ("$(wildcard ../../lib/libfixmath/README.md)","")
 $(info GIT cloning libfixmath submodule)
-$(shell cd $(TOP)/ports/pybricks && git submodule update --init lib/libfixmath)
+$(info $(shell cd ../.. && git submodule update --init lib/libfixmath))
+ifeq ("$(wildcard ../../lib/libfixmath/README.md)","")
+$(error failed)
+endif
 endif
 
+# lets micropython make files work with external files
+USER_C_MODULES = ../..
+
+# Environment
+-include mpconfigport.mk
+include ../../micropython/py/mkenv.mk
+
 FROZEN_DIR = scripts
 FROZEN_MPY_DIR = modules
 QSTR_GLOBAL_DEPENDENCIES = brickconfig.h
@@ -38,19 +55,19 @@ UNAME_S := $(shell uname -s)
 # include py core make definitions
 include $(TOP)/py/py.mk
 
-INC +=  -I.
-INC +=  -I$(TOP)
+INC += -I.
+INC += -I$(TOP)
 INC += -I$(BUILD)
-INC += -I$(TOP)/ports/pybricks/lib/contiki-core
-INC += -I$(TOP)/ports/pybricks/lib/ev3dev
-INC += -I$(TOP)/ports/pybricks/lib/ev3dev/include
-INC += -I$(TOP)/ports/pybricks/lib/lego
-INC += -I$(TOP)/ports/pybricks/lib/libfixmath/libfixmath
-INC += -I$(TOP)/ports/pybricks/lib/pbio
-INC += -I$(TOP)/ports/pybricks/lib/pbio/include
-INC += -I$(TOP)/ports/pybricks/lib/pbio/platform/ev3dev_stretch
-INC += -I$(TOP)/ports/pybricks/extmod
-INC += -I$(TOP)/ports/pybricks/py
+INC += -I../../lib/contiki-core
+INC += -I../../lib/ev3dev
+INC += -I../../lib/ev3dev/include
+INC += -I../../lib/lego
+INC += -I../../lib/libfixmath/libfixmath
+INC += -I../../lib/pbio
+INC += -I../../lib/pbio/include
+INC += -I../../lib/pbio/platform/ev3dev_stretch
+INC += -I../../extmod
+INC += -I../../py
 INC += -I$(TOP)/ports/unix
 
 # compiler settings
@@ -165,7 +182,7 @@ LDFLAGS_MOD += -li2c
 endif
 
 # source files
-SRC_C = $(addprefix ports/unix/,\
+SRC_C = $(addprefix micropython/ports/unix/,\
 	main.c \
 	gccollect.c \
 	mpthreadport.c \
@@ -196,14 +213,14 @@ PYBRICKS_SRC_C += \
 	pbinit.c \
 	pbsmbus.c \
 
-LIB_SRC_C = $(addprefix lib/,\
+LIB_SRC_C = $(addprefix micropython/lib/,\
 	$(LIB_SRC_C_EXTRA) \
 	timeutils/timeutils.c \
 	utils/pyexec.c \
 	)
 
 # Pybricks drivers and modules
-PYBRICKS_EXTMOD_SRC_C = $(addprefix ports/pybricks/extmod/,\
+PYBRICKS_EXTMOD_SRC_C = $(addprefix extmod/,\
 	modbattery.c \
 	modbuiltins.c \
 	modbuttons.c \
@@ -221,14 +238,14 @@ PYBRICKS_EXTMOD_SRC_C = $(addprefix ports/pybricks/extmod/,\
 	moduos.c \
 	)
 
-PYBRICKS_PY_SRC_C = $(addprefix ports/pybricks/py/,\
+PYBRICKS_PY_SRC_C = $(addprefix py/,\
 	pb_type_enum.c \
 	pberror.c \
 	pbobj.c \
 	pbthread.c \
 	)
 
-PYBRICKS_LIB_SRC_C = $(addprefix ports/pybricks/lib/,\
+PYBRICKS_LIB_SRC_C = $(addprefix lib/,\
 	contiki-core/sys/autostart.c \
 	contiki-core/sys/etimer.c \
 	contiki-core/sys/process.c \
@@ -296,7 +313,7 @@ include $(TOP)/py/mkrules.mk
 
 .PHONY: test
 
-EV3DEV_TEST_DIRS = $(addprefix ../ports/pybricks/tests/ev3dev/, \
+EV3DEV_TEST_DIRS = $(addprefix ../../tests/ev3dev/, \
 	brick \
 	experimental \
 	media \
@@ -317,12 +334,12 @@ $(GRX_TEST_PLUGIN_LIB): $(GRX_TEST_PLUGIN_OBJ)
 	$(Q)$(CC) -shared -o $@ $^ $(LDFLAGS)
 
 test-ev3dev: $(PROG) $(TOP)/tests/run-tests $(GRX_TEST_PLUGIN_LIB)
-	cd $(TOP)/tests && MICROPY_MICROPYTHON="../ports/pybricks/tests/ev3dev/test-wrapper.sh" \
+	cd $(TOP)/tests && MICROPY_MICROPYTHON="../../tests/ev3dev/test-wrapper.sh" \
 		GRX_PLUGIN_PATH=$(realpath $(BUILD)) GRX_DRIVER=test \
 		./run-tests --test-dirs $(EV3DEV_TEST_DIRS)
 
 test: $(PROG) $(TOP)/tests/run-tests $(GRX_TEST_PLUGIN_LIB)
-	$(eval DIRNAME=ports/pybricks/bricks/$(notdir $(CURDIR)))
+	$(eval DIRNAME=../bricks/$(notdir $(CURDIR)))
 	cd $(TOP)/tests && MICROPY_MICROPYTHON=../$(DIRNAME)/$(PROG) \
 		GRX_PLUGIN_PATH=$(realpath $(BUILD)) GRX_DRIVER=test \
 		./run-tests

bricks/check.mk

@@ -26,7 +26,7 @@ if ! which docker >/dev/null; then
     exit 1
 fi
 
-src_dir="${script_dir}/../../../../.."
+src_dir="${script_dir}/../../.."
 build_dir="${script_dir}/../build-${arch}"
 image_name="docker.pkg.github.com/pybricks/pybricks-micropython/${project}-${arch}:latest"
 container_name="${project}_${arch}"
@@ -60,7 +60,7 @@ fi
 docker rm --force ${container_name} >/dev/null 2>&1 || true
 docker run \
     --volume "$(abs_path ${src_dir}):/src" \
-    --workdir /src/ports/pybricks/bricks/ev3dev \
+    --workdir /src/bricks/ev3dev \
     --name ${container_name} \
     --env "TERM=${TERM}" \
     --env "DESTDIR=/build/dist" \