summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLouie Shprung <lshprung@tutanota.com>2024-06-18 17:37:47 -0400
committerLouie Shprung <lshprung@tutanota.com>2024-06-18 17:37:47 -0400
commit964d541dac77dd33f0ac516793a3ac3297599749 (patch)
tree454d903047a64de36dbf85849e9b204ec45e5da3
parentce243577c87a8937f8d77f67142dd0fd2fbd9731 (diff)
Fix documentation; fix bug when docsets don't have an icon; add flex
-rw-r--r--.gitmodules3
-rw-r--r--Makefile1
-rw-r--r--README.md18
-rw-r--r--src/Makefile4
m---------src/configs/flex0
5 files changed, 17 insertions, 9 deletions
diff --git a/.gitmodules b/.gitmodules
index cb76a60..d4a09d1 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -4,3 +4,6 @@
[submodule "src/configs/debmake"]
path = src/configs/debmake
url = https://github.com/lshprung/debmake-dash-docset.git
+[submodule "src/configs/flex"]
+ path = src/configs/flex
+ url = https://github.com/lshprung/flex-dash-docset
diff --git a/Makefile b/Makefile
index c4b54f8..7d463e4 100644
--- a/Makefile
+++ b/Makefile
@@ -18,6 +18,7 @@ clean:
# All supported docsets should be listed here
SUPPORTED_TARGETS = \
debmake \
+flex \
GNU_Make
.phony: $(SUPPORTED_TARGETS)
diff --git a/README.md b/README.md
index c1a0a3e..5519b0f 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,11 @@
# Dash Docset Builder
-This is a repository providing sources building various Dash docsets using a Makefile. Supported docsets can be found as a submodule under `./src/configs`. Simply pass the name of the docset as a target for the Makefile (e.g., `make GNU_Make`).
+This is a repository providing sources building various [Dash](https://kapeli.com/dash) docsets using a Makefile. Supported docsets can be found as a submodule under `./src/configs`. Simply pass the name of the docset as a target for the Makefile (e.g., `make GNU_Make`).
### Documentation
+<!-- TODO support for VERSION flag -->
+
```
Usage: make DOCSET_NAME [BUILD_DIR=...] [NO_CSS=yes] [LOCALE=...]
@@ -23,19 +25,21 @@ Other possible targets:
This table shows which supported docsets support which options. All targets support the setting of DOCSET_NAME and BUILD_DIR.
-| |NO_CSS|LOCALE|
+| |LOCALE|NO_CSS|
|--------------------------------------------------|------|------|
-|[GNU_Make](http://www.gnu.org/software/make/) |✓ | |
-|[debmake](https://salsa.debian.org/debian/debmake)| |✓ (see [here](./src/configs/debmake/README.md))|
+|[debmake](https://salsa.debian.org/debian/debmake)|✓ (see [here](./src/configs/debmake/README.md))||
+|[flex](https://github.com/westes/flex)| | | |
+|[GNU_Make](http://www.gnu.org/software/make/) | |✓ |
### 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)|
+| |[curl](https://curl.se/)|[po4a](https://po4a.org/)|[pup](https://github.com/ericchiang/pup)|[texinfo](https://www.gnu.org/software/texinfo/)|
|-|------------------------|-------------------------|----------------------------------------|
-|[GNU_Make](http://www.gnu.org/software/make/) |✓|✓| |
-|[debmake](https://salsa.debian.org/debian/debmake)|✓| |✓|
+|[debmake](https://salsa.debian.org/debian/debmake)|✓|✓| | |
+|[flex](https://github.com/westes/flex) |✓| |✓|✓|
+|[GNU_Make](http://www.gnu.org/software/make/) |✓| |✓| |
### Project Structure
diff --git a/src/Makefile b/src/Makefile
index dbe7da8..9e11874 100644
--- a/src/Makefile
+++ b/src/Makefile
@@ -29,7 +29,7 @@ DOCSET = $(INFO_PLIST_FILE) $(INDEX_FILE) $(ICON_FILE)
all: $(DOCSET)
ifdef DOCSET_NAME
-include src/configs/$(DOCSET_NAME)/config.mk
+include $(SOURCE_DIR)/config.mk
endif
tmp:
@@ -47,7 +47,7 @@ $(RESOURCES_DIR): $(CONTENTS_DIR)
$(INFO_PLIST_FILE): $(SRC_INFO_PLIST_FILE) $(CONTENTS_DIR)
cp $(SRC_INFO_PLIST_FILE) $@
-ifdef SRC_ICON_FILE
$(ICON_FILE): $(SRC_ICON_FILE) $(DOCSET_DIR)
+ifdef SRC_ICON_FILE
cp $(SRC_ICON_FILE) $@
endif
diff --git a/src/configs/flex b/src/configs/flex
new file mode 160000
+Subproject 52d6db2cc8dcb3112dff4cae4bcddbdbfbc7afd