From 2a5b73121ce7ce4c4bd5f3f482187dd22489e330 Mon Sep 17 00:00:00 2001
From: Arun Isaac
Date: Thu, 30 May 2024 02:42:40 +0100
Subject: doc: Document prefixing arguments.

* doc/ccwl.skb (Cookbook)[Prefix arguments]: New section.
* doc/prefix-arguments.scm: New file.
---
 doc/ccwl.skb             | 7 +++++++
 doc/prefix-arguments.scm | 5 +++++
 2 files changed, 12 insertions(+)
 create mode 100644 doc/prefix-arguments.scm

(limited to 'doc')

diff --git a/doc/ccwl.skb b/doc/ccwl.skb
index 700406d..cc4c339 100644
--- a/doc/ccwl.skb
+++ b/doc/ccwl.skb
@@ -356,6 +356,13 @@ accept). Here are a couple of examples passing in an ,(code
 respectively.]
          (scheme-source "doc/inline-javascript-requirement.scm")
          (scheme-source "doc/resource-requirement.scm")))
+    (section :title [Prefix arguments]
+      :ident "prefix-arguments"
+      (p [You want to be able to associate arguments of a command to a
+prefix. For example, in the following example, we associate the input
+,(code "output_filename") to the prefix ,(code "-o"). Notice the
+parentheses around ,(code "-o output_filename").]
+         (scheme-source "doc/prefix-arguments.scm")))
     (section :title [Array types]
              :ident "section-array-types"
       (p [ccwl supports array types using the following syntax.]
diff --git a/doc/prefix-arguments.scm b/doc/prefix-arguments.scm
new file mode 100644
index 0000000..ec95aeb
--- /dev/null
+++ b/doc/prefix-arguments.scm
@@ -0,0 +1,5 @@
+(command #:inputs (source #:type File) (output_filename #:type string)
+         #:run "gcc" source ("-o" output_filename)
+         #:outputs (executable
+                    #:type File
+                    #:binding ((glob . "$(inputs.output_filename)"))))
-- 
cgit v1.2.3