Skip to content

Commit 8d6143f

Browse files
Update documentation
1 parent 2499319 commit 8d6143f

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/reference-manual/native-image/guides/debug-native-executables-with-gdb.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -580,21 +580,21 @@ If the C data structures cannot be printed by the SVM pretty printer, printing i
580580

581581
The pretty printer also supports printing of the primitive value instead of a Java Object for boxed primitives.
582582

583-
Whenever printing is done via the `p` (alias for `print`) the pretty printer intercepts that call to perform type casts to the respective runtime types of Java Objects.
584-
This also applies for auto-completion when using the `p` command.
585-
This means, if the static type is different to the runtime type, `print` uses the static types, which leaves finding out the runtime types and type casting to the user.
586-
Additionally, the `p` command understands Java field and array access and function calls for Java Objects.
583+
Whenever printing is done via the `p` alias of the `print` command the pretty printer intercepts that call to perform type casts to the respective runtime types of Java Objects.
584+
This also applies for auto-completion when using the `p` alias.
585+
This means that if the static type is different to the runtime type, the `print` command uses the static types, which leaves finding out the runtime types and type casting to the user.
586+
Additionally, the `p` alias understands Java field and array access and function calls for Java Objects.
587587

588588
##### Limitations
589589

590-
The `print` still uses its default implementation, as there is no way to overwrite it, while still keeping the capability of the default `print` command.
590+
The `print` command still uses its default implementation, as there is no way to overwrite it, while still keeping the capability of the default `print` command.
591591
This would cause printing non-Java Objects to not work properly.
592-
Therefore, only the alias `p` for the `print` command is overwritten by the SVM pretty printer, such that the user can still make use of GDBs default `print` command.
592+
Therefore, only the `p` alias for the `print` command is overwritten by the SVM pretty printer, such that the user can still make use of GDBs default `print` command.
593593

594594

595595
#### Options for controlling the behavior of the SVM Pretty Printer
596596

597-
In addition to the enhanced `p` command `svmhelpers.py` introduces some GDB parameters to customize the behavior of the SVM Pretty Printer.
597+
In addition to the enhanced `p` alias, `svmhelpers.py` introduces some GDB parameters to customize the behavior of the SVM Pretty Printer.
598598
Parameters in GDB can be interacted with `set <param> <value>` and `show <param>` and therefore, integrates into GDBs customization options.
599599

600600
* ##### svm-print on/off
@@ -620,28 +620,28 @@ Alternatively SVM pretty printing can be suppressed with the
620620
* ##### svm-print-string-limit &lt;int&gt;
621621

622622
Allows to customize the maximum length for pretty printing Java Strings.
623-
The default value is 200, set to -1 or _unlimited_ for unlimited printing of Java Strings.
623+
The default value is `200`, set to `-1` or `unlimited` for unlimited printing of Java Strings.
624624
This does not change the limit for c strings, which can be controlled with GDBs `set print characters`.
625625

626626
* ##### svm-print-element-limit &lt;int&gt;
627627

628628
Allows to customize the maximum number of elements for pretty printing Java Arrays, ArrayLists and HashMaps.
629-
The default value is 10, set to -1 or _unlimited_ for printing unlimited number of elements.
629+
The default value is `10`, set to `-1` or `unlimited` for printing unlimited number of elements.
630630
This does not change the limit for c arrays, which can be controlled with GDBs `set print elements`.
631631
However, GDBs parameter `print elements` is the upper bound for `svm-print-element-limit`.
632632

633633
* ##### svm-print-field-limit &lt;int&gt;
634634

635635
Allows to customize the maximum number of elements for pretty printing fields of Java Objects.
636-
The default value is 50, set to -1 or _unlimited_ for printing unlimited number of fields.
636+
The default value is `50`, set to `-1` or `unlimited` for printing unlimited number of fields.
637637
GDBs parameter `print elements` is the upper bound for `svm-print-field-limit`.
638638

639639
* ##### svm-print-depth-limit &lt;int&gt;
640640

641641
Allows to customize the maximum depth of recursive svm pretty printing.
642-
The default value is 1.
642+
The default value is `1`.
643643
The children of direct children are printed (a sane default to make contents of boxed values visible).
644-
Set to -1 or _unlimited_ for printing unlimited depth.
644+
Set to `-1` or `unlimited` for printing unlimited depth.
645645
GDBs parameter `print max-depth` is the upper bound for `svm-print-depth-limit`.
646646

647647
* ##### svm-use-hlrep on/off
@@ -653,8 +653,8 @@ Currently supports ArrayList and HashMap.
653653
* ##### svm-infer-generics &lt;int&gt;
654654

655655
Allows to customize the amount of elements taken into account for inferring the generic type of higher level representations.
656-
The default value is 10.
657-
Set to 0 for not inferring generic types and -1 or _unlimited_ for inferring the generic type over all elements.
656+
The default value is `10`.
657+
Set to `0` for not inferring generic types and `-1` or `unlimited` for inferring the generic type over all elements.
658658

659659
* ##### svm-print-address absolute/on/off
660660

@@ -669,7 +669,7 @@ This command allows to customize this behavior.
669669

670670
* ##### svm-complete-static-variables on/off
671671

672-
Per default static field members completion is provided by the **p** command.
672+
Per default auto-completion for static fields is enabled for the enhanced `p` alias.
673673
This command allows to enable/disable completion for static field members.
674674

675675
* ##### svm-selfref-check on/off

0 commit comments

Comments
 (0)