mirror of https://github.com/mruby/mruby synced 2026-06-08 16:11:16 +00:00

Files

T

Yukihiro "Matz" Matsumoto 3e5e84e391 mruby-task: update README and headers for ports-based HAL layout

The HAL was integrated into mruby-task/ports/{posix,win}/ in
be6413f0d8 and the function names were updated in 610ff67906, but
the docs and one header still described the old separate-gem layout:

  - mrbgems/mruby-task/README.md described hal-posix-task and
    hal-win-task as separate gems, used the pre-rename function
    names (mrb_task_hal_*), and omitted mrb_hal_task_sleep_us.
    Rewrote the HAL section to match the current ports/ model.

  - mrbgems/mruby-task/include/task.h had three orphan declarations
    (mrb_task_hal_init / _final / _idle_cpu) from before the
    rename. Removed; the real declarations are in task_hal.h.

  - mrbgems/mruby-task/include/task_hal.h had a comment referring
    to the removed hal-* gems.

  - doc/guides/amalgamation.md listed hal-posix-io and hal-posix-task
    as platform-specific gems alongside mruby-io and mruby-task; both
    are now ports under the parent gem.

Reported by Asmod4n in #6825.

Co-authored-by: Claude <noreply@anthropic.com>

2026-05-14 13:48:55 +09:00

guides

mruby-task: update README and headers for ports-based HAL layout

2026-05-14 13:48:55 +09:00

internal

doc/internal/gc.md: add practical tuning examples

2026-04-23 19:25:27 +09:00

limitations.md

limitations.md: document Class#initialize re-invocation difference

2026-05-13 12:02:30 +09:00

mruby3.0.md

Fix spelling

2024-09-24 00:14:24 +10:00

mruby3.1.md

mrbconf.h: rename MRB_WORDBOX_NO_FLOAT_TRUNCATE to MRB_WORDBOX_NO_INLINE_FLOAT

2026-02-27 10:30:01 +09:00

mruby3.2.md

Fix typo in mruby3.2 documentation

2025-07-25 16:10:03 +09:00

mruby3.3.md

Merge branch 'dearblue-doc/mruby3.3.md'

2024-02-14 09:29:54 +09:00

mruby3.4.md

misc: fix spelling

2025-05-14 02:01:02 +10:00

mruby4.0.md

Update version and release date. (mruby 4.0.0 (2026-04-20))

2026-04-20 17:43:06 +09:00

mruby_logo_red_icon.png

Add pre-commit hook oxipng for lossless PNG compression

2024-10-16 03:10:16 +10:00

README.md

doc: fix prettier formatting in markdown files

2026-03-12 14:33:37 +09:00

README.md

mruby Documentation

Getting Started

New to mruby? Start here:

Document	Description
Getting Started	Build mruby and run your first program
Language Features	Ruby subset supported by mruby
Limitations	Behavioral differences from CRuby

Guides (for embedders and gem authors)

Embedding mruby in C

Document	Description
C API Reference	Values, classes, methods, error handling, fibers
GC Arena	Managing temporary objects in C extensions
Linking	Linking with `libmruby`
Amalgamation	Single-file build for easy integration
Precompiled Symbols	Compile-time symbol allocation

Building and Configuring

Document	Description
Compilation	Build system, cross-compilation, toolchains
Build Configuration	Compile-time macros (`MRB_*` flags)
mrbgems	Creating and managing gems
Memory	Allocator customization and heap regions

Tools

Document	Description
Debugger	Using `mrdb` for debugging
ROM Method Tables	Read-only method tables for constrained devices

Reference

Document	Description
Directory Structure	Source tree layout

Internals (for mruby contributors)

Start with Architecture for an overview, then dive into the subsystem you need:

Document	Description
Architecture	Overview of object model, VM, GC, compiler
Virtual Machine	Dispatch loop, call frames, method lookup, fibers
Garbage Collector	Tri-color marking, write barriers, generational GC
Compiler Pipeline	Parser, code generator, IRep, binary format
Opcodes	VM instruction set reference
Value Boxing	How `mrb_value` encodes types

README.md

mruby Documentation

Getting Started

Guides (for embedders and gem authors)

Embedding mruby in C

Building and Configuring

Tools

Reference

Internals (for mruby contributors)

Release Notes