Skip to content

Commit

Permalink
Fix some rendering issues
Browse files Browse the repository at this point in the history
  • Loading branch information
lizmat committed Nov 6, 2024
1 parent d0809f4 commit b78d205
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 28 deletions.
33 changes: 10 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ Request a list of all threads, with some information about each one. This reques

Response to a "Thread List Request". It contains an array of hashes, with one hash per running thread, providing information about that thread. It also contains an indication of whether the thread was suspended, and the number of locks it is currently holding.

The "name" key was added in version 1.2
The `name` key was added in version 1.2.

```raku
{
Expand All @@ -282,15 +282,11 @@ The "name" key was added in version 1.2
}
```

```raku
=head3 Thread Stack Trace Request (13)
Request the stack trace of a thread. This is only allowed if that
thread is suspended; an "Error Processing Message" response will be
returned otherwise.
### Thread Stack Trace Request (13)

=begin code :lang<raku>
Request the stack trace of a thread. This is only allowed if that thread is suspended; an "Error Processing Message" response will be returned otherwise.

```raku
{
type => 13, # MT_ThreadStackTraceRequest
id => $new-request-id,
Expand Down Expand Up @@ -338,26 +334,17 @@ The `type` key is the debug name of the type of the code object, or `Nil` if the
}
```

```raku
=head3 Set Breakpoint Request (15)
### Set Breakpoint Request (15)

Request to set a breakpoint at the specified location, or the closest
possible location to it.
Request to set a breakpoint at the specified location, or the closest possible location to it.

The C<file> key refers to the source file.
The `file` key refers to the source file.

If the C<suspend> key is set to C<True> then execution of all threads
will be suspended when the breakpoint is hit. In either case, the client
will be notified. The use of non-suspend breakpoints is for counting
the number of times a certain point is reached.
If the `suspend` key is set to `True` then execution of all threads will be suspended when the breakpoint is hit. In either case, the client will be notified. The use of non-suspend breakpoints is for counting the number of times a certain point is reached.

If the C<stacktrace> key is set to C<true> then a stack trace of the
location where the breakpoint was hit will be included. This can be
used both with and without `suspend`; with the C<suspend> key set to
C<True> it can save an extra round-trip to request the stack location,
while with C<suspend> key set to C<False> it can be useful for features
like "capture a stack trace every time foo is called".
If the `stacktrace` key is set to `true` then a stack trace of the location where the breakpoint was hit will be included. This can be used both with and without `suspend`; with the `suspend` key set to `True` it can save an extra round-trip to request the stack location, while with `suspend` key set to `False` it can be useful for features like "capture a stack trace every time foo is called".

```raku
{
type => 15, # MT_SetBreakpointRequest
id => $new-request-id,
Expand Down
8 changes: 3 additions & 5 deletions doc/MoarVM-Remote.rakudoc
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ with one hash per running thread, providing information about that
thread. It also contains an indication of whether the thread was
suspended, and the number of locks it is currently holding.

The "name" key was added in version 1.2
The C<name> key was added in version 1.2.

=begin code :lang<raku>

Expand Down Expand Up @@ -398,8 +398,6 @@ The "name" key was added in version 1.2

=end code

=begin code :lang<raku>

=head3 Thread Stack Trace Request (13)

Request the stack trace of a thread. This is only allowed if that
Expand Down Expand Up @@ -463,8 +461,6 @@ or C<Nil> if there is none.

=end code

=begin code :lang<raku>

=head3 Set Breakpoint Request (15)

Request to set a breakpoint at the specified location, or the closest
Expand All @@ -484,6 +480,8 @@ C<True> it can save an extra round-trip to request the stack location,
while with C<suspend> key set to C<False> it can be useful for features
like "capture a stack trace every time foo is called".

=begin code :lang<raku>

{
type => 15, # MT_SetBreakpointRequest
id => $new-request-id,
Expand Down

0 comments on commit b78d205

Please sign in to comment.