Skip to content

Commit f689a15

Browse files
committed
make clear the notation of /regexp/ in doc
1 parent 37abde3 commit f689a15

File tree

2 files changed

+20
-32
lines changed

2 files changed

+20
-32
lines changed

README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -567,10 +567,8 @@ The `<...>` notation means the argument.
567567
* break and run `<command>` before stopping.
568568
* `b[reak] ... do: <command>`
569569
* break and run `<command>`, and continue.
570-
* `b[reak] ... path: </path_regexp/>`
571-
* break if the triggering event's path matches </path_regexp/>.
572-
* `b[reak] ... path: <path_string>`
573-
* break if the triggering event's path matches <path_string>.
570+
* `b[reak] ... path: <path>`
571+
* break if the path matches to `<path>`. `<path>` can be a regexp with `/regexp/`.
574572
* `b[reak] if: <expr>`
575573
* break if: `<expr>` is true at any lines.
576574
* Note that this feature is super slow.
@@ -582,10 +580,8 @@ The `<...>` notation means the argument.
582580
* runs `<command>` before stopping.
583581
* `catch ... do: <command>`
584582
* stops and run `<command>`, and continue.
585-
* `catch ... path: </path_regexp/>`
586-
* stops if the exception is raised from a path that matches </path_regexp/>.
587-
* `catch ... path: <path_string>`
588-
* stops if the exception is raised from a path that matches <path_string>.
583+
* `catch ... path: <path>`
584+
* stops if the exception is raised from a `<path>`. `<path>` can be a regexp with `/regexp/`.
589585
* `watch @ivar`
590586
* Stop the execution when the result of current scope's `@ivar` is changed.
591587
* Note that this feature is super slow.
@@ -595,10 +591,8 @@ The `<...>` notation means the argument.
595591
* runs `<command>` before stopping.
596592
* `watch ... do: <command>`
597593
* stops and run `<command>`, and continue.
598-
* `watch ... path: </path_regexp/>`
599-
* stops if the triggering event's path matches </path_regexp/>.
600-
* `watch ... path: <path_string>`
601-
* stops if the triggering event's path matches <path_string>.
594+
* `watch ... path: <path>`
595+
* stops if the path matches `<path>`. `<path>` can be a regexp with `/regexp/`.
602596
* `del[ete]`
603597
* delete all breakpoints.
604598
* `del[ete] <bpnum>`
@@ -637,8 +631,8 @@ The `<...>` notation means the argument.
637631
* Show information about accessible constants except toplevel constants.
638632
* `i[nfo] g[lobal[s]]`
639633
* Show information about global variables
640-
* `i[nfo] ... </pattern/>`
641-
* Filter the output with `</pattern/>`.
634+
* `i[nfo] ... /regexp/`
635+
* Filter the output with `/regexp/`.
642636
* `i[nfo] th[read[s]]`
643637
* Show all threads (same as `th[read]`).
644638
* `o[utline]` or `ls`
@@ -689,8 +683,8 @@ The `<...>` notation means the argument.
689683
* Add an exception tracer. It indicates raising exceptions.
690684
* `trace object <expr>`
691685
* Add an object tracer. It indicates that an object by `<expr>` is passed as a parameter or a receiver on method call.
692-
* `trace ... </pattern/>`
693-
* Indicates only matched events to `</pattern/>` (RegExp).
686+
* `trace ... /regexp/`
687+
* Indicates only matched events to `/regexp/`.
694688
* `trace ... into: <file>`
695689
* Save trace information into: `<file>`.
696690
* `trace off <num>`

lib/debug/session.rb

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -511,10 +511,8 @@ def process_command line
511511
# * break and run `<command>` before stopping.
512512
# * `b[reak] ... do: <command>`
513513
# * break and run `<command>`, and continue.
514-
# * `b[reak] ... path: </path_regexp/>`
515-
# * break if the triggering event's path matches </path_regexp/>.
516-
# * `b[reak] ... path: <path_string>`
517-
# * break if the triggering event's path matches <path_string>.
514+
# * `b[reak] ... path: <path>`
515+
# * break if the path matches to `<path>`. `<path>` can be a regexp with `/regexp/`.
518516
# * `b[reak] if: <expr>`
519517
# * break if: `<expr>` is true at any lines.
520518
# * Note that this feature is super slow.
@@ -569,10 +567,8 @@ def process_command line
569567
# * runs `<command>` before stopping.
570568
# * `catch ... do: <command>`
571569
# * stops and run `<command>`, and continue.
572-
# * `catch ... path: </path_regexp/>`
573-
# * stops if the exception is raised from a path that matches </path_regexp/>.
574-
# * `catch ... path: <path_string>`
575-
# * stops if the exception is raised from a path that matches <path_string>.
570+
# * `catch ... path: <path>`
571+
# * stops if the exception is raised from a `<path>`. `<path>` can be a regexp with `/regexp/`.
576572
when 'catch'
577573
check_postmortem
578574

@@ -593,10 +589,8 @@ def process_command line
593589
# * runs `<command>` before stopping.
594590
# * `watch ... do: <command>`
595591
# * stops and run `<command>`, and continue.
596-
# * `watch ... path: </path_regexp/>`
597-
# * stops if the triggering event's path matches </path_regexp/>.
598-
# * `watch ... path: <path_string>`
599-
# * stops if the triggering event's path matches <path_string>.
592+
# * `watch ... path: <path>`
593+
# * stops if the path matches `<path>`. `<path>` can be a regexp with `/regexp/`.
600594
when 'wat', 'watch'
601595
check_postmortem
602596

@@ -706,8 +700,8 @@ def process_command line
706700
# * Show information about accessible constants except toplevel constants.
707701
# * `i[nfo] g[lobal[s]]`
708702
# * Show information about global variables
709-
# * `i[nfo] ... </pattern/>`
710-
# * Filter the output with `</pattern/>`.
703+
# * `i[nfo] ... /regexp/`
704+
# * Filter the output with `/regexp/`.
711705
# * `i[nfo] th[read[s]]`
712706
# * Show all threads (same as `th[read]`).
713707
when 'i', 'info'
@@ -841,8 +835,8 @@ def process_command line
841835
# * Add an exception tracer. It indicates raising exceptions.
842836
# * `trace object <expr>`
843837
# * Add an object tracer. It indicates that an object by `<expr>` is passed as a parameter or a receiver on method call.
844-
# * `trace ... </pattern/>`
845-
# * Indicates only matched events to `</pattern/>` (RegExp).
838+
# * `trace ... /regexp/`
839+
# * Indicates only matched events to `/regexp/`.
846840
# * `trace ... into: <file>`
847841
# * Save trace information into: `<file>`.
848842
# * `trace off <num>`

0 commit comments

Comments
 (0)