From 5ee732006ddd5c05eb15cce952807e508daa9e15 Mon Sep 17 00:00:00 2001
From: William Melody <hi@williammelody.com>
Date: Tue, 15 May 2018 08:37:24 -0700
Subject: [PATCH] Add comments about option parsing.

---
 hosts | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/hosts b/hosts
index ac6b881..17a5b82 100755
--- a/hosts
+++ b/hosts
@@ -123,6 +123,21 @@ die() {
 
 ###############################################################################
 # Options
+#
+# NOTE: The `getops` builtin command only parses short options and BSD `getopt`
+# does not support long arguments (GNU `getopt` does), so the most portable
+# and clear way to parse options is often to just use a `while` loop.
+#
+# For a pure bash `getopt` function, try pure-getopt:
+#   https://github.com/agriffis/pure-getopt
+#
+# More info:
+#   http://wiki.bash-hackers.org/scripting/posparams
+#   http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html
+#   http://stackoverflow.com/a/14203146
+#   http://stackoverflow.com/a/7948533
+#   https://stackoverflow.com/a/12026302
+#   https://stackoverflow.com/a/402410
 ###############################################################################
 
 # Get raw options for any commands that expect them.