diff --git a/.gitignore b/.gitignore new file mode 100755 index 000000000..c81441881 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +_build +images diff --git a/Makefile b/Makefile index 7d2e6fd9c..d67e4cf80 100755 --- a/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ VERSION_MAJOR := 1 VERSION_MINOR := 15 -BUILD_DIR := build +BUILD_DIR := _build PROJECT := picoprobe @@ -73,16 +73,16 @@ flash: all .PHONY: create-images create-images: $(MAKE) clean-build - $(MAKE) cmake-create-debug PICO_BOARD=pico OPT_SIGROK=1 + $(MAKE) cmake-create-release PICO_BOARD=pico OPT_SIGROK=0 $(MAKE) all mkdir -p images cp $(BUILD_DIR)/$(PROJECT).uf2 images/yapicoprobe-$(shell printf "%02d%02d" $(VERSION_MAJOR) $(VERSION_MINOR))-pico-$(GIT_HASH).uf2 # - $(MAKE) cmake-create-debug PICO_BOARD=pico_w OPT_SIGROK=1 + $(MAKE) cmake-create-release PICO_BOARD=pico_w OPT_SIGROK=0 $(MAKE) all cp $(BUILD_DIR)/$(PROJECT).uf2 images/yapicoprobe-$(shell printf "%02d%02d" $(VERSION_MAJOR) $(VERSION_MINOR))-picow-$(GIT_HASH).uf2 # - $(MAKE) cmake-create-debug PICO_BOARD=pico_debug_probe OPT_SIGROK=0 + $(MAKE) cmake-create-release PICO_BOARD=pico_debug_probe OPT_SIGROK=0 $(MAKE) all cp $(BUILD_DIR)/$(PROJECT).uf2 images/yapicoprobe-$(shell printf "%02d%02d" $(VERSION_MAJOR) $(VERSION_MINOR))-picodebugprobe-$(GIT_HASH).uf2 @@ -91,3 +91,8 @@ create-images: check-clang: # clang-tidy has its limit if another target is used... @cd $(BUILD_DIR) && run-clang-tidy -checks='-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling' + +.PHONY: show-options +show-options: + @cd $(BUILD_DIR) && cmake -LH . | sed -n -e '/OPT_/{x;1!p;g;$!N;p;D;}' -e h + diff --git a/README.adoc b/README.adoc index 920b35564..e48eaa245 100644 --- a/README.adoc +++ b/README.adoc @@ -32,7 +32,7 @@ Finally there is **Y**et **A**nother **Picoprobe** around, the YAPicoprobe. ** UART connection between target and probe is redirected ** RTT terminal channel is automatically redirected into this CDC (if there is no CMSIS-DAPv2/MSC connection) -* https://www.segger.com/products/development-tools/systemview/[SystemView] support over TCP/IP (ECM/NCM/RNDIS) +* https://www.segger.com/products/development-tools/systemview/[SystemView] support over TCP/IP (NCM/ECM/RNDIS) * CDC - virtual com port for (debug) logging of the probe * optional CDC sigrok probe - data collection on eight digital and three analog channels (logic analyzer and oscilloscope) with auto-trigger capability @@ -357,7 +357,7 @@ The Pico Debug Probe has four additional LEDs. Assignment is as follows: ## Configuration -### udev rules for MSC and CMSIS-DAP +### udev rules Under Linux one wants to use the following udev rules for convenience. @@ -530,10 +530,10 @@ git submodule update --init .General build sequence [source,bash] ---- -# create build/ninja.build for a debug target +# create _build/ninja.build for a debug target make cmake-create-debug -# build yapicoprobe, output in build/picoprobe.uf2 +# build yapicoprobe, output in _build/picoprobe.uf2 make all # clean build files @@ -563,8 +563,9 @@ cmake --build . # output in picoprobe.elf/uf2/hex/bin ---- -If you want to know the several options use the one liner -`cmake -LH .. | sed -n -e '/OPT_/{x;1!p;g;$!N;p;D;}' -e h`. +If you want to know the several options use the one liner in the build directory: +`cmake -LH . | sed -n -e '/OPT_/{x;1!p;g;$!N;p;D;}' -e h`. + +Or use simply `make show-options` in the projects root. ### Code Inherited