New features for Makefile 🐧

[mitsuki31]

What's Changed

• Added new rule named build-docs, that builds and generates the HTML pages of JMatrix's javadocs automatically.

  Warning This rule is standalone and can't be combined with other rules.

• Added new file named makefile-usage.txt that would stores all of usage instructions and the list of available Make's options.

  Note This change also created new directory docs/.

• Refactored the all rule and moved all usage instructions to makefile-usage.txt file.

  Note This refactor only change its method to prints the usage information,
  and does not change its original behavior.

• Added a new Bash script that processes the command-line arguments and searches for a specific argument in the list, then outputs the index of the desired argument.

  Note This change also created new directory bin/.

• Refactored the build-docs rule to be a standalone rule that ignores other rules.
• The build-docs rule now supports several options.

  Note The build-docs supports 3 verbose modes:

  • Quiet mode (default) -> make build-docs
  • Normal mode -> make build-docs VERBOSE=true
  • All mode -> make build-docs VERBOSE=all

Summary

These changes introduce new functionality and improvements to the build process and documentation. The build-docs rule allows for easy generation of JMatrix's javadocs in HTML format. The addition of the makefile-usage.txt file centralizes the usage instructions and available options. These changes enhance the functionality and flexibility of the Makefile for building and documenting the project.

[mitsuki31]

The usage instructions and list of available rules and options has been moved to makefile-usage.txt.
And here, the only way to print the usage instructions it uses cat command (Unix built-in).
This also improve the flexibility and reduce the code.

[mitsuki31]

Now this code is inside of case block and only create the temporary directory if one of arguments activating the verbose mode (e.g -v or --verbose).

[mitsuki31]

Please note, this function below doesn't echoing the info message directly onto standard output, instead it writes the info message to log file named get_argument.log in tmp/ directory.

jmatrix/bin/get_argument.sh

Lines 44 to 47 in 51ba40e

	info() {
	[ $1 = "Info" ] && echo -ne "[\033[1;92m$1\033[0m]${@/$1}\n" &>>$log
	[ $1 = "Warning" ] && echo -ne "[\033[1;93m$1\033[0m]${@/$1}\n" &>>$log
	}

Note The log file and its temporary directory only created if the verbose output is activated by using switch -v or --verbose.
See more details.

[mitsuki31]

Now several rules has supported using VERBOSE option:

• clean - Cleans the working directory thoroughly.
• cleanbin - Cleans the compiled class files only.
• cleandocs - Cleans the generated HTML documentation only.

Usage:

$ make [rules] VERBOSE[=<bool>]
$ make [clean | cleanbin | cleandocs] VERBOSE[=<bool>]