Build improvements and guard hd function from being in default releases

Author: markjfisher

Changelog.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased]
 
+- [build] Guarded hex_dump.c with flag `FN_LIB_DEBUG` which can be enabled via `application.mk`.
+          Added additional docs to `README.md` to explain this.
+          Added comments to top of `build.mk` to explain a little bit about paths that are included.
+          Cosolidated the CFLAGS/ASMFLAGS inclusion in `build.mk` into common pattern.
+          The fix included putting a space after the args in `compiler-cc65.mk` so it was separated from the parameter correctly.
+
 ## 4.8.1 2025-11-01
 
 - [coco] rollback dragon changes for dwread/write that broke coco. Dragon will need testing and future fix potentially by Eric Carr

README.md

@@ -15,6 +15,19 @@ $ make clean
 $ make release
 ```
 
+## Adding additional build flags to local release
+
+Edit the `application.mk` and add any options you need to build a release with additional flags.
+The `hd` function (for hex dumping) is guarded by the `FN_LIB_DEBUG` define.
+
+```makefile
+# CFLAGS += -DFN_LIB_DEBUG
+```
+
+This is not enabled by default, so release libraries will not contain the hd function.
+If you are doing local testing, this is the place to add custom CFLAGS or ASMFLAGS for
+the built library to pickup.
+
 ## Releasing a new version of the library
 
 This can be done with the gitlab automated workflow.

application.mk

@@ -1,3 +1,5 @@
 # for application specific settings
 
--include makefiles/unit_tests.mk
+-include makefiles/unit_tests.mk
+
+# CFLAGS += -DFN_LIB_DEBUG

common/inc/hex_dump.h

@@ -1,6 +1,9 @@
+#ifdef FN_LIB_DEBUG
+
 #ifndef HEX_DUMP_H
 #define HEX_DUMP_H
 
 void hd(void* data, int size);
 
-#endif
+#endif
+#endif

common/src/util/hex_dump.c

@@ -1,3 +1,5 @@
+#ifdef FN_LIB_DEBUG
+
 #ifdef _CMOC_VERSION_
 #include <cmoc.h>
 #else
@@ -37,3 +39,5 @@ void hd(void* data, unsigned int size) {
         }
     }
 }
+
+#endif

makefiles/build.mk

@@ -1,7 +1,23 @@
-# Generic Build script for CC65
+# generic c/asm build script.
 #
-
-# Customized for fujinet-libs
+# This makefile is responsible for compiling the asm/s/c files for a particular target, passed in as CURRENT_TARGET
+#
+# You should not normally need to update this file unless you are making enhancements or bug fixes to it.
+# For compiling the library, it does not need changes for simple additions of new files etc.
+#
+# It will RECURSIVELY add to the sources to be built everything that isunder the folders
+# - <CURRENT_TARGET>/src/*.[c,<s|asm>]
+# - common/src/*.[c,<s|asm>]
+# - <CURRENT_TARGET>/<platform specific path>/
+#
+# This means that the makefile does not have to be updated to add new folders, or if you restructure your code.
+#
+# Platform specific paths are defined in os.mk, and allow a particular target within a platform (e.g. apple2gs) to
+# add its own folders that are not included for other targets of that platform.
+# e.g. for apple2 and apple2enh it includes "apple2/apple2-6502", whereas the apple2gs target adds "apple2/apple2gs"
+#
+# code is compiled into the obj/ folder including the full paths of the src file to ensure similarly named files
+# from different folders do not clash
 
 # Ensure WSL2 Ubuntu and other linuxes use bash by default instead of /bin/sh, which does not always like the shell commands.
 SHELL := /usr/bin/env bash
@@ -85,36 +101,17 @@ OBJECTS_ARC := $(strip $(OBJECTS_ARC))
 # Ensure make recompiles parts it needs to if src files change
 DEPENDS := $(OBJECTS:$(OBJEXT)=.d)
 
-ifeq ($(CC),iix compile)
-CFLAGS += \
-	$(INCC_ARG)common/inc \
-	$(INCC_ARG)$(PLATFORM_SRC_DIR)/include \
-	$(INCC_ARG).
-else ifeq ($(CC),zcc)
 CFLAGS += \
 	$(INCC_ARG)common/inc \
 	$(INCC_ARG)$(PLATFORM_SRC_DIR)/include \
 	$(INCC_ARG).
 
+# only include ASFLAGS if not wcc or iix
+ifneq ($(filter $(CC),wcc iix),$(CC))
 ASFLAGS += \
 	$(INCS_ARG)common/inc \
 	$(INCS_ARG)$(PLATFORM_SRC_DIR)/include \
 	$(INCS_ARG).
-else ifeq ($(CC),wcc)
-CFLAGS += \
-	$(INCC_ARG)common/inc \
-	$(INCC_ARG)$(PLATFORM_SRC_DIR)/include \
-	$(INCC_ARG).
-else
-ASFLAGS += \
-	$(INCS_ARG) common/inc \
-	$(INCS_ARG) $(PLATFORM_SRC_DIR)/include \
-	$(INCS_ARG) .
-
-CFLAGS += \
-	$(INCC_ARG) common/inc \
-	$(INCC_ARG) $(PLATFORM_SRC_DIR)/include \
-	$(INCC_ARG) .
 endif
 
 FN_NW_HEADER = fujinet-network.h
@@ -192,14 +189,6 @@ else
 	$(CC) -c --deps $(CFLAGS) -o $@ $<
 endif
 
-## For now, no asm in common dirs... as it would be compiler specific
-# $(OBJDIR)/$(CURRENT_TARGET)/common/%$(OBJEXT): %$(ASMEXT) | $(TARGETOBJDIR)
-# 	@$(call MKDIR,$(dir $@))
-# ifeq ($(CC),cl65)
-# 	$(CC) -t $(CURRENT_TARGET) -c --create-dep $(@:.o=.d) $(ASFLAGS) -o $@ $<
-# else
-# endif
-
 # below shell part is a hack to make foo.ROOT become foo.root, even though the output name is already foo.root, iix capitalizes the "ROOT" part in the filename, which breaks the linux version of linker
 $(OBJDIR)/$(CURRENT_TARGET)/%$(OBJEXT): %$(ASMEXT) $(VERSION_FILE) | $(OBJDIR)
 	@$(call MKDIR,$(dir $@))

makefiles/compiler-cc65.mk

@@ -2,5 +2,6 @@ CC        := cl65
 AR        := ar65
 CFLAGS    := -Osir
 
-INCC_ARG  := --include-dir
-INCS_ARG  := --asm-include-dir
+# IMPORTANT: these lines have a trailing space to separate the argument from the path they include
+INCC_ARG  := --include-dir 
+INCS_ARG  := --asm-include-dir