Skip to content

Commit 1968021

Browse files
authored
Update loadup and medley scripts to use "tag" instead of "branch"; add ability to completely delete tagged loadups rather than just thin them (#2249)
* WIP in changing loadups to tagged nomeclature rather that branch and ability to delete tagged branches as well as thin them. * In loadup and medley scripts, changed the --branch (-br) command line argument to --tag (-tg). Correspondingly changed the MEDLEYDIR/loadups/branches directory to be MEDLEYDIR/loadups/tagged. Separately, added a + parameter to the --thinw and --thinl command line arguments which causes ALL files to be deleted, not just the versioned files. Added a --thin command line argument that is equivalent to --thinw followed by --thinl. Updated the man page to reflect all these changes. * Updated medley script man page to reflect the new tag nomenclature instead of branch nomenclature. * Fix issue#2063 - typo in medley man page * 1) In loadup script made --help (-h) be a synomym of --man (-z). 2) In both loadup and medley scripts added an optional parameter (+) to the --man (z) command line argument that when specified will display the man page without paging - i.e., sets the pager to cat. * Fix Issue#2251 LOADUPSDIRECTORIES settings by the MEDLEYDIR fn now takes into account tagged loadups
1 parent ec16faf commit 1968021

File tree

16 files changed

+340
-173
lines changed

16 files changed

+340
-173
lines changed

docs/man-page/man_medley.html

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ <h2>Flags</h2>
2020
<dd>
2121
<p>Prints out a brief summary of the flags and arguments to medley.</p>
2222
</dd>
23-
<dt>-z, --man</dt>
23+
<dt>-z [+], --man [+]</dt>
2424
<dd>
25-
<p>Show the man page for medley</p>
25+
<p>Show the man page for medley. If the <strong>+</strong> parameter is
26+
specified, then no pager is used when displaying the man page.</p>
2627
</dd>
2728
<dt>-c [<em>FILE</em> | -], --config [<em>FILE</em> | -]</dt>
2829
<dd>
@@ -101,7 +102,7 @@ <h2>Flags</h2>
101102
<dt>-g [<em>WxH</em> | -], --geometry [<em>WxH</em> | -]</dt>
102103
<dd>
103104
<p>Sets the size of the X Window (or VNC window) that Medley runs in to
104-
be Width x Height. (Full X Windows geomtery specification with +X+Y is
105+
be Width x Height. (Full X Windows geometry specification with +X+Y is
105106
not currently supported).</p>
106107
<p>If a value of “-” is given, geometry is set to the default value.</p>
107108
<p>If --geometry is not specified but --screensize is, then the window
@@ -293,15 +294,15 @@ <h2>Flags</h2>
293294
that very short Medley sessions are possible and the Xvnc error
294295
detection needs to be adjusted accordingly.</p>
295296
</dd>
296-
<dt>-br [<em>BRANCH</em> | -], --branch [<em>BRANCH</em> | -]</dt>
297+
<dt>-tg [<em>TAG</em> | -], --tag [<em>TAG</em> | -]</dt>
297298
<dd>
298299
<p>By default, sysout files are loaded from the MEDLEYDIR/loadups
299-
directory. If “--branch <em>BRANCH</em>” is specified, then by default
300-
sysout files are loaded from the MEDLEYDIR/loadups/branches/BRANCH
301-
directory. The sysouts in these directories are created using a loadups
302-
script with the --branch flag set. See the loadup man page. If
303-
<em>BRANCH</em> is “-”, then the name of the active git branch for
304-
MEDLEYDIR (if any) is used as <em>BRANCH</em>.</p>
300+
directory. If “--tag <em>TAG</em>” is specified, then by default sysout
301+
files are loaded from the MEDLEYDIR/loadups/tagged/TAG directory. The
302+
sysouts in these directories are created using a loadups script with the
303+
--tag flag set. See the loadup man page. If <em>TAG</em> is “-”, then
304+
the name of the active git branch for MEDLEYDIR (if any) is used as
305+
<em>TAG</em>.</p>
305306
</dd>
306307
</dl>
307308
<h2>Other Options</h2>

docs/man-page/medley.1

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,10 @@ hence MEDLEYDIR is computed on each invocation of medley.
4545
-h, --help
4646
Prints out a brief summary of the flags and arguments to medley.
4747
.TP
48-
-z, --man
49-
Show the man page for medley
48+
-z [+], --man [+]
49+
Show the man page for medley.
50+
If the \f[B]+\f[R] parameter is specified, then no pager is used when
51+
displaying the man page.
5052
.TP
5153
-c [\f[I]FILE\f[R] | -], --config [\f[I]FILE\f[R] | -]
5254
Use \f[I]FILE\f[R] as the config file for this run of Medley.
@@ -151,7 +153,7 @@ virtual display.
151153
-g [\f[I]WxH\f[R] | -], --geometry [\f[I]WxH\f[R] | -]
152154
Sets the size of the X Window (or VNC window) that Medley runs in to be
153155
Width x Height.
154-
(Full X Windows geomtery specification with +X+Y is not currently
156+
(Full X Windows geometry specification with +X+Y is not currently
155157
supported).
156158
.RS
157159
.PP
@@ -396,17 +398,16 @@ failures.
396398
Setting this flag notifies Medley that very short Medley sessions are
397399
possible and the Xvnc error detection needs to be adjusted accordingly.
398400
.TP
399-
-br [\f[I]BRANCH\f[R] | -], --branch [\f[I]BRANCH\f[R] | -]
401+
-tg [\f[I]TAG\f[R] | -], --tag [\f[I]TAG\f[R] | -]
400402
By default, sysout files are loaded from the MEDLEYDIR/loadups
401403
directory.
402-
If \[lq]--branch \f[I]BRANCH\f[R]\[rq] is specified, then by default
403-
sysout files are loaded from the MEDLEYDIR/loadups/branches/BRANCH
404-
directory.
404+
If \[lq]--tag \f[I]TAG\f[R]\[rq] is specified, then by default sysout
405+
files are loaded from the MEDLEYDIR/loadups/tagged/TAG directory.
405406
The sysouts in these directories are created using a loadups script with
406-
the --branch flag set.
407+
the --tag flag set.
407408
See the loadup man page.
408-
If \f[I]BRANCH\f[R] is \[lq]-\[rq], then the name of the active git
409-
branch for MEDLEYDIR (if any) is used as \f[I]BRANCH\f[R].
409+
If \f[I]TAG\f[R] is \[lq]-\[rq], then the name of the active git branch
410+
for MEDLEYDIR (if any) is used as \f[I]TAG\f[R].
410411
.SS Other Options
411412
.PP
412413
\

docs/man-page/medley.1.gz

27 Bytes
Binary file not shown.

docs/man-page/medley.1.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,9 @@ Flags
3838
-h, \-\-help
3939
: Prints out a brief summary of the flags and arguments to medley.
4040

41-
-z, \-\-man
42-
: Show the man page for medley
41+
-z [+], \-\-man [+]
42+
: Show the man page for medley. If the **+** parameter is specified, then no pager is used when
43+
displaying the man page.
4344

4445
-c [*FILE* | -], \-\-config [*FILE* | -]
4546
: Use *FILE* as the config file for this run of Medley. See information on *CONFIG FILE* below.
@@ -106,7 +107,7 @@ than the window, there will be no way to pan to the non-visible parts of the vir
106107

107108
-g [*WxH* | -], \-\-geometry [*WxH* | -]
108109
: Sets the size of the X Window (or VNC window) that Medley runs in to be Width x Height. (Full X Windows
109-
geomtery specification with +X+Y is not currently supported).
110+
geometry specification with +X+Y is not currently supported).
110111

111112
If a value of "-" is given, geometry is set to the default value.
112113

@@ -263,14 +264,13 @@ specified in the Medley file system, not the host Windows file system.
263264
will run for a very short time (< a couple of seconds). This can cause issues with medley code that detects Xvnc server failures.
264265
Setting this flag notifies Medley that very short Medley sessions are possible and the Xvnc error detection needs to be adjusted accordingly.
265266

266-
-br [*BRANCH* | -], \-\-branch [*BRANCH* | -]
267+
-tg [*TAG* | -], \-\-tag [*TAG* | -]
267268
: By default, sysout files are loaded from the MEDLEYDIR/loadups directory.
268-
If "\-\-branch *BRANCH*" is specified, then by default sysout files are loaded from the
269-
MEDLEYDIR/loadups/branches/BRANCH directory. The sysouts in these directories are created using
270-
a loadups script with the \-\-branch flag set. See the loadup man page.
271-
If *BRANCH* is "-", then the name of the active git branch for MEDLEYDIR (if any) is used as
272-
*BRANCH*.
273-
269+
If "\-\-tag *TAG*" is specified, then by default sysout files are loaded from the
270+
MEDLEYDIR/loadups/tagged/TAG directory. The sysouts in these directories are created using
271+
a loadups script with the \-\-tag flag set. See the loadup man page.
272+
If *TAG* is "-", then the name of the active git branch for MEDLEYDIR (if any) is used as
273+
*TAG*.
274274

275275

276276
Other Options

internal/loadups/man-page/loadup.1

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,10 @@ But Medley can be installed in multiple places on any given machine and
130130
hence MEDLEYDIR is computed on each invocation of loadup.
131131
.SH OPTIONS
132132
.TP
133-
\f[B]-z, --man, -man\f[R]
133+
\f[B]-z [+], --man [+], -man [+], -h [+], \[en]help [+]\f[R]
134134
Print this manual page on the screen.
135+
If the \f[B]+\f[R] parameter is specified, then no pager is used when
136+
displaying the man page.
135137
.TP
136138
\f[B]-t STAGE, --target STAGE, -target STAGE\f[R]
137139
Run the sequential loadup procedure until the STAGE is complete,
@@ -266,31 +268,47 @@ simultaneously.
266268
If this flag is not set and an active lock is encountered, the user will
267269
be asked to choose whether to override or exit.
268270
.TP
269-
\f[B]-br [ BRANCH | -], --branch [ BRANCH | - ]\f[R]
271+
\f[B]-tg [ TAG | -], --tag [ TAG | - ]\f[R]
270272
By default the sysouts and other files produced by loadup are placed at
271273
the top level of the <MEDLEYDIR>/loadups directory.
272274
If this flag is specified, then the sysout and other output files are
273-
placed in the directory <MEDLEYDIR>/loadups/branches/BRANCH.
274-
If BRANCH is \[lq]-\[rq] or not specified at all, then BRANCH is the
275-
name of the currently active git branch of <MEDLEYDIR>, except if git is
276-
not installled on the current system or if <MEDLEYDIR> is not a git
275+
placed in the directory <MEDLEYDIR>/loadups/tagged/TAG.
276+
If TAG is \[lq]-\[rq] or not specified at all, then TAG is the name of
277+
the currently active git branch of <MEDLEYDIR>, except if git is not
278+
installled on the current system or if <MEDLEYDIR> is not a git
277279
directory, in which case then this flag is ignored.
278-
BRANCH can contain alphanumerics, dashes, underscores,and periods.
280+
TAG can contain alphanumerics, dashes, underscores,and periods.
279281
Any other character is replaced by an underscore.
280-
The medley script has a corresponding --branch argument to load these
282+
The medley script has a corresponding --tag (-tg) argument to load these
281283
sysout files.
282284
.TP
283285
\f[B]-nc, --nocopy, -nocopy\f[R]
284286
Run the specified loadups, but do not copy results into loadups
285287
directory.
286288
.TP
287-
\f[B]-tw, --thinw, -thinw\f[R]
289+
\f[B]-tw [+], --thinw [+], -thinw [+]\f[R]
288290
Before running loadups (if any), thin the working directory by deleting
289-
all versioned (\f[I].\[ti][0-9]\f[R]\[ti]) files.
291+
all versioned (\f[I].\[ti][0-9]\f[R]\[ti]) files therein.
292+
If the \f[B]+\f[R] parameter is used, then instead of deleting just the
293+
versioned files, the working directory (and all files and subdirectories
294+
it contains) is deleted.
290295
.TP
291-
\f[B]-tl, --thinl, -thinl\f[R]
296+
\f[B]-tl [+], --thinl [+], -thinl [+]\f[R]
292297
Before running loadups (if any), thin the loadups directory by deleting
293-
all versioned (\f[I].\[ti][0-9]\f[R]\[ti]) files.
298+
all versioned (\f[I].\[ti][0-9]\f[R]\[ti]) files except for those
299+
contained in the working directory.
300+
If the \f[B]+\f[R] parameter is used, then instead of deleting just the
301+
versioned files, all files and subdirectories are deleted except for
302+
those contained in the working directory.
303+
If \f[B]+\f[R] is used and there is no working directory and
304+
\f[I]\[en]tag TAG\f[R] is also specified, then the tagged loadups
305+
directory (<MEDLEYDIR>/loadups/tagged/TAG) is also deleted.
306+
.TP
307+
\f[B]-th [+], --thin [+], -thin [+]\f[R]
308+
Equivalent to specifying both -tw [+] and -tl [+].
309+
If \f[I]\[en]tag TAG\f[R] is also specified and the \f[B]+\f[R]
310+
parameter is used here, then the tagged loadups directory
311+
(<MEDLEYDIR>/loadups/tagged/TAG) is removed.
294312
.TP
295313
\f[B]-d DIR, --maikodir DIR, -maikodir DIR\f[R]
296314
Use DIR as the directory from which to execute lde (Miko) when running

internal/loadups/man-page/loadup.1.gz

242 Bytes
Binary file not shown.

internal/loadups/man-page/loadup.1.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,9 @@ hence MEDLEYDIR is computed on each invocation of loadup.
6161

6262
OPTIONS
6363
=======
64-
**-z, \-\-man, \-man**
65-
: Print this manual page on the screen.
64+
**-z [+], \-\-man [+], \-man [+], -h [+], --help [+]**
65+
: Print this manual page on the screen. If the **+** parameter is specified, then no pager is used when
66+
displaying the man page.
6667

6768
**-t STAGE, \-\-target STAGE, -target STAGE**
6869
: Run the sequential loadup procedure until the STAGE is complete, starting from the files created by the previously run STAGE specified in the --start option.
@@ -124,25 +125,37 @@ OPTIONS
124125
**-ov, \-\-override, -override**
125126
: Automatically override the lock that prevents two loadups from running simultaneously. If this flag is not set and an active lock is encountered, the user will be asked to choose whether to override or exit.
126127

127-
**-br [ BRANCH | -], \-\-branch [ BRANCH | - ]**
128+
**-tg [ TAG | -], \-\-tag [ TAG | - ]**
128129
: By default the sysouts and other files produced by loadup are placed at the top level of
129130
the \<MEDLEYDIR>/loadups directory. If this flag is specified, then the sysout and other
130-
output files are placed in the directory \<MEDLEYDIR>/loadups/branches/BRANCH.
131-
If BRANCH is "-" or not specified at all, then BRANCH is the name of the currently active
131+
output files are placed in the directory \<MEDLEYDIR>/loadups/tagged/TAG.
132+
If TAG is "-" or not specified at all, then TAG is the name of the currently active
132133
git branch of \<MEDLEYDIR>, except if git is not installled on the current system
133134
or if \<MEDLEYDIR> is not a git directory, in which case then this flag is ignored.
134-
BRANCH can contain alphanumerics, dashes, underscores,and periods.
135+
TAG can contain alphanumerics, dashes, underscores,and periods.
135136
Any other character is replaced by an underscore.
136-
The medley script has a corresponding \-\-branch argument to load these sysout files.
137+
The medley script has a corresponding \-\-tag (-tg) argument to load these sysout files.
137138

138139
**-nc, \-\-nocopy, -nocopy**
139140
: Run the specified loadups, but do not copy results into loadups directory.
140141

141-
**-tw, \-\-thinw, -thinw**
142-
: Before running loadups (if any), thin the working directory by deleting all versioned (*.~[0-9]*~) files.
143-
144-
**-tl, \-\-thinl, -thinl**
145-
: Before running loadups (if any), thin the loadups directory by deleting all versioned (*.~[0-9]*~) files.
142+
**-tw [+], \-\-thinw [+], -thinw [+]**
143+
: Before running loadups (if any), thin the working directory by deleting all versioned (*.~[0-9]*~)
144+
files therein. If the **+** parameter is used, then instead of deleting just the versioned files, the
145+
working directory (and all files and subdirectories it contains) is deleted.
146+
147+
**-tl [+], \-\-thinl [+], -thinl [+]**
148+
: Before running loadups (if any), thin the loadups directory by deleting all versioned (*.~[0-9]*~)
149+
files except for those contained in the working directory.
150+
If the **+** parameter is used, then instead of deleting just the versioned files, all files and
151+
subdirectories are deleted except for those contained in the working directory. If **+** is used and
152+
there is no working directory and *--tag TAG* is also specified,
153+
then the tagged loadups directory (\<MEDLEYDIR>/loadups/tagged/TAG) is also deleted.
154+
155+
**-th [+], \-\-thin [+], -thin [+]**
156+
: Equivalent to specifying both -tw [+] and -tl [+]. If *--tag TAG* is also specified and
157+
the **+** parameter is used here, then the tagged loadups directory (\<MEDLEYDIR>/loadups/tagged/TAG)
158+
is removed.
146159

147160
**-d DIR, \-\-maikodir DIR, -maikodir DIR**
148161
: Use DIR as the directory from which to execute lde (Miko) when running Medley in the loadup process. If this flag is not present, the value of the environment variable MAIKODIR will be used instead. And if MAIKODIR does not exist, then the default Maiko directory search within Medley will be used.

internal/loadups/man-page/man_loadup.html

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,11 @@ <h1>DESCRIPTION</h1>
9999
computed on each invocation of loadup.</p>
100100
<h1>OPTIONS</h1>
101101
<dl>
102-
<dt><strong>-z, --man, -man</strong></dt>
102+
<dt><strong>-z [+], --man [+], -man [+], -h [+], –help [+]</strong></dt>
103103
<dd>
104-
<p>Print this manual page on the screen.</p>
104+
<p>Print this manual page on the screen. If the <strong>+</strong>
105+
parameter is specified, then no pager is used when displaying the man
106+
page.</p>
105107
</dd>
106108
<dt><strong>-t STAGE, --target STAGE, -target STAGE</strong></dt>
107109
<dd>
@@ -208,34 +210,51 @@ <h1>OPTIONS</h1>
208210
encountered, the user will be asked to choose whether to override or
209211
exit.</p>
210212
</dd>
211-
<dt><strong>-br [ BRANCH | -], --branch [ BRANCH | - ]</strong></dt>
213+
<dt><strong>-tg [ TAG | -], --tag [ TAG | - ]</strong></dt>
212214
<dd>
213215
<p>By default the sysouts and other files produced by loadup are placed
214216
at the top level of the &lt;MEDLEYDIR&gt;/loadups directory. If this
215217
flag is specified, then the sysout and other output files are placed in
216-
the directory &lt;MEDLEYDIR&gt;/loadups/branches/BRANCH. If BRANCH is
217-
“-” or not specified at all, then BRANCH is the name of the currently
218-
active git branch of &lt;MEDLEYDIR&gt;, except if git is not installled
219-
on the current system or if &lt;MEDLEYDIR&gt; is not a git directory, in
220-
which case then this flag is ignored. BRANCH can contain alphanumerics,
221-
dashes, underscores,and periods. Any other character is replaced by an
222-
underscore. The medley script has a corresponding --branch argument to
223-
load these sysout files.</p>
218+
the directory &lt;MEDLEYDIR&gt;/loadups/tagged/TAG. If TAG is “-” or not
219+
specified at all, then TAG is the name of the currently active git
220+
branch of &lt;MEDLEYDIR&gt;, except if git is not installled on the
221+
current system or if &lt;MEDLEYDIR&gt; is not a git directory, in which
222+
case then this flag is ignored. TAG can contain alphanumerics, dashes,
223+
underscores,and periods. Any other character is replaced by an
224+
underscore. The medley script has a corresponding --tag (-tg) argument
225+
to load these sysout files.</p>
224226
</dd>
225227
<dt><strong>-nc, --nocopy, -nocopy</strong></dt>
226228
<dd>
227229
<p>Run the specified loadups, but do not copy results into loadups
228230
directory.</p>
229231
</dd>
230-
<dt><strong>-tw, --thinw, -thinw</strong></dt>
232+
<dt><strong>-tw [+], --thinw [+], -thinw [+]</strong></dt>
231233
<dd>
232234
<p>Before running loadups (if any), thin the working directory by
233-
deleting all versioned (<em>.~[0-9]</em>~) files.</p>
235+
deleting all versioned (<em>.~[0-9]</em>~) files therein. If the
236+
<strong>+</strong> parameter is used, then instead of deleting just the
237+
versioned files, the working directory (and all files and subdirectories
238+
it contains) is deleted.</p>
234239
</dd>
235-
<dt><strong>-tl, --thinl, -thinl</strong></dt>
240+
<dt><strong>-tl [+], --thinl [+], -thinl [+]</strong></dt>
236241
<dd>
237242
<p>Before running loadups (if any), thin the loadups directory by
238-
deleting all versioned (<em>.~[0-9]</em>~) files.</p>
243+
deleting all versioned (<em>.~[0-9]</em>~) files except for those
244+
contained in the working directory. If the <strong>+</strong> parameter
245+
is used, then instead of deleting just the versioned files, all files
246+
and subdirectories are deleted except for those contained in the working
247+
directory. If <strong>+</strong> is used and there is no working
248+
directory and <em>–tag TAG</em> is also specified, then the tagged
249+
loadups directory (&lt;MEDLEYDIR&gt;/loadups/tagged/TAG) is also
250+
deleted.</p>
251+
</dd>
252+
<dt><strong>-th [+], --thin [+], -thin [+]</strong></dt>
253+
<dd>
254+
<p>Equivalent to specifying both -tw [+] and -tl [+]. If <em>–tag
255+
TAG</em> is also specified and the <strong>+</strong> parameter is used
256+
here, then the tagged loadups directory
257+
(&lt;MEDLEYDIR&gt;/loadups/tagged/TAG) is removed.</p>
239258
</dd>
240259
<dt><strong>-d DIR, --maikodir DIR, -maikodir DIR</strong></dt>
241260
<dd>

0 commit comments

Comments
 (0)