From: Mathieu Baudier <mbaudier@argeo.org>
Date: Wed, 6 Mar 2024 08:08:09 +0000 (+0100)
Subject: Improve documentation
X-Git-Tag: v2.3.10~39
X-Git-Url: https://git.argeo.org/?p=cc0%2Fargeo-build.git;a=commitdiff_plain;h=37451358d3c486d28f6df404859c1cffdb6f4ed9

Improve documentation
---

diff --git a/common.mk b/common.mk
index 025ac54..31177be 100644
--- a/common.mk
+++ b/common.mk
@@ -7,15 +7,15 @@ BNDLIB_BRANCH=5.3
 SYSLOGGER_BRANCH=$(build-major).$(build-minor)
 
 # The following variables are found in the sdk.mk file which is generated by the configure script:
-# SDK_SRC_BASE		the base of the source code, typically the root of the cloned git repository
-# SDK_BUILD_BASE	the base of the output
-# JAVA_HOME			the base of the JDK used to build
+# SDK_SRC_BASE      the base of the source code, typically the root of the cloned git repository
+# SDK_BUILD_BASE    the base of the output
+# JAVA_HOME         the base of the JDK used to build
 A2_OUTPUT = $(SDK_BUILD_BASE)/a2
 JVM ?= $(JAVA_HOME)/bin/java
 JAVADOC ?= $(JAVA_HOME)/bin/javadoc
 
 # The following variables have default values which can be overriden
-# A2_BASE			the space-separated directories where already built a2 categories can be found
+# A2_BASE           the space-separated directories where already built a2 categories can be found
 A2_BASE ?=$(A2_OUTPUT) /usr/local/share/a2 /usr/share/a2
 
 # GNU defaults
diff --git a/jni.mk b/jni.mk
index 2bbcf44..a5bbccf 100644
--- a/jni.mk
+++ b/jni.mk
@@ -2,21 +2,21 @@ ARGEO_BUILD_BASE := $(dir $(lastword $(MAKEFILE_LIST)))
 include $(ARGEO_BUILD_BASE)common.mk
 
 # The following variables should be declared in the including Makefile:
-# NATIVE_PACKAGE	this native package name
-# A2_CATEGORY		the (single) a2 category the bundles will belong to
+# NATIVE_PACKAGE    this native package name
+# A2_CATEGORY       the (single) a2 category the bundles will belong to
 
 # The following variables have default values which can be overriden
-# DEP_NATIVE		space-separated logical names of named depdencies
-# ADDITIONAL_INC	additional includes
-# ADDITIONAL_LIBS	additional native libraries
+# DEP_NATIVE        space-separated logical names of named depdencies
+# DEP_INCLUDES      additional includes
+# DEP_LIBS          additional native libraries
 DEP_NATIVE ?=
-ADDITIONAL_INC ?= $(foreach dep, $(DEP_NATIVE), /usr/include/$(dep))
-ADDITIONAL_LIBS ?= $(foreach dep, $(DEP_NATIVE), -l$(dep))
+DEP_INCLUDES ?= $(foreach dep, $(DEP_NATIVE), /usr/include/$(dep))
+DEP_LIBS ?= $(foreach dep, $(DEP_NATIVE), -l$(dep))
 
 A2_NATIVE_CATEGORY=$(A2_OUTPUT)/lib/linux/$(shell uname -m)/$(A2_CATEGORY)
 TARGET_EXEC := libJava_$(NATIVE_PACKAGE).so
 
-LDFLAGS ?= -shared -fPIC -Wl,-soname,$(TARGET_EXEC).$(MAJOR).$(MINOR) $(ADDITIONAL_LIBS)
+LDFLAGS ?= -shared -fPIC -Wl,-soname,$(TARGET_EXEC).$(MAJOR).$(MINOR) $(DEP_LIBS)
 CFLAGS ?= -O3 -fPIC
 
 SRC_DIRS := . 
@@ -27,7 +27,7 @@ SRC_DIRS := .
 BUILD_DIR := $(SDK_BUILD_BASE)/jni/$(NATIVE_PACKAGE)
 
 # Include directories
-INC_DIRS := $(shell find $(SRC_DIRS) -type d) $(JAVA_HOME)/include $(JAVA_HOME)/include/linux $(ADDITIONAL_INC)
+INC_DIRS := $(shell find $(SRC_DIRS) -type d) $(JAVA_HOME)/include $(JAVA_HOME)/include/linux $(DEP_INCLUDES)
 
 all: $(A2_NATIVE_CATEGORY)/$(TARGET_EXEC)
 
@@ -36,7 +36,7 @@ clean:
 	$(RM) $(A2_NATIVE_CATEGORY)/$(TARGET_EXEC)
 
 install:
-	$(CP) $(A2_NATIVE_CATEGORY)/$(TARGET_EXEC) $(A2_NATIVE_INSTALL_TARGET)
+	install $(A2_NATIVE_CATEGORY)/$(TARGET_EXEC) $(A2_NATIVE_INSTALL_TARGET)
 
 uninstall:
 	$(RM) $(A2_NATIVE_INSTALL_TARGET)/$(TARGET_EXEC)
diff --git a/osgi.mk b/osgi.mk
index ad77233..4af7fff 100644
--- a/osgi.mk
+++ b/osgi.mk
@@ -2,16 +2,16 @@ ARGEO_BUILD_BASE := $(dir $(lastword $(MAKEFILE_LIST)))
 include $(ARGEO_BUILD_BASE)common.mk
 
 # The following variables should be declared in the including Makefile:
-# BUNDLES			the space-separated list of bundles to build
-# A2_CATEGORY		the (single) a2 category the bundles will belong to
+# BUNDLES           the space-separated list of bundles to build
+# A2_CATEGORY       the (single) a2 category the bundles will belong to
 
 # The following environment variables can change the behaviour of the build
-# SOURCE_BUNDLES	sources will be packaged separately in Eclipse-compatible source bundles
-# NO_MANIFEST_COPY	generated MANIFESTs won't be copied to the source tree
+# SOURCE_BUNDLES    sources will be packaged separately in Eclipse-compatible source bundles
+# NO_MANIFEST_COPY  generated MANIFESTs won't be copied to the source tree
 
 # The following variables have default values which can be overriden
-# DEP_CATEGORIES	the a2 categories the compilation depends on
-# JAVADOC_PACKAGES	the space-separated list of packages for which javadoc will be generated
+# DEP_CATEGORIES    the a2 categories the compilation depends on
+# JAVADOC_PACKAGES  the space-separated list of packages for which javadoc will be generated
 # NATIVE_PACKAGES   the space-separated list of JNI packages (directories)
 DEP_CATEGORIES ?=
 JAVADOC_PACKAGES ?=
diff --git a/repackage.mk b/repackage.mk
index 54b6d65..6f9eeec 100644
--- a/repackage.mk
+++ b/repackage.mk
@@ -2,7 +2,7 @@ ARGEO_BUILD_BASE := $(dir $(lastword $(MAKEFILE_LIST)))
 include $(ARGEO_BUILD_BASE)common.mk
 
 # The following variables should be declared in the including Makefile:
-# CATEGORIES		the space-separated list of categories to repackage
+# CATEGORIES        the space-separated list of categories to repackage
 
 A2_BASE ?=/usr/share/a2 /usr/local/share/a2 $(A2_OUTPUT)