Missed xdoc -> doc earlier

4 years ago · 792b208643
parent 9819b557fe
commit 792b208643
20 changed files with 46 additions and 31 deletions
--- a/01_wait_forever/Makefile
+++ b/01_wait_forever/Makefile
@ -36,6 +36,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel
@ -62,7 +63,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/02_runtime_init/Makefile
+++ b/02_runtime_init/Makefile
@ -36,6 +36,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel
@ -62,7 +63,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/03_hacky_hello_world/Makefile
+++ b/03_hacky_hello_world/Makefile
@ -36,6 +36,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel
@ -62,7 +63,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/04_zero_overhead_abstraction/Makefile
+++ b/04_zero_overhead_abstraction/Makefile
@ -36,6 +36,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel
@ -62,7 +63,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/05_safe_globals/Makefile
+++ b/05_safe_globals/Makefile
@ -36,6 +36,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel
@ -62,7 +63,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/06_drivers_gpio_uart/Makefile
+++ b/06_drivers_gpio_uart/Makefile
@ -36,6 +36,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel
@ -62,7 +63,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/07_uart_chainloader/Makefile
+++ b/07_uart_chainloader/Makefile
@ -43,6 +43,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel
@ -72,7 +73,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/07_uart_chainloader/README.md
+++ b/07_uart_chainloader/README.md
@ -120,7 +120,7 @@ diff -uNr 06_drivers_gpio_uart/Makefile 07_uart_chainloader/Makefile
 endif

 SOURCES = $(wildcard **/*.rs) $(wildcard **/*.S) $(wildcard **/*.ld)
-@@ -48,9 +55,12 @@
+@@ -49,9 +56,12 @@
 DOCKER_IMAGE         = rustembedded/osdev-utils
 DOCKER_CMD           = docker run -it --rm
 DOCKER_ARG_DIR_TUT   = -v $(shell pwd):/work -w /work
@ -134,7 +134,7 @@ diff -uNr 06_drivers_gpio_uart/Makefile 07_uart_chainloader/Makefile

 all: clean $(OUTPUT)

-@@ -67,13 +77,26 @@
+@@ -68,13 +78,26 @@
 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
 	@echo "This board is not yet supported for QEMU."
--- a/08_timestamps/Makefile
+++ b/08_timestamps/Makefile
@ -41,6 +41,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel
@ -70,7 +71,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/08_timestamps/README.md
+++ b/08_timestamps/README.md
@ -66,7 +66,7 @@ diff -uNr 07_uart_chainloader/Makefile 08_timestamps/Makefile
 endif

 SOURCES = $(wildcard **/*.rs) $(wildcard **/*.S) $(wildcard **/*.ld)
-@@ -60,7 +58,7 @@
+@@ -61,7 +59,7 @@
 DOCKER_EXEC_QEMU     = $(QEMU_BINARY) -M $(QEMU_MACHINE_TYPE)
 DOCKER_EXEC_MINIPUSH = ruby /utils/minipush.rb

@ -75,7 +75,7 @@ diff -uNr 07_uart_chainloader/Makefile 08_timestamps/Makefile

 all: clean $(OUTPUT)

-@@ -77,25 +75,17 @@
+@@ -78,25 +76,17 @@
 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
 	@echo "This board is not yet supported for QEMU."
@ -272,8 +272,8 @@ diff -uNr 07_uart_chainloader/src/bsp/raspberrypi/link.ld 08_timestamps/src/bsp/

 SECTIONS
 {
-    /* Set the link address to the top-most 40 KiB of DRAM (assuming 1GiB) */
-    . = 0x3F000000 - 0x10000;
+-    /* Set the link address to 256 MiB */
+-    . = 0x10000000;
 +    /* Set current address to the value from which the RPi starts execution */
 +    . = 0x80000;

--- a/09_hw_debug_JTAG/Makefile
+++ b/09_hw_debug_JTAG/Makefile
@ -45,6 +45,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel
@ -76,7 +77,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/09_hw_debug_JTAG/README.md
+++ b/09_hw_debug_JTAG/README.md
@ -323,7 +323,7 @@ diff -uNr 08_timestamps/Makefile 09_hw_debug_JTAG/Makefile
 	LINKER_FILE       = src/bsp/raspberrypi/link.ld
 	RUSTC_MISC_ARGS   = -C target-cpu=cortex-a72
 endif
-@@ -54,11 +58,13 @@
+@@ -55,11 +59,13 @@
 DOCKER_CMD           = docker run -it --rm
 DOCKER_ARG_DIR_TUT   = -v $(shell pwd):/work -w /work
 DOCKER_ARG_DIR_UTILS = -v $(shell pwd)/../utils:/utils
@ -338,7 +338,7 @@ diff -uNr 08_timestamps/Makefile 09_hw_debug_JTAG/Makefile

 all: clean $(OUTPUT)

-@@ -87,6 +93,28 @@
+@@ -88,6 +94,28 @@
 		$(DOCKER_IMAGE) $(DOCKER_EXEC_MINIPUSH) $(DEV_SERIAL)                  \
 		$(OUTPUT)

--- a/10_privilege_level/Makefile
+++ b/10_privilege_level/Makefile
@ -45,6 +45,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel
@ -76,7 +77,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/11_virtual_memory/Makefile
+++ b/11_virtual_memory/Makefile
@ -45,6 +45,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel
@ -76,7 +77,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/12_exceptions_part1_groundwork/Makefile
+++ b/12_exceptions_part1_groundwork/Makefile
@ -45,6 +45,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel
@ -76,7 +77,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/13_integrated_testing/Makefile
+++ b/13_integrated_testing/Makefile
@ -58,6 +58,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)
 TEST_CMD   = cargo test $(COMPILER_ARGS)

@ -91,7 +92,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/13_integrated_testing/README.md
+++ b/13_integrated_testing/README.md
@ -853,15 +853,15 @@ diff -uNr 12_exceptions_part1_groundwork/Makefile 13_integrated_testing/Makefile
 SOURCES = $(wildcard **/*.rs) $(wildcard **/*.S) $(wildcard **/*.ld)

 RUSTFLAGS          = -C link-arg=-T$(LINKER_FILE) $(RUSTC_MISC_ARGS)
-@@ -46,6 +59,7 @@
-
+@@ -47,6 +60,7 @@
 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+ DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)
 +TEST_CMD   = cargo test $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel

-@@ -55,7 +69,8 @@
+@@ -56,7 +70,8 @@
 	-O binary

 DOCKER_IMAGE         = rustembedded/osdev-utils
@ -871,7 +871,7 @@ diff -uNr 12_exceptions_part1_groundwork/Makefile 13_integrated_testing/Makefile
 DOCKER_ARG_DIR_TUT   = -v $(shell pwd):/work -w /work
 DOCKER_ARG_DIR_UTILS = -v $(shell pwd)/../utils:/utils
 DOCKER_ARG_DIR_JTAG  = -v $(shell pwd)/../X1_JTAG_boot:/jtag
-@@ -64,7 +79,7 @@
+@@ -65,7 +80,7 @@
 DOCKER_EXEC_QEMU     = $(QEMU_BINARY) -M $(QEMU_MACHINE_TYPE)
 DOCKER_EXEC_MINIPUSH = ruby /utils/minipush.rb

@ -880,7 +880,7 @@ diff -uNr 12_exceptions_part1_groundwork/Makefile 13_integrated_testing/Makefile

 all: clean $(OUTPUT)

-@@ -80,32 +95,51 @@
+@@ -81,32 +96,51 @@

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
--- a/14_exceptions_part2_peripheral_IRQs/Makefile
+++ b/14_exceptions_part2_peripheral_IRQs/Makefile
@ -59,6 +59,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)
 TEST_CMD   = cargo test $(COMPILER_ARGS)

@ -92,7 +93,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 qemu: FEATURES += --features qemu-quirks
 ifeq ($(QEMU_MACHINE_TYPE),)
--- a/14_exceptions_part2_peripheral_IRQs/README.md
+++ b/14_exceptions_part2_peripheral_IRQs/README.md
@ -774,15 +774,15 @@ diff -uNr 13_integrated_testing/Makefile 14_exceptions_part2_peripheral_IRQs/Mak
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
-@@ -93,6 +94,7 @@
+@@ -94,6 +95,7 @@
 doc:
- 	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+ 	$(DOC_CMD) --document-private-items --open

 +qemu: FEATURES += --features qemu-quirks
 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu:
 	@echo $(QEMU_MISSING_STRING)
-@@ -115,6 +117,7 @@
+@@ -116,6 +118,7 @@
 endef

 export KERNEL_TEST_RUNNER
--- a/X1_JTAG_boot/Makefile
+++ b/X1_JTAG_boot/Makefile
@ -41,6 +41,7 @@ COMPILER_ARGS = --target=$(TARGET) \
 	--release

 RUSTC_CMD  = cargo rustc $(COMPILER_ARGS)
+DOC_CMD     = cargo doc $(COMPILER_ARGS)
 CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)

 CARGO_OUTPUT = target/$(TARGET)/release/kernel
@ -70,7 +71,7 @@ $(OUTPUT): $(CARGO_OUTPUT)
 	$(OBJCOPY_CMD) $< $(OUTPUT)

 doc:
-	cargo xdoc --target=$(TARGET) --features bsp_$(BSP) --document-private-items --open
+	$(DOC_CMD) --document-private-items --open

 ifeq ($(QEMU_MACHINE_TYPE),)
 qemu: