[pkgsrc/trunk]: pkgsrc/mk/wrapper Replaced jlam's initial sketch with one in ...

[rillig <rillig%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/7aa386e2e754
branches:  trunk
changeset: 507481:7aa386e2e754
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Thu Feb 02 23:08:31 2006 +0000

description:
Replaced jlam's initial sketch with one in which the parts are arranged
in a much simpler way, which hopefully makes the wrapper framework less
frightening to the pkgsrc developers. Added some additional notes.

diffstat:

 mk/wrapper/NOTES |  62 +++++++++++++++++++++++++++++++------------------------
 1 files changed, 35 insertions(+), 27 deletions(-)

diffs (70 lines):

diff -r eb366afbf0f5 -r 7aa386e2e754 mk/wrapper/NOTES
--- a/mk/wrapper/NOTES  Thu Feb 02 21:27:12 2006 +0000
+++ b/mk/wrapper/NOTES  Thu Feb 02 23:08:31 2006 +0000
@@ -1,31 +1,39 @@
-$NetBSD: NOTES,v 1.2 2005/01/18 17:25:13 jlam Exp $
-
+$NetBSD: NOTES,v 1.3 2006/02/02 23:08:31 rillig Exp $
 
-    ==>  {"$@"}        ,-->  {argbuf}    ,-->  {cmdbuf}
-                       |                 |
-           ^ |         |        |        |        |
-           | `------.  |        |        |        |
-           |        |  |        |        |        |
-           v        v  |        |        |        |
-                                |                 |
-        [scan]   [arg-source]   `-->  [logic]     `-------->  [cmd-sink]
+The wrapper scripts work roughly like the block diagram below.
 
-                                     ^ ^ ^ ^ ^                    ^
-       ,-----------------------------' | | | |                    |
-       |           ,-------------------' | | |                    |
-       |           |       ,-------------' | |                    |
-       |           |       |           ,---' `-------.            |
-       v           v       v           v             v            v
-
- [arg-pp-main] [arg-pp] [cache] [transform.sed] [transform]   [buildcmd]
+===> {"$@"} <---> [scan]
+      |
+      v
+     [arg-source]
+      |
+      v
+     {argbuf}
+      |                   / [arg-pp-main]
+      v                   | [arg-pp]
+     [logic] <---------> <| [cache]
+      |                   | [transform.sed]
+      v                   \ [transform]
+     {cmdbuf}
+      |
+      v
+     [cmd-sink] <---.
+      |              |
+      v              |
+     [buildcmd] ----'
+      |      |
+      v      v
+     {cmd}  {libs}
+      |      |
+      |      v
+      |     [reorderlibs]
+      |      |
+      |     /
+       \   /
+        v v
+<===   {cmd}
 
-                                                                  |
-                                                  ,--  {cmd}   <--|
-                                       {cmd}  <===|               |
-                                                  `--  {libs}  <--'
+Additional notes:
 
-                                                         ^
-                                                         |
-                                                         v
-
-                                                   [reorderlibs]
+* The <---> between the "$@" and the [scan] is indentional. The [scan]
+  program may indeed modify "$@" by using the "set --" shell command.