From 20c016f068422d2daaaf9be13390b68239f0ba59 Mon Sep 17 00:00:00 2001 From: 20kdc Date: Sat, 28 Mar 2020 19:12:31 +0000 Subject: [PATCH] Document svc-virtudev --- claw/repo-claw.lua | 37 ++++++++++++------------ repository/docs/repoauthors/svc-virtudev | 1 + repository/docs/us-virtu | 26 +++++++++++++++++ 3 files changed, 46 insertions(+), 18 deletions(-) create mode 100644 repository/docs/us-virtu diff --git a/claw/repo-claw.lua b/claw/repo-claw.lua index 571aa60..27dab20 100644 --- a/claw/repo-claw.lua +++ b/claw/repo-claw.lua @@ -251,24 +251,6 @@ return { "docs/repoauthors/app-slaunch" }, }, - ["svc-virtudev"] = { - desc = "a clone of vcomponent", - v = 0, - deps = { - "neo", - "zzz-license-pd" - }, - dirs = { - "apps", - "docs", - "docs/repoauthors" - }, - files = { - "apps/svc-virtudev.lua", - "apps/app-vdrslamp.lua", - "docs/repoauthors/svc-virtudev" - }, - }, -- libraries ["lib-knbs"] = { desc = "NBS reader/writer library", @@ -286,6 +268,25 @@ return { "docs/repoauthors/lib-knbs" }, }, + ["svc-virtudev"] = { + desc = "a clone of vcomponent", + v = 1, + deps = { + "neo", + "zzz-license-pd" + }, + dirs = { + "apps", + "docs", + "docs/repoauthors" + }, + files = { + "apps/svc-virtudev.lua", + "apps/app-vdrslamp.lua", + "docs/us-virtu", + "docs/repoauthors/svc-virtudev" + }, + }, -- licenses (MUST BE IMMUTABLE) ["zzz-license-pd"] = { desc = "license file 'Public Domain'", diff --git a/repository/docs/repoauthors/svc-virtudev b/repository/docs/repoauthors/svc-virtudev index c031a1f..ca3820b 100644 --- a/repository/docs/repoauthors/svc-virtudev +++ b/repository/docs/repoauthors/svc-virtudev @@ -1,3 +1,4 @@ repository/apps/svc-virtudev.lua: 20kdc, Public Domain repository/apps/app-vdrslamp.lua: 20kdc, Public Domain +repository/docs/us-virtu: 20kdc, Public Domain diff --git a/repository/docs/us-virtu b/repository/docs/us-virtu new file mode 100644 index 0000000..8cf2ee5 --- /dev/null +++ b/repository/docs/us-virtu @@ -0,0 +1,26 @@ +The "x.svc.virtudev" service allows + the creation of virtual components. + +It provides two functions: + +install = function (proxy): +Installs a virtual component. + +The provided proxy must have: + address: The address (string) + type: The type (string) + +It SHOULD have the 'slot' attribute + that proxies have. + +uninstall = function (address): +Uninstalls a component that your + process installed by address. + +The service automatically starts + and stops as required. + +-- This is released into + the public domain. +-- No warranty is provided, + implied or otherwise.