diff options
| -rw-r--r-- | .gitmodules | 3 | ||||
| -rw-r--r-- | Makefile | 10 | ||||
| -rw-r--r-- | README.md | 24 | ||||
| -rw-r--r-- | src/Makefile | 1 | ||||
| m--------- | src/configs/debmake | 0 |
5 files changed, 32 insertions, 6 deletions
diff --git a/.gitmodules b/.gitmodules index b06168b..cb76a60 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,6 @@ [submodule "src/configs/GNU_Make"] path = src/configs/GNU_Make url = https://github.com/lshprung/gnu-make-dash-docset.git +[submodule "src/configs/debmake"] + path = src/configs/debmake + url = https://github.com/lshprung/debmake-dash-docset.git @@ -16,11 +16,13 @@ clean: rm -rf $(BUILD_DIR)/*.docset $(BUILD_DIR)/*.tgz # All supported docsets should be listed here -.phony: GNU_Make -GNU_Make: $(BUILD_DIR)/GNU_Make.docset +SUPPORTED_TARGETS = \ +debmake \ +GNU_Make -$(BUILD_DIR)/%.docset: - $(SRC_MAKE_CALL) DOCSET_NAME=$(basename $(@F)) +.phony: $(SUPPORTED_TARGETS) +$(SUPPORTED_TARGETS): + $(SRC_MAKE_CALL) DOCSET_NAME=$@ $(BUILD_DIR)/%.tgz: $(BUILD_DIR)/%.docset tar --exclude='.DS_Store' -czf $@ $(basename $@).docset @@ -5,10 +5,12 @@ This is a repository providing sources building various Dash docsets using a Mak ### Documentation ``` -Usage: make DOCSET_NAME [BUILD_DIR=...] +Usage: make DOCSET_NAME [BUILD_DIR=...] [NO_CSS=yes] [LOCALE=...] DOCSET_NAME must be a directory under ./src/configs. - BUILD_DIR can be set to a directory to build under. The default is ./build + BUILD_DIR can be set to a directory to build under. The default is ./build + NO_CSS if defined, build with stylesheets disabled. Supported by GNU_Make + LOCALE specify a locale to build for (see below table for more details). Supported by debmake Other possible targets: archive - create .tgz archives for all docsets in BUILD_DIR @@ -17,6 +19,24 @@ Other possible targets: $(BUILD_DIR)/$(DOCSET_NAME).tgz - create a .tgz archive of DOCSET_NAME ``` +#### Supported Definitions + +This table shows which supported docsets support which options. All targets support the setting of DOCSET_NAME and BUILD_DIR. + +| |NO_CSS|LOCALE| +|--------------------------------------------------|------|------| +|[GNU_Make](http://www.gnu.org/software/make/) |✓ | | +|[debmake](https://salsa.debian.org/debian/debmake)| |✓ (see [here](./src/configs/debmake/README.md))| + +### Build Requirements + +This table shows the dependencies for each supported docset. Additionally, all docsets depend on a POSIX-compliant shell (e.g. [bash](https://www.gnu.org/software/bash/)), [make](https://www.gnu.org/software/make/), and [sqlite3](https://www.sqlite.org/index.html). + +| |[curl](https://curl.se/)|[po4a](https://po4a.org/)|[pup](https://github.com/ericchiang/pup)| +|-|------------------------|-------------------------|----------------------------------------| +|[GNU_Make](http://www.gnu.org/software/make/) |✓|✓| | +|[debmake](https://salsa.debian.org/debian/debmake)|✓| |✓| + ### Project Structure ``` diff --git a/src/Makefile b/src/Makefile index 3aff8a9..dbe7da8 100644 --- a/src/Makefile +++ b/src/Makefile @@ -1,6 +1,7 @@ # If called directly, Makefile should be called passing the following arguments: # DOCSET_NAME = ... (should be a directory under ./configs) # BUILD_DIR = ... (create built docsets under the directory BUILD_DIR) +# ... (see project README for more options) ERROR_DOCSET_NAME = $(error DOCSET_NAME is unset) .phony: err diff --git a/src/configs/debmake b/src/configs/debmake new file mode 160000 +Subproject a9e08d14469a5d97b9b3c556e61eff84782d2e5 |