chore: add build specific version number and add comments

Author: madjesc

CMakeLists.txt

@@ -1,6 +1,7 @@
 cmake_minimum_required(VERSION 3.20)
 project(ltfs,
-  VERSION "2.5.0.0"
+  # TODO: Find a better solution to mark this version as different from the official build
+  VERSION "2.5.0.9999"
 )
 include(CheckSymbolExists REQUIRED)
 include(CheckTypeSize REQUIRED)
@@ -29,7 +30,8 @@ endif()
 add_subdirectory(messages)
 add_subdirectory(src)
 
-
+# TODO: Improve the use of SNMP, right now this flags are not added to the build.
+# TODO: Test the use of SNMP
 option(ENABLE_SNMP "Force to use ICU6x (unorm2) functions" OFF)
 if(ENABLE_SNMP)
   pkg_check_modules(SNMP REQUIRED "net-snmp>=5.3" IMPORTED_TARGET)

messages/CMakeLists.txt

@@ -1,4 +1,3 @@
-# file(GLOB _MESSAGES_LIBS RELATIVE "." "*/")
 set(MESSAGES_LIBS
   bin_ltfs
   bin_ltfsck
@@ -22,22 +21,23 @@ set(MESSAGES_LIBS
 foreach(NAME IN LISTS MESSAGES_LIBS)
   file(GLOB SRCS "${NAME}/*.txt")
 
+  # Compile the message resources using genrb and pkgdata see make_message_src.sh
   add_custom_command(
     OUTPUT "res_${NAME}/lib${NAME}.a"
-    # ALL
     COMMAND mkdir -p res_${NAME}
     COMMAND ${ICU_GENRB_EXECUTABLE} -q ${SRCS} -d res_${NAME} 1> /dev/null
     COMMAND find res_${NAME} -name *.res > res_${NAME}/paths.txt
     COMMAND ${ICU_PKGDATA_EXECUTABLE} -d res_${NAME}/ -m static -p ${NAME} -q res_${NAME}/paths.txt 1> /dev/null
     BYPRODUCTS "res_${NAME}"
-    # SOURCES
   )
+  # Add the command as a target to be build when all is invoked
   add_custom_target("${NAME}.a" ALL
     cp res_${NAME}/lib${NAME}.a lib${NAME}.a
     DEPENDS "res_${NAME}/lib${NAME}.a"
     BYPRODUCTS lib${NAME}.a
   )
 
+  # Define the library as an imported CMake lib
   add_library("lib${NAME}_messages" STATIC IMPORTED GLOBAL)
   set_target_properties("lib${NAME}_messages" PROPERTIES IMPORTED_LOCATION "${CMAKE_CURRENT_BINARY_DIR}/lib${NAME}.a")
 endforeach()

src/libltfs/CMakeLists.txt

@@ -3,6 +3,8 @@ add_library(libltfs SHARED ${LIBLTFS_SRCS})
 set_property(TARGET libltfs PROPERTY OUTPUT_NAME ltfs)
 target_include_directories(libltfs BEFORE PUBLIC "..")
 
+# TODO: Fix bundle errors.
+#   ICU cannot find the message bundles for some weird reason
 target_link_libraries(libltfs
   Threads::Threads
   PkgConfig::FUSE