From 45e9205ab91bbb3e24c219285a5f4179fb6c969f Mon Sep 17 00:00:00 2001 From: "Sean T. Allen" Date: Sun, 18 Oct 2026 18:41:47 -0400 Subject: [PATCH] Remove stale ponyc --docs references The --docs flag was removed from ponyc when documentation generation moved to pony-doc. --- docs/appendices/compiler-args.md | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/docs/appendices/compiler-args.md b/docs/appendices/compiler-args.md index c38cb217..5c7f7f95 100644 --- a/docs/appendices/compiler-args.md +++ b/docs/appendices/compiler-args.md @@ -6,7 +6,7 @@ ponyc [OPTIONS] ``` -The most useful options are `--debug`, `--path` or just `-p`, `--output` or just `-o` and `--docs` or `-g`. +The most useful options are `--debug`, `--path` or just `-p`, and `--output` or just `-o`. `--debug` will skip the LLVM optimizations passes. This should not be mixed up with `make config=debug`, the default make configuration target. `config=debug` will create DWARF symbols, and add slower assertions to ponyc, but not to the generated binaries. For those, you can omit DWARF symbols with the `--strip` or `-s` option. @@ -14,17 +14,6 @@ The most useful options are `--debug`, `--path` or just `-p`, `--output` or just `--output` or `-o` takes a directory name where the final binary is created. -`--docs` or -`g` creates a directory of the module with documentation in [Read the Docs](https://readthedocs.org) format, i.e. markdown with nice navigation. - -Let's study the documentation of the builtin standard library: - -```bash -pip install mkdocs -ponyc packages/stdlib --docs && cd stdlib-docs && mkdocs serve -``` - -And point your web browser to [127.0.0.1:8000](http://127.0.0.1:8000) serving a live-reloading local version of the docs. - Note that there is _no built-in debugger_ to interactively step through your program and interpret the results. But ponyc creates proper DWARF symbols and you can step through your programs with a conventional debugger, such as GDB or LLDB. ## Runtime options for Pony programs