* Migrate standard library doc page to markdown
* Improve libraries listing and link to source code
* Fix grammar and improve phrasing
Co-authored-by: Jeremy Evans <code@jeremyevans.net>
The inspect format was intentionally changed as an outcome of
[Bug #20433] [ruby-core:118668], but some documentation update
was missing, as [Bug #20962] pointed out. Update some output
examples that clearly use Hash#inspect.
* Add back summary table for pack/unpack directives
* This concise summary is very helpful e.g. to find the right Integer
directive, and is much better at getting an overview than very long text.
* From https://github.com/ruby/ruby/pull/6567
* I merged the tables for Array#pack and String#unpack,
there were almost the same except for String and Misc. directives.
* Tune up the tabular data and moves it to the top.
Co-authored-by: Burdette Lamar <BurdetteLamar@Yahoo.com>
Co-authored-by: Stan Lo <stan001212@gmail.com>
* Clarify “Building Ruby” docs
* Fix test examples to work from `build` dir
* Clarify “Testing Ruby” examples with real examples
All the commands should run correctly by default, without the user needing to modify them. This builds confidence that the relative paths are working correct from within the `build` directory.
Also, let’s use a consistent example throughout, for greater clarity.
* Improve examples to use `-v` flag in-context
This shows the correct way to combine `-v` with another parameter, e.g. a specific file to test.
* Other readability improvements
* Clarify `make` implementation support
* Fix WASM bullet/code indentation
* Use `console` code highlighting where appropriate
… which handles the prefix `$` correctly.
* Migrate feature proposal template to MarkDown
* Set language on code blocks
This reverts commit 743a31d639,
"[ruby/date] [DOC] Make document coverage 100%". This file is only
for rdoc coverage in the date gem, and useless when the built-in Time
is documented.
* YJIT: Add `--yjit-compilation-log` flag to print out the compilation log at exit.
* YJIT: Add an option to enable the compilation log at runtime.
* YJIT: Fix a typo in the `IseqPayload` docs.
* YJIT: Add stubs for getting the YJIT compilation log in memory.
* YJIT: Add a compilation log based on a circular buffer to cap the log size.
* YJIT: Allow specifying either a file or directory name for the YJIT compilation log.
The compilation log will be populated as compilation events occur. If a directory is supplied, then a filename based on the PID will be used as the write target. If a file name is supplied instead, the log will be written to that file.
* YJIT: Add JIT compilation of C function substitutions to the compilation log.
* YJIT: Add compilation events to the circular buffer even if output is sent to a file.
Previously, the two modes were treated as being exclusive of one another. However, it could be beneficial to log all events to a file while also allowing for direct access of the last N events via `RubyVM::YJIT.compilation_log`.
* YJIT: Make timestamps the first element in the YJIT compilation log tuple.
* YJIT: Stream log to stderr if `--yjit-compilation-log` is supplied without an argument.
* YJIT: Eagerly compute compilation log messages to avoid hanging on to references that may GC.
* YJIT: Log all compiled blocks, not just the method entry points.
* YJIT: Remove all compilation events other than block compilation to slim down the log.
* YJIT: Replace circular buffer iterator with a consuming loop.
* YJIT: Support `--yjit-compilation-log=quiet` as a way to activate the in-memory log without printing it.
Co-authored-by: Randy Stauner <randy.stauner@shopify.com>
* YJIT: Promote the compilation log to being the one YJIT log.
Co-authored-by: Randy Stauner <randy.stauner@shopify.com>
* Update doc/yjit/yjit.md
* Update doc/yjit/yjit.md
---------
Co-authored-by: Randy Stauner <randy.stauner@shopify.com>
Co-authored-by: Maxime Chevalier-Boisvert <maximechevalierb@gmail.com>
Stan Lo