Skip to content

Commit 620a47a

Browse files
committed
chore: update docs
1 parent 7d5bd48 commit 620a47a

4 files changed

Lines changed: 9 additions & 6 deletions

File tree

content/docs/prologue/building.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ Different CMake switches are available to customize the build:
8282
- `-DARK_NO_STDLIB` to avoid the installation of the ArkScript standard library
8383
- `-DARK_SANITIZERS` to enable ASAN and UBSAN
8484
- `-DARK_UNITY_BUILD` to enable unity building (generally faster as it merges source files together), defaults to Off
85+
- `-DARK_STATIC` to build arkscript statically, defaults to Off
8586
- `-DARK_TESTS` to build the unit tests (separate target named `unittests`)
8687
- `-DARK_COVERAGE` to enable coverage analysis ; only works in conjunction with `-DARK_TESTS`, enables the `coverage` target: `cmake --build build --target coverage`
8788

content/docs/reference/testing_arkscript.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ draft: false
88
weight: 503
99
---
1010

11-
This page guides you through enabling and running ArkScript test suites, which is important when developping features for the language, to ensure it still works as intended.
11+
This page guides you through enabling and running ArkScript test suites, which is important when developing features for the language, to ensure it still works as intended.
1212

1313
## Running the test suites
1414

15-
When builing ArkScript, you can build the tests using the CMake configuration flag `-DARK_TESTS=On`. It will generate an additional target `unittests`.
15+
When building ArkScript, you can build the tests using the CMake configuration flag `-DARK_TESTS=On`. It will generate an additional target `unittests`.
1616

1717
Run the `unittests` target to:
1818
- run various C++ unit tests,

content/docs/tutorials/debugging.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ ArkScript has a debugger built into its VM, that usually do not trigger, unless
2626
- `q` or `quit`: quit the debugger and stop the script execution
2727
- `locals <n>`: display the last `n` locals in the current scope (default: 5)
2828
- `stack <n>`: display the last `n` values on the stack (default: 5)
29+
- `ptr`: show the values of the VM pointers
30+
- `trace <n>`: show the last n executed instructions (default: 10)
2931

3032
## Using the debugger on error
3133

hugo_stats.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,7 @@
321321
"append",
322322
"append-1",
323323
"appendtofile",
324+
"apply",
324325
"arccos",
325326
"arcsin",
326327
"arctan",
@@ -330,7 +331,7 @@
330331
"arkscript",
331332
"arkscript-bytecode-headers",
332333
"arkscript-guidelines",
333-
"arkscript-v440-documentation",
334+
"arkscript-v441-documentation",
334335
"as-is",
335336
"asciiletters",
336337
"asciilowercase",
@@ -518,7 +519,6 @@
518519
"example-58",
519520
"example-59",
520521
"example-6",
521-
"example-60",
522522
"example-7",
523523
"example-8",
524524
"example-9",
@@ -555,6 +555,7 @@
555555
"fuzzing",
556556
"gcd",
557557
"generating-documentation",
558+
"gensym",
558559
"get",
559560
"getorelse",
560561
"getting-a-list-of-documented-functions--macros",
@@ -763,7 +764,6 @@
763764
"parameters-41",
764765
"parameters-42",
765766
"parameters-43",
766-
"parameters-44",
767767
"parameters-5",
768768
"parameters-6",
769769
"parameters-7",
@@ -776,7 +776,6 @@
776776
"parting-words",
777777
"partition",
778778
"permutations",
779-
"permutationswithreplacement",
780779
"pi",
781780
"placing-breakpoints",
782781
"platform",
@@ -921,6 +920,7 @@
921920
"using-docker",
922921
"using-macros-to-manipulate-code-at-compile-time",
923922
"using-the-debugger-on-error",
923+
"utf8len",
924924
"value",
925925
"values",
926926
"values-table",

0 commit comments

Comments
 (0)