Rename targets and add cross-language rules for running examples

kgryte · kgryte · commit 279080cb0090 · 2018-02-27T12:53:27.000-08:00
diff --git a/tools/make/lib/examples/Makefile b/tools/make/lib/examples/Makefile
@@ -21,3 +21,43 @@
 include $(TOOLS_MAKE_LIB_DIR)/examples/c.mk
 include $(TOOLS_MAKE_LIB_DIR)/examples/javascript.mk
 include $(TOOLS_MAKE_LIB_DIR)/examples/markdown.mk
+
+
+# RULES #
+
+#/
+# Runs examples.
+#
+# @param {string} [EXAMPLES_FILTER] - file path pattern (e.g., `.*/blas/base/dasum/.*`)
+#
+# @example
+# make examples
+#
+# @example
+# make examples EXAMPLES_FILTER=.*/blas/base/dasum/.*
+#/
+examples: examples-javascript
+
+.PHONY: examples
+
+#/
+# Runs cross-language examples.
+#
+# ## Notes
+#
+# -   This rule supports the environment variables supported by each language-specific (`examples-<lang>`) prerequisite.
+# -   This rule is useful when wanting to glob for examples files, irrespective of language, for a particular package in order to compare cross-language example output.
+#
+#
+# @param {string} [EXAMPLES_FILTER] - file path pattern (e.g., `.*/blas/base/dasum/.*`)
+#
+# @example
+# make examples-lang
+#
+# @example
+# make examples-lang EXAMPLES_FILTER=.*/blas/base/dasum/.*
+#/
+examples-lang: examples-javascript examples-c
+
+.PHONY: examples-lang
+
diff --git a/tools/make/lib/examples/javascript.mk b/tools/make/lib/examples/javascript.mk
@@ -22,7 +22,7 @@
 #
 # This target runs a list of examples in sequential order. Note that we assume the examples can be run using Node.js.
 
-examples: $(NODE_MODULES)
+examples-javascript: $(NODE_MODULES)
 	$(QUIET) $(FIND_EXAMPLES_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | while read -r file; do \
 		echo ""; \
 		echo "Running example: $$file"; \
@@ -31,14 +31,14 @@ examples: $(NODE_MODULES)
 		$(NODE) $$file || exit 1; \
 	done
 
-.PHONY: examples
+.PHONY: examples-javascript
 
 
 # Run examples.
 #
 # This target runs a specified list of examples in sequential order. Note that we assume the examples can be run using Node.js.
 
-examples-files: $(NODE_MODULES)
+examples-javascript-files: $(NODE_MODULES)
 	$(QUIET) for file in $(FILES); do \
 		echo ""; \
 		echo "Running example: $$file"; \
@@ -47,4 +47,4 @@ examples-files: $(NODE_MODULES)
 		$(NODE) $$file || exit 1; \
 	done
 
-.PHONY: examples-files
+.PHONY: examples-javascript-files
