Compare commits
1 Commits
fgh_wget
...
mth48--Use
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d00a9c4367 |
@@ -3,7 +3,7 @@
|
||||
First, we want to thank you for helping reach the goal of restoring Medley Interlisp
|
||||
to the point where it is as useful today as it was 30 years ago.
|
||||
|
||||
This guide is meant to help you make useful contributions, whether to the [Maiko](https://github.com/Interlisp/maiko) C-based virtual machine implementation, the [Medley](https://github.com/Interlisp/medley) Lisp code (in Interlisp and Common Lisp), or [documentation](https://interlisp.org/software/using-medley). There are a number of [GitHub](https://github.com/Interlisp/medley/discussions/categories/github-use) problems that could use some attention.
|
||||
This guide is meant to help you make useful contributions, whether to the [Maiko](https://github.com/Interlisp/maiko) C-based virtual machine implementation, the [Medley](https://github.com/Interlisp/medley) Lisp code (in Interlisp and Common Lisp), or [documentation](https://github.com/Interlisp/medley/wiki). There are a number of [GitHub](https://github.com/Interlisp/medley/discussions/categories/github-use) problems that could use some attention.
|
||||
|
||||
## Working with Maiko
|
||||
|
||||
@@ -17,8 +17,6 @@ The current arrangement of files and extentions is awkward for working on the im
|
||||
* The most useful contributions are reproducible errors -- things that don't work as documented.
|
||||
* Second most useful are reports of unexpected behavior -- things that aren't documented but behave unexpectedly.
|
||||
|
||||
To report these errors and behaviors [open an issue](https://github.com/Interlisp/medley/issues).
|
||||
|
||||
## Reporting a bug or feature request
|
||||
* Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/Interlisp/medley/issues) or [Discussions](https://github.com/Interlisp/medley/discussions). Note that all issues and Discussions are found in the Medley repository, using labels to distinguish. Discussions are for questions or topics where there is some disagreement or uncertainty about the "right" direction.
|
||||
* If you're unable to find a discussion or open issue addressing the problem, open a new one. Be sure to include a title
|
||||
@@ -26,7 +24,7 @@ and clear description, as much relevant information as possible. Use the issue t
|
||||
|
||||
## Did you write a patch that fixes a bug?
|
||||
* Some bug fixes and "improvements" have unintended consequences, well beyond what you might expect for well-written modern code. We don't have testing new builds automated or integrated. Be sure you've tested your patch.
|
||||
* Open a new GitHub pull request with the patch.
|
||||
* Open a new [GitHub pull request](https://github.com/Interlisp/maiko/pulls) with the patch.
|
||||
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
|
||||
* Keep Pull Requests small and easily reviewable. https://www.thedroidsonroids.com/blog/splitting-pull-request for
|
||||
a writeup of good practices.
|
||||
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -20,10 +20,9 @@ invocation of medley.</p>
|
||||
<dd>
|
||||
<p>Prints out a brief summary of the flags and arguments to medley.</p>
|
||||
</dd>
|
||||
<dt>-z [+], --man [+]</dt>
|
||||
<dt>-z, --man</dt>
|
||||
<dd>
|
||||
<p>Show the man page for medley. If the <strong>+</strong> parameter is
|
||||
specified, then no pager is used when displaying the man page.</p>
|
||||
<p>Show the man page for medley</p>
|
||||
</dd>
|
||||
<dt>-c [<em>FILE</em> | -], --config [<em>FILE</em> | -]</dt>
|
||||
<dd>
|
||||
@@ -102,7 +101,7 @@ virtual display.</p>
|
||||
<dt>-g [<em>WxH</em> | -], --geometry [<em>WxH</em> | -]</dt>
|
||||
<dd>
|
||||
<p>Sets the size of the X Window (or VNC window) that Medley runs in to
|
||||
be Width x Height. (Full X Windows geometry specification with +X+Y is
|
||||
be Width x Height. (Full X Windows geomtery specification with +X+Y is
|
||||
not currently supported).</p>
|
||||
<p>If a value of “-” is given, geometry is set to the default value.</p>
|
||||
<p>If --geometry is not specified but --screensize is, then the window
|
||||
@@ -294,15 +293,15 @@ that detects Xvnc server failures. Setting this flag notifies Medley
|
||||
that very short Medley sessions are possible and the Xvnc error
|
||||
detection needs to be adjusted accordingly.</p>
|
||||
</dd>
|
||||
<dt>-tg [<em>TAG</em> | -], --tag [<em>TAG</em> | -]</dt>
|
||||
<dt>-br [<em>BRANCH</em> | -], --branch [<em>BRANCH</em> | -]</dt>
|
||||
<dd>
|
||||
<p>By default, sysout files are loaded from the MEDLEYDIR/loadups
|
||||
directory. If “--tag <em>TAG</em>” is specified, then by default sysout
|
||||
files are loaded from the MEDLEYDIR/loadups/tagged/TAG directory. The
|
||||
sysouts in these directories are created using a loadups script with the
|
||||
--tag flag set. See the loadup man page. If <em>TAG</em> is “-”, then
|
||||
the name of the active git branch for MEDLEYDIR (if any) is used as
|
||||
<em>TAG</em>.</p>
|
||||
directory. If “--branch <em>BRANCH</em>” is specified, then by default
|
||||
sysout files are loaded from the MEDLEYDIR/loadups/branches/BRANCH
|
||||
directory. The sysouts in these directories are created using a loadups
|
||||
script with the --branch flag set. See the loadup man page. If
|
||||
<em>BRANCH</em> is “-”, then the name of the active git branch for
|
||||
MEDLEYDIR (if any) is used as <em>BRANCH</em>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h2>Other Options</h2>
|
||||
|
||||
@@ -45,10 +45,8 @@ hence MEDLEYDIR is computed on each invocation of medley.
|
||||
-h, --help
|
||||
Prints out a brief summary of the flags and arguments to medley.
|
||||
.TP
|
||||
-z [+], --man [+]
|
||||
Show the man page for medley.
|
||||
If the \f[B]+\f[R] parameter is specified, then no pager is used when
|
||||
displaying the man page.
|
||||
-z, --man
|
||||
Show the man page for medley
|
||||
.TP
|
||||
-c [\f[I]FILE\f[R] | -], --config [\f[I]FILE\f[R] | -]
|
||||
Use \f[I]FILE\f[R] as the config file for this run of Medley.
|
||||
@@ -153,7 +151,7 @@ virtual display.
|
||||
-g [\f[I]WxH\f[R] | -], --geometry [\f[I]WxH\f[R] | -]
|
||||
Sets the size of the X Window (or VNC window) that Medley runs in to be
|
||||
Width x Height.
|
||||
(Full X Windows geometry specification with +X+Y is not currently
|
||||
(Full X Windows geomtery specification with +X+Y is not currently
|
||||
supported).
|
||||
.RS
|
||||
.PP
|
||||
@@ -398,16 +396,17 @@ failures.
|
||||
Setting this flag notifies Medley that very short Medley sessions are
|
||||
possible and the Xvnc error detection needs to be adjusted accordingly.
|
||||
.TP
|
||||
-tg [\f[I]TAG\f[R] | -], --tag [\f[I]TAG\f[R] | -]
|
||||
-br [\f[I]BRANCH\f[R] | -], --branch [\f[I]BRANCH\f[R] | -]
|
||||
By default, sysout files are loaded from the MEDLEYDIR/loadups
|
||||
directory.
|
||||
If \[lq]--tag \f[I]TAG\f[R]\[rq] is specified, then by default sysout
|
||||
files are loaded from the MEDLEYDIR/loadups/tagged/TAG directory.
|
||||
If \[lq]--branch \f[I]BRANCH\f[R]\[rq] is specified, then by default
|
||||
sysout files are loaded from the MEDLEYDIR/loadups/branches/BRANCH
|
||||
directory.
|
||||
The sysouts in these directories are created using a loadups script with
|
||||
the --tag flag set.
|
||||
the --branch flag set.
|
||||
See the loadup man page.
|
||||
If \f[I]TAG\f[R] is \[lq]-\[rq], then the name of the active git branch
|
||||
for MEDLEYDIR (if any) is used as \f[I]TAG\f[R].
|
||||
If \f[I]BRANCH\f[R] is \[lq]-\[rq], then the name of the active git
|
||||
branch for MEDLEYDIR (if any) is used as \f[I]BRANCH\f[R].
|
||||
.SS Other Options
|
||||
.PP
|
||||
\
|
||||
|
||||
Binary file not shown.
@@ -38,9 +38,8 @@ Flags
|
||||
-h, \-\-help
|
||||
: Prints out a brief summary of the flags and arguments to medley.
|
||||
|
||||
-z [+], \-\-man [+]
|
||||
: Show the man page for medley. If the **+** parameter is specified, then no pager is used when
|
||||
displaying the man page.
|
||||
-z, \-\-man
|
||||
: Show the man page for medley
|
||||
|
||||
-c [*FILE* | -], \-\-config [*FILE* | -]
|
||||
: Use *FILE* as the config file for this run of Medley. See information on *CONFIG FILE* below.
|
||||
@@ -107,7 +106,7 @@ than the window, there will be no way to pan to the non-visible parts of the vir
|
||||
|
||||
-g [*WxH* | -], \-\-geometry [*WxH* | -]
|
||||
: Sets the size of the X Window (or VNC window) that Medley runs in to be Width x Height. (Full X Windows
|
||||
geometry specification with +X+Y is not currently supported).
|
||||
geomtery specification with +X+Y is not currently supported).
|
||||
|
||||
If a value of "-" is given, geometry is set to the default value.
|
||||
|
||||
@@ -264,13 +263,14 @@ specified in the Medley file system, not the host Windows file system.
|
||||
will run for a very short time (< a couple of seconds). This can cause issues with medley code that detects Xvnc server failures.
|
||||
Setting this flag notifies Medley that very short Medley sessions are possible and the Xvnc error detection needs to be adjusted accordingly.
|
||||
|
||||
-tg [*TAG* | -], \-\-tag [*TAG* | -]
|
||||
-br [*BRANCH* | -], \-\-branch [*BRANCH* | -]
|
||||
: By default, sysout files are loaded from the MEDLEYDIR/loadups directory.
|
||||
If "\-\-tag *TAG*" is specified, then by default sysout files are loaded from the
|
||||
MEDLEYDIR/loadups/tagged/TAG directory. The sysouts in these directories are created using
|
||||
a loadups script with the \-\-tag flag set. See the loadup man page.
|
||||
If *TAG* is "-", then the name of the active git branch for MEDLEYDIR (if any) is used as
|
||||
*TAG*.
|
||||
If "\-\-branch *BRANCH*" is specified, then by default sysout files are loaded from the
|
||||
MEDLEYDIR/loadups/branches/BRANCH directory. The sysouts in these directories are created using
|
||||
a loadups script with the \-\-branch flag set. See the loadup man page.
|
||||
If *BRANCH* is "-", then the name of the active git branch for MEDLEYDIR (if any) is used as
|
||||
*BRANCH*.
|
||||
|
||||
|
||||
|
||||
Other Options
|
||||
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user