devops: Document main and give an example bash script.
authorMatt Birkholz <matt@birchwood-abbey.net>
Mon, 19 Mar 2018 01:14:15 +0000 (18:14 -0700)
committerMatt Birkholz <matt@birchwood-abbey.net>
Mon, 19 Mar 2018 01:14:15 +0000 (18:14 -0700)
src/devops/build.texi

index fb5c2a0026c7acef00eaeea3c25df8eb628c50b4..a40f29971a592de82b82cb7165c135e43749beb3 100644 (file)
@@ -93,6 +93,23 @@ the host's operating system.  If it starts with @code{"Ubuntu"} and
 mentions a recent Ubuntu version, the host will build Debian packages.
 @end deffn
 
+@deffn Procedure main
+This procedure is for the convenience of scripts.  It dispatches off
+the first argument on Scheme's command line to execute one of the
+build procedures (e.g. @code{devops:status}).  For example:
+
+@example
+  #!/bin/bash
+
+  exec mit-scheme-pucked --batch-mode -- "$@" <<\EOF
+  (begin
+    (parameterize ((param:suppress-loading-message? #t))
+      (load-option 'devops))
+    ((access main (->environment '(devops)))))
+  EOF
+@end example
+@end deffn
+
 @node Debugging Builds
 @section Debugging Builds