summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/plugins/dummy.rst
diff options
context:
space:
mode:
author Vas Crabb <vas@vastheman.com>2021-10-24 05:48:05 +1100
committer Vas Crabb <vas@vastheman.com>2021-10-24 05:48:05 +1100
commit669b1f6adecfd940d5ae8b97150dc73db04894c5 (patch)
tree3b32a4f2d55f558be04294ebe818c8f35135ef8b /docs/source/plugins/dummy.rst
parent3a11f9168703f33f2f066c3e9d0f6905f2c95453 (diff)
-docs: Started documenting plugins.
* Also added a couple of missing command-line options, and added a local table of contents to the (rather long) command line options page. -Added a separate CI target for localisation updates that produces an artefact, and removed the message catalogs from the trigger paths for the Linux CI build.
Diffstat (limited to 'docs/source/plugins/dummy.rst')
-rw-r--r--docs/source/plugins/dummy.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/source/plugins/dummy.rst b/docs/source/plugins/dummy.rst
new file mode 100644
index 00000000000..78cc262c53e
--- /dev/null
+++ b/docs/source/plugins/dummy.rst
@@ -0,0 +1,9 @@
+.. _plugins-dummy:
+
+Dummy Test Plugin
+=================
+
+This is a sample plugin that shows how to set necessary plugin metadata,
+register callbacks, and display a simple menu. It prints status messages if the
+:ref:`verbose <mame-commandline-verbose>` option is on, and it adds a **Dummy**
+option to the **Plugin Options** menu.