Skip to content

Make help target #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
arbormoss wants to merge 3 commits into
base: trunk
Choose a base branch
from
+44 −2
Open

Make help target #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
edb9389
Add cscope and .swp files to .gitignore
arbormoss Apr 9, 2026
a21b33a
Make help target
arbormoss Apr 9, 2026
6d39f21
fix: make format prints
arbormoss Apr 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,7 @@ result-*
/src/kernel/arch/riscv64/kernel.elf
/src/kernel/kernel.elf
/src/kernel/kernel.sym

cscope.*
*.swp
Comment thread
arbormoss marked this conversation as resolved.
*~
42 changes: 40 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,44 @@
#
# SPDX-License-Identifier: GPL-3.0-or-later

define HELP_TEXT
Configuring:
mkdir build
cd build
../configure

Make targets other than "help" require configuration.

Make Targets:
- (default): Build UkoOS.
- qemu: Run inside of the QEMU virtual machine.
- qemu-debug: Run inside of QEMU for debugging. Run make gdb in another
terminal to attach.
- gdb: Attach gdb to a running debug session.
- clean: Clean build artefacts.
- watch: Build and rebuild on new changes in doc/ and src/.
- doc-serve: Serve the UkoOS docs on port 3000, and rebuild on changes.
- doc: Build HTML documentation.
- help: Show this help text.
- format: clang-format source files.

More documentation is available at https://docs.ukoos.org
endef
export HELP_TEXT

ifeq ($(strip $(MAKECMDGOALS)),$(strip $(filter help,$(MAKECMDGOALS))))
ifneq (,$(MAKECMDGOALS))
help_only = 1
endif
endif

# Include config.mak, and make sure that it is present.
ifndef help_only
-include config.mak
ifndef config_mak_present
$(error The build was not configured; run ./configure)
endif
endif # help_only

# Turn off some built-in behavior we don't want.
.DEFAULT_GOAL = all
Expand Down Expand Up @@ -40,18 +73,23 @@ $(1)-ldflags ?=
endef

# Information about the build to perform.
ifndef help_only
include $(srcdir)/doc/include.mak
include $(srcdir)/src/kernel/include.mak

# Load the target.
ifeq ($(realpath $(srcdir)/src/targets/$(arch)/$(target).mak),)
$(error The target $(target) did not exist; rerun ./configure)
endif

include $(srcdir)/src/targets/$(arch)/$(target).mak
endif # help_only

# Common rules.
all::
$(call defcleanable,compile_commands.json)
help:
@echo "$$HELP_TEXT"
distclean: clean
@if [[ -e config.mak ]]; then echo "CLEAN config.mak"; rm config.mak; fi
@if [[ -e Makefile ]]; then echo "CLEAN Makefile"; rm Makefile; fi
Expand All @@ -66,9 +104,9 @@ watch:
format:
@find $(srcdir) -type f \( -name '*.c' -o -name '*.h' \) \
-exec clang-format -i {} \; \
-printf "FORMAT %P\n"
-exec echo 'FORMAT {}' \;

.PHONY: all clean install watch format
.PHONY: all clean install watch format help
.SUFFIXES:

define common_rules_for_dir
Expand Down
Loading