Browse Source

Updated notes based on new terminology

No more STS and STM, I was pretty confused all the time...
Alois Mahdal (@azzgoat) 12 years ago
parent
commit
cb687fc7fc
2 changed files with 22 additions and 21 deletions
  1. 18
    17
      notes/arch.md
  2. 4
    4
      notes/matrices.md

+ 18
- 17
notes/arch.md View File

@@ -5,34 +5,35 @@ Workflow
5 5
 --------
6 6
 
7 7
 
8
-    [ Repo ]
8
+    [ SugarTrail::Repo ]
9 9
 
10 10
        | 1      init(type,args) # init repo:
11 11
        |                        # * type can be Filesystem or other,
12 12
        |                        # * args can be root, connection string...
13
-       |        load(stm)       # obtain STM from repo
13
+       |        load(master)    # obtain Master from repo
14 14
        v n
15 15
 
16
-    [ STM ]
16
+    [ SugarTrail::Template::Master ]
17 17
 
18 18
        | 1      parse_head()    # parse text and fill out metadata properties
19
-       |        gen_sts(args)   # generate a number of STS from an STM
19
+       |        gen_slave(args) # generate a number of Slaves from a Master
20 20
        |                        # * args - args specify ranges from where
21
-       |                        #          STMs are generated; typically
22
-       |                        #          Cartesian product
21
+       |                        #          Slavess are generated; typically
22
+       |                        #          based on a Cartesian product
23
+       |                        #          (think OS x ARCHS x PROTOCOLS)
23 24
        v n
24 25
 
25
-    [ STS ] = STM + ARGS
26
+    [ SugarTrail::Template::Slave ] = ::Master + args
26 27
 
27
-       | 1      gen_task(sts,args)  # a task (or a number of) can be created
28
-       |                            # from STS.  In less managed scenarios
29
-       |                            # (e.g. Beta testing) STS can be served
28
+       | 1      gen_task(slave)     # a task (or a number of) can be created
29
+       |                            # from Slave.  In less managed scenarios
30
+       |                            # (e.g. Beta testing) Slave can be served
30 31
        |                            # right away, and task ID will be generated
31 32
        |                            # off-site, e.g. using embedded JS, at
32 33
        |                            # time of report
33 34
        v n
34 35
 
35
-    [ TSK ] = STS + TID
36
+    [ SugarTrail::Task ] = ::Slave + (taskid)
36 37
 
37 38
 
38 39
 
@@ -45,7 +46,7 @@ Workflow
45 46
     /release/rc.stm
46 47
 
47 48
         +------------------[ vcs rev: 123 ]-----+
48
-        | STM # Source file                     |
49
+        | ::Master # Source file                |
49 50
         +---------------------------------------+
50 51
         | Name: Release Client                  |
51 52
         | Component: ~                          |
@@ -72,7 +73,7 @@ Workflow
72 73
         Accept: text/plain
73 74
 
74 75
         +---------------------------------------+
75
-        | STS # Slave template                  |
76
+        | ::Slave # Slave template              |
76 77
         +---------------------------------------+
77 78
         | Stm: /release/rc.stm                  |
78 79
         | Stm Revision: 123                     |
@@ -93,7 +94,7 @@ Workflow
93 94
         Accept: text/html
94 95
 
95 96
         +---------------------------------------+
96
-        | HTML # Generated from STS             |
97
+        | HTML # Generated from Slave           |
97 98
         +---------------------------------------+
98 99
         | # HTML version of above...            |
99 100
         | # With POP3 step instead of IMAP step |
@@ -106,7 +107,7 @@ Workflow
106 107
 
107 108
 Even more graphical from time POV.
108 109
 
109
-     User  :  App  :  Repo :  STM  :  STS
110
+     User  :  App  :  Repo : Master : Slave
110 111
     =======================================
111 112
        |       |       |       |       |
112 113
        |       o ----> |       |       |
@@ -116,13 +117,13 @@ Even more graphical from time POV.
116 117
        | /rc?a o ----> |       |       |
117 118
        | =b    | load  |       |       |
118 119
        |       | <---- o       |       |
119
-       |       |  stm  |       |       |
120
+       |       |  mst  |       |       |
120 121
        |       |       |       |       |
121 122
        |       o ------------> |       |
122 123
        |       |       | gen(a |       |
123 124
        |       |       | =b)   |       |
124 125
        |       | <------------ o       |
125
-       |       |       | sts   |       |
126
+       |       |       | slv   |       |
126 127
        |       |       |       |       |
127 128
        |       o --------------------> |
128 129
        |       |       |       | rndr  |

+ 4
- 4
notes/matrices.md View File

@@ -11,7 +11,7 @@ Example
11 11
 -------
12 12
 
13 13
 
14
-Source STM defines actions that are only valid under certain circumstances.
14
+Master template defines actions that are only valid under certain circumstances.
15 15
 
16 16
     Name: Release Client - parallel
17 17
     Description: Example of parallel procedures
@@ -30,7 +30,7 @@ Source STM defines actions that are only valid under certain circumstances.
30 30
     5. Restart
31 31
 
32 32
 
33
-The above can result in two STS:
33
+The above can result in two Slaves:
34 34
 
35 35
     Stm: /release/rc.stm
36 36
     Stm Revision: 123
@@ -65,7 +65,7 @@ The above can result in two STS:
65 65
     5. Restart
66 66
 
67 67
 
68
-Or one "double" STS -- notice `Params:` header:
68
+Or one "double" Slave -- notice `Params:` header:
69 69
 
70 70
     Stm: /release/rc.stm
71 71
     Stm Revision: 123
@@ -84,7 +84,7 @@ Or one "double" STS -- notice `Params:` header:
84 84
     5. Restart
85 85
 
86 86
 
87
-The point is that the double STM can be rendered for parallel processing:
87
+The point is that the double Slave can be rendered for parallel processing:
88 88
 
89 89
     +-------------------------------------------------------------------+
90 90
     | PARALLEL SHOWCASE                                                 |