Add information about build config to --version output

Closes igrr/mkspiffs#32

Author: igrr

.travis.yml

@@ -12,7 +12,7 @@ script:
   - make dist
   # Build configuration with SPIFFS_USE_MAGIC_LENGTH=0 (legacy version)
   - make clean
-  - make dist BUILD_CONFIG_NAME="-no_magic_length" CFLAGS="-DSPIFFS_USE_MAGIC_LENGTH=0 -DSPIFFS_ALIGNED_OBJECT_INDEX_TABLES=1"
+  - make dist BUILD_CONFIG_NAME="-no_magic_length" CPPFLAGS="-DSPIFFS_USE_MAGIC_LENGTH=0 -DSPIFFS_ALIGNED_OBJECT_INDEX_TABLES=1"
 
 notifications:
   email:

Makefile

@@ -1,5 +1,3 @@
-BUILD_CONFIG_NAME ?= 
-
 ifeq ($(OS),Windows_NT)
 	TARGET_OS := WINDOWS
 	DIST_SUFFIX := windows
@@ -37,6 +35,8 @@ else
 endif
 
 VERSION ?= $(shell git describe --always)
+SPIFFS_VERSION := $(shell git -C spiffs describe --tags || echo "unknown")
+BUILD_CONFIG_NAME ?= -generic
 
 OBJ		:= main.o \
 		   spiffs/src/spiffs_cache.o \
@@ -47,10 +47,19 @@ OBJ		:= main.o \
 
 INCLUDES := -Itclap -Iinclude -Ispiffs/src -I.
 
+override CPPFLAGS := \
+	$(INCLUDES) \
+	-D $(TARGET_OS) \
+	-D VERSION=\"$(VERSION)\" \
+	-D SPIFFS_VERSION=\"$(SPIFFS_VERSION)\" \
+	-D "BUILD_CONFIG=\"$(CPPFLAGS)\"" \
+	-D BUILD_CONFIG_NAME=\"$(BUILD_CONFIG_NAME)\" \
+	-D __NO_INLINE__ \
+	$(CPPFLAGS)
+
 override CFLAGS := -std=gnu99 -Os -Wall $(TARGET_CFLAGS) $(CFLAGS)
 override CXXFLAGS := -std=gnu++11 -Os -Wall $(TARGET_CXXFLAGS) $(CXXFLAGS)
 override LDFLAGS := $(TARGET_LDFLAGS) $(LDFLAGS)
-override CPPFLAGS := $(INCLUDES) -D$(TARGET_OS) -DVERSION=\"$(VERSION)\" -D__NO_INLINE__ $(CPPFLAGS)
 
 DIST_NAME := mkspiffs-$(VERSION)$(BUILD_CONFIG_NAME)-$(DIST_SUFFIX)
 DIST_DIR := $(DIST_NAME)

README.md

@@ -61,6 +61,45 @@ Run:
 $ make dist
 ```
 
+## SPIFFS configuration
+
+Some SPIFFS options which are set at mkspiffs build time affect the format of the generated filesystem image. Make sure such options are set to the same values when builing mkspiffs and when building the application which uses SPIFFS.
+
+These options include:
+
+  - SPIFFS_OBJ_NAME_LEN
+  - SPIFFS_OBJ_META_LEN
+  - SPIFFS_USE_MAGIC
+  - SPIFFS_USE_MAGIC_LENGTH
+  - SPIFFS_ALIGNED_OBJECT_INDEX_TABLES
+  - possibly others
+
+To see the default values of these options, check `include/spiffs_config.h` file in this repository.
+
+To override some options at build time, pass extra `CPPFLAGS` to `make`. You can also set `BUILD_CONFIG_NAME` variable to distinguish the built binary:
+
+```bash
+$ make clean
+$ make dist CPPFLAGS="-DSPIFFS_OBJ_META_LEN=4" BUILD_CONFIG_NAME=-custom
+```
+
+To check which options were set when building mkspiffs, use `--version` command:
+
+```
+$ mkspiffs --version
+mkspiffs ver. 0.2.2
+Build configuration name: custom
+SPIFFS ver. 0.3.7-5-gf5e26c4
+Extra build flags: -DSPIFFS_OBJ_META_LEN=4
+SPIFFS configuration:
+  SPIFFS_OBJ_NAME_LEN: 32
+  SPIFFS_OBJ_META_LEN: 4
+  SPIFFS_USE_MAGIC: 1
+  SPIFFS_USE_MAGIC_LENGTH: 1
+  SPIFFS_ALIGNED_OBJECT_INDEX_TABLES: 0
+```
+
+
 ### Build status
 
 Linux | Windows

include/spiffs_config.h

@@ -125,7 +125,9 @@ typedef uint8_t u8_t;
 // Object name maximum length. Note that this length include the
 // zero-termination character, meaning maximum string of characters
 // can at most be SPIFFS_OBJ_NAME_LEN - 1.
+#ifndef SPIFFS_OBJ_NAME_LEN
 #define SPIFFS_OBJ_NAME_LEN             (32)
+#endif
 
 // Maximum length of the metadata associated with an object.
 // Setting to non-zero value enables metadata-related API but also
@@ -137,7 +139,9 @@ typedef uint8_t u8_t;
 // This is derived from following:
 // logical_page_size - (SPIFFS_OBJ_NAME_LEN + sizeof(spiffs_page_header) +
 // spiffs_object_ix_header fields + at least some LUT entries)
+#ifndef SPIFFS_OBJ_META_LEN
 #define SPIFFS_OBJ_META_LEN             (0)
+#endif
 
 // Size of buffer allocated on stack used when copying data.
 // Lower value generates more read/writes. No meaning having it bigger

main.cpp

@@ -535,8 +535,39 @@ int actionVisualize() {
     return 0;
 }
 
+#define PRINT_INT_MACRO(def_name) \
+    std::cout << "  " # def_name ": " << def_name << std::endl;
+
+class CustomOutput : public TCLAP::StdOutput
+{
+    public:
+        virtual void version(TCLAP::CmdLineInterface& c)
+        {
+            std::cout << "mkspiffs ver. " VERSION << std::endl;
+            const char* configName = BUILD_CONFIG_NAME;
+            if (configName[0] == '-') configName += 1;
+            std::cout << "Build configuration name: " << configName << std::endl;
+            std::cout << "SPIFFS ver. " SPIFFS_VERSION << std::endl;
+            const char* buildConfig = BUILD_CONFIG;
+            std::cout << "Extra build flags: " << (strlen(buildConfig) ? buildConfig : "(none)") << std::endl;
+            std::cout << "SPIFFS configuration:" << std::endl;
+            PRINT_INT_MACRO(SPIFFS_OBJ_NAME_LEN);
+            PRINT_INT_MACRO(SPIFFS_OBJ_META_LEN);
+            PRINT_INT_MACRO(SPIFFS_USE_MAGIC);
+            #if SPIFFS_USE_MAGIC == 1
+                PRINT_INT_MACRO(SPIFFS_USE_MAGIC_LENGTH);
+            #endif
+            PRINT_INT_MACRO(SPIFFS_ALIGNED_OBJECT_INDEX_TABLES);
+        }
+};
+
+#undef PRINT_INT_MACRO
+
 void processArgs(int argc, const char** argv) {
     TCLAP::CmdLine cmd("", ' ', VERSION);
+    CustomOutput output;
+    cmd.setOutput(&output);
+
     TCLAP::ValueArg<std::string> packArg( "c", "create", "create spiffs image from a directory", true, "", "pack_dir");
     TCLAP::ValueArg<std::string> unpackArg( "u", "unpack", "unpack spiffs image to a directory", true, "", "dest_dir");
     TCLAP::SwitchArg listArg( "l", "list", "list files in spiffs image", false);