@@ -7,7 +7,7 @@ done or not.
7
7
8
8
For some types of scripts (for example very short ones, or
9
9
non-destructive, fast executing scripts), it is not worth the effort.
10
- The problem is that often it is not until later that the benefit are
10
+ The problem is that often it is not until later that the benefits are
11
11
understood for a particular script. And then the programmer ends up
12
12
wishing that the enhancements had been included in the script from the
13
13
beginning.
@@ -19,15 +19,14 @@ For example, consider this 4 line script (pseudo code):
19
19
make
20
20
make install
21
21
22
- There are many ways to do add the two enhancements to this code. This
22
+ There are many ways to add the two enhancements to this code. This
23
23
could be done directly with well-placed conditional statements, but
24
24
such an over-simplified solution would limit the benefits. A better
25
25
solution might be to use a special framework that can maximize the
26
26
benefits of the enhancements (e.g. dependency analysis, logging,
27
- progress updates, debugging tools, etc.) Unfortunately, using such a
28
- framework requires more upfront effort to understand the
29
- framework(s), choose the framework, install the frameworks, and adapt
30
- the script to the framework. With either solution, there are real
27
+ progress updates, debugging tools, etc.). Unfortunately, using such a
28
+ framework requires more upfront effort to understand, choose, install, and adapt
29
+ the script to the framework(s). With either solution, there are real
31
30
risks that discourage adding the enhancements in the first place.
32
31
33
32
The goal of bashsteps is to address these risks. It is designed to be
@@ -66,7 +65,7 @@ direct. The key design choice here is that the code can appear in the
66
65
same order as the unenhanced script, as opposed to being split out
67
66
into separate functions or separate files. Another related point is
68
67
that this design makes it easy to later split steps into multiple
69
- steps, and vise versa .
68
+ steps, or to recombine multiple steps into fewer steps .
70
69
71
70
Now that we have created a couple steps, the lines that can test
72
71
whether the step has been done can be inserted:
@@ -88,7 +87,7 @@ whether the step has been done can be inserted:
88
87
89
88
Now the script has been enhanced by both splitting it into steps and
90
89
by including code that can test whether the step has been done. With
91
- The above minimal framework, however, the functionality of the script
90
+ the above minimal framework, however, the functionality of the script
92
91
is still unchanged.
93
92
94
93
To start getting benefits, here is a still-quite-simple framework
0 commit comments