]> Kevux Git Server - controller/commitdiff
Cleanup: Update comments in examples.
authorKevin Day <Kevin@kevux.org>
Thu, 13 Nov 2025 12:29:18 +0000 (06:29 -0600)
committerKevin Day <Kevin@kevux.org>
Thu, 13 Nov 2025 12:29:18 +0000 (06:29 -0600)
The rules should have `iki-0000` to designate such support.

Add additonal comments in some of the example files.
Update some comments in some of the example files.

62 files changed:
data/data/controller/example/cgroup/rules/network/firewall.rule
data/data/controller/example/cgroup/rules/program/chromium.rule
data/data/controller/example/cgroup/rules/program/falkon.rule
data/data/controller/example/cgroup/rules/program/firefox.rule
data/data/controller/example/cgroup/rules/program/terminator.rule
data/data/controller/example/cgroup/rules/setup/cgroups.rule
data/data/controller/example/init/rules/boot/devices.rule
data/data/controller/example/init/rules/boot/file_system.rule
data/data/controller/example/init/rules/boot/modules.rule
data/data/controller/example/init/rules/boot/proc.rule
data/data/controller/example/init/rules/boot/root.rule
data/data/controller/example/init/rules/maintenance/console.rule
data/data/controller/example/init/rules/net/all.rule
data/data/controller/example/init/rules/net/loopback.rule
data/data/controller/example/init/rules/service/dbus.rule
data/data/controller/example/init/rules/service/logger.rule
data/data/controller/example/init/rules/service/mouse.rule
data/data/controller/example/init/rules/task/clock.rule
data/data/controller/example/init/rules/task/keyboard.rule
data/data/controller/example/init/rules/task/ntpdate.rule
data/data/controller/example/init/rules/terminal/four.rule
data/data/controller/example/init/rules/terminal/one.rule
data/data/controller/example/init/rules/terminal/three.rule
data/data/controller/example/init/rules/terminal/two.rule
data/data/controller/example/miscellaneous/exits/htop-alternate.exit
data/data/controller/example/miscellaneous/exits/serial.exit
data/data/controller/example/miscellaneous/exits/sshd.exit
data/data/controller/example/miscellaneous/rules/asynchronous/sleep_1.rule
data/data/controller/example/miscellaneous/rules/asynchronous/sleep_10.rule
data/data/controller/example/miscellaneous/rules/asynchronous/sleep_2.rule
data/data/controller/example/miscellaneous/rules/asynchronous/sleep_3.rule
data/data/controller/example/miscellaneous/rules/asynchronous/sleep_5.rule
data/data/controller/example/miscellaneous/rules/asynchronous/sleep_8.rule
data/data/controller/example/miscellaneous/rules/command/htop.rule
data/data/controller/example/miscellaneous/rules/command/multiple.rule
data/data/controller/example/miscellaneous/rules/delay/long.rule
data/data/controller/example/miscellaneous/rules/delay/short.rule
data/data/controller/example/miscellaneous/rules/environment/default.rule
data/data/controller/example/miscellaneous/rules/environment/empty.rule
data/data/controller/example/miscellaneous/rules/environment/exported.rule
data/data/controller/example/miscellaneous/rules/environment/exporting.rule
data/data/controller/example/miscellaneous/rules/environment/fake-nothing.rule
data/data/controller/example/miscellaneous/rules/environment/fake-something.rule
data/data/controller/example/miscellaneous/rules/maintenance/boom.rule
data/data/controller/example/miscellaneous/rules/print/newline.rule
data/data/controller/example/miscellaneous/rules/script/create_socket_path.rule
data/data/controller/example/miscellaneous/rules/script/fail.rule
data/data/controller/example/miscellaneous/rules/script/iki.rule
data/data/controller/example/miscellaneous/rules/script/php.rule
data/data/controller/example/miscellaneous/rules/script/python.rule
data/data/controller/example/miscellaneous/rules/script/require_me.rule
data/data/controller/example/miscellaneous/rules/script/succeed.rule
data/data/controller/example/miscellaneous/rules/serial/s_1.rule
data/data/controller/example/miscellaneous/rules/serial/s_2.rule
data/data/controller/example/miscellaneous/rules/serial/s_3.rule
data/data/controller/example/miscellaneous/rules/serial/s_4.rule
data/data/controller/example/miscellaneous/rules/serial/s_5.rule
data/data/controller/example/miscellaneous/rules/serial/s_6.rule
data/data/controller/example/miscellaneous/rules/service/sshd.rule
data/data/controller/example/miscellaneous/rules/utility/sleeper_1.rule
data/data/controller/example/miscellaneous/rules/utility/sleeper_2.rule
data/data/controller/example/miscellaneous/rules/utility/sleeper_3.rule

index c4592488d7b55e8a97d999c724f70991ae9a01c8..1fd7bbb16712b7aedaca79bc67bc2c3703828f8e 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for loading the FLL firewall settings on system start.
 #
index 38d455ceb47ab29a97a457f9775bb65bd48d69f0..e301270c5e8d5f5d43b7a72685f5b1fc8f293087 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Helper rule for starting chromium using a sub-user account.
 #
index 94bd242a65a97806a19f8d15b7ee904fca48fbb9..69aeba20bd1f029654b86cfe3cf1bdc63573cea0 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Helper rule for starting falcon using a sub-user account.
 #
index 9f36b697f9e5ff0ae86d979439d978dc493f139d..4ae5513bcc05ca0df36c4039f4d7fb64847ee27f 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Helper rule for starting firefox using a sub-user account.
 #
index d1ea68ca32ec1925ab71607105b8f9851479f722..fd7b0b227e18a62cb8cd99ec0e4aa07540866faa 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Helper rule for starting terminator using a sub-user account.
 #
index 2020e5fdc5f8912a3dd2573cc44cc1dd3e6c220b..5b93ff9a67fc5b780b1043d006aad7d3747a29c7 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for auto-configuring specific CGroup settings for some users.
 #
index f7a841856a2be91a398f4f44ccbad94aba0680ca..485acdbe91564abfb3df69cf150ec79c46b107c6 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for initializing the /dev file system.
 #
index fb763fe14f851be75959a5fac851bc0bcb2910a2..5f6aa3eff074cc03513d2aa1e4a4105a42e6999a 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for initializing the filesystem.
 #
index eb0c88cd955f4ebf285da1566d4568214c50e2c5..68bd01bdbfd38c8aab5ddd7b90ae15141b0786ea 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for initializing the kernel modules.
 #
index 28b605f44be22b98a7ee2e70b98063c5d9cce529..b19afc721845da0e783435cb8835b0e080fdfe77 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for initializing the /proc filesystem.
 #
index dcdeae78cf5493b9414fe7198d155747835becaa..c5e36853d965e18764b73fc66c24c7852889e1fe 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for initializing the root filesystem, assuring certain directories always exist.
 #
index 1cad18f9e6d5c14081c809d4e5f06a131bcbb300..32d0a5d6facd473ae3e1a279f9321a16add6068f 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for maintenance/failsafe console.
 #
index 79c28193c4b8c2e69f1fe6ac0d1a148fa63c72be..b2249444c98aa208a7864a8621ed1d3b149ebd75 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for starting all network devices.
 #
index 1ac8841f263c214977ea7701bffe957a9e68df99..d6a346b77fd53fbf9258ecbbf03000284deb7bb0 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for loopback device.
 #
index d32e1e096d862f73d390f7e1da360462d6922d68..3879fc25035a131891c6344761d4c718c7c26bb9 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for D-Bus service.
 #
index 6ac54c7cd7edc66302bbec02d9f31a9aed40d462..8ce00a0f4b2e618d93b0d1f60449c622aaebfa93 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for system logger service.
 #
index ecfcb3822fbd504e49ca71a3be0e3c2975647f59..88d09c2648daa40227093ea92ba02b51d6e72af8 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for console mouse.
 #
index 6463e57dcb5f49acc0826753b2ce345ea8239f84..d29c54870aee57fd485847835a5bfcf03d73bdbe 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for setting the clock.
 #
index 72c7add93c207b9618bb913d9d64ff8aa476acea..5b17daf22feca02ae6a417ea0d94e6f094fc0151 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for setting the keyboard.
 #
index f8d35bded2163ffb04122f89ca8e8ac87bbe565a..59cf335fd253c71a388a1841174149f2e09b5773 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for executing ntpdate.
 #
index 5bc8189dce8e9c1802739440ae17a29568e78a97..55c2aa6d3b4c2c42be8d51722ca0271278d37ce7 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for the terminal programs.
 #
index 14b0d64ac099a6557c7c280f18e16e89d5b2d0dc..c09b6629a05cd4d0c8f229ccab6055c958b56315 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for the terminal programs.
 #
index aa90f01ab690c62236c9370b01b7c55a820b4463..e2965d42218f74d9cf660419fecba8d18e8c01d8 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for the terminal programs.
 #
index 2dde16e5ec41c8dd728dec73bb5a96a58ab267b5..129c630479a03be34df01937f6a25f2649d4e077 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for the terminal programs.
 #
index 3fac642c0d0c5f9f652995a7360cea82def1ca72..a460c706dce82e7b6493f049640ff03cd09ccdcb 100644 (file)
@@ -1,7 +1,9 @@
 # fss-0005
 #
 # This example shows how htop can be started during the exit process rather than the entry.
+#
 # See the htop-alternate.entry example.
+#
 
 main:
   failsafe "start top"
index 1245486d36bb1dfeb22c90da72d0a39ce260dbbc..cbca05e9dffb03ce928c6bd8a1360c5d735590c5 100644 (file)
@@ -1,4 +1,7 @@
 # fss-0005
+#
+# This example is the exit for the serial.entry.
+#
 
 main:
   consider serial s_1
index 79e738aecbc49a73eb722009c550d3c1928b8516..0fc61ac9ce68c78a4a8941bf4fb389d53e54c484 100644 (file)
@@ -1,4 +1,7 @@
 # fss-0005
+#
+# This example is the exit for the sshd.entry.
+#
 
 main:
   timeout start 7
index f722689ec82c189f69163c7bbaca36579a986d2a..f3589831c387b02537af1f912fc28403b44162d8 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Note: The example setting "limit nice 1 2" may cause this rule to fail if the user has insufficient privileges granted by ulimits or some other system security measure.
 #
index 873419081c21ca7272097ad897a020aca1e8d95d..2e3cfcd7d48912f48349d4c67cafedb578aaf44c 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Note: The example setting "limit nice 1 2" may cause this rule to fail if the user has insufficient privileges granted by ulimits or some other system security measure.
 #
index c8546957d6acbf732f74f9768bce9992c088d918..66c44c731f94929dfa20b01bae20fa911bfb61f1 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Note: The example setting "limit nice 1 2" may cause this rule to fail if the user has insufficient privileges granted by ulimits or some other system security measure.
 #
index ad3d8f9bcf491f6b9af98d5f73f778827a2b69fc..61581cf8732e9c38406bed14988ef1a67c2bf03a 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Note: The example setting "limit nice 1 2" may cause this rule to fail if the user has insufficient privileges granted by ulimits or some other system security measure.
 #
index e4ed3dbc9440d815ceafe309b3e365f775f3b6c2..9425b107c5c484e6b8fd73432180b67f634878e1 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Note: The example setting "limit nice 1 2" may cause this rule to fail if the user has insufficient privileges granted by ulimits or some other system security measure.
 #
index a9af41288db0aad60ac2c14bf6c8b83b6870e259..d82d1418a23e1b800e1f1e1d08f22008af6213f4 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Note: The example setting "limit nice 1 2" may cause this rule to fail if the user has insufficient privileges granted by ulimits or some other system security measure.
 #
index 197ad86d55032f4831d3299357912897b357bdb3..8fd758670f8168af960e9ce1b3ef805184e364fb 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Run htop"
index 32ff117b0ef7ed39b263aab691679a8247410161..4642cff14a0315bd89ab0c18b26886f2961931c8 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Multiple Commands: id, whoami, date, etc.."
index 7e77bb7cfea57b47f36cd6185adc4d42cb109f78..a6af99c25dfdb580bc1760e2fde68bf4dbe51913 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for a long delay.
 #
index 12e0856b921a2be86cc3278be42bd95e46359813..ed32ff60c27ae3c70bddf0087dce913c1fc2f591 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Rule for a short delay.
 #
index dffe66be7dee6f0dda5f84542f04aa012e143f31..5087f193363a41e0293a362109f3617e89a414d4 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Note: bash automatically creates PWD, SHLVL, and _ environment variables.
 #
index fdb479430d03f95a4081d52fe5b9e32eec70ff76..d813c57f1b67a5c5089135c8b347fac90a0c870b 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Note: bash automatically creates PWD, SHLVL, and _ environment variables.
 #
index a7e626babea4952da7815d8d73d78db260bc2c0b..0372e9549313288a793d9b1f45606d699a29f184 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Note: bash automatically creates PWD, SHLVL, and _ environment variables.
 #
index 5b4cd9b8056a2eed27a697741fc2a9005b93a3cc..2660b594aa5977566665189143581d0a53441205 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Note: bash automatically creates PWD, SHLVL, and _ environment variables.
 #
index cfdfb9c74be575786255661156b2c634397652a9..edb0affc351ad8e7ba096e87e9645d72fd178e20 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Environment using fake as an engine"
index 77c22f1726e465e4dff13639b25bc61dc99efcca..d9be3b616a4a5dbb3bdd14597ab88942f862869c 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Environment using fake as an engine"
index 4a4fa8dba6f1724fdc6ad1d9090ed1ffb144b73d..1053b8c864c6355c52da522b50428366ccef980d 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Explosion!"
index 0f2f489b14fa5e45e5ae40b5acf569a6849380bc..9897d7b4dd94fb3aeaacf55cc45aa7fe2530b499 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Print New Line"
index 5b3b210f5a5fd976723b6aeccde947b064013e74..5c90200430b11554a2e76a9dd0bbd78ac238a407 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Create Socket Path"
index 536b4e54c9e7708d8b09ba6de34456e23deb1aa1..4f00938ee31e1885ecdd7df2320910c850684795 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Script #2"
index 6f34ddbcf59af1487cfb0920f69501ce56c41b23..44686cc30397d0ac7d87316dad93ece2da72545a 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "IKI Variable Substitution"
index 65ed2fc8cd3ddb248d7d4f1561aad5ce828f9671..e8be600c99efae55b6c6d39653f8696ee919fffc 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "PHP script"
index a486a6ad7ae15b090ba306557504464020aa68e5..c08d52e5752832c55d33bfb73350c49d784b8021 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Python (Version 3.X) script"
index bede8df0c4f7cda3e0453096abaeae92075ed976..6251652b27ace32350d7c9fd483378c551e3778f 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Example script for needs, wants, and wishes."
index fa0df59ee15631ace97a934174919fb39370cb58..98ce33d30fc14dc4d9acf031b379de3a439048bd 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Script #1"
index a66184611b6973724da3644699ba8000a8a5d41e..4dfa51928ab86111c94013f66a95aac9c196b281 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Serial 1"
index afb7392e306db24ee2608bc646a8e12a191469df..d9017e10512555fce398f3d76d1df72a2b156940 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Serial 2"
index bc17f589d222ed8419a94d8274efa65b211fe1bf..89ce3742cca16d4302553c15fc061674e4826dd6 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Serial 3"
index b144dcc8d8a8a86988af90af4213fec076e8b82d..1a4327a73cb19d86dfc8f42daaad7b8dda1bb936 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Serial 4"
index 60b4a3129da4313eea617fa75002075a7a593701..48c22f31d4c427ec3ecb6bc7f9804343f404d59f 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Serial 5"
index c6d971a98b8efc94abf8982e16b0deb02cbeb0c0..3851d0ba7bdd74d19a3555a31430ff1d29428bbc 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 
 settings:
   name "Serial 6"
index 3ef5c2e83c227f98de00b8d64da0bc7b56be5e61..61c5b39de8198a676cc528b52f1d161dcd485c5e 100644 (file)
@@ -1,4 +1,4 @@
-# fss-000d
+# fss-000d iki-0000
 #
 # Example using the common sshd service.
 # Sshd appears to require a full path.
index 3ac8048ee0542a711d660c1a4e33955c1013fc24..ce8690ad6108c7a84cb3d2db34b0ca23098a58dc 100644 (file)
@@ -1,5 +1,7 @@
-# fss-000d
-# sleeper rule whose program creates its own PID file, runs in the background, sleep for a while, removes PID file, and returns.
+# fss-000d iki-0000]
+#
+# Example sleeper rule whose program creates its own PID file, runs in the background, sleep for a while, removes PID file, and returns.
+#
 
 settings:
   name "Sleeper #1"
index 89e8fec6dbb0192488abc34648c8b6006db62e10..d81b96b93d0fccf759a46066864c423f93da44cf 100644 (file)
@@ -1,5 +1,7 @@
-# fss-000d
-# sleeper rule whose program creates its own PID file, runs in the background, sleep for a while, removes PID file, and returns.
+# fss-000d iki-0000
+#
+# Example sleeper rule whose program creates its own PID file, runs in the background, sleep for a while, removes PID file, and returns.
+#
 
 settings:
   name "Sleeper #2"
index adf0ca8c652733ffc0546f9c5f56567ac8a82ea4..a799ee3454210f3e9eb6689921d5572e4ca6b5db 100644 (file)
@@ -1,5 +1,7 @@
-# fss-000d
-# sleeper rule whose program creates its own PID file, runs in the background, sleep for a while, removes PID file, and returns.
+# fss-000d iki-0000
+#
+# Example sleeper rule whose program creates its own PID file, runs in the background, sleep for a while, removes PID file, and returns.
+#
 
 settings:
   name "Sleeper #2"