Skip to content

Commit

Permalink
Tools book: fixing formatting problems with Jekyll
Browse files Browse the repository at this point in the history
  • Loading branch information
mgroeber9110 committed Nov 30, 2023
1 parent 1638661 commit 704faeb
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 23 deletions.
2 changes: 1 addition & 1 deletion TechDocs/Markdown/Tools/tini.md
Original file line number Diff line number Diff line change
Expand Up @@ -987,7 +987,7 @@ following entry:

A string by which remote machines may identify you. When the remote
machine sees your drives, their names will be
<machine-name>-<drive-letter>:.
`<machine-name>-<drive-letter>:`.

#### port

Expand Down
12 changes: 6 additions & 6 deletions TechDocs/Markdown/Tools/tswatcm.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,8 @@ argument if the user gives it a particular address to look at.
+ `* +`
An asterisk following any of the previous constructs indicates zero or
more repetitions of the construct may be typed. A plus sign indicates one
or more repetitions of the construct may be used. For example, `unalias
<word>*` can be the `unalias` command by itself, or it can be followed by
or more repetitions of the construct may be used. For example, `unalias <word>*`
can be the `unalias` command by itself, or it can be followed by
a list of words to be unaliased.

### 3.3 Address Expressions
Expand Down Expand Up @@ -280,7 +280,7 @@ To get information about a GEOS topic, use the doc functions.
apropos [<string>]

The **apropos** command searches the list of commands and command help for
all entries containing <string>. It lists each command and its synopsis. The string may actually be a partial word.
all entries containing `<string>`. It lists each command and its synopsis. The string may actually be a partial word.

----------
#### doc, doc-next, doc-previous
Expand Down Expand Up @@ -626,7 +626,7 @@ This is the main command to use when setting breakpoints in C programs.
The "stop in" command will set a breakpoint at the beginning of a procedure,
immediately after the procedure's stack frame has been set up. The "stop at"
command will set a breakpoint at the first instruction of the given source
line. If no <file> is specified, the source file for the current stack frame is
line. If no `<file>` is specified, the source file for the current stack frame is
used. If a condition is specified by means of an "if <expr>" clause, you should
enclose the expression in curly braces to prevent any nested commands, such
as a "value fetch" command, from being evaluated until the breakpoint is hit.
Expand Down Expand Up @@ -1506,7 +1506,7 @@ are being sent to the object at addr. If no argument is given, then any current

**Swat Display 3-13 The objwatch Command**

mess1:0) 2 => objwatch Mess1View
(mess1:0) 2 => objwatch Mess1View
brk5
(mess1:0) 3 => c
MSG_META_MOUSE_PTR, ^l44a0h:0020h, GenViewClass
Expand Down Expand Up @@ -1640,7 +1640,7 @@ the previous command.
+ Address History
Swat has an address history which is composed of tokens for address
expressions previously used by commands such as print or pobj. The
elements in the history can be accessed by typing @<number> where the
elements in the history can be accessed by typing `@<number>` where the
number argument is the number of the item in the history. These
elements can replace a full address expression (except constants) and are
often used when traversing through fields of a previously printed
Expand Down
8 changes: 3 additions & 5 deletions TechDocs/Markdown/Tools/tswtj_z.md
Original file line number Diff line number Diff line change
Expand Up @@ -4953,7 +4953,7 @@ returned as \n).
array.

Structures, unions and records are returned as a list of elements, each of
which is a 3-element list: `{<field-name> <type> <value>}` `<field-name>` is
which is a 3-element list: `{<field-name> <type> <value>}`. `<field-name>` is
the name of the field, `<type>` is the type token for the type of data stored
in the field, and `<value>` is the value list for the data in the field,
appropriate to its data type.
Expand All @@ -4962,8 +4962,7 @@ appropriate to its data type.
if a structure has a field that is an array, the `<value>` element in the list
that describes that particular field will be itself a list whose elements are
the elements of the array. If that array were an array of structures, each
element of that list would again be a list of `{<field-name> <type>
<value>}` lists.
element of that list would again be a list of `{<field-name> <type> <value>}` lists.

+ The "field" command is very useful when you want to extract the value
for a structure field from a value list.
Expand Down Expand Up @@ -5400,8 +5399,7 @@ Examine memory as a dump of words.
address after the last examined memory location is used. If no address
has been examined then DS:SI is used for the address.

+ The `<length>` argument is the number of bytes to examine. It defaults to
8.
+ The `<length>` argument is the number of bytes to examine. It defaults to 8.

+ Pressing `<Return>` after this command continues the list.

Expand Down
18 changes: 9 additions & 9 deletions TechDocs/Markdown/Tools/ttcl.md
Original file line number Diff line number Diff line change
Expand Up @@ -1694,7 +1694,7 @@ purposes.
"uplevel 1 {var foo 36}", you would modify (or create) the
variable "foo" in your caller's scope.
`<= 0` - Indicates the number of scopes to go down from the global one.
"uplevel 0 `<body>` will execute <body> in the top-most scope,
"uplevel 0 `<body>` will execute `<body>` in the top-most scope,
which means that no local variables are involved, and any
variables created by the commands in `<body>` persist as global
variables.
Expand Down Expand Up @@ -2338,8 +2338,8 @@ element of the result with the "index" command, however; you'll have to
use the "range" command to get the first 8 characters, then use "index" to
trim the trailing spaces off, if you want to.

+ "patient data" returns a three-element list: `{<name> <fullname>
<thread-number>}` `<name>` and `<fullname>` are the same as returned by
+ "patient data" returns a three-element list: `{<name> <fullname> <thread-number>}`.
`<name>` and `<fullname>` are the same as returned by
the "name" and "fullname" subcommands. `<thread-number`> is the
number of the current thread for the patient. Each patient has a single
thread that is the one the user looked at most recently, and that is its
Expand Down Expand Up @@ -2528,8 +2528,8 @@ passed address.
uniquely identifies the symbol. Thus if a procedure-local variable belongs
to the current patient, the fullname would be
`<segment>::<procedure>::<name>`
where `<segment>` is the segment holding the `<procedure>`, which is the
procedure for which the local variable named <name> is defined.
where `<segment>` is the segment holding the `<procedure>`, which is the
procedure for which the local variable named `<name>` is defined.

+ You can force the prepending of the owning patient to the fullname by
passing `<with-patient>` as a non-empty argument ("yes" or "1" are both
Expand Down Expand Up @@ -2930,8 +2930,8 @@ of `{<name> <value>}` pairs for the members of the enumerated type.
of pointer ("near", "far", "seg", "lmem", "handle", or "object") and the
token for the type to which it points.

+ "type bfget" returns a three-list for the given bitfield type: `{<offset>
<width> <is-signed>}`
+ "type bfget" returns a three-list for the given bitfield type:
`{<offset> <width> <is-signed>}`

+ "type signed" returns non-zero if the type is signed. If the `<type>` is not
an int-class type, it is considered unsigned.
Expand Down Expand Up @@ -2972,8 +2972,8 @@ procedure has not been loaded into Swat yet (i.e. it has not been used yet). If
this is the case, Swat will have no information about the procedure and will
thus print nothing. The command must be loaded into Swat either with the
load command, or by just typing the command name which will usually
autoload the command. (See section 5.7.) Then the `info body
<procname>` command can be used.
autoload the command. (See section 5.7.) Then the
`info body <procname>` command can be used.

Some code examples:

Expand Down
4 changes: 2 additions & 2 deletions TechDocs/Markdown/Tools/ttools.md
Original file line number Diff line number Diff line change
Expand Up @@ -1006,7 +1006,7 @@ sent by any program that can access the serial port.
**1** - Notify PCCOM that a file is on its way.
Send the Send File escape character sequence to the serial port, notifying
PCCOM that a file is about to be sent to it. The escape sequence is
<Esc>XF1.
`<Esc>XF1`.

**2** - Send the destination file name.
Send the name PCCOM should use for the file when saving it. The name
Expand Down Expand Up @@ -1111,7 +1111,7 @@ of commands is different, however, and is listed below.
**1** - Notify PCCOM that you're getting a file.
Send the Get File escape character sequence to the serial port, notifying
PCCOM that it should get ready to send a file. The escape sequence is
<Esc>XF2.
`<Esc>XF2`.

**2** - Send the source file name.
Send the name of the file to be retrieved. The name is a string of
Expand Down

0 comments on commit 704faeb

Please sign in to comment.