From 3446f52c59189d94d410c7e8eb034f1193fcf178 Mon Sep 17 00:00:00 2001
From: Mikaela Suomalainen <mikaela+git@mikaela.info>
Date: Sun, 19 Dec 2021 19:56:24 +0200
Subject: [PATCH] IRC: move documentation to the README.md

---
 irc/README.md                        |  6 ++++++
 irc/generate-amode-cmds.bash         | 15 +++------------
 irc/generate-oper-override-mode.bash | 12 +++---------
 irc/generate-usual-mode-cmds.bash    | 12 ++++--------
 4 files changed, 16 insertions(+), 29 deletions(-)

diff --git a/irc/README.md b/irc/README.md
index b9e06e4..ebbb8e7 100644
--- a/irc/README.md
+++ b/irc/README.md
@@ -18,3 +18,9 @@ in hope that PPFI is able to operate IRC without @Mikaela constantly present.
 * `./generate-usual-mode-cmds.bash +o MI1` - non-oper version of the previous script,
   generates normal `/mode` commands within the usual permission system most likely
   requiring being op (use the amode script for that, see drawbacks of the previous script).
+
+## Further reading and notes
+
+* (CS) AMODE +h (halfop) overrides mode `+i` (invite-only channel).
+* https://github.com/ergochat/ergo/blob/master/docs/MANUAL.md#channel-prefixes - on owner/protected/op/halfop/voice
+* https://github.com/ergochat/ergo/blob/master/docs/MANUAL.md#modes - on channel modes such as the aforementioned invite-only
diff --git a/irc/generate-amode-cmds.bash b/irc/generate-amode-cmds.bash
index c8999da..2c9c34f 100755
--- a/irc/generate-amode-cmds.bash
+++ b/irc/generate-amode-cmds.bash
@@ -1,18 +1,9 @@
 #!/usr/bin/env bash
 
-# Generates lines to be copy-pasted to IRC client for mass-managing modes
-# in our PUBLIC IRC channels. Note: +h overrides cmode +i.
-
-# Modes: refer to https://github.com/ergochat/ergo/blob/master/docs/MANUAL.md#channel-prefixes
-
-# Usage: ./generate-amode-cmds.bash username <+|->mode
-
-# public channels where matterbridge is
-# excluded: #globalpirates (we just provide the bridge), oper room x2 (not solely ours either)
-#  If they were included, oper running this would cause takeover of those
-#  channels as being oper overrides AMODE permission check
-# included: #messi (if they have power in our rooms, hopefully they are also an activist)
+# Looping through all the channels
 for channel in \#helsinki \#keski-suomi \#pirkanmaa \#oulu \#puoluevaltuusto \#puoluetoimisto \#pinu_hallitus \#uusimaa \#varsinais-suomi \#akateemisetpiraatit \#piraattinuoret \#kampanjateltta \#sateenkaaripiraatit \#hame \#vaasa \#hallituskokous \#grafiikka \#toiminta \#piraattivpn \#ppfi \#hepihalko \#aaltopiraatit \#kaakko \#mediaseuranta \#savo-karjala \#messi \#piraatit \#suomiareena \#satakunta \#verkkopalvelut
 do
+    # Printing the lines to be copy-pasted to IRC
+    # Example output: /quote cs amode #channel +o MI1
     echo "/cs amode $channel $1 $2"
 done
diff --git a/irc/generate-oper-override-mode.bash b/irc/generate-oper-override-mode.bash
index a00a711..7c5abdf 100755
--- a/irc/generate-oper-override-mode.bash
+++ b/irc/generate-oper-override-mode.bash
@@ -1,15 +1,9 @@
 #!/usr/bin/env bash
 
-# Generates lines to be copy-pasted to IRC client for mass adjusting modes
-# in our PUBLIC IRC channels through OPER OVERRIDE / SAMODE.
-
-# Modes: refer to https://github.com/ergochat/ergo/blob/master/docs/MANUAL.md#modes
-
-# Usage e.g.: ./generate-oper-override-mode.bash +q yourusername
-
-# This should be the same list as the amode script which is preferable alongside
-# the normal mode script
+# Looping through all the channels
 for channel in \#helsinki \#keski-suomi \#pirkanmaa \#oulu \#puoluevaltuusto \#puoluetoimisto \#pinu_hallitus \#uusimaa \#varsinais-suomi \#akateemisetpiraatit \#piraattinuoret \#kampanjateltta \#sateenkaaripiraatit \#hame \#vaasa \#hallituskokous \#grafiikka \#toiminta \#piraattivpn \#ppfi \#hepihalko \#aaltopiraatit \#kaakko \#mediaseuranta \#savo-karjala \#messi \#piraatit \#suomiareena \#satakunta \#verkkopalvelut
 do
+    # Printing the lines to be copy-pasted to IRC
+    # Example output: /quote samode #channel +o MI1
     echo "/quote samode $channel $1 $2"
 done
diff --git a/irc/generate-usual-mode-cmds.bash b/irc/generate-usual-mode-cmds.bash
index 1384e54..b697176 100755
--- a/irc/generate-usual-mode-cmds.bash
+++ b/irc/generate-usual-mode-cmds.bash
@@ -1,13 +1,9 @@
 #!/usr/bin/env bash
 
-# Generates lines to be copy-pasted to IRC client for mass-managing modes
-# in our PUBLIC IRC channels. Note: +h overrides cmode +i.
-
-# WARNING: While changed channel modes stay, changing modes of users
-# is temporary until they /cycle or similar. For registered users please
-# use the AMODE script.
-
+# Looping through all the channels
 for channel in \#helsinki \#keski-suomi \#pirkanmaa \#oulu \#puoluevaltuusto \#puoluetoimisto \#pinu_hallitus \#uusimaa \#varsinais-suomi \#akateemisetpiraatit \#piraattinuoret \#kampanjateltta \#sateenkaaripiraatit \#hame \#vaasa \#hallituskokous \#grafiikka \#toiminta \#piraattivpn \#ppfi \#hepihalko \#aaltopiraatit \#kaakko \#mediaseuranta \#savo-karjala \#messi \#piraatit \#suomiareena \#satakunta \#verkkopalvelut
 do
-    echo "/cs amode $channel $1 $2"
+    # Printing the lines to be copy-pasted to IRC
+    # Example output: /mode #channel +o MI1
+    echo "/mode $channel $1 $2"
 done