From 278b004d17830c7be7b329d7036cf82a246039fd Mon Sep 17 00:00:00 2001
From: Bruce Hill <bitbucket@bruce-hill.com>
Date: Mon, 23 Jul 2018 15:54:27 -0700
Subject: Added more file descriptions.

---
 tools/autoformat.nom  | 6 ++++++
 tools/find_action.nom | 5 +++++
 tools/parse.nom       | 4 ++++
 tools/test.nom        | 4 ++++
 tools/upgrade.nom     | 6 ++++++
 5 files changed, 25 insertions(+)

(limited to 'tools')

diff --git a/tools/autoformat.nom b/tools/autoformat.nom
index 971aec3..6f8e0c2 100755
--- a/tools/autoformat.nom
+++ b/tools/autoformat.nom
@@ -1,4 +1,10 @@
 #!/usr/bin/env nomsu -V2.5.4.3
+#
+    Auto-format Nomsu code. Usage:
+        nomsu tools/autoformat.nom [-i] file1 file2 directory1 ...
+    If the first argument is "-i", modifications will be performed in-place. Otherwise,
+    the formatted code will be printed.
+
 use "lib/os.nom"
 
 %args = (command line args)
diff --git a/tools/find_action.nom b/tools/find_action.nom
index 716fc9f..0d7ac4f 100755
--- a/tools/find_action.nom
+++ b/tools/find_action.nom
@@ -1,4 +1,9 @@
 #!/usr/bin/env nomsu -V2.5.4.3
+#
+    Find an action by its stub. Usage:
+        nomsu tools/find_action.nom "foo %" file1 file2 directory1 ...
+    Will print all the code locations and code that uses the stub.
+
 use "lib/os.nom"
 use "lib/consolecolor.nom"
 
diff --git a/tools/parse.nom b/tools/parse.nom
index 2c70f71..a79635f 100755
--- a/tools/parse.nom
+++ b/tools/parse.nom
@@ -1,4 +1,8 @@
 #!/usr/bin/env nomsu -V2.5.4.3
+#
+    Tool to print out a parse tree of files in an easy-to-read format. Usage:
+        nomsu tools/parse.nom file1 file2 directory1 ...        
+
 use "lib/os.nom"
 
 action [print tree %t at indent %indent]:
diff --git a/tools/test.nom b/tools/test.nom
index 1cad598..c6c21fa 100755
--- a/tools/test.nom
+++ b/tools/test.nom
@@ -1,4 +1,8 @@
 #!/usr/bin/env nomsu -V2.5.4.3
+#
+    Tool to run all tests in a file (i.e. the code block inside a call to 'test %'). Usage:
+        nomsu tools/test.nom file1 file2 directory1 ...
+
 use "lib/os.nom"
 use "lib/consolecolor.nom"
 
diff --git a/tools/upgrade.nom b/tools/upgrade.nom
index a051818..85d4a26 100755
--- a/tools/upgrade.nom
+++ b/tools/upgrade.nom
@@ -1,4 +1,10 @@
 #!/usr/bin/env nomsu -V2.5.4.3
+#
+    Tool to automatically update code from old versions of Nomsu. Usage:
+        nomsu tools/upgrade.nom [-i] file1 file2 directory1 ...
+    If "-i" is the first argument, upgrades will be performed in-place. Otherwise, the
+    upgraded code will be printed.
+
 use "compatibility"
 use "lib/os.nom"
 
-- 
cgit v1.2.3