Refactor str_succ_bang for in-place modification

This commit refactors the str_succ_bang function in mrbgems/mruby-string-ext/src/string.c to perform string succession in-place.

The previous implementation used an intermediate temporary string, which incurred memory and performance overhead.
This change aims to reduce memory usage and improve performance by modifying the string buffer directly, using mrb_str_resize and memmove when prepending characters is necessary (e.g., '9' -> '10').

Formatting changes (newlines before 'else') have also been applied as per user request.

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+ignore-words = .github/linters/codespell.txt
+skip = ./build,./doc/api,./doc/capi

.dockerignore

@@ -0,0 +1,14 @@
+.DS_Store
+.idea
+.vscode
+.yardoc
+*.bak
+*.iml
+*.ipr
+*.swp
+*.tmp
+bin
+build
+doc/api
+doc/capi
+node_modules

.editorconfig

@@ -0,0 +1,30 @@
+# About this file, see:
+#   Website: https://editorconfig.org/
+#   For Emacs users: https://github.com/editorconfig/editorconfig-emacs
+#   For Vim users: https://github.com/editorconfig/editorconfig-vim
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+tab_width = 8
+trim_trailing_whitespace = true
+
+[{Makefile,Makefile.*,makefile,*.mk}]
+indent_style = tab
+#max_line_length = 80
+
+#[*.{c,cc,C,cxx,cpp,h,hh,H,hxx,hpp,inc,y}]
+#max_line_length = 120
+
+#[{*.rb,Rakefile,rakefile,*.rake,*.gemspec,*.gembox}]
+#max_line_length = 120
+
+# limitation to US-ASCII
+[*.bat]
+end_of_line = crlf
+#max_line_length = 80

.git-blame-ignore-revs

@@ -0,0 +1,8 @@
+# Extend the tab with 8 whitespace
+6fc5dc986a5ffc1a74c63ad0617ea1dcc10d3cdd
+# reformatted doc/opcode.md
+61e8a540869c57ebddac53cf9d243db407d57fff
+# reindent parse.y
+650ffb9d8410e1ae2206890ef6e2a8643c600454
+# reindent build_config/playstationportable.rb
+90ab714fda6825c4e951d47d7e6ecff033dd14e3

.gitattributes

@@ -0,0 +1,4 @@
+*       text=auto eol=lf
+*.bat   text eol=crlf
+*.cmd   text eol=crlf
+*.png   binary

.github/CODEOWNERS

@@ -0,0 +1 @@
+*   @matz

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/labeler.yml

@@ -0,0 +1,81 @@
+# https://github.com/actions/labeler
+benchmark:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file:
+              - benchmark/**/*
+build:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file:
+              - Dockerfile
+              - Doxyfile
+              - Makefile
+              - Rakefile
+              - appveyor.yml
+              - build_config.rb
+              - build_config/**/*
+              - docker-compose.yml
+              - lib/**/*
+              - minirake
+              - tasks/**/*
+              - .codespellrc
+              - .dockerignore
+              - .pre-commit-config.yaml
+              - .prettierignore
+              - .prettierrc
+              - .travis.yml
+              - .yardopts
+core:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file:
+              - include/**/*
+              - mrblib/**/*
+              - src/**/*
+              - test/**/*
+doc:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file:
+              - CONTRIBUTING.md
+              - LEGAL
+              - LICENSE
+              - NEWS
+              - README.md
+              - SECURITY.md
+              - TODO.md
+              - doc/**/*
+              - examples/**/*
+github:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file:
+              - .github/**/*
+miscellaneous:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file:
+              - .editorconfig
+              - .git-blame-ignore-revs
+              - .gitattributes
+              - .gitignore
+              - AUTHORS
+              - Gemfile
+              - Gemfile.lock
+              - mruby-source.gemspec
+mrbgems:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file:
+              - mrbgems/**/*
+oss-fuzz:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file:
+              - oss-fuzz/**/*
+tools:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file:
+              - tools/**/*

.github/linters/.ecrc

@@ -0,0 +1,12 @@
+{
+    "verbose": false,
+    "ignore_defaults": false,
+    "exclude": ["oss-fuzz/", "src/"],
+    "disable": {
+        "end_of_line": false,
+        "trim_trailing_whitespace": false,
+        "insert_final_newline": false,
+        "indent_size": true,
+        "indent_style": true
+   }
+}

.github/linters/.hadolint.yaml

@@ -0,0 +1,4 @@
+failure-threshold: info
+ignored:
+  - DL3008 # https://github.com/hadolint/hadolint/wiki/DL3008
+  - DL3013 # https://github.com/hadolint/hadolint/wiki/DL3013

.github/linters/.ls-lint.yml

@@ -0,0 +1,12 @@
+ls:
+  .c: snake_case
+  .cpp: snake_case
+  .h: snake_case
+  .json: snake_case
+  .rb: snake_case
+  .yaml: regex:\.?[a-z]+(-[a-z]+)*
+  .yml: regex:\.?[a-z]+(-[a-z]+)*
+
+ignore:
+  - build_config
+  - mrbgems/mruby-compiler/core/y.tab.c

.github/linters/.markdown-lint.yml

@@ -0,0 +1,33 @@
+# https://github.com/DavidAnson/markdownlint#rules--aliases
+# https://github.com/igorshubovych/markdownlint-cli
+# markdownlint -c .github/linters/.markdown-lint.yml .
+
+# MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time
+MD001: false
+
+# MD013 line-length - Line length
+MD013: false
+
+# MD014 commands-show-output - Dollar signs used before commands without showing output
+MD014: false
+
+# MD024 no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
+MD024: false
+
+# MD025 single-title/single-h1 - Multiple top-level headings in the same document
+MD025: false
+
+# MD026 no-trailing-punctuation - Trailing punctuation in heading
+MD026: false
+
+# MD029/ol-prefix Ordered list item prefix
+MD029: false
+
+# MD033/no-inline-html - Inline HTML
+MD033: false
+
+# MD040 fenced-code-language - Fenced code blocks should have a language specified
+MD040: false
+
+# MD041 first-line-heading/first-line-h1 - First line in a file should be a top-level heading
+MD041: false

.github/linters/.yaml-lint.yml

@@ -0,0 +1,11 @@
+---
+# https://yamllint.readthedocs.io/en/stable/
+# yamllint --strict -c .github/linters/.yaml-lint.yml .
+extends: default
+
+rules:
+  comments:
+    min-spaces-from-content: 1
+  document-start: disable
+  line-length: disable
+  truthy: false

.github/linters/codespell.txt

@@ -0,0 +1,16 @@
+ans
+celler
+clen
+delet
+disabl
+filetest
+fo
+hel
+ist
+nd
+quitt
+remore
+runn
+sting
+strin
+wronly

.github/linters/mlc_config.json

@@ -0,0 +1,10 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^https://github.com/mruby/mruby/commit/"
+    },
+    {
+      "pattern": "^mailto:"
+    }
+  ]
+}

.github/workflows/build.yml

@@ -1,106 +1,56 @@
+# https://github.com/actions/runner-images#available-images
 name: Build & Test
 
 on: [push, pull_request]
 
+permissions:
+  contents: read
+
 jobs:
-  Ubuntu-1604:
-    runs-on: ubuntu-16.04
+  GCC-CLANG:
+    name: "${{ matrix.os }}-${{ matrix.altname || matrix.cc }}"
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+      max-parallel: 8
+      matrix:
+        include:
+          - {os: ubuntu-24.04, cc: gcc, cxx: g++}
+          - {os: ubuntu-24.04, cc: clang, cxx: clang++}
+          - {os: ubuntu-22.04, cc: gcc, cxx: g++}
+          - {os: ubuntu-22.04, cc: clang, cxx: clang++}
+          - {os: macos-15, cc: clang, cxx: clang++}
+          - {os: macos-14, cc: clang, cxx: clang++}
+          - {os: windows-2025, cc: gcc, cxx: g++, altname: "mingw-gcc"}
+          - {os: windows-2022, cc: gcc, cxx: g++, altname: "mingw-gcc"}
+    env:
+      MRUBY_CONFIG: ci/gcc-clang
+      CC: ${{ matrix.cc }}
+      CXX: ${{ matrix.cxx }}
+      LD: ${{ matrix.cc }}
     steps:
-    - uses: actions/checkout@v1
-    - name: apt
-      run: sudo apt install ruby gperf
-    - name: build and test
-      run: rake -m -j4 all test
-      env:
-        MRUBY_CONFIG: travis_config.rb
-
-  Ubuntu-1804-gcc:
-    runs-on: ubuntu-18.04
-    steps:
-    - uses: actions/checkout@v1
-    - name: apt
-      run: sudo apt install ruby gperf gcc g++
-    - name: build and test
-      run: rake -m -j4 all test
-      env:
-        MRUBY_CONFIG: travis_config.rb
-        CC: gcc
-        CXX: g++
-
-  Ubuntu-1804-clang:
-    runs-on: ubuntu-18.04
-    steps:
-    - uses: actions/checkout@v1
-    - name: apt
-      run: sudo apt install ruby gperf
-    - name: build and test
-      run: rake -m -j4 all test
-      env:
-        MRUBY_CONFIG: travis_config.rb
-        CC: clang
-        CXX: clang++
-
-  macOS:
-    runs-on: macos-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: brew
-      run: brew install ruby gperf
-    - name: build and test
-      run: rake -m -j4 all test
-      env:
-        MRUBY_CONFIG: travis_config.rb
-
-  Windows-MinGW:
-    runs-on: windows-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: chocolatey
-      run: choco install -y ruby gperf
-    - name: build and test
-      run: rake -E '$stdout.sync=true' -j4 test
-      env:
-        MRUBY_CONFIG: travis_config.rb
-        CFLAGS: -g -O1 -Wall -Wundef
-
-  Windows-Cygwin:
-    runs-on: windows-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: actions/cache@v1
-      with:
-        path: C:\Users\runneradmin\AppData\Local\Temp\chocolatey
-        key: ${{ runner.os }}-cygwin-chocolatey-${{ matrix.os }}-${{ github.sha }}
-        restore-keys: |
-          ${{ runner.os }}-cygwin-chocolatey-${{ matrix.os }}-
-          ${{ runner.os }}-cygwin-chocolatey-
-    - name: chocolatey
-      run: choco install -y cygwin
-    - name: Install cygwin packages
-      shell: cmd
-      run: C:\tools\cygwin\cygwinsetup.exe -qgnNdO -R C:/tools/cygwin -l C:/tools/cygwin/package -s http://mirrors.kernel.org/sourceware/cygwin/ -P gcc-core,gcc-g++,make,gperf,ruby
-    - name: Set ENV
-      run: |
-        echo '::set-env name=PATH::C:\tools\cygwin\bin;C:\tools\cygwin\usr\bin'
-    - name: build and test
-      shell: cmd
-      run: C:\tools\cygwin\bin\ruby.exe /usr/bin/rake -m -j4 -E 'STDOUT.sync=true' test
-      env:
-        MRUBY_CONFIG: travis_config.rb
+      - name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
+        uses: actions/checkout@v4
+      - name: Ruby version
+        run: ruby -v
+      - name: Compiler version
+        run: ${{ env.CC }} --version
+      - name: Build and test
+        run: rake -m test:run:serial
 
   Windows-VC:
-    runs-on: windows-latest
+    runs-on: windows-2022
+    timeout-minutes: 10
+    env:
+      MRUBY_CONFIG: ci/msvc
     steps:
-    - uses: actions/checkout@v1
-    - name: chocolatey
-      run: choco install -y ruby gperf
-    - name: build and test
-      shell: cmd
-      run: |
-        call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvars64.bat"
-        rake -E "STDOUT.sync=true" -m -j4 test
-      env:
-        MRUBY_CONFIG: appveyor_config.rb
-        # TODO(take-cheeze): Re-enable /O2
-        CFLAGS: "/c /nologo /W3 /we4013 /Zi /MD /D_CRT_SECURE_NO_WARNINGS"
-        CXXFLAGS: "/c /nologo /W3 /Zi /MD /EHs /D_CRT_SECURE_NO_WARNINGS"
+      - name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
+        uses: actions/checkout@v4
+      - name: Ruby version
+        run: ruby -v
+      - name: Build and test
+        shell: cmd
+        run: |
+          call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvars64.bat"
+          rake -m test:run:serial

.github/workflows/codeql-analysis.yml

@@ -1,51 +0,0 @@
-name: "Code scanning - action"
-
-on:
-  push:
-  pull_request:
-  schedule:
-    - cron: '0 19 * * 4'
-
-jobs:
-  CodeQL-Build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-      with:
-        # We must fetch at least the immediate parents so that if this is
-        # a pull request then we can checkout the head.
-        fetch-depth: 2
-
-    # If this run was triggered by a pull request event, then checkout
-    # the head of the pull request instead of the merge commit.
-    - run: git checkout HEAD^2
-      if: ${{ github.event_name == 'pull_request' }}
-      
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      # Override language selection by uncommenting this and choosing your languages
-      # with:
-      #   languages: go, javascript, csharp, python, cpp, java
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1

.github/workflows/coverage.yml

@@ -0,0 +1,41 @@
+name: Coverage
+
+on: [push]
+
+jobs:
+  coverage:
+    name: Coverage
+    runs-on: ubuntu-24.04
+    env:
+      MRUBY_CONFIG: ci/gcc-clang
+      CC: clang-18
+      CXX: clang++-18
+      LD: clang-18
+      CFLAGS: -O0 -g --coverage
+      CXXFLAGS: -O0 -g --coverage
+      LDFLAGS: --coverage
+    steps:
+      - name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
+        uses: actions/checkout@v4
+      - name: Ruby version
+        run: ruby -v
+      - name: Compiler version
+        run: ${{ env.CC }} --version
+      - name: Build and test
+        run: rake test
+      - name: Install gcovr
+        run: pip install gcovr
+      - name: Generate coverage report
+        run: |
+          {
+            echo "# Coverage report"
+            echo \`\`\`
+            gcovr --gcov-executable "llvm-cov-18 gcov" -e ".*_test.c" -e ".*/test/.*" -s --html-details -o coverage/ build
+            echo \`\`\`
+          } > "$GITHUB_STEP_SUMMARY"
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{ github.sha }}
+          path: coverage/
+          retention-days: 3

.github/workflows/labeler.yml

@@ -0,0 +1,15 @@
+# https://github.com/actions/labeler
+name: Pull Request Labeler
+on:
+  - pull_request_target
+jobs:
+  triage:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/labeler@v5
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          sync-labels: true

.github/workflows/lint.yml

@@ -0,0 +1,35 @@
+# https://pre-commit.com/
+name: Lint
+
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  pre-commit:
+    name: Run pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
+        uses: actions/checkout@v4
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install pre-commit
+      - name: Set PY
+        run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> "$GITHUB_ENV"
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+      - name: Run pre-commit
+        run: pre-commit run --all-files
+  ls-lint:
+    name: Run ls-lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ls-lint/action@v2.3.1
+        with:
+          config: .github/linters/.ls-lint.yml

.github/workflows/main.yml

@@ -1,24 +0,0 @@
-name: CIFuzz
-on: [pull_request]
-jobs:
-  Fuzzing:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Build Fuzzers
-      uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master
-      with:
-        oss-fuzz-project-name: 'mruby'
-        dry-run: false
-    - name: Run Fuzzers
-      uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master
-      with:
-        oss-fuzz-project-name: 'mruby'
-        fuzz-seconds: 600
-        dry-run: false
-    - name: Upload Crash
-      uses: actions/upload-artifact@v1
-      if: failure()
-      with:
-        name: artifacts
-        path: ./out/artifacts
-

.github/workflows/oss-fuzz.yml

@@ -0,0 +1,27 @@
+# https://github.com/google/oss-fuzz
+name: CIFuzz
+on: [pull_request]
+permissions:
+  contents: read
+
+jobs:
+  Fuzzing:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build Fuzzers
+        uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master
+        with:
+          oss-fuzz-project-name: "mruby"
+          dry-run: false
+      - name: Run Fuzzers
+        uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master
+        with:
+          oss-fuzz-project-name: "mruby"
+          fuzz-seconds: 600
+          dry-run: false
+      - name: Upload Crash
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: artifacts
+          path: ./out/artifacts

.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Release Builds
+
+on:
+  push:
+    tags:
+      - "*.*.*"
+
+permissions: read-all
+
+jobs:
+  source:
+    name: Source Code Releasing
+    if: ${{ github.repository == 'mruby/mruby' }}
+    permissions:
+      contents: write
+    runs-on: ubuntu-22.04
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+    steps:
+      - name: "Checkout ${{ github.ref_name }} ( ${{ github.sha }} )"
+        uses: actions/checkout@v4
+      - name: Builds
+        id: builds
+        run: |
+          tagname="$GITHUB_REF_NAME"
+          packagename="mruby-$tagname"
+          destdir=packages
+
+          mkdir -p "$destdir"
+          git archive --format zip --prefix "$packagename/" -o "$destdir/$packagename.zip" "$GITHUB_REF"
+          git archive --format tar.gz --prefix "$packagename/" -o "$destdir/$packagename.tar.gz" "$GITHUB_REF"
+          gunzip -c "$destdir/$packagename.tar.gz" | xz > "$destdir/$packagename.tar.xz"
+
+          (
+            cd "$destdir" || exit
+            sha256sum -- * > .sha256
+            mv .sha256 "$packagename.sha256"
+          )
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          draft: true
+          prerelease: ${{ contains(github.ref_name, '-rc') }}
+          body_path: NEWS
+          files: packages/*

.github/workflows/super-linter.yml

@@ -0,0 +1,31 @@
+# https://github.com/super-linter/super-linter
+name: Super-Linter
+
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    permissions:
+      contents: read # for actions/checkout to fetch code
+      statuses: write # for super-linter/super-linter/slim to mark status of each linter run
+    name: Lint Code Base
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
+        uses: actions/checkout@v4
+        with:
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
+      - name: Lint Code Base
+        uses: super-linter/super-linter/slim@v7.4.0
+        env:
+          # VALIDATE_BASH_EXEC: true
+          VALIDATE_DOCKERFILE_HADOLINT: true
+          # VALIDATE_EDITORCONFIG: true
+          # VALIDATE_SHELL_SHFMT: true
+          DEFAULT_BRANCH: master
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VALIDATE_ALL_CODEBASE: true

.gitignore

@@ -1,8 +1,8 @@
-*.lock
 *.bak
 *.bc
 *.d
 *.i
+*.lock
 *.o
 *.orig
 *.pdb
@@ -13,25 +13,27 @@
 *.tmp
 *~
 .DS_Store
+.cache
+.ccls*
 .ccmalloc
+.git
 .svn
 .vscode
 .yardoc
-.ccls*
-compile_flags.txt
+benchmark/**/*.dat
+benchmark/*.pdf
+benchmark/*.png
+bin
+build
+doc/api
+doc/capi
 compile_commands.json
+compile_flags.txt
 cscope.files
 cscope.out
+gmon.out
+mruby-source-*.gem
+node_modules
+perf.data*
 tags
-
-/.git
-/bin
-/build
-/mruby-source-*.gem
-
-/benchmark/**/*.dat
-/benchmark/*.pdf
-/benchmark/*.png
-
-/doc/api
-/doc/capi
+!Gemfile.lock

.pre-commit-config.yaml

@@ -0,0 +1,132 @@
+---
+# https://pre-commit.com/
+default_stages: [pre-commit, pre-push]
+default_language_version:
+  # force all unspecified Python hooks to run python3
+  python: python3
+  # force all unspecified Node hooks to run Node.js v22.15.0 LTS
+  node: 22.15.0
+minimum_pre_commit_version: "3.2.0"
+exclude: "^tools/lrama/"
+repos:
+  - repo: meta
+    hooks:
+      - id: identity
+        name: run identity
+        description: check your identity
+      - id: check-hooks-apply
+        name: run check-hooks-apply
+        description: check hooks apply to the repository
+  - repo: local
+    hooks:
+      - id: prettier
+        name: run prettier
+        description: format files with prettier
+        entry: prettier --write .
+        files: \.(json|md|ya?ml)$
+        language: node
+        additional_dependencies: ["prettier@3.5.3"]
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.25.1
+    hooks:
+      - id: gitleaks
+        name: run gitleaks
+        description: detect hardcoded secrets with gitleaks
+  - repo: https://github.com/shssoichiro/oxipng
+    rev: v9.1.5
+    hooks:
+      - id: oxipng
+        name: run oxipng
+        description: use lossless compression to optimize PNG files
+        args: ["-o", "4", "--strip", "safe", "--alpha"]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+        exclude: ^test/t/lang\.rb$
+      - id: check-illegal-windows-names
+      - id: pretty-format-json
+        args: [--autofix, --no-sort-keys]
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-vcs-permalinks
+      - id: check-yaml
+      - id: destroyed-symlinks
+      - id: detect-aws-credentials
+        args: [--allow-missing-credentials]
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: file-contents-sorter
+        args: [--unique]
+        files: ^\.github/linters/codespell\.txt$
+      - id: fix-byte-order-marker
+      - id: forbid-submodules
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.5
+    hooks:
+      - id: forbid-tabs
+        name: run no-tabs checker
+        description: check the codebase for tabs
+        exclude: Makefile$
+      - id: remove-tabs
+        name: run tabs remover
+        description: find and convert tabs to spaces
+        args: [--whitespaces-count, "2"]
+        exclude: Makefile$
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.7
+    hooks:
+      - id: actionlint
+        name: run actionlint
+        description: lint GitHub Actions workflow files
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        name: run codespell
+        description: check spelling with codespell
+  - repo: https://github.com/jumanjihouse/pre-commit-hooks
+    rev: 3.0.0
+    hooks:
+      - id: script-must-not-have-extension
+        name: run script-must-not-have-extension
+        description: local policy is to exclude extension from all shell files
+        types: [shell]
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.44.0
+    hooks:
+      - id: markdownlint
+        name: run markdownlint
+        description: checks the style of Markdown files
+        args: [--config=.github/linters/.markdown-lint.yml]
+        types: [markdown]
+        files: \.md$
+  - repo: https://github.com/tcort/markdown-link-check
+    rev: v3.13.7
+    hooks:
+      - id: markdown-link-check
+        name: run markdown-link-check
+        description: checks hyperlinks in Markdown files
+        args: [--config=.github/linters/mlc_config.json, -q]
+        types: [markdown]
+        files: \.md$
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck
+        name: run shellcheck
+        description: check shell scripts with a static analysis tool
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.37.0
+    hooks:
+      - id: yamllint
+        name: run yamllint
+        description: check YAML files with yamllint
+        args: [--strict, -c=.github/linters/.yaml-lint.yml]
+        types: [yaml]
+        files: \.ya?ml$

.prettierignore

@@ -0,0 +1,5 @@
+# Ignore artifacts:
+build
+coverage
+doc/internal/opcode.md
+tools/lrama

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "bracketSpacing": false
+}

.travis.yml

@@ -5,7 +5,7 @@ jobs:
   - os: osx
 
 env:
-  - MRUBY_CONFIG=travis_config.rb
+  - MRUBY_CONFIG=ci/gcc-clang
 
 script:
-  - rake -m && rake test
+  - rake -m test:run:serial

.yardopts

@@ -11,7 +11,13 @@ mrbgems/*/src/**/*.c
 mrbgems/*/mrblib/**/*.rb
 mrbgems/*/include/**/*.h
 -
-AUTHORS
-LICENSE
 CONTRIBUTING.md
+SECURITY.md
+TODO.md
+doc/*.md
 doc/guides/*.md
+doc/internal/*.md
+AUTHORS
+LEGAL
+LICENSE
+NEWS

AUTHORS

@@ -1,45 +1,342 @@
-This is the (likely incomplete) list of "mruby developers".
-If you submit a patch to mruby, please add your name to the end
-of this list.
+# Authors of mruby (mruby developers)
 
-   Yukihiro Matsumoto (Matz)
+## The List of Contributors sorted by number of commits (as of 2025-06-03 a3e7280)
+
+   6258 Yukihiro "Matz" Matsumoto (@matz)*
+    681 dearblue (@dearblue)*
+    587 KOBAYASHI Shuji (@shuujii)
+    353 Daniel Bovensiepen (@bovi)*
+    345 Takeshi Watanabe (@take-cheeze)*
+    333 Masaki Muranaka (@monaka)
+    234 Jun Hiroe (@suzukaze)
+    233 John Bampton (@jbampton)
+    228 Tomoyuki Sahara (@tsahara)*
+    220 Cremno (@cremno)*
+    209 Yuki Kurihara (@ksss)+
+    144 Yasuhiro Matsumoto (@mattn)*
+    113 Carson McDonald (@carsonmcdonald)
+    104 Tomasz Pędraszewski (@dabroz)*
+     83 Akira Yumiyama (@akiray03)*
+     83 skandhas (@skandhas)
+     80 Masamitsu MURASE (@masamitsu-murase)
+     73 Hiroshi Mimaki (@mimaki)*
+     71 Tatsuhiko Kubo (@cubicdaiya)*
+     71 Yuichiro MASUI (@masuidrive)
+     62 Yuichiro Kaneko (@yui-knk)+
+     59 Kurebayashi, Takahiro (@crimsonwoods)*
+     56 h2so5 (@h2so5)
+     52 Ralph Desir (@Mav7)*
+     48 Paolo Bosetti (@pbosetti)*
+     45 Rory O'Connell (@RoryO)*
+     42 fleuria (@flaneur2020)
+     40 Christopher Aue (@christopheraue)
+     40 Seba Gamboa (@sagmor)
+     39 Kouhei Sutou (@kou)*
+     38 Koji Yoshioka (@kyab)*+
+     32 Masayoshi Takahashi (@takahashim)+
+     31 MATSUMOTO Ryosuke (@matsumotory)*
+     30 Nobuyoshi Nakada (@nobu)
+     26 Hoshiumi Arata (@hoshiumiarata)*
+     25 Julian Aron Prenner (@furunkel)*
+     22 Clayton Smith (@clayton-shopify)
+     22 Uchio Kondo (@udzura)*
+     22 Zachary Scott (@zzak)*
+     21 Ryan Lopopolo (@lopopolo)
+     20 Ryan Scott (@ryan-scott-dev)*
+     19 Bouke van der Bijl (@bouk)
+     19 Jared Breeden (@jbreeden)*
+     19 go kikuta (@gkta)*
+     18 Corey Powell (@IceDragon200)
+     18 Hidetaka Takano (@TJ-Hidetaka-Takano)
+     18 Jon Maken (@jonforums)+
+     18 leviongit (@leviongit)
+     18 mirichi (@mirichi)
+     17 Mitchell Blank Jr (@mitchblank)*
+     16 bggd (@bggd)
+     16 kano4 (@kano4)
+     15 Felix Jones (@felixjones)*
+     14 Blaž Hrastnik (@archseer)*
+     14 Kazuki Tsujimoto (@k-tsj)
+     14 Tadashi FUKUZAWA (@FUKUZAWA-Tadashi)+
+     14 fn ⌃ ⌥ (@FnControlOption)
+     13 Jose Narvaez (@goyox86)
+     13 Patrick Hogan (@pbhogan)
+     13 google-labs-jules[bot] (@google-jules)
+     12 Akira Kuroda (@akuroda)
+     12 Kouki Ooyatsu (kaishuu0123)*
+     12 NAKAMURA Usaku (@unak)*
+     12 Ray Chason (@chasonr)*
+     12 Takashi Sawanaka (@sdottaka)*
+     12 Ukrainskiy Sergey (@ukrainskiysergey)
+     12 Xuejie "Rafael" Xiao (@xxuejie)*
+     11 Julien Ammous (@schmurfy)
+     11 Kazuho Oku (@kazuho)
+     11 RIZAL Reckordp (@Reckordp)+
+     11 Seeker (@SeekingMeaning)
+     11 takkaw (@takkaw)
+     10 Miura Hideki (@miura1729)
+     10 Narihiro Nakamura (@authorNari)
+     10 YAMAMOTO Masaya (pandax381)
+     10 Yuichi Nishiwaki (@nyuichi)
+      9 Akira Mitsui (@murasesyuka)*
+      9 Frank Celler (@fceller)
+      9 Tatsuya Matsumoto (@tmash06)*
+      8 Takashi Sogabe (@sogabe)
+      8 Wataru Ashihara (@wataash)*
+      7 Bhargava Shastry (@bshastry)*
+      7 Kouichi Nakanishi (@keizo042)
+      7 Rubyist (@expeditiousRubyist)
+      7 SiZiOUS (@sizious)
+      7 Simon Génier (@simon-shopify)
+      7 Terence Lee (@hone)
+      7 roco (@rystyle)*
+      7 vickash (@vickash)
+      6 Akito Mochizuki (@ak-mochi)
+      6 Beoran (@beoran)
+      6 David Siaw (@davidsiaw)*
+      6 Frederick John Milens III (@fjmilens3)
+      6 HASUMI Hitoshi (@hasumikin)
+      6 Hiro Asari (@BanzaiMan)
+      6 INOUE Yasuyuki (@yasuyuki)
+      6 Junji Sawada (@junjis0203)
+      6 Kenji Okimoto (@okkez)+
+      6 Selman ULUG (@selman)
+      6 Yusuke Endoh (@mame)*
+      6 masahino (@masahino)
+      5 Chris Reuter (@suetanvil)
+      5 Davide D'Agostino (@DAddYE)
+      5 Eric Hodel (@drbrain)
+      5 Hendrik (@Asmod4n)
+      5 Ichito Nagata (@i110)
+      5 Keita Obo (@ktaobo)*
+      5 Max Anselm (@silverhammermba)
+      5 Rodrigo Malizia (@rmalizia44)+
+      5 Syohei YOSHIDA (@syohex)
+      5 TOMITA Masahiro (@tmtm)
+      5 Yurie Yamane (@yurie)+
+      5 dreamedge (@dreamedge)
+      5 nkshigeru (@nkshigeru)
+      5 xuejianqing (@joans321)
+      4 Dante Catalfamo (@dantecatalfamo)
+      4 Goro Kikuchi (@gorogit)
+      4 Herwin Weststrate (@herwinw)
+      4 Horimoto Yasuhiro (@komainu8)
+      4 Jon Moss (@maclover7)
+      4 Ken Muramatsu (@ken-mu)+
+      4 Kohei Suzuki (@eagletmt)
+      4 Lanza (@LanzaSchneider)
+      4 Li Yazhou (@flaneur2020)
+      4 Marcus Stollsteimer (@stomar)
+      4 Mark Delk (@jethrodaniel)
+      4 NARUSE, Yui (@nurse)
+      4 Ravil Bayramgalin (@brainopia)*+
+      4 Satoshi Odawara (@SatoshiOdawara)
+      4 Yuhei Okazaki (@Yuuhei-Okazaki)*
+      4 Yuji Yamano (@yyamano)
+      4 kurodash (@kurodash)*
+      4 wanabe (@wanabe)*
+      3 Anton Davydov (@davydovanton)
+      3 Aurora Nockert (@auroranockert)
+      3 Carlo Prelz (@asfluido)*
+      3 Daniel K. Sierpiński (@513ry)+
+      3 David Turnbull (@AE9RB)
+      3 Franck Verrot (@franckverrot)
+      3 Hirohito Higashi (@HirohitoHigashi)
+      3 J. Mutua (@katmutua)+
+      3 Jan Berdajs (@mrbrdo)
+      3 Jonas Minnberg (@sasq64)
+      3 Joseph McCullough (@joequery)
+      3 Mark McCurry (@fundamental)
+      3 Nobuhiro Iwamatsu (@iwamatsu)
+      3 Per Lundberg (@perlun)*
+      3 Rob Fors (@robfors)*
+      3 Robert Rowe (@CaptainJet)
+      3 Sebastián Katzer (@katzer)*
+      3 Shuta Kimura (@kimushu)+
+      3 TERAJIMA, Motoyuki (@trmmy)
+      3 Taichi AOKI (@aoki1980taichi)
+      3 Takashi Kokubun (@k0kubun)
+      3 Tatsuhiro Tsujikawa (@tatsuhiro-t)
+      3 Thiago Scalone (@scalone)
+      3 Vladimir Dementyev (@palkan)*
+      3 William Light (@wrl)
+      3 bamchoh (@bamchoh)
+      3 sasaki takeru (@takeru)
+      3 windwiny (@windwiny)
+      2 Akira Moroo (@retrage)
+      2 Artur K (@nemerle)
+      2 Christian Mauceri (@mauceri)
+      2 Craig Lehmann (@craiglrock)*
+      2 Dominic Sisneros (@dsisnero)*
+      2 Dusan D. Majkic (@dmajkic)
+      2 Emiliano Lesende (@3miliano)
+      2 Francois Chagnon (@EiNSTeiN-)*
+      2 Gilad Zohari (@gzohari)
+      2 Go Saito (@govm)
+      2 Hiroyuki Iwatsuki (@iwadon)
+      2 Huei-Horng Yo (@hiroshiyui)
+      2 Jonas Kulla (@Ancurio)
+      2 Jun Takeda (@takjn)
+      2 Kazuaki Tanaka (@kaz0505)
+      2 Kazuhiko Yamashita (@pyama86)+
+      2 Kazuhiro Sera (@seratch)
+      2 Kuroda Daisuke (@dycoon)+
+      2 Lothar Scholz (@llothar)
+      2 Lukas Joeressen (@kext)
+      2 Masahiro Wakame (@vvkame)+
+      2 Minao Yamamoto (@tarosay)+
+      2 Nihad Abbasov (@NARKOZ)
+      2 Robert Mosolgo (@rmosolgo)
+      2 Russel Hunter Yukawa (@rhykw)+
+      2 Ryunosuke SATO (@tricknotes)
+      2 Santa Zhang (@santazhang)
+      2 Serg Podtynnyi (@shtirlic)
+      2 Shannen Saez (@shancat)
+      2 Shouji Kuboyama (@Shokuji)*
+      2 SouthWolf (@southwolf)
+      2 TJ Singleton (@tjsingleton)
+      2 Taiyo Mizuhashi (@taiyoslime)+
+      2 Tomás Pollak (@tomas)*
+      2 Yutaka HARA (@yhara)*+
+      2 Zhang Xiaohui (@hifoolno)
+      2 buty4649 (@buty4649)
+      2 icm7216 (@icm7216)
+      1 A-Sat (@asatou)+
+      1 Abinoam Praxedes Marques Junior (@abinoam)
+      1 Alex Wang (@nanamiwang)+
+      1 AlexDenisov (@AlexDenisov)
+      1 Andrew Nordman (@cadwallion)
+      1 Ashish Kurmi (@boahc077)
+      1 Atsushi Morimoto (@mynz)
+      1 Ben A Morgan (@BenMorganIO)
+      1 Benoit Daloze (@eregon)
+      1 Bradley Whited (@esotericpig)
+      1 Colin MacKenzie IV (@sinisterchipmunk)
+      1 Daehyub Kim (@lateau)
+      1 Daniel Varga (@vargad)
+      1 Diamond Rivero (@diamant3)
+      1 Edgar Boda-Majer (@eboda)
+      1 Fangrui Song (@MaskRay)
+      1 Flavio Medeiros (@flaviommedeiros)
+      1 Francis Bogsanyi (@fbogsany)
+      1 Guo Xiao (@guoxiao)
+      1 Gwen Boatrite (@boatrit)
+      1 Gwendolyn Boatrite (@boatrite)
+      1 HARADA Makoto (@haramako)
+      1 HAYASHI Kentaro (@kenhys)
+      1 Hiroki Mori (@yamori813)+
+      1 Hiromasa Ishii (@Hir0)+
+      1 Hiroyuki Matsuzaki (@Hiroyuki-Matsuzaki)
+      1 Hugo Logmans (@hlogmans)
+      1 Jack Danger Canty (@JackDanger)
+      1 Jeff Federman (@jefffederman)
+      1 Jeffrey Crowell (@crowell)
+      1 Jeremy Ong (@jeremyong)
+      1 Jiro Nishiguchi (@spiritloose)
+      1 Joachim Baran (@indiedotkim)
+      1 Joe Kutner (@jkutner)
+      1 Jun Aruga (@junaruga)
+      1 Junichi Kajiwara (@kjunichi)
+      1 Jurriaan Pruis (@jurriaan)
+      1 Katsuhiko Kageyama (@kishima)+
+      1 Katsuyoshi Ito (@katsuyoshi)
+      1 Kazuhiro NISHIYAMA (@znz)
+      1 Kei Sawada (@remore)
+      1 Kim H Madsen (@kimhmadsen)
+      1 Koichi ITO (@koic)
+      1 Konstantin Haase (@rkh)
+      1 Leo Neat (@Leo-Neat)
+      1 Lian Cheng (@liancheng)
+      1 Luis Lavena (@luislavena)
+      1 Lukas Elmer (@lukaselmer)
+      1 Lukas Stabe (@Ahti)
+      1 M.Naruoka (@fenrir-naru)
+      1 Marcelo Juchem (@juchem)
+      1 Martin Bosslet (@emboss)+
+      1 Masahiko Sawada (@MasahikoSawada)
+      1 Matt Aimonetti (@mattetti)
+      1 Max Base (@MaxFork)
+      1 Maxim Abramchuk (@MaximAbramchuck)
+      1 Megumi Tomita (@tomykaira)+
+      1 Mitchell Hashimoto (@mitchellh)
+      1 Mitsutaka Mimura (@takkanm)
+      1 Nathan Ladd (@ntl)
+      1 Nicholas (@knf)
+      1 Nozomi SATO (@nozomiS)
+      1 Okumura Takahiro (@hfm)
+      1 Patrick Ellis (@pje)
+      1 Patrick Pokatilo (@SHyx0rmZ)
+      1 Pavel Evstigneev (@Paxa)+
+      1 Paweł Świątkowski (@katafrakt)
+      1 Pete Kinnecom (@petekinnecom)
+      1 Prayag Verma (@pra85)
+      1 Ranmocy (@ranmocy)
+      1 Robert McNally (@wolfmcnally)
+      1 Ryan Davis (@zenspider)
+      1 Ryan Scott Lewis (@RyanScottLewis)
+      1 Ryo Okubo (@syucream)
+      1 SAkira a.k.a. Akira Suzuki (@sakisakira)
+      1 Santiago Rodriguez (@sanrodari)
+      1 Satoh, Hiroh (@cho45)+
+      1 Satoru Naba (@snaba)+
+      1 Sayed Abdelhaleem (@visualsayed)
+      1 Sergey Ukrainskiy (@ukrainskiysergey)
+      1 Shugo Maeda (@shugo)
+      1 Sinkevich Artem (@ArtSin)
+      1 Sorah Fukumori (@sorah)
+      1 Stephen Jothen (@sjothen)
+      1 Stuart Hinson (@stuarth)
+      1 Takuma Kume (@takumakume)+
+      1 Takuya ASADA (@syuu1228)
+      1 Thomas Schmidt (@digitaltom)
+      1 Timo Schilling (@timoschilling)
+      1 Tom Black (@blacktm)
+      1 Utkarsh Kukreti (@utkarshkukreti)
+      1 W (@graywolf)
+      1 Wuffers Lightwolf (@w-x-l)
+      1 YAMAMOTO Yuji (@igrep)
+      1 Yevhen Viktorov (@yevgenko)
+      1 Yoji SHIDARA (@darashi)
+      1 Yoshiori SHOJI (@yoshiori)
+      1 Yuji Yokoo (@yujiyokoo)
+      1 Yukang (@chenyukang)
+      1 Yurii Nakonechnyi (@inobelar)
+      1 Yusuke Suzuki (@Constellation)+
+      1 Yusuke Tanaka (@csouls)
+      1 alpha.netzilla (@alpha-netzilla)
+      1 arton (@arton)
+      1 duangsuse (@duangsuse)
+      1 fl0l0u (@fl0l0u)
+      1 hasse (@hasse09052)
+      1 hhc0null (@hhc0null)
+      1 iTitou (@titouanc)
+      1 javier ramírez (@javier)
+      1 liyuray (@liyuray)
+      1 lucas dicioccio (@lucasdicioccio)
+      1 n4o847 (@n4o847)
+      1 niyarin (@niyarin)
+      1 robert (@R-obert)
+      1 sbsoftware (@sbsoftware)
+      1 ssmallkirby (@smallkirby)
+      1 taku toyama (@tsuichu)
+
+`*` - Entries unified according to names and addresses
+`+` - Entries with names different from commits
+
+## Contributors without named commits
+
+   Yuichi Osawa (Mitsubishi Electric Micro-Computer Application Software)
+   Shota Nakano (Manycolors)
+   Bjorn De Meyer
+
+## Corporate contributors
+
+   Ministry of Economy, Trade and Industry, Japan
+   Kyushu Bureau of Economy, Trade and Industry
    SCSK KYUSHU CORPORATION
    Kyushu Institute of Technology
    Network Applied Communication Laboratory, Inc.
-   Daniel Bovensiepen
-   Jon Maken
-   Bjorn De Meyer
-   Yuichiro MASUI
-   Masamitsu MURASE
-   Masaki Muranaka
    Internet Initiative Japan Inc.
-   Tadashi FUKUZAWA
-   MATSUMOTO Ryosuke
-   Yasuhiro Matsumoto
-   Koji Yoshioka
-   Jun Hiroe
-   Narihiro Nakamura
-   Yuichi Nishiwaki
-   Tatsuhiko Kubo
-   Takeshi Watanabe
-   Yuki Kurihara
-   specified non-profit corporation mruby Forum
-   Kazuaki Tanaka
-   Hiromasa Ishii
-   Hiroshi Mimaki
-   Satoshi Odawara
+   Specified non-profit organization mruby Forum
    Mitsubishi Electric Micro-Computer Application Software Co.,Ltd.
-   Ralph Desir(Mav7)
-   Hiroyuki Matsuzaki
-   Yuhei Okazaki
    Manycolors, Inc.
-   Shota Nakano
-   Yuichi Osawa
-   Terence Lee
-   Zachary Scott
-   Tomasz Dąbrowski
-   Christopher Aue
-   Masahiro Wakame
-   YAMAMOTO Masaya
-   KOBAYASHI Shuji
-   RIZAL Reckordp

CONTRIBUTING.md

@@ -1,22 +1,127 @@
 # How to contribute
 
 mruby is an open-source project which is looking forward to each contribution.
+Contributors agree to license their contribution(s) under MIT license.
 
 ## Your Pull Request
 
 To make it easy to review and understand your change please keep the following
 things in mind before submitting your pull request:
 
-* Work on the latest possible state of **mruby/master**
-* Create a branch which is dedicated to your change
-* Test your changes before creating a pull request (```rake test```)
-* If possible write a test case which confirms your change
-* Don't mix several features or bug-fixes in one pull request
-* Create a meaningful commit message
-* Explain your change (i.e. with a link to the issue you are fixing)
-* Use mrbgem to provide non ISO features (classes, modules and methods) unless
+- Work on the latest possible state of **mruby/master**
+- Create a branch which is dedicated to your change
+- Test your changes before creating a pull request (`rake test`)
+- If possible write a test case which confirms your change
+- Don't mix several features or bugfixes in one pull request
+- Create a meaningful commit message
+- Explain your change (i.e. with a link to the issue you are fixing)
+- Use mrbgem to provide non ISO features (classes, modules and methods) unless
   you have a special reason to implement them in the core
 
+## pre-commit
+
+A framework for managing and maintaining multi-language `pre-commit` hooks.
+`pre-commit` can be [installed](https://pre-commit.com/#installation) with `pip`, `curl`, `brew` or `conda`.
+
+You need to first install `pre-commit` and then install the `pre-commit` hooks with `pre-commit install`.
+Now `pre-commit` will run automatically on git commit!
+
+It's usually a good idea to run the hooks against all the files when adding new hooks (usually `pre-commit`
+will only run on the changed files during git hooks). Use `pre-commit run --all-files` to check all files.
+
+To run a single hook use `pre-commit run --all-files <hook_id>`
+
+To update use `pre-commit autoupdate`
+
+Sometimes you might need to skip one or more hooks which can be done with the `SKIP` environment variable.
+
+`$ SKIP=yamllint git commit -m "foo"`
+
+For convenience, we have added `pre-commit run --all-files`, `pre-commit install` and `pre-commit autoupdate`
+to both the Makefile and the Rakefile. Run them with:
+
+- `make check` or `rake check`
+- `make checkinstall` or `rake checkinstall`
+- `make checkupdate` or `rake checkupdate`
+
+To configure `pre-commit` you can modify the config file [.pre-commit-config.yaml](.pre-commit-config.yaml).
+We use [GitHub Actions](.github/workflows/lint.yml) to run `pre-commit` on every pull request.
+
+### pre-commit quick links
+
+- [Quick start](https://pre-commit.com/#quick-start)
+- [Usage](https://pre-commit.com/#usage)
+- [pre-commit autoupdate](https://pre-commit.com/#pre-commit-autoupdate)
+- [Temporarily disabling hooks](https://pre-commit.com/#temporarily-disabling-hooks)
+
+## Docker
+
+We have both a `Dockerfile` and `docker-compose.yml` files in the repository root.
+You can run these with the command line or use
+[Docker Desktop](https://www.docker.com/products/docker-desktop/).
+
+The Docker image is running Debian bullseye with Ruby and Python installed.
+You can build the Docker image with:
+
+`$ docker-compose build test`
+
+So far we just have one service: `test`. Running the default `docker-compose`
+command will create the Docker image, spin up a container and then build and
+run all mruby tests.
+
+The default `docker-compose` command is:
+
+`$ docker-compose -p mruby run test`
+
+You can also use Make or Rake to run the default `docker-compose`
+command from above:
+
+- `make composetest`
+- `rake composetest`
+
+List your Docker images with:
+
+```console
+$ docker images
+REPOSITORY   TAG       IMAGE ID       CREATED          SIZE
+mruby-test   latest    ec60f9536948   29 seconds ago   1.29GB
+```
+
+You can also run any custom `docker-compose` command which will override
+the default. For example to run `pre-commit run --all-files` type:
+
+`$ docker-compose -p mruby run test pre-commit run --all-files`
+
+For convenience, you can also run `pre-commit` with:
+
+- `make composecheck`
+- `rake composecheck`
+
+The bonus of running `pre-commit` with `docker-compose` is that you won't need
+to install `pre-commit` and the hooks on your local machine. And that also
+means you won't need to install `brew`, `conda` or `pip`.
+
+Note limitation: currently running `pre-commit` with `docker-compose` we
+skip the `check-executables-have-shebangs` hook.
+
+Two more examples of custom `docker-compose` commands are:
+
+- `$ docker-compose -p mruby run test ls`
+- `$ docker-compose -p mruby run test rake doc:api`
+
+If you want to test using a different `docker-compose` YAML config file you
+can use the `-f` flag:
+
+`$ docker-compose -p mruby -f docker-compose.test.yml run test`
+
+- <https://docs.docker.com/compose/>
+- <https://docs.docker.com/engine/reference/commandline/cli/>
+
+## Spell Checking
+
+We are using `pre-commit` to run [codespell](https://github.com/codespell-project/codespell)
+to check code for common misspellings. We have a small custom dictionary file [codespell.txt](.github/linters/codespell.txt).
+
 ## Coding conventions
 
 How to style your C and Ruby code which you want to submit.
@@ -31,12 +136,7 @@ C code:
 
 mruby should be highly portable to other systems and compilers. For this it is
 recommended to keep your code as close as possible to the C99 standard
-(http://www.open-std.org/jtc1/sc22/WG14/www/docs/n1256.pdf).
-
-Although we target C99, we've heard some compilers in the embedded environment
-still requires declarations of local variables to be at the beginning of a
-scope. Until we confirm the situation has changed, we use the old-style
-variable declaration.
+(<http://www.open-std.org/jtc1/sc22/WG14/www/docs/n1256.pdf>).
 
 Visual C++ is also an important target for mruby (supported version is 2013 or
 later). For this reason features that are not supported by Visual C++ may not
@@ -50,19 +150,15 @@ The dependencies to libraries should be kept to an absolute minimum. This
 increases the portability but makes it also easier to cut away parts of mruby
 on-demand.
 
-#### Don't use C++ style comments
+#### Insert a break after the function return value:
 
-    /* This is the preferred comment style */
-
-Use C++ style comments only for temporary comment e.g. commenting out some code lines.
-
-#### Insert a break after the method return value:
-
-    int
-    main(void)
-    {
-      ...
-    }
+```c
+int
+main(void)
+{
+  ...
+}
+```
 
 ### Ruby code
 
@@ -72,4 +168,18 @@ language itself. Please note the following hints for your Ruby code:
 #### Comply with the Ruby standard (ISO/IEC 30170:2012)
 
 mruby is currently targeting to execute Ruby code which complies to ISO/IEC
-30170:2012 (http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579).
+30170:2012 (<https://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579>),
+unless there's a clear reason, e.g. the latest Ruby has changed behavior from ISO.
+
+## Building documentation
+
+### mruby API
+
+- [YARD](https://yardoc.org/) - YARD is a documentation generation tool for the Ruby programming language
+- [yard-mruby](https://rubygems.org/gems/yard-mruby) - Document mruby sources with YARD
+- [yard-coderay](https://rubygems.org/gems/yard-coderay) - Adds coderay syntax highlighting to YARD docs
+
+### C API
+
+- [Doxygen](https://www.doxygen.nl/) - Generate documentation from source code
+- [Graphviz](https://graphviz.org/) - Graphviz is open source graph visualization software

Dockerfile

@@ -0,0 +1,13 @@
+FROM ruby:3.2.2-bullseye
+
+RUN apt-get update && apt-get install --no-install-recommends -y python3-pip shellcheck \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+COPY Gemfile Gemfile.lock .pre-commit-config.yaml ./
+
+RUN bundle install && pip3 install --no-cache-dir pre-commit && git init . && pre-commit install-hooks
+
+COPY . .

Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'yard'
+gem 'yard-coderay'
+gem 'yard-mruby'

Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    rake (13.3.0)
+    yard (0.9.37)
+    yard-coderay (0.1.0)
+      coderay
+      yard
+    yard-mruby (0.3.0)
+      yard (~> 0.9.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  rake
+  yard
+  yard-coderay
+  yard-mruby
+
+BUNDLED WITH
+   2.4.10

LEGAL

@@ -4,3 +4,59 @@ LEGAL NOTICE INFORMATION
 All the files in this distribution are covered under the MIT license
 (see the file LICENSE) except some files mentioned below:
 
+- src/string.c (memsearch_swar): 2 clause BSD license code by Wojciech Muła (@WojciechMula)
+- src/fmt_fp.c: public domain by Dave Hylands (@dhylands)
+- mrbgems/mruby-dir/src/Win/dirent.c: MIT-like license by Kevlin Henney
+
+[src/string.c]
+The implementation of mrb_memsearch_ss() is taken from
+https://github.com/WojciechMula/sse4-strstr.git
+
+Copyright (c) 2008-2016, Wojciech Muła
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+[src/fmt_fp.c]
+
+The code in this function was inspired from Fred Bayer's pdouble.c.
+Since pdouble.c was released as Public Domain, I'm releasing this
+code as public domain as well.
+
+Dave Hylands
+
+The original code can be found in https://github.com/dhylands/format-float
+
+[mrbgems/mruby-dir/src/Win/dirent.c] used only for Windows platform
+
+Copyright Kevlin Henney, 1997, 2003, 2012. All rights reserved.
+
+Permission to use, copy, modify, and distribute this software and its
+documentation for any purpose is hereby granted without fee, provided
+that this copyright and permissions notice appear in all copies and
+derivatives.
+
+This software is supplied "as is" without express or implied warranty.
+
+But that said, if there are any problems please get in touch.

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020 mruby developers
+Copyright (c) 2010- mruby developers
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"),
@@ -17,4 +17,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
-

Makefile

@@ -1,15 +1,56 @@
-# mruby is using Rake (http://rake.rubyforge.org) as a build tool.
+# mruby is using Rake (https://ruby.github.io/rake/) as a build tool.
 
 RAKE = rake
+DOCKER_COMPOSE = docker-compose
+PRE_COMMIT = pre-commit
 
-all :
+define check_command
+	@command -v $(1) >/dev/null 2>&1 || { \
+		echo "Error: $(1) is not installed or not in PATH."; \
+		exit 1; \
+	}
+endef
+
+all : check_rake
 	$(RAKE)
 .PHONY : all
 
-test : all
+test : check_rake all
 	$(RAKE) test
 .PHONY : test
 
-clean :
+clean : check_rake
 	$(RAKE) clean
 .PHONY : clean
+
+check : check_pre_commit
+	$(PRE_COMMIT) run --all-files
+.PHONY : check
+
+checkinstall : check_pre_commit
+	$(PRE_COMMIT) install
+.PHONY : checkinstall
+
+checkupdate : check_pre_commit
+	$(PRE_COMMIT) autoupdate
+.PHONY : checkupdate
+
+composecheck : check_docker_compose check_pre_commit
+	$(DOCKER_COMPOSE) -p mruby run test $(PRE_COMMIT) run --all-files
+.PHONY : composecheck
+
+composetest : check_docker_compose
+	$(DOCKER_COMPOSE) -p mruby run test
+.PHONY : composetest
+
+check_rake:
+	$(call check_command, $(RAKE))
+.PHONY : check_rake
+
+check_docker_compose:
+	$(call check_command, $(DOCKER_COMPOSE))
+.PHONY : check_docker_compose
+
+check_pre_commit:
+	$(call check_command, $(PRE_COMMIT))
+.PHONY : check_pre_commit

NEWS

@@ -1,13 +1,254 @@
-* NEWS
+NEWS
+----
 
-This document is a list of user visible feature changes made between
-releases except for bug fixes.
+# User visible changes in `mruby3.4` from `mruby3.3`
 
-Note that each entry is kept so brief that no reason behind or
-reference information is supplied with.  For a full list of changes
-with all sufficient information, see the ChangeLog file.
+"**_NOTE_**:" are changes to be aware of.
 
+# The language
 
-** Information about first release v1.0.0
+- mruby now supports `private` and `protected` visibility ([b0db0bd](https://github.com/mruby/mruby/commit/b0db0bd))
+- Maximum length of inlined symbols reduced from 5 to 4 characters to provide space for visibility flags ([6442a01](https://github.com/mruby/mruby/commit/6442a01))
+- Many methods are made private according to CRuby visibility ([4a0e806](https://github.com/mruby/mruby/commit/4a0e806))
+- Generate OP_SSEND for `self.method` type calls ([111fe4b](https://github.com/mruby/mruby/commit/111fe4b))
+- `initialize` method will be always private ([eb8b412](https://github.com/mruby/mruby/commit/eb8b412))
+- Add new hooks `method_removed`, `method_undefined` ([9c74f6e](https://github.com/mruby/mruby/commit/9c74f6e))
+- Add new hooks `singleton_method_removed`, `singleton_method_undefined` ([0863c08](https://github.com/mruby/mruby/commit/0863c08))
+- Updated `OP_DEF` output from codedump ([3a3e877](https://github.com/mruby/mruby/commit/3a3e877))
+- Better handling of binary strings, e.g. String#b ([b0127f0](https://github.com/mruby/mruby/commit/b0127f0))
+- Hash `to_s` format has changed ([baeeb5e](https://github.com/mruby/mruby/commit/baeeb5e))
+- Some encoding related method such as `#force_encoding` ([e47b4ca](https://github.com/mruby/mruby/commit/e47b4ca)), `#b` ([b0127f0](https://github.com/mruby/mruby/commit/b0127f0))
+- Constant folding for `String#+` ([6687bdd](https://github.com/mruby/mruby/commit/6687bdd))
+- Remove Float bit-operation ([db8368f](https://github.com/mruby/mruby/commit/db8368f))
+- use SWAR technique for strlen performance ([cbb31e6](https://github.com/mruby/mruby/commit/cbb31e6))
+- use merge sort for `Array#sort` ([5bd63d6](https://github.com/mruby/mruby/commit/5bd63d6))
 
+# Changes in C API
 
+- pool.c renamed to mempool.c (and mrb_pool to mrb_mempool) ([49525fa](https://github.com/mruby/mruby/commit/49525fa))
+- mrb_pool_value renamed to mrb_irep_pool to reduce confusion ([62ef5db](https://github.com/mruby/mruby/commit/62ef5db))
+- rename BOXNIX_SET_VALUE to BOXNO_SET_VALUE ([#6397](https://github.com/mruby/mruby/pull/6397))
+- `MRB_FROZEN_P()` is replaced by `mrb_frozen_p()` ([c11d18e](https://github.com/mruby/mruby/commit/c11d18e))
+- rename `color` to `gc_color` ([0e79f6b](https://github.com/mruby/mruby/commit/0e79f6b), [1e36d76](https://github.com/mruby/mruby/commit/1e36d76))
+- add `obj->frozen` instead of flags `MRB_SET_FROZEN_FLAG`/`MRB_UNSET_FROZEN_FLAG` ([8276143](https://github.com/mruby/mruby/commit/8276143))
+
+# Build & Configuration
+
+- New Build Target: `test:run:serial`, `test:run:serial:lib`, `test:run:serial:bin` ([#6423](https://github.com/mruby/mruby/pull/6423))
+- New Platform: PlayStation Portable ([#6022](https://github.com/mruby/mruby/pull/6465))
+- New Platform: emscripten ([#6487](https://github.com/mruby/mruby/pull/6487))
+- New Config: no-float (with MRB_NO_FLOAT) ([32200f1](https://github.com/mruby/mruby/commit/32200f1))
+
+# Changes in mrbgems
+
+- **mruby-print**: removed; if you do not use `mruby-io`, mruby use `#print` etc. in the core ([8c8bbd9](https://github.com/mruby/mruby/commit/8c8bbd9))
+- **mruby-enum-lazy**: Add Enumerable::Lazy#grep_v to mruby-enum-lazy ([#6171](https://github.com/mruby/mruby/pull/6171))
+- **mruby-io**: Add `level` argument to `File.dirname` ([#6463](https://github.com/mruby/mruby/pull/6463))
+- **mruby-io**: File.absolute_path? ([#6482](https://github.com/mruby/mruby/pull/6482))
+- **mruby-io**: File.absolute_path ([96113a2](https://github.com/mruby/mruby/commit/96113a2))
+- **mruby-toplevel-ext**: top-level public/private/protected moved to the core ([2a876d2](https://github.com/mruby/mruby/commit/2a876d2))
+- **mruby-metaprog**: method list methods now works according to the visibility ([9229da1](https://github.com/mruby/mruby/commit/9229da1))
+- **mruby-metaprog**: `public_instance_methods`, `private_instance_methods`, `protected_instance_methods` ([9e3e7b2](https://github.com/mruby/mruby/commit/9e3e7b2))
+- **mruby-encoding**: MRB_UTF8_STRING turned on automatically with this gem ([74bdae9](https://github.com/mruby/mruby/commit/74bdae9))
+
+# Fixed GitHub Issues
+
+- [#6173](https://github.com/mruby/mruby/issues/6173) Fails to build with tcc(Tiny C Compiler)
+- [#6156](https://github.com/mruby/mruby/issues/6156) '/LIBPATH' issue
+- [#6183](https://github.com/mruby/mruby/issues/6183) ".e".to_f returns NAN
+- [#6182](https://github.com/mruby/mruby/issues/6182) mrb_read_float() converts "0.3" with a small error compared to strtod()
+- [#6210](https://github.com/mruby/mruby/issues/6210) Unary minus seems broken
+- [#6255](https://github.com/mruby/mruby/issues/6255) Wrong number of characters in broken UTF-8 string
+- [#4038](https://github.com/mruby/mruby/issues/4038) Heap buffer overflow in OP_ENTER
+- [#6262](https://github.com/mruby/mruby/issues/6262) Unable to define == for objects when using Array#delete
+- [#6267](https://github.com/mruby/mruby/issues/6267) When MRB_UTF8_STRING is enabled, giving byte characters for String#index and String#split gives wrong results
+- [#6277](https://github.com/mruby/mruby/issues/6277) MSVC: can't use malloc() in string.c with WIN32_LEAN_AND_MEAN
+- [#6240](https://github.com/mruby/mruby/issues/6240) Differentiate between lib and lib64 in the build settings.
+- [#6304](https://github.com/mruby/mruby/issues/6304) Calling method_missing with only Kwargs passes arguments incorrectly
+- [#6317](https://github.com/mruby/mruby/issues/6317) mrb_gc_register() may cause GC and collect the object being protected
+- [#6307](https://github.com/mruby/mruby/issues/6307) Planned change patch for mrb_vm_exec()
+- [#6298](https://github.com/mruby/mruby/issues/6298) foo :bar {} is legal in mruby?
+- [#6326](https://github.com/mruby/mruby/issues/6326) Detect “Use-after-free” with address sanitizer
+- [#5358](https://github.com/mruby/mruby/issues/5358) static warning from getpwnam
+- [#6339](https://github.com/mruby/mruby/issues/6339) mrb_ary_delete() may refer to an invalid address (use-after-free)
+- [#6346](https://github.com/mruby/mruby/issues/6346) Block kwargs are passed as last positional arg when using yield
+- [#6365](https://github.com/mruby/mruby/issues/6365) powl() not available when compiling for Dreamcast
+- [#6369](https://github.com/mruby/mruby/issues/6369) 100x Performance Regression from 3.1
+- [#6270](https://github.com/mruby/mruby/issues/6270) NODE_ZSUPER from deeply nested blocks will result in a truncated digits for block index in OP_ARGARY
+- [#6297](https://github.com/mruby/mruby/issues/6297) Assigning to a block variable changes the actual block (thus affecting block_given? and yield)
+- [#6389](https://github.com/mruby/mruby/issues/6389) instance_exec named block args don't work properly
+- [#6388](https://github.com/mruby/mruby/issues/6388) Recent commit broke my windows build
+- [#6411](https://github.com/mruby/mruby/issues/6411) Wrong function unwinding when using return in a block
+- [#6439](https://github.com/mruby/mruby/issues/6439) OP_JMPUW does not call the ensure block when it jumps to the beginning of the begin block
+- [#6441](https://github.com/mruby/mruby/issues/6441) break inside while loop will execute the ensure block outside of the while loop
+- [#6453](https://github.com/mruby/mruby/issues/6453) Bigint: incorrect behavior of ^ operator
+- [#6452](https://github.com/mruby/mruby/issues/6452) Bigint: weird mod behavior
+- [#6451](https://github.com/mruby/mruby/issues/6451) Bigint: incorrect division behavior
+- [#6456](https://github.com/mruby/mruby/issues/6456) bigint: bug with division of a small number by a bigint
+- [#6466](https://github.com/mruby/mruby/issues/6466) mruby-bin-mruby using Kernel#p and Kernel#print in bintest fails test
+- [#6467](https://github.com/mruby/mruby/issues/6467) Heap-Use-After-Free due to Recursive group_by Calls
+- [#6471](https://github.com/mruby/mruby/issues/6471) Discrepancy in codegen for binary operations between master branch and 3.3.0
+- [#6477](https://github.com/mruby/mruby/issues/6477) heap-buffer-overflow in mrb_vm_exec
+- [#6485](https://github.com/mruby/mruby/issues/6485) Hash#rehash does not check if the hash is frozen
+- [#6483](https://github.com/mruby/mruby/issues/6483) Hash#default_proc= accepts arbitrary objects that are not callable
+- [#6491](https://github.com/mruby/mruby/issues/6491) Destroy existing string literals when composing string literals
+
+# Merged Pull Requests (User Visible Ones)
+
+- [#6171](https://github.com/mruby/mruby/pull/6171) Add Enumerable::Lazy#grep_v to mruby-enum-lazy
+- [#6174](https://github.com/mruby/mruby/pull/6174) Fix MRUBY_PACKAGE_DIR in mruby-config.bat
+- [#6175](https://github.com/mruby/mruby/pull/6175) Corrected strange conditional in mrb_vm_run()
+- [#6176](https://github.com/mruby/mruby/pull/6176) Stop assuming alias proc in CI_PROC_SET()
+- [#6177](https://github.com/mruby/mruby/pull/6177) gha: add macOS 14 to the build
+- [#6184](https://github.com/mruby/mruby/pull/6184) Remove the L_STOP label
+- [#6185](https://github.com/mruby/mruby/pull/6185) Added mrb_callinfo::u.keep_context for clarity
+- [#6186](https://github.com/mruby/mruby/pull/6186) Omit NULL check of e->cxt in OP_RETURN_BLK
+- [#6191](https://github.com/mruby/mruby/pull/6191) Speed up symbol equality comparison
+- [#6192](https://github.com/mruby/mruby/pull/6192) Fix `OP_STOP` with exception
+- [#6193](https://github.com/mruby/mruby/pull/6193) Fix wrong assertion in `OP_SENDB`.
+- [#6194](https://github.com/mruby/mruby/pull/6194) Simplify the calculation of the number of closures in `MRB_TT_FIBER`
+- [#6197](https://github.com/mruby/mruby/pull/6197) Fix int_xor to call flo_xor.
+- [#6201](https://github.com/mruby/mruby/pull/6201) tasks/doc.rake: standardize the `rake doc` error messages
+- [#6202](https://github.com/mruby/mruby/pull/6202) Remove the `.yardoc` folder with `rake doc:clean:api`
+- [#6204](https://github.com/mruby/mruby/pull/6204) Clean up the `.editorconfig` file
+- [#6209](https://github.com/mruby/mruby/pull/6209) Minor `.gitignore` clean up
+- [#6211](https://github.com/mruby/mruby/pull/6211) Minor `.gitignore` clean up; order entries
+- [#6216](https://github.com/mruby/mruby/pull/6216) Shared empty `iv_tbl` of module
+- [#6217](https://github.com/mruby/mruby/pull/6217) Strict declaration for `mrb_istruct_size()`
+- [#6219](https://github.com/mruby/mruby/pull/6219) Avoid assigning a fixed value in the loop
+- [#6220](https://github.com/mruby/mruby/pull/6220) Reorganize `mrb_cache_entry` and `mrb_method_t` types
+- [#6221](https://github.com/mruby/mruby/pull/6221) Arranging `each_backtrace()`
+- [#6222](https://github.com/mruby/mruby/pull/6222) Need to synchronize `dbg->regs` after VM call in `mrdb`
+- [#6224](https://github.com/mruby/mruby/pull/6224) `mrb_env_unshare()` to break the link to fiber
+- [#6225](https://github.com/mruby/mruby/pull/6225) Revert "Adjust environment when `mrb_exec_irep` happened."
+- [#6227](https://github.com/mruby/mruby/pull/6227) fix: `Array#shuffle(!)` result distribution
+- [#6228](https://github.com/mruby/mruby/pull/6228) Revert "`env` referred from top-level callinfo should not be unshared; fix #4019"
+- [#6230](https://github.com/mruby/mruby/pull/6230) Fix status of fiber after switched by exception raised
+- [#6231](https://github.com/mruby/mruby/pull/6231) Add a way to let other gems handle closing of fds in mruby-io
+- [#6232](https://github.com/mruby/mruby/pull/6232) Fold the code for freeing `env`
+- [#6233](https://github.com/mruby/mruby/pull/6233) Free stack memory at end of fiber
+- [#6235](https://github.com/mruby/mruby/pull/6235) fix `Array#delete` always firing the block when deleting `nil`
+- [#6236](https://github.com/mruby/mruby/pull/6236) unify the code for filter methods (and speed up `#reject!`)
+- [#6237](https://github.com/mruby/mruby/pull/6237) Stricter env objects to attach to ci
+- [#6238](https://github.com/mruby/mruby/pull/6238) Minimize zero initialization of the stack
+- [#6243](https://github.com/mruby/mruby/pull/6243) Fixed base64 decoding in `mruby-pack`
+- [#6244](https://github.com/mruby/mruby/pull/6244) Revise scope of role of `mrb_vm_run()`
+- [#6246](https://github.com/mruby/mruby/pull/6246) Fix typo in `test/t/hash.rb`
+- [#6249](https://github.com/mruby/mruby/pull/6249) Fix spelling in `src/vm.c`
+- [#6250](https://github.com/mruby/mruby/pull/6250) Fix spelling
+- [#6251](https://github.com/mruby/mruby/pull/6251) Clean up root move `CODEOWNERS` to `.github` directory
+- [#6253](https://github.com/mruby/mruby/pull/6253) Allow recycling fibers by GC if not referenced directly
+- [#6256](https://github.com/mruby/mruby/pull/6256) Update documentation for `mrb_top_run()`
+- [#6257](https://github.com/mruby/mruby/pull/6257) fix some mrbconf.md typos
+- [#6260](https://github.com/mruby/mruby/pull/6260) Remove `exc_caught` from `mrb_vm_exec()`
+- [#6261](https://github.com/mruby/mruby/pull/6261) fix: `to_a` integer ranges with `begin > end` failing
+- [#6263](https://github.com/mruby/mruby/pull/6263) fix: `Array#delete` mistakenly calling block even if not passed
+- [#6264](https://github.com/mruby/mruby/pull/6264) Must pass keyword arguments for `Kernel#to_enum`
+- [#6265](https://github.com/mruby/mruby/pull/6265) Fixes `Dir.children` and `Dir.each_child`
+- [#6266](https://github.com/mruby/mruby/pull/6266) Passes the nonexistent key as a block argument in `Array#delete`
+- [#6273](https://github.com/mruby/mruby/pull/6273) Improvements to `mrb_protect_atexit()`
+- [#6275](https://github.com/mruby/mruby/pull/6275) Fixed `Binding#eval` that failed to assign to the same variable
+- [#6276](https://github.com/mruby/mruby/pull/6276) Always run `atexit` on the top-level call frame
+- [#6279](https://github.com/mruby/mruby/pull/6279) Include headers for malloc() explicitly; fix #6277
+- [#6280](https://github.com/mruby/mruby/pull/6280) Remove `MRB_ENV_CLOSED` flag
+- [#6281](https://github.com/mruby/mruby/pull/6281) Fixes local variables in `mruby-binding`.
+- [#6283](https://github.com/mruby/mruby/pull/6283) Simplify `uvenv()`
+- [#6288](https://github.com/mruby/mruby/pull/6288) Detach `env` of ci explicitly on atexit
+- [#6289](https://github.com/mruby/mruby/pull/6289) Simplify `OP_RETURN_BLK` and `OP_BREAK`
+- [#6290](https://github.com/mruby/mruby/pull/6290) Allow to change the output directory name of the `libmruby` file
+- [#6293](https://github.com/mruby/mruby/pull/6293) Changed the instruction table in `opcode.md`
+- [#6294](https://github.com/mruby/mruby/pull/6294) Optimise `mrb_iv_get`
+- [#6302](https://github.com/mruby/mruby/pull/6302) Minor cleanup in mrb_str_init
+- [#6303](https://github.com/mruby/mruby/pull/6303) mrb_str_aset_m() should return replace instead of str
+- [#6305](https://github.com/mruby/mruby/pull/6305) Protect keyword arguments in `prepare_missing()`
+- [#6308](https://github.com/mruby/mruby/pull/6308) Assume that `MRB_CATCH()` has `mrb->exc` set
+- [#6310](https://github.com/mruby/mruby/pull/6310) Doubling the call stack when extending it
+- [#6311](https://github.com/mruby/mruby/pull/6311) Added fast-path for positional arguments less than 15 in `OP_SEND`
+- [#6312](https://github.com/mruby/mruby/pull/6312) Omit error checking at `OP_RETURN`, `OP_RETURN_BLK` and `OP_BREAK`
+- [#6313](https://github.com/mruby/mruby/pull/6313) Fix wrong column number in opcode.md
+- [#6314](https://github.com/mruby/mruby/pull/6314) Optimize even?/odd? for big integers
+- [#6318](https://github.com/mruby/mruby/pull/6318) Shrink variables in `mrb_vm_exec()`
+- [#6320](https://github.com/mruby/mruby/pull/6320) Shrinking the code in `OP_BREAK` and `OP_RETURN_BLK`
+- [#6321](https://github.com/mruby/mruby/pull/6321) Avoid warnings in `lib/**/*.rb`
+- [#6322](https://github.com/mruby/mruby/pull/6322) Fix mrb_ro_data_p on Intel Mac
+- [#6324](https://github.com/mruby/mruby/pull/6324) Remove `localjump_error()`
+- [#6327](https://github.com/mruby/mruby/pull/6327) fix ncurses linking issues
+- [#6328](https://github.com/mruby/mruby/pull/6328) Fix use-after-free in `obj_free()` for env objects
+- [#6329](https://github.com/mruby/mruby/pull/6329) Fix use-after-free in `mrb_obj_alloc()`
+- [#6330](https://github.com/mruby/mruby/pull/6330) Add a precondition to call `mrb_env_unshare()`.
+- [#6331](https://github.com/mruby/mruby/pull/6331) Restore the GC arena with tests
+- [#6332](https://github.com/mruby/mruby/pull/6332) Must not depend on the “host” build to generate `mruby-compiler/core/y.tab.c`
+- [#6333](https://github.com/mruby/mruby/pull/6333) Reduce the number of branch instructions in the `heap_p()`
+- [#6335](https://github.com/mruby/mruby/pull/6335) Add `return_ci` in `CHECKPOINT_MAIN()` of `OP_RETURN`
+- [#6338](https://github.com/mruby/mruby/pull/6338) Need to place static proc objects into 8-byte alignments
+- [#6340](https://github.com/mruby/mruby/pull/6340) Fix use-after-free for `Array#<=>`
+- [#6341](https://github.com/mruby/mruby/pull/6341) Need to restore the GC arena after some function calls
+- [#6344](https://github.com/mruby/mruby/pull/6344) prefer using `mrb_yield` to call block arguments
+- [#6347](https://github.com/mruby/mruby/pull/6347) codegen.c,parse.y: remove flattening of `yield` arguments; fix #6346
+- [#6348](https://github.com/mruby/mruby/pull/6348) Cancel the warning disablement
+- [#6349](https://github.com/mruby/mruby/pull/6349) Perform GC before deleting directories
+- [#6350](https://github.com/mruby/mruby/pull/6350) Fixed character encoding conversion function mismatch
+- [#6351](https://github.com/mruby/mruby/pull/6351) Remove unnecessary `mrb_gc_arena_restore()`
+- [#6353](https://github.com/mruby/mruby/pull/6353) Fix use-after-free in `mrb_ary_delete()`
+- [#6356](https://github.com/mruby/mruby/pull/6356) Making splat argument objects invisible from Ruby side
+- [#6373](https://github.com/mruby/mruby/pull/6373) Add build config for Milk-V Duo (RISC-V Linux) board
+- [#6382](https://github.com/mruby/mruby/pull/6382) Make array objects invisible in `mrb_gc_register()`
+- [#6385](https://github.com/mruby/mruby/pull/6385) Small improvements for `mrb_gc_register()`
+- [#6386](https://github.com/mruby/mruby/pull/6386) Avoid calling `mrb_gv_set()` from `mrb_gc_unregister()`
+- [#6387](https://github.com/mruby/mruby/pull/6387) Small improvements for `mrb_gc_unregister()`
+- [#6390](https://github.com/mruby/mruby/pull/6390) Fix use-after-free by `mrb_gc_unregistor()`
+- [#6391](https://github.com/mruby/mruby/pull/6391) Fixed argument forwarding in `instance_exec`
+- [#6392](https://github.com/mruby/mruby/pull/6392) Fix argument forwarding in `mrb_exec_irep()`
+- [#6393](https://github.com/mruby/mruby/pull/6393) Follow-up to #6391
+- [#6395](https://github.com/mruby/mruby/pull/6395) Storing method-id inside Symbol#to_proc
+- [#6396](https://github.com/mruby/mruby/pull/6396) Milk-V Build Config: update GPIO gem URL
+- [#6397](https://github.com/mruby/mruby/pull/6397) boxing_no.h: rename BOXNIX_SET_VALUE -> BOXNO_SET_VALUE
+- [#6399](https://github.com/mruby/mruby/pull/6399) Add macOS 15 to the build
+- [#6405](https://github.com/mruby/mruby/pull/6405) `io_read`: use `%i` instead of `%d` in call to `mrb_raisef`
+- [#6407](https://github.com/mruby/mruby/pull/6407) Allow to exclude specific files in `rake install`
+- [#6408](https://github.com/mruby/mruby/pull/6408) Improve compliance with C++ standards
+- [#6410](https://github.com/mruby/mruby/pull/6410) Put `#include <stdlib.h>` in `parse.y`
+- [#6412](https://github.com/mruby/mruby/pull/6412) Distinguish the call frame of the generator with `OP_RETURN_BLK`
+- [#6413](https://github.com/mruby/mruby/pull/6413) Add links to documentation in `README.md`
+- [#6415](https://github.com/mruby/mruby/pull/6415) Fix numbered parameters when used as a singleton
+- [#6416](https://github.com/mruby/mruby/pull/6416) Optimize the "new" method's iseq
+- [#6419](https://github.com/mruby/mruby/pull/6419) Follow Ruby's behavior for numbered parameters in -> {}
+- [#6420](https://github.com/mruby/mruby/pull/6420) Update `labeler.yml`: add label for the `tools` directory
+- [#6422](https://github.com/mruby/mruby/pull/6422) Add annotations for function names defined in the preprocessor
+- [#6423](https://github.com/mruby/mruby/pull/6423) Adding a serialized test task
+- [#6427](https://github.com/mruby/mruby/pull/6427) Need to update `ci` variable after re-entry to VM
+- [#6428](https://github.com/mruby/mruby/pull/6428) Change the limits of OP_ADDI and OP_SUBI from 0-127 to 0-255.
+- [#6429](https://github.com/mruby/mruby/pull/6429) Fix numbered parameters when used as hash keys
+- [#6432](https://github.com/mruby/mruby/pull/6432) Moving code in macro arguments out of macros
+- [#6434](https://github.com/mruby/mruby/pull/6434) Added document "Layout of the mruby filesystem"
+- [#6436](https://github.com/mruby/mruby/pull/6436) Make `rake doc:update-index` prettier friendly
+- [#6437](https://github.com/mruby/mruby/pull/6437) Add more details to the pre-commit config
+- [#6438](https://github.com/mruby/mruby/pull/6438) Remove unused `MRuby::Build#list_install_excludes` method
+- [#6440](https://github.com/mruby/mruby/pull/6440) Fix `redo` keyword
+- [#6442](https://github.com/mruby/mruby/pull/6442) Fixed wrong range condition in `OP_JMPUW`
+- [#6443](https://github.com/mruby/mruby/pull/6443) Fix NODE_NEGATE for bigints
+- [#6444](https://github.com/mruby/mruby/pull/6444) Add test cases for bigints
+- [#6446](https://github.com/mruby/mruby/pull/6446) Omit the `_WIN64` definition check
+- [#6447](https://github.com/mruby/mruby/pull/6447) Fixed `File.expand_path`
+- [#6448](https://github.com/mruby/mruby/pull/6448) Suppress presym in `mruby/ext/io.h` file
+- [#6449](https://github.com/mruby/mruby/pull/6449) Using presym in the `mruby-io/src/file_test.c` file
+- [#6450](https://github.com/mruby/mruby/pull/6450) Change `MRB_WITH_IO_PREAD_PWRITE` configuration name
+- [#6454](https://github.com/mruby/mruby/pull/6454) mruby-bigint: handle rhs bigint in int_mod and int_divmod functions
+- [#6455](https://github.com/mruby/mruby/pull/6455) mruby-bigint: fix rounding behavior in mpz_mdiv and mpz_mdivmod functions
+- [#6457](https://github.com/mruby/mruby/pull/6457) bigint: fix bug with division of a small number by a bigint
+- [#6459](https://github.com/mruby/mruby/pull/6459) `FileTest` is a module
+- [#6461](https://github.com/mruby/mruby/pull/6461) To create a release package file in draft
+- [#6462](https://github.com/mruby/mruby/pull/6462) Properly cast the return value of `memchr()`
+- [#6463](https://github.com/mruby/mruby/pull/6463) Add `level` argument to `File.dirname`
+- [#6465](https://github.com/mruby/mruby/pull/6465) Add initial PlayStation portable crossbuild support
+- [#6468](https://github.com/mruby/mruby/pull/6468) Fixed missing changes to `IB_FIND_BY_KEY()` parameter names
+- [#6469](https://github.com/mruby/mruby/pull/6469) Add more `const` qualifier for `RProc`
+- [#6472](https://github.com/mruby/mruby/pull/6472) Moved tests for `Integer#quo`
+- [#6473](https://github.com/mruby/mruby/pull/6473) Hide `mpz_and()` symbol
+- [#6473](https://github.com/mruby/mruby/pull/6473) Hide mpz_and() symbol
+- [#6474](https://github.com/mruby/mruby/pull/6474) Avoid array object creation with “unknown keyword” error
+- [#6475](https://github.com/mruby/mruby/pull/6475) Don't include deleted mruby-print
+- [#6478](https://github.com/mruby/mruby/pull/6478) Fixed buffer overrun in function `chars2bytes()`
+- [#6479](https://github.com/mruby/mruby/pull/6479) Reimplementation of `File.expand_path` method
+- [#6482](https://github.com/mruby/mruby/pull/6482) Add `File.absolute_path?` method
+- [#6487](https://github.com/mruby/mruby/pull/6487) Add Emscripten toolchain & build_config

README.md

@@ -1,78 +1,117 @@
-[![Build Status][build-status-img]][travis-ci]
+<div align="center">
+  <p>
+    <a href="https://mruby.org/">
+      <img src="https://avatars.githubusercontent.com/u/1796512?s=200&v=4"
+        alt="The mruby programming language" title="mruby">
+    </a>
+  </p>
+  <h1>mruby</h1>
+  <a href="https://github.com/marketplace/actions/super-linter">
+    <img src="https://github.com/mruby/mruby/actions/workflows/super-linter.yml/badge.svg"
+      alt="GitHub Super-Linter">
+  </a>
+</div>
 
 ## What is mruby
 
 mruby is the lightweight implementation of the Ruby language complying to (part
-of) the [ISO standard][ISO-standard]. Its syntax is Ruby 2.x compatible.
+of) the [ISO standard][ISO-standard] with more recent features provided by Ruby 3.x.
+Also, its syntax is Ruby 3.x compatible except for pattern matching.
 
-mruby can be linked and embedded within your application.  We provide the
-interpreter program "mruby" and the interactive mruby shell "mirb" as examples.
-You can also compile Ruby programs into compiled byte code using the mruby
-compiler "mrbc".  All those tools reside in the "bin" directory.  "mrbc" is
-also able to generate compiled byte code in a C source file, see the "mrbtest"
-program under the "test" directory for an example.
+You can link and embed mruby within your application. The "mruby" interpreter
+program and the interactive "mirb" shell are provided as examples. You can also
+compile Ruby programs into compiled byte code using the "mrbc" compiler. All
+these tools are located in the "bin" directory. "mrbc" can also generate
+compiled byte code in a C source file. See the "mrbtest" program under the
+"test" directory for an example.
 
 This achievement was sponsored by the Regional Innovation Creation R&D Programs
 of the Ministry of Economy, Trade and Industry of Japan.
 
 ## How to get mruby
 
-The stable version 2.1.2 of mruby can be downloaded via the following URL: [https://github.com/mruby/mruby/archive/2.1.2.zip](https://github.com/mruby/mruby/archive/2.1.2.zip)
+To get mruby, you can download the stable version 3.4.0 from the official mruby
+GitHub repository or clone the trunk of the mruby source tree with the "git
+clone" command. You can also install and compile mruby using [ruby-install](https://github.com/postmodern/ruby-install), [ruby-build](https://github.com/rbenv/ruby-build) or [rvm](https://github.com/rvm/rvm).
 
 The latest development version of mruby can be downloaded via the following URL: [https://github.com/mruby/mruby/zipball/master](https://github.com/mruby/mruby/zipball/master)
 
 The trunk of the mruby source tree can be checked out with the
 following command:
 
-    $ git clone https://github.com/mruby/mruby.git
+```console
+$ git clone https://github.com/mruby/mruby.git
+```
 
-You can also install and compile mruby using [ruby-install](https://github.com/postmodern/ruby-install), [ruby-build](https://github.com/rbenv/ruby-build) or [rvm](https://github.com/rvm/rvm).
+## mruby homepage
 
-## mruby home-page
-
-The URL of the mruby home-page is: https://mruby.org.
+The URL of the mruby homepage is: <https://mruby.org>.
 
 ## Mailing list
 
 We don't have a mailing list, but you can use [GitHub issues](https://github.com/mruby/mruby/issues).
 
-## How to compile and install (mruby and gems)
+## How to compile, test, and install (mruby and gems)
 
-See the [compile.md](https://github.com/mruby/mruby/blob/master/doc/guides/compile.md) file.
+For the simplest case, type
 
-## Running Tests
+```console
+rake all test
+```
 
-To run the tests, execute the following from the project's root directory.
-
-    $ rake test
-
-Note: `bison` bundled with MacOS is too old to compile `mruby`.
-Try `brew install bison` and follow the instuction shown to update
-the `$PATH` to compile `mruby`.
+See the [compile.md](doc/guides/compile.md) file for the detail.
 
 ## Building documentation
 
-There are two sets of documentation in mruby: the mruby API (generated by yard) and C API (Doxygen)
+There are two sets of documentation in mruby: the mruby API (generated by YARD) and C API (Doxygen and Graphviz)
 
 To build both of them, simply go
 
-    rake doc
+```console
+rake doc
+```
 
 You can also view them in your browser
 
-    rake view_api
-    rake view_capi
+```console
+rake view_api
+rake view_capi
+```
 
 ## How to customize mruby (mrbgems)
 
-mruby contains a package manager called *mrbgems*. To create extensions
-in C and/or Ruby you should create a *GEM*. For a documentation of how to
-use mrbgems consult the file [mrbgems.md](https://github.com/mruby/mruby/blob/master/doc/guides/mrbgems.md).
-For example code of how to use mrbgems look into the folder *examples/mrbgems/*.
+mruby contains a package manager called "mrbgems" that you can use to create
+extensions in C and/or Ruby. For a guide on how to use mrbgems, consult the
+[mrbgems.md](doc/guides/mrbgems.md) file, and for example code, refer to the
+[examples/mrbgems/](examples/mrbgems) folder.
+
+## Index of Document
+
+<!--
+    This section is generated by `rake doc:update-index`.
+    All manual changes will get lost.
+-->
+
+<!-- BEGIN OF MRUBY DOCUMENT INDEX -->
+
+- [About the Limitations of mruby](doc/limitations.md)
+- [About the Compile](doc/guides/compile.md)
+- [About the Debugger with the `mrdb` Command](doc/guides/debugger.md)
+- [About GC Arena](doc/guides/gc-arena-howto.md)
+- [About the mruby directory structure](doc/guides/hier.md)
+- [About Linking with `libmruby`](doc/guides/link.md)
+- [About Memory Allocator Customization](doc/guides/memory.md)
+- [About Build-time Configurations](doc/guides/mrbconf.md)
+- [About the Build-time Library Manager](doc/guides/mrbgems.md)
+- [About the Symbols](doc/guides/symbol.md)
+- [Internal Implementation / About Value Boxing](doc/internal/boxing.md)
+- [Internal Implementation / About mruby Virtual Machine Instructions](doc/internal/opcode.md)
+
+<!-- END OF MRUBY DOCUMENT INDEX -->
 
 ## License
 
-mruby is released under the [MIT License](https://github.com/mruby/mruby/blob/master/LICENSE).
+mruby is released under the [MIT License](LICENSE).
 
 ## Note for License
 
@@ -80,26 +119,21 @@ mruby has chosen a MIT License due to its permissive license allowing
 developers to target various environments such as embedded systems.
 However, the license requires the display of the copyright notice and license
 information in manuals for instance. Doing so for big projects can be
-complicated or troublesome.  This is why mruby has decided to display "mruby
+complicated or troublesome. This is why mruby has decided to display "mruby
 developers" as the copyright name to make it simple conventionally.
 In the future, mruby might ask you to distribute your new code
 (that you will commit,) under the MIT License as a member of
 "mruby developers" but contributors will keep their copyright.
 (We did not intend for contributors to transfer or waive their copyrights,
-Actual copyright holder name (contributors) will be listed in the AUTHORS
+actual copyright holder name (contributors) will be listed in the [AUTHORS](AUTHORS)
 file.)
 
 Please ask us if you want to distribute your code under another license.
 
 ## How to Contribute
 
-See the [contribution guidelines][contribution-guidelines], and then send a pull
-request to <http://github.com/mruby/mruby>.  We consider you have granted
-non-exclusive right to your contributed code under MIT license.  If you want to
-be named as one of mruby developers, please include an update to the AUTHORS
-file in your pull request.
+To contribute to mruby, please refer to the [contribution guidelines][contribution-guidelines] and send a pull request to the [mruby GitHub repository](https://github.com/mruby/mruby).
+By contributing, you grant non-exclusive rights to your code under the MIT License.
 
-[ISO-standard]: http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579
-[build-status-img]: https://travis-ci.org/mruby/mruby.svg?branch=master
-[contribution-guidelines]: https://github.com/mruby/mruby/blob/master/CONTRIBUTING.md
-[travis-ci]: https://travis-ci.org/mruby/mruby
+[ISO-standard]: https://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579
+[contribution-guidelines]: CONTRIBUTING.md

Rakefile

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # Build description.
 # basic build file for mruby
 MRUBY_ROOT = File.dirname(File.expand_path(__FILE__))
@@ -10,11 +9,11 @@ Rake.verbose(false) if Rake.verbose == Rake::DSL::DEFAULT
 $LOAD_PATH << File.join(MRUBY_ROOT, "lib")
 
 # load build systems
-require "mruby-core-ext"
+require "mruby/core_ext"
 require "mruby/build"
 
 # load configuration file
-MRUBY_CONFIG = (ENV['MRUBY_CONFIG'] && ENV['MRUBY_CONFIG'] != '') ? ENV['MRUBY_CONFIG'] : "#{MRUBY_ROOT}/build_config.rb"
+MRUBY_CONFIG = MRuby::Build.mruby_config_path
 load MRUBY_CONFIG
 
 # load basic rules
@@ -23,138 +22,75 @@ MRuby.each_target do |build|
 end
 
 # load custom rules
-load "#{MRUBY_ROOT}/src/mruby_core.rake"
-load "#{MRUBY_ROOT}/mrblib/mrblib.rake"
-
+load "#{MRUBY_ROOT}/tasks/core.rake"
+load "#{MRUBY_ROOT}/tasks/mrblib.rake"
 load "#{MRUBY_ROOT}/tasks/mrbgems.rake"
 load "#{MRUBY_ROOT}/tasks/libmruby.rake"
-
+load "#{MRUBY_ROOT}/tasks/bin.rake"
+load "#{MRUBY_ROOT}/tasks/presym.rake"
+load "#{MRUBY_ROOT}/tasks/test.rake"
 load "#{MRUBY_ROOT}/tasks/benchmark.rake"
-
-load "#{MRUBY_ROOT}/tasks/gitlab.rake"
 load "#{MRUBY_ROOT}/tasks/doc.rake"
-
-def install_D(src, dst)
-  rm_f dst
-  mkdir_p File.dirname(dst)
-  cp src, dst
-end
+load "#{MRUBY_ROOT}/tasks/install.rake"
 
 ##############################
 # generic build targets, rules
 task :default => :all
 
-bin_path = ENV['INSTALL_DIR'] || "#{MRUBY_ROOT}/bin"
-
-depfiles = MRuby.targets['host'].bins.map do |bin|
-  install_path = MRuby.targets['host'].exefile("#{bin_path}/#{bin}")
-  source_path = MRuby.targets['host'].exefile("#{MRuby.targets['host'].build_dir}/bin/#{bin}")
-
-  file install_path => source_path do |t|
-    install_D t.prerequisites.first, t.name
-  end
-
-  install_path
-end
-
-MRuby.each_target do |target|
-  gems.map do |gem|
-    current_dir = gem.dir.relative_path_from(Dir.pwd)
-    relative_from_root = gem.dir.relative_path_from(MRUBY_ROOT)
-    current_build_dir = File.expand_path "#{build_dir}/#{relative_from_root}"
-
-    if current_build_dir !~ /^#{Regexp.escape(build_dir)}/
-      current_build_dir = "#{build_dir}/mrbgems/#{gem.name}"
-    end
-
-    gem.bins.each do |bin|
-      exec = exefile("#{build_dir}/bin/#{bin}")
-      objs = Dir.glob("#{current_dir}/tools/#{bin}/*.{c,cpp,cxx,cc}").map { |f| objfile(f.pathmap("#{current_build_dir}/tools/#{bin}/%n")) }
-
-      file exec => objs + target.libraries do |t|
-        gem_flags = gems.map { |g| g.linker.flags }
-        gem_flags_before_libraries = gems.map { |g| g.linker.flags_before_libraries }
-        gem_flags_after_libraries = gems.map { |g| g.linker.flags_after_libraries }
-        gem_libraries = gems.map { |g| g.linker.libraries }
-        gem_library_paths = gems.map { |g| g.linker.library_paths }
-        linker.run t.name, t.prerequisites, gem_libraries, gem_library_paths, gem_flags, gem_flags_before_libraries, gem_flags_after_libraries
-      end
-
-      if target == MRuby.targets['host']
-        install_path = MRuby.targets['host'].exefile("#{bin_path}/#{bin}")
-
-        file install_path => exec do |t|
-          install_D t.prerequisites.first, t.name
-        end
-        depfiles += [ install_path ]
-      elsif target == MRuby.targets['host-debug']
-        unless MRuby.targets['host'].gems.map {|g| g.bins}.include?([bin])
-          install_path = MRuby.targets['host-debug'].exefile("#{bin_path}/#{bin}")
-
-          file install_path => exec do |t|
-            install_D t.prerequisites.first, t.name
-          end
-          depfiles += [ install_path ]
-        end
-      else
-        depfiles += [ exec ]
-      end
-    end
-  end
-end
-
-depfiles += MRuby.targets.map { |n, t|
-  t.libraries
-}.flatten
-
-depfiles += MRuby.targets.reject { |n, t| n == 'host' }.map { |n, t|
-  t.bins.map { |bin| t.exefile("#{t.build_dir}/bin/#{bin}") }
-}.flatten
-
 desc "build all targets, install (locally) in-repo"
-task :all => depfiles do
+task :all => :gensym do
+  Rake::Task[:build].invoke
   puts
   puts "Build summary:"
   puts
-  MRuby.each_target do
-    print_build_summary
+  MRuby.each_target do |build|
+    build.print_build_summary
   end
   MRuby::Lockfile.write
 end
 
-desc "run all mruby tests"
-task :test
-MRuby.each_target do
-  if test_enabled?
-    t = :"test_#{self.name}"
-    task t => ["all"] do
-      run_test
-    end
-    task :test => t
-  end
-
-  if bintest_enabled?
-    t = :"bintest_#{self.name}"
-    task t => ["all"] do
-      run_bintest
-    end
-    task :test => t
-  end
-end
+task :build => MRuby.targets.flat_map{|_, build| build.products}
 
 desc "clean all built and in-repo installed artifacts"
 task :clean do
-  MRuby.each_target do |t|
-    rm_rf t.build_dir
+  MRuby.each_target do |build|
+    rm_rf build.build_dir
+    rm_f build.products
   end
-  rm_f depfiles
-  puts "Cleaned up target build folder"
+  puts "Cleaned up target build directory"
 end
 
 desc "clean everything!"
-task :deep_clean => ["clean", "clean_doc"] do
-  MRuby.each_target do |t|
-    rm_rf t.gem_clone_dir
+task :deep_clean => %w[clean doc:clean] do
+  MRuby.each_target do |build|
+    rm_rf build.gem_clone_dir
   end
-  puts "Cleaned up mrbgems build folder"
+  rm_rf "#{MRUBY_ROOT}/bin"
+  rm_rf "#{MRUBY_ROOT}/build"
+  puts "Cleaned up mrbgems build directory"
+end
+
+desc "run all pre-commit hooks against all files"
+task :check do
+  sh "pre-commit run --all-files"
+end
+
+desc "install the pre-commit hooks"
+task :checkinstall do
+  sh "pre-commit install"
+end
+
+desc "check the pre-commit hooks for updates"
+task :checkupdate do
+  sh "pre-commit autoupdate"
+end
+
+desc "run all pre-commit hooks against all files with docker-compose"
+task :composecheck do
+  sh "docker-compose -p mruby run test pre-commit run --all-files"
+end
+
+desc "build and run all mruby tests with docker-compose"
+task :composetest do
+  sh "docker-compose -p mruby run test"
 end

SECURITY.md

@@ -0,0 +1,20 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you have any security concern, contact <matz@ruby.or.jp>.
+
+## Scope
+
+We consider the following issues as vulnerabilities:
+
+- Remote code execution
+- Crash caused by a valid Ruby script
+
+We _don't_ consider the following issues as vulnerabilities:
+
+- Runtime C undefined behavior (including integer overflow)
+- Crash caused by misused API
+- Crash caused by modified compiled binary
+- ASAN/Valgrind warning for too big memory allocation
+  mruby assumes `malloc(3)` returns `NULL` for too big allocations

TODO

@@ -1,8 +0,0 @@
-Things to do (Things that are not done yet)
-
-* special variables ($1,$2..)
-* super in aliased methods
-
-Things to improve (Done but things to fix)
-
-* Make additions as they are noticed.

TODO.md

@@ -0,0 +1,13 @@
+# Things to Do in the future
+
+# After mruby 3.1
+
+- parser and code generator independent from `mrb_state` (picoruby?)
+- variable sized AST node
+- iv/hash entry cache
+- more peephole optimization (if possible)
+
+# Things to do (Things we need to consider)
+
+- `begin ... end while cond` to behave as CRuby
+- special variables ($1,$2..)

appveyor.yml

@@ -1,39 +1,47 @@
 version: "{build}"
 
-os: Visual Studio 2017
-
 shallow_clone: true
 
 environment:
   matrix:
-    # Visual Studio 2017 64bit
-    - visualcpp: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat
+    - job_name: Visual Studio 2022 64-bit
+      visualcpp: C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvars64.bat
+      appveyor_build_worker_image: Visual Studio 2022
 
-    # Visual Studio 2017 32bit
-    - visualcpp: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvarsall.bat
+    - job_name: Visual Studio 2019 64-bit
+      visualcpp: C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat
+      appveyor_build_worker_image: Visual Studio 2019
+
+    - job_name: Visual Studio 2019 32-bit
+      visualcpp: C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars32.bat
+      appveyor_build_worker_image: Visual Studio 2019
+
+    - job_name: Visual Studio 2017 64-bit
+      visualcpp: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat
+      appveyor_build_worker_image: Visual Studio 2017
+
+    - job_name: Visual Studio 2017 32-bit
+      visualcpp: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars32.bat
+      appveyor_build_worker_image: Visual Studio 2017
+
+    - job_name: Visual Studio 2015 64-bit
+      visualcpp: C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat
+      appveyor_build_worker_image: Visual Studio 2015
+      machine: x86_amd64
+
+    - job_name: Visual Studio 2015 32-bit
+      visualcpp: C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat
+      appveyor_build_worker_image: Visual Studio 2015
       machine: x86
 
-    # Visual Studio 2015 64bit
-    - visualcpp: C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat
-      machine: amd64
-
-    # Visual Studio 2015 32bit
-    - visualcpp: C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat
-      machine: x86
-
-    # Visual Studio 2013 64bit
-    - visualcpp: C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat
-      machine: amd64
-
-
 init:
   - call "%visualcpp%" %machine%
-  # For using Rubyinstaller's Ruby 2.4 64bit
-  - set PATH=C:\Ruby24-x64\bin;%PATH%
+  # For using RubyInstaller's Ruby 2.6 64-bit
+  # 2.6 is the highest supported Ruby version across all historical
+  # Visual Studio AppVeyor images. Ruby 2.7 is only on the 2019 image.
+  - set PATH=C:\Ruby26-x64\bin;%PATH%
   - ruby --version
 
-
 build_script:
-  - set MRUBY_CONFIG=appveyor_config.rb
-  - rake -m
-  - rake -E $stdout.sync=true test
+  - set MRUBY_CONFIG=ci/msvc
+  - rake -m test:run:serial

appveyor_config.rb

@@ -1,46 +0,0 @@
-def setup_option(conf)
-  conf.cc.flags[0].delete("/Zi") unless ENV['CFLAGS']
-  conf.cxx.flags[0].delete("/Zi") unless ENV['CFLAGS'] || ENV['CXXFLAGS']
-  conf.linker.flags << "/DEBUG:NONE" unless ENV['LDFLAGS']
-end
-
-MRuby::Build.new('full-debug') do |conf|
-  toolchain :visualcpp
-  enable_debug
-
-  # include all core GEMs
-  conf.gembox 'full-core'
-  conf.cc.defines += %w(MRB_GC_STRESS MRB_METHOD_CACHE MRB_ENABLE_DEBUG_HOOK)
-  setup_option(conf)
-
-  conf.enable_test
-end
-
-MRuby::Build.new do |conf|
-  toolchain :visualcpp
-
-  # include all core GEMs
-  conf.gembox 'full-core'
-  conf.compilers.each do |c|
-    c.defines += %w(MRB_GC_FIXED_ARENA)
-  end
-  setup_option(conf)
-  conf.enable_bintest
-  conf.enable_test
-end
-
-MRuby::Build.new('cxx_abi') do |conf|
-  toolchain :visualcpp
-
-  conf.gembox 'full-core'
-  conf.compilers.each do |c|
-    c.defines += %w(MRB_GC_FIXED_ARENA)
-  end
-  setup_option(conf)
-  conf.enable_bintest
-  conf.enable_test
-
-  enable_cxx_abi
-
-  build_mrbc_exec
-end

benchmark/bm_ao_render.rb

@@ -1,29 +1,29 @@
 # AO render benchmark
-# Original program (C) Syoyo Fujita in Javascript (and other languages)
+# Original program (C) Syoyo Fujita in JavaScript (and other languages)
 #      https://code.google.com/p/aobench/
 # Ruby(yarv2llvm) version by Hideki Miura
 # mruby version by Hideki Miura
 #
 
-IMAGE_WIDTH = 64
-IMAGE_HEIGHT = 64
+IMAGE_WIDTH = Integer(ARGV[0] || 64)
+IMAGE_HEIGHT = IMAGE_WIDTH
 NSUBSAMPLES = 2
 NAO_SAMPLES = 8
 
 module Rand
   # Use xorshift
-  @@x = 123456789
-  @@y = 362436069
-  @@z = 521288629
-  @@w = 88675123
+  @x = 123456789
+  @y = 362436069
+  @z = 521288629
+  @w = 88675123
   BNUM = 1 << 29
   BNUMF = BNUM.to_f
   def self.rand
-    x = @@x
+    x = @x
     t = x ^ ((x & 0xfffff) << 11)
-    w = @@w
-    @@x, @@y, @@z = @@y, @@z, w
-    w = @@w = (w ^ (w >> 19) ^ (t ^ (t >> 8)))
+    w = @w
+    @x, @y, @z = @y, @z, w
+    w = @w = (w ^ (w >> 19) ^ (t ^ (t >> 8)))
     (w % BNUM) / BNUMF
   end
 end
@@ -179,7 +179,7 @@ def clamp(f)
   i.to_i
 end
 
-def otherBasis(basis, n)
+def orthoBasis(basis, n)
   basis[2] = Vec.new(n.x, n.y, n.z)
   basis[1] = Vec.new(0.0, 0.0, 0.0)
 
@@ -211,7 +211,7 @@ class Scene
 
   def ambient_occlusion(isect)
     basis = Array.new(3)
-    otherBasis(basis, isect.n)
+    orthoBasis(basis, isect.n)
 
     ntheta    = NAO_SAMPLES
     nphi      = NAO_SAMPLES
@@ -243,8 +243,6 @@ class Scene
         @plane.intersect(ray, occisect)
         if occisect.hit
           occlusion = occlusion + 1.0
-        else
-          0.0
         end
       end
     end
@@ -254,16 +252,15 @@ class Scene
   end
 
   def render(w, h, nsubsamples)
-    cnt = 0
     nsf = nsubsamples.to_f
+    nsfs = nsf * nsf
     h.times do |y|
       w.times do |x|
         rad = Vec.new(0.0, 0.0, 0.0)
 
-        # Subsmpling
+        # Subsampling
         nsubsamples.times do |v|
           nsubsamples.times do |u|
-            cnt = cnt + 1
             wf = w.to_f
             hf = h.to_f
             xf = x.to_f
@@ -288,15 +285,13 @@ class Scene
               rad.x = rad.x + col.x
               rad.y = rad.y + col.y
               rad.z = rad.z + col.z
-            else
-              0.0
             end
           end
         end
 
-        r = rad.x / (nsf * nsf)
-        g = rad.y / (nsf * nsf)
-        b = rad.z / (nsf * nsf)
+        r = rad.x / nsfs
+        g = rad.y / nsfs
+        b = rad.z / nsfs
         printf("%c", clamp(r))
         printf("%c", clamp(g))
         printf("%c", clamp(b))

benchmark/bm_fib.rb

@@ -1,4 +1,3 @@
-
 def fib n
   return n if n < 2
   fib(n-2) + fib(n-1)

benchmark/bm_so_lists.rb

@@ -1,9 +1,11 @@
-#from http://www.bagley.org/~doug/shootout/bench/lists/lists.ruby
+# from http://www.bagley.org/~doug/shootout/bench/lists/lists.ruby
+# which is lost long time ago. The past content can be retrieved from
+# https://web.archive.org/web/20040805115204/http://www.bagley.org/~doug/shootout/bench/lists/lists.ruby
 
 NUM = 300
 SIZE = 10000
 
-def test_lists()
+def test_lists
   # create a list of integers (Li1) from 1 to SIZE
   li1 = (1..SIZE).to_a
   # copy the list to li2 (not by individual items)

benchmark/bm_so_mandelbrot.rb

@@ -0,0 +1,57 @@
+#  The Computer Language Benchmarks Game
+#  http://shootout.alioth.debian.org/
+#
+#  contributed by Karl von Laudermann
+#  modified by Jeremy Echols
+
+size = 600 # ARGV[0].to_i
+
+puts "P4\n#{size} #{size}"
+
+ITER = 49                           # Iterations - 1 for easy for..in looping
+LIMIT_SQUARED = 4.0                 # Presquared limit
+
+byte_acc = 0
+bit_num = 0
+
+count_size = size - 1               # Precomputed size for easy for..in looping
+
+# For..in loops are faster than .upto, .downto, .times, etc.
+for y in 0..count_size
+  for x in 0..count_size
+    zr = 0.0
+    zi = 0.0
+    cr = (2.0*x/size)-1.5
+    ci = (2.0*y/size)-1.0
+    escape = false
+
+    # To make use of the for..in code, we use a dummy variable,
+    # like one would in C
+    for dummy in 0..ITER
+      tr = zr*zr - zi*zi + cr
+      ti = 2*zr*zi + ci
+      zr, zi = tr, ti
+
+      if (zr*zr+zi*zi) > LIMIT_SQUARED
+        escape = true
+        break
+      end
+    end
+
+    byte_acc = (byte_acc << 1) | (escape ? 0b0 : 0b1)
+    bit_num += 1
+
+    # Code is very similar for these cases, but using separate blocks
+    # ensures we skip the shifting when it's unnecessary, which is most cases.
+    if (bit_num == 8)
+      print byte_acc.chr
+      byte_acc = 0
+      bit_num = 0
+    elsif (x == count_size)
+      byte_acc <<= (8 - bit_num)
+      print byte_acc.chr
+      byte_acc = 0
+      bit_num = 0
+    end
+  end
+end

benchmark/build_config_boxing.rb

@@ -1,28 +0,0 @@
-MRuby::Build.new do |conf|
-  toolchain :gcc
-end
-
-MRuby::Build.new('no_boxing') do |conf|
-  toolchain :gcc
-
-  conf.gembox 'default'
-end
-
-MRuby::Build.new('word_boxing') do |conf|
-  toolchain :gcc
-
-  conf.gembox 'default'
-  conf.compilers.each do |c|
-    c.defines += %w(MRB_WORD_BOXING)
-  end
-end
-
-MRuby::Build.new('nan_boxing') do |conf|
-  toolchain :gcc
-
-  conf.gembox 'default'
-  conf.compilers.each do |c|
-    c.defines += %w(MRB_NAN_BOXING)
-  end
-end
-

benchmark/build_config_cc.rb

@@ -1,13 +0,0 @@
-MRuby::Build.new do |conf|
-  toolchain :gcc
-end
-
-MRuby::Build.new('gcc') do |conf|
-  toolchain :gcc
-  conf.gembox 'default'
-end
-
-MRuby::Build.new('clang') do |conf|
-  toolchain :clang
-  conf.gembox 'default'
-end

build_config.rb

@@ -1,152 +1,9 @@
-MRuby::Build.new do |conf|
-  # load specific toolchain settings
-
-  # Gets set by the VS command prompts.
-  if ENV['VisualStudioVersion'] || ENV['VSINSTALLDIR']
-    toolchain :visualcpp
-  else
-    toolchain :gcc
-  end
-
-  # Turn on `enable_debug` for better debugging
-  # enable_debug
-
-  # Use mrbgems
-  # conf.gem 'examples/mrbgems/ruby_extension_example'
-  # conf.gem 'examples/mrbgems/c_extension_example' do |g|
-  #   g.cc.flags << '-g' # append cflags in this gem
-  # end
-  # conf.gem 'examples/mrbgems/c_and_ruby_extension_example'
-  # conf.gem :core => 'mruby-eval'
-  # conf.gem :mgem => 'mruby-onig-regexp'
-  # conf.gem :github => 'mattn/mruby-onig-regexp'
-  # conf.gem :git => 'git@github.com:mattn/mruby-onig-regexp.git', :branch => 'master', :options => '-v'
-
-  # include the default GEMs
-  conf.gembox 'default'
-  # C compiler settings
-  # conf.cc do |cc|
-  #   cc.command = ENV['CC'] || 'gcc'
-  #   cc.flags = [ENV['CFLAGS'] || %w()]
-  #   cc.include_paths = ["#{root}/include"]
-  #   cc.defines = %w()
-  #   cc.option_include_path = %q[-I"%s"]
-  #   cc.option_define = '-D%s'
-  #   cc.compile_options = %Q[%{flags} -MMD -o "%{outfile}" -c "%{infile}"]
-  # end
-
-  # mrbc settings
-  # conf.mrbc do |mrbc|
-  #   mrbc.compile_options = "-g -B%{funcname} -o-" # The -g option is required for line numbers
-  # end
-
-  # Linker settings
-  # conf.linker do |linker|
-  #   linker.command = ENV['LD'] || 'gcc'
-  #   linker.flags = [ENV['LDFLAGS'] || []]
-  #   linker.flags_before_libraries = []
-  #   linker.libraries = %w()
-  #   linker.flags_after_libraries = []
-  #   linker.library_paths = []
-  #   linker.option_library = '-l%s'
-  #   linker.option_library_path = '-L%s'
-  #   linker.link_options = "%{flags} -o "%{outfile}" %{objs} %{libs}"
-  # end
-
-  # Archiver settings
-  # conf.archiver do |archiver|
-  #   archiver.command = ENV['AR'] || 'ar'
-  #   archiver.archive_options = 'rs "%{outfile}" %{objs}'
-  # end
-
-  # Parser generator settings
-  # conf.yacc do |yacc|
-  #   yacc.command = ENV['YACC'] || 'bison'
-  #   yacc.compile_options = %q[-o "%{outfile}" "%{infile}"]
-  # end
-
-  # gperf settings
-  # conf.gperf do |gperf|
-  #   gperf.command = 'gperf'
-  #   gperf.compile_options = %q[-L ANSI-C -C -p -j1 -i 1 -g -o -t -N mrb_reserved_word -k"1,3,$" "%{infile}" > "%{outfile}"]
-  # end
-
-  # file extensions
-  # conf.exts do |exts|
-  #   exts.object = '.o'
-  #   exts.executable = '' # '.exe' if Windows
-  #   exts.library = '.a'
-  # end
-
-  # file separetor
-  # conf.file_separator = '/'
-
-  # bintest
-  # conf.enable_bintest
-end
-
-MRuby::Build.new('host-debug') do |conf|
-  # load specific toolchain settings
-
-  # Gets set by the VS command prompts.
-  if ENV['VisualStudioVersion'] || ENV['VSINSTALLDIR']
-    toolchain :visualcpp
-  else
-    toolchain :gcc
-  end
-
-  enable_debug
-
-  # include the default GEMs
-  conf.gembox 'default'
-
-  # C compiler settings
-  conf.cc.defines = %w(MRB_ENABLE_DEBUG_HOOK)
-
-  # Generate mruby debugger command (require mruby-eval)
-  conf.gem :core => "mruby-bin-debugger"
-
-  # bintest
-  # conf.enable_bintest
-end
-
-MRuby::Build.new('test') do |conf|
-  # Gets set by the VS command prompts.
-  if ENV['VisualStudioVersion'] || ENV['VSINSTALLDIR']
-    toolchain :visualcpp
-  else
-    toolchain :gcc
-  end
-
-  enable_debug
-  conf.enable_bintest
-  conf.enable_test
-
-  conf.gembox 'default'
-end
-
-#MRuby::Build.new('bench') do |conf|
-#  # Gets set by the VS command prompts.
-#  if ENV['VisualStudioVersion'] || ENV['VSINSTALLDIR']
-#    toolchain :visualcpp
-#  else
-#    toolchain :gcc
-#    conf.cc.flags << '-O3'
-#  end
+# The default build configuration file was moved to `build_config/default.rb`.
 #
-#  conf.gembox 'default'
-#end
-
-# Define cross build settings
-# MRuby::CrossBuild.new('32bit') do |conf|
-#   toolchain :gcc
-#
-#   conf.cc.flags << "-m32"
-#   conf.linker.flags << "-m32"
-#
-#   conf.build_mrbtest_lib_only
-#
-#   conf.gem 'examples/mrbgems/c_and_ruby_extension_example'
-#
-#   conf.test_runner.command = 'env'
-# end
+# Recommended way to customize the build configuration is:
+#  * copy `default.rb` (or any config file) to a new file (e.g. `myconfig.rb`)
+#  * edit `myconfig.rb`.
+#  * `rake MRUBY_CONFIG=/path/to/myconfig.rb` to compile and test.
+#  * or `rake MRUBY_CONFIG=myconfig` if your configuration file is in the `build_config` directory.
+#  * (optional) submit your configuration as a pull-request if it's useful for others
+raise "The default configuration was moved to `build_config/default.rb`"

build_config/ArduinoDue.rb

@@ -1,21 +1,5 @@
-MRuby::Build.new do |conf|
-
-  # Gets set by the VS command prompts.
-  if ENV['VisualStudioVersion'] || ENV['VSINSTALLDIR']
-    toolchain :visualcpp
-  else
-    toolchain :gcc
-  end
-
-  enable_debug
-
-  # include the default GEMs
-  conf.gembox 'default'
-
-end
-
 # Cross Compiling configuration for Arduino Due
-# http://arduino.cc/en/Main/ArduinoBoardDue
+# https://arduino.cc/en/Main/ArduinoBoardDue
 #
 # Requires Arduino IDE >= 1.5
 MRuby::CrossBuild.new("ArduinoDue") do |conf|
@@ -27,7 +11,7 @@ MRuby::CrossBuild.new("ArduinoDue") do |conf|
   # ARDUINO_PATH = '/Applications/Arduino.app/Contents/Java'
   # GNU Linux
   ARDUINO_PATH = '/opt/arduino'
-   # Arduino IDE <= 1.5.6
+  # Arduino IDE <= 1.5.6
   BIN_PATH = "#{ARDUINO_PATH}/hardware/tools/g++_arm_none_eabi/bin"
   # Arduino IDE >= 1.5.7
   # BIN_PATH = "#{ARDUINO_PATH}/hardware/tools/gcc-arm-none-eabi-4.8.3-2014q1/bin"
@@ -47,9 +31,8 @@ MRuby::CrossBuild.new("ArduinoDue") do |conf|
     #configuration for low memory environment
     cc.defines << %w(MRB_HEAP_PAGE_SIZE=64)
     cc.defines << %w(KHASH_DEFAULT_SIZE=8)
-    cc.defines << %w(MRB_STR_BUF_MIN_SIZE=20)
     cc.defines << %w(MRB_GC_STRESS)
-    #cc.defines << %w(MRB_DISABLE_STDIO) #if you dont need stdio.
+    #cc.defines << %w(MRB_NO_STDIO) #if you don't need stdio.
     #cc.defines << %w(POOL_PAGE_SIZE=1000) #effective only for use with mruby-eval
   end
 
@@ -77,7 +60,6 @@ MRuby::CrossBuild.new("ArduinoDue") do |conf|
   conf.disable_cxx_exception
 
   #gems from core
-  conf.gem :core => "mruby-print"
   conf.gem :core => "mruby-math"
   conf.gem :core => "mruby-enum-ext"
 

build_config/IntelEdison.rb

@@ -5,7 +5,7 @@
 MRuby::Build.new do |conf|
   toolchain :gcc
   conf.gembox 'default'
-  conf.cc.defines = %w(ENABLE_READLINE)
+  conf.cc.defines = %w(MRB_USE_READLINE)
   conf.gembox 'default'
 
   #lightweight regular expression
@@ -21,7 +21,7 @@ MRuby::CrossBuild.new('core2-32-poky-linux') do |conf|
   #
   POKY_EDISON_PATH = '/opt/poky-edison/1.7.2'
 
-  POKY_EDISON_SYSROOT =  "#{POKY_EDISON_PATH}/sysroots/core2-32-poky-linux"
+  POKY_EDISON_SYSROOT  = "#{POKY_EDISON_PATH}/sysroots/core2-32-poky-linux"
   POKY_EDISON_X86_PATH = "#{POKY_EDISON_PATH}/sysroots/i386-pokysdk-darwin"
   POKY_EDISON_BIN_PATH = "#{POKY_EDISON_X86_PATH}/usr/bin/i586-poky-linux"
 
@@ -33,7 +33,7 @@ MRuby::CrossBuild.new('core2-32-poky-linux') do |conf|
     cc.flags << %w(-O2 -pipe -g -feliminate-unused-debug-types)
     cc.flags << "--sysroot=#{POKY_EDISON_SYSROOT}"
     cc.compile_options = %Q[%{flags} -o "%{outfile}" -c "%{infile}"]
-    cc.defines = %w(ENABLE_READLINE)
+    cc.defines = %w(MRB_USE_READLINE)
   end
 
   conf.cxx do |cxx|

build_config/IntelGalileo.rb

@@ -1,22 +1,5 @@
-MRuby::Build.new do |conf|
-
-  # Gets set by the VS command prompts.
-  if ENV['VisualStudioVersion'] || ENV['VSINSTALLDIR']
-    toolchain :visualcpp
-  else
-    toolchain :gcc
-  end
-
-  enable_debug
-
-  # include the default GEMs
-  conf.gembox 'default'
-
-end
-
-
 # Cross Compiling configuration for Intel Galileo on Arduino environment
-# http://arduino.cc/en/ArduinoCertified/IntelGalileo
+# https://arduino.cc/en/ArduinoCertified/IntelGalileo
 #
 # Requires Arduino IDE for Intel Galileo
 MRuby::CrossBuild.new("Galileo") do |conf|
@@ -29,7 +12,7 @@ MRuby::CrossBuild.new("Galileo") do |conf|
   #ARDUINO_GALILEO_PATH = '/opt/arduino'
 
   GALILEO_BIN_PATH = "#{GALILEO_ARDUINO_PATH}/hardware/tools/x86/i386-pokysdk-darwin/usr/bin/i586-poky-linux-uclibc"
-  GALILEO_SYSROOT =  "#{GALILEO_ARDUINO_PATH}/hardware/tools/x86/i586-poky-linux-uclibc"
+  GALILEO_SYSROOT  = "#{GALILEO_ARDUINO_PATH}/hardware/tools/x86/i586-poky-linux-uclibc"
   GALILEO_X86_PATH = "#{GALILEO_ARDUINO_PATH}/hardware/arduino/x86"
 
 
@@ -73,7 +56,6 @@ MRuby::CrossBuild.new("Galileo") do |conf|
 
   #official mrbgems
   conf.gem :core => "mruby-sprintf"
-  conf.gem :core => "mruby-print"
   conf.gem :core => "mruby-math"
   conf.gem :core => "mruby-time"
   conf.gem :core => "mruby-struct"
@@ -91,7 +73,7 @@ MRuby::CrossBuild.new("Galileo") do |conf|
   conf.gem :core => "mruby-fiber"
   conf.gem :core => "mruby-toplevel-ext"
 
-  #lightweigh regular expression
+  #lightweight regular expression
   conf.gem :github => "masamitsu-murase/mruby-hs-regexp", :branch => "master"
 
   #Arduino API

build_config/RX630.rb

@@ -1,19 +1,3 @@
-MRuby::Build.new do |conf|
-
-  # Gets set by the VS command prompts.
-  if ENV['VisualStudioVersion'] || ENV['VSINSTALLDIR']
-    toolchain :visualcpp
-  else
-    toolchain :gcc
-  end
-
-  enable_debug
-
-  # include the default GEMs
-  conf.gembox 'default'
-
-end
-
 # Cross Compiling configuration for RX630
 # http://gadget.renesas.com/
 #
@@ -30,12 +14,11 @@ MRuby::CrossBuild.new("RX630") do |conf|
     cc.compile_options = %Q[%{flags} -o "%{outfile}" -c "%{infile}"]
 
     #configuration for low memory environment
-    cc.defines << %w(MRB_USE_FLOAT)
+    cc.defines << %w(MRB_USE_FLOAT32)
     cc.defines << %w(MRB_HEAP_PAGE_SIZE=64)
     cc.defines << %w(KHASH_DEFAULT_SIZE=8)
-    cc.defines << %w(MRB_STR_BUF_MIN_SIZE=20)
     cc.defines << %w(MRB_GC_STRESS)
-    cc.defines << %w(MRB_DISABLE_STDIO) #if you dont need stdio.
+    cc.defines << %w(MRB_NO_STDIO) #if you don't need stdio.
     #cc.defines << %w(POOL_PAGE_SIZE=1000) #effective only for use with mruby-eval
   end
 
@@ -67,7 +50,6 @@ MRuby::CrossBuild.new("RX630") do |conf|
 
   #gems from core
   conf.gem :core => "mruby-sprintf"
-  conf.gem :core => "mruby-print"
   conf.gem :core => "mruby-math"
   conf.gem :core => "mruby-enum-ext"
   conf.gem :core => "mruby-numeric-ext"

build_config/android_arm64_v8a.rb

@@ -0,0 +1,11 @@
+# Requires Android NDK r13 or later.
+MRuby::CrossBuild.new('android-arm64-v8a') do |conf|
+  params = {
+    :arch => 'arm64-v8a',
+    :sdk_version => 33,
+    :toolchain => :clang
+  }
+  toolchain :android, params
+
+  conf.gembox 'default'
+end

build_config/android_armeabi_v7a_neon_hard.rb

@@ -0,0 +1,13 @@
+# Requires Android NDK r13 or later.
+MRuby::CrossBuild.new('android-armeabi-v7a-neon-hard') do |conf|
+  params = {
+    :arch => 'armeabi-v7a',
+    :mfpu => 'neon',
+    :mfloat_abi => 'hard',
+    :sdk_version => 33,
+    :toolchain => :clang
+  }
+  toolchain :android, params
+
+  conf.gembox 'default'
+end

build_config/bench.rb

@@ -0,0 +1,11 @@
+MRuby::Build.new('bench') do |conf|
+  # Gets set by the VS command prompts.
+  if ENV['VisualStudioVersion'] || ENV['VSINSTALLDIR']
+    toolchain :visualcpp
+  else
+    toolchain :gcc
+    conf.cc.flags << '-O3'
+  end
+
+  conf.gembox 'default'
+end

build_config/boxing.rb

@@ -0,0 +1,19 @@
+boxings = %w[no word nan]
+bits = [64, 32]
+ints = [64, 32]
+
+boxings.product(bits, ints) do |boxing, bit, int|
+  MRuby::Build.new("boxing-#{boxing}-m#{bit}-i#{int}") do |conf|
+    conf.toolchain :gcc
+    conf.gembox 'full-core'
+    conf.compilers.each do |c|
+      c.defines << "MRB_#{boxing.upcase}_BOXING"
+      c.defines << "MRB_INT#{int}"
+      c.flags << "-m#{bit}"
+    end
+    conf.linker.flags << "-m#{bit}"
+    conf.enable_debug
+    conf.enable_test
+    conf.enable_bintest
+  end
+end

build_config/chipKITMax32.rb

@@ -1,21 +1,5 @@
-MRuby::Build.new do |conf|
-
-  # Gets set by the VS command prompts.
-  if ENV['VisualStudioVersion'] || ENV['VSINSTALLDIR']
-    toolchain :visualcpp
-  else
-    toolchain :gcc
-  end
-
-  enable_debug
-
-  # include the default GEMs
-  conf.gembox 'default'
-
-end
-
 # Cross Compiling configuration for Digilent chipKIT Max32
-# http://www.digilentinc.com/Products/Detail.cfm?Prod=CHIPKIT-MAX32
+# https://www.digilentinc.com/Products/Detail.cfm?Prod=CHIPKIT-MAX32
 #
 # Requires MPIDE (https://github.com/chipKIT32/chipKIT32-MAX)
 #
@@ -44,9 +28,8 @@ MRuby::CrossBuild.new("chipKITMax32") do |conf|
     #configuration for low memory environment
     cc.defines << %w(MRB_HEAP_PAGE_SIZE=64)
     cc.defines << %w(KHASH_DEFAULT_SIZE=8)
-    cc.defines << %w(MRB_STR_BUF_MIN_SIZE=20)
     cc.defines << %w(MRB_GC_STRESS)
-    #cc.defines << %w(MRB_DISABLE_STDIO) #if you dont need stdio.
+    #cc.defines << %w(MRB_NO_STDIO) #if you don't need stdio.
     #cc.defines << %w(POOL_PAGE_SIZE=1000) #effective only for use with mruby-eval
   end
 
@@ -73,7 +56,6 @@ MRuby::CrossBuild.new("chipKITMax32") do |conf|
   conf.disable_cxx_exception
 
   #gems from core
-  conf.gem :core => "mruby-print"
   conf.gem :core => "mruby-math"
   conf.gem :core => "mruby-enum-ext"
 

build_config/ci/gcc-clang.rb

@@ -1,21 +1,22 @@
+STDOUT.sync = STDERR.sync = true unless Rake.application.options.always_multitask
+
 MRuby::Build.new('full-debug') do |conf|
-  toolchain :gcc
-  enable_debug
+  conf.toolchain
+  conf.enable_debug
 
   # include all core GEMs
   conf.gembox 'full-core'
-  conf.cc.flags += %w(-Werror=declaration-after-statement)
-  conf.cc.defines += %w(MRB_GC_STRESS MRB_METHOD_CACHE MRB_ENABLE_DEBUG_HOOK)
+  conf.cc.defines += %w(MRB_GC_STRESS MRB_USE_DEBUG_HOOK)
 
   conf.enable_test
 end
 
 MRuby::Build.new do |conf|
-  toolchain :gcc
+  conf.toolchain
 
   # include all core GEMs
   conf.gembox 'full-core'
-  conf.cc.flags += %w(-Werror=declaration-after-statement)
+  conf.gem :core => 'mruby-bin-debugger'
   conf.compilers.each do |c|
     c.defines += %w(MRB_GC_FIXED_ARENA)
   end
@@ -24,17 +25,16 @@ MRuby::Build.new do |conf|
 end
 
 MRuby::Build.new('cxx_abi') do |conf|
-  toolchain :gcc
+  conf.toolchain
 
   conf.gembox 'full-core'
-  conf.cc.flags += %w(-fpermissive)
+  conf.cc.flags += %w(-fpermissive -std=gnu++03)
   conf.compilers.each do |c|
     c.defines += %w(MRB_GC_FIXED_ARENA)
   end
-  conf.enable_bintest
   conf.enable_test
 
-  enable_cxx_abi
+  conf.enable_cxx_abi
 
-  build_mrbc_exec
+  conf.build_mrbc_exec
 end

build_config/ci/msvc.rb

@@ -0,0 +1,20 @@
+STDOUT.sync = STDERR.sync = true unless Rake.application.options.always_multitask
+
+def setup_option(conf)
+  conf.cc.compile_options.sub!(%r{/Zi }, "") unless ENV['CFLAGS']
+  conf.cxx.compile_options.sub!(%r{/Zi }, "") unless ENV['CFLAGS'] || ENV['CXXFLAGS']
+  conf.linker.flags << "/DEBUG:NONE" unless ENV['LDFLAGS']
+end
+
+MRuby::Build.new do |conf|
+  conf.toolchain :visualcpp
+
+  # include all core GEMs
+  conf.gembox 'full-core'
+  conf.compilers.each do |c|
+    c.defines += %w(MRB_GC_FIXED_ARENA)
+  end
+  setup_option(conf)
+  conf.enable_bintest
+  conf.enable_test
+end

build_config/clang-asan.rb

@@ -0,0 +1,11 @@
+MRuby::Build.new do |conf|
+  conf.toolchain :clang
+  # include the GEM box
+  conf.gembox 'full-core'
+
+  # Turn on `enable_debug` for better debugging
+  conf.enable_sanitizer "address,undefined"
+  conf.enable_debug
+  conf.enable_bintest
+  conf.enable_test
+end

build_config/cross-32bit.rb

@@ -0,0 +1,14 @@
+# Define cross build settings
+MRuby::CrossBuild.new('cross-32bit') do |conf|
+  conf.toolchain :gcc
+
+  conf.cc.flags << "-m32"
+  conf.linker.flags << "-m32"
+
+  # conf.build_mrbtest_lib_only
+
+  conf.gem :core => "mruby-bin-mruby"
+  conf.gem "#{MRUBY_ROOT}/examples/mrbgems/c_and_ruby_extension_example"
+
+  conf.test_runner.command = 'env'
+end

build_config/cross-mingw-winetest.rb

@@ -0,0 +1,90 @@
+# Cross-compile using MinGW and test using Wine.
+#
+# Steps:
+#
+#   1. Install MinGW; 64-bit target seems to work best.
+#
+#   2. Install Wine.
+#
+#   3. Run command:
+#
+#           wine cmd /c echo "Hello world"'
+#
+#      This will confirm that Wine works and will trigger standard
+#      Wine setup, which is slow.
+#
+#   4. Confirm that drive 'z:' is mapped to your root filesystem.
+#      (This is supposed to be a default but it helps to
+#      double-check.) To confirm, run:
+#
+#           wine cmd /c dir 'z:\\'
+#
+#      This should give you a DOS-style equivalent of 'ls /'. If not,
+#      you'll need to fix that with winecfg or by adding a symlink to
+#      '~/.wine/dosdevices'.
+#
+#   5. You will likely need to tweak the settings below to work with
+#      your configuration unless it is exactly like one of the platforms
+#      I've tested on (Ubuntu 20.04 or macOS using brew.)
+#
+#   6. Run the build command:
+#
+#           MRUBY_CONFIG=build_config/cross-mingw-winetest.rb rake test
+#
+#      If all goes well, you should now have Windows executables and a
+#      set of passing tests.
+#
+#
+#  Caveats:
+#
+#    1. This works by using a helper script that rewrites test output
+#       to make it look *nix-like and then handing it back to the test
+#       cases. Some of the existing tests were (slightly) modified to
+#       make this easier but only for the 'full-core' gembox. Other
+#       gems' bintests may or may not work with the helper script and
+#       may or may not be fixable by extending the script.
+#
+#   2.  MinGW and Wine are both complex and not very consistent so you
+#       will likely need to do some fiddling to get things to work.
+#
+#   3.  This script assumes you are running it on a *nix-style OS.
+#
+#   4.  I recommend building 64-bit targets only. Building a 32-bit
+#       Windows binary with i686-w64-mingw32 seems to work (at least,
+#       it did for me) but the resulting executable failed a number of
+#       unit tests due to small errors in some floating-point
+#       operations. It's unclear if this indicates more serious problems.
+#
+
+
+MRuby::CrossBuild.new("cross-mingw-winetest") do |conf|
+  conf.toolchain :gcc
+
+  conf.host_target = "x86_64-w64-mingw32"
+
+  # Ubuntu 20
+  conf.cc.command = "#{conf.host_target}-gcc-posix"
+
+  # macOS+Wine from brew
+  #conf.cc.command = "#{conf.host_target}-gcc"
+
+  conf.linker.command = conf.cc.command
+  conf.archiver.command = "#{conf.host_target}-gcc-ar"
+  conf.exts.executable = ".exe"
+
+  # By default, we compile as static as possible to remove runtime
+  # MinGW dependencies; they are probably fixable but it gets
+  # complicated.
+  conf.cc.flags = ['-static']
+  conf.linker.flags += ['-static']
+
+  conf.test_runner do |t|
+    thisdir = File.absolute_path( File.dirname(__FILE__) )
+    t.command = File.join(thisdir, * %w{ helpers wine_runner.rb})
+  end
+
+  conf.gembox "full-core"
+
+  conf.enable_bintest
+  conf.enable_test
+end

build_config/cross-mingw.rb

@@ -0,0 +1,14 @@
+#
+# Ubuntu 20.04 requires at least `gcc-mingw-w64-x86-64` package as a
+# cross compiler.
+#
+
+MRuby::CrossBuild.new("cross-mingw") do |conf|
+  conf.toolchain :gcc
+  conf.host_target = "x86_64-w64-mingw32"  # required for `for_windows?` used by `mruby-socket` gem
+  conf.cc.command = "#{conf.host_target}-gcc-posix"
+  conf.linker.command = conf.cc.command
+  conf.archiver.command = "#{conf.host_target}-gcc-ar"
+  conf.exts.executable = ".exe"
+  conf.gembox "default"
+end

build_config/default.rb

@@ -0,0 +1,83 @@
+MRuby::Build.new do |conf|
+  # load specific toolchain settings
+  conf.toolchain
+
+  # Use mrbgems
+  # conf.gem 'examples/mrbgems/ruby_extension_example'
+  # conf.gem 'examples/mrbgems/c_extension_example' do |g|
+  #   g.cc.flags << '-g' # append cflags in this gem
+  # end
+  # conf.gem 'examples/mrbgems/c_and_ruby_extension_example'
+  # conf.gem :core => 'mruby-eval'
+  # conf.gem :mgem => 'mruby-onig-regexp'
+  # conf.gem :github => 'mattn/mruby-onig-regexp'
+  # conf.gem :git => 'git@github.com:mattn/mruby-onig-regexp.git', :branch => 'master', :options => '-v'
+
+  # include the GEM box
+  conf.gembox 'default'
+
+  # C compiler settings
+  # conf.cc do |cc|
+  #   cc.command = ENV['CC'] || 'gcc'
+  #   cc.flags = [ENV['CFLAGS'] || %w()]
+  #   cc.include_paths = ["#{root}/include"]
+  #   cc.defines = %w()
+  #   cc.option_include_path = %q[-I"%s"]
+  #   cc.option_define = '-D%s'
+  #   cc.compile_options = %Q[%{flags} -MMD -o "%{outfile}" -c "%{infile}"]
+  # end
+
+  # mrbc settings
+  # conf.mrbc do |mrbc|
+  #   mrbc.compile_options = "-g -B%{funcname} -o-" # The -g option is required for line numbers
+  # end
+
+  # Linker settings
+  # conf.linker do |linker|
+  #   linker.command = ENV['LD'] || 'gcc'
+  #   linker.flags = [ENV['LDFLAGS'] || []]
+  #   linker.flags_before_libraries = []
+  #   linker.libraries = %w()
+  #   linker.flags_after_libraries = []
+  #   linker.library_paths = []
+  #   linker.option_library = '-l%s'
+  #   linker.option_library_path = '-L%s'
+  #   linker.link_options = %Q[%{flags} -o "%{outfile}" %{objs} %{libs}]
+  # end
+
+  # Archiver settings
+  # conf.archiver do |archiver|
+  #   archiver.command = ENV['AR'] || 'ar'
+  #   archiver.archive_options = 'rs "%{outfile}" %{objs}'
+  # end
+
+  # Parser generator settings
+  # conf.yacc do |yacc|
+  #   yacc.command = ENV['YACC'] || 'bison'
+  #   yacc.compile_options = %q[-o "%{outfile}" "%{infile}"]
+  # end
+
+  # gperf settings
+  # conf.gperf do |gperf|
+  #   gperf.command = 'gperf'
+  #   gperf.compile_options = %q[-L ANSI-C -C -j1 -i 1 -o -t -N mrb_reserved_word -k"1,3,$" "%{infile}" > "%{outfile}"]
+  # end
+
+  # file extensions
+  # conf.exts do |exts|
+  #   exts.object = '.o'
+  #   exts.executable = '' # '.exe' if Windows
+  #   exts.library = '.a'
+  # end
+
+  # file separator
+  # conf.file_separator = '/'
+
+  # change library directory name from the default "lib" if necessary
+  # conf.libdir_name = 'lib64'
+
+  # Turn on `enable_debug` for better debugging
+  # conf.enable_debug
+  conf.enable_bintest
+  conf.enable_test
+end

build_config/dreamcast_shelf.rb

@@ -0,0 +1,82 @@
+# Cross Compiling configuration for the Sega Dreamcast
+# https://dreamcast.wiki/Using_Ruby_for_Sega_Dreamcast_development
+#
+# Requires KallistiOS (KOS)
+# http://gamedev.allusion.net/softprj/kos/
+#
+# This configuration has been improved to be used as KallistiOS Port (kos-ports)
+# Updated: 2023-12-24
+#
+# Tested on GNU/Linux, macOS and Windows (MinGW-w64/MSYS2, Cygwin, DreamSDK)
+# DreamSDK is based on MinGW/MSYS: https://dreamsdk.org/
+#
+# Install mruby for Sega Dreamcast using the "mruby" kos-port.
+#
+MRuby::CrossBuild.new("dreamcast") do |conf|
+  toolchain :gcc
+
+  # Getting critical environment variables
+  KOS_BASE = ENV["KOS_BASE"]
+  KOS_CC_BASE = ENV["KOS_CC_BASE"]
+
+  if (KOS_BASE.nil? || KOS_BASE.empty? || KOS_CC_BASE.nil? || KOS_CC_BASE.empty?)
+    raise "Error: KallistiOS is required; KOS_BASE/KOS_CC_BASE needs to be declared; Stop."
+  end
+
+  # C compiler
+  # All flags and settings below were extracted from KallistiOS environment files
+  conf.cc do |cc|
+    cc.command = "#{KOS_CC_BASE}/bin/sh-elf-gcc"
+    cc.include_paths << ["#{KOS_BASE}/include", "#{KOS_BASE}/kernel/arch/dreamcast/include", "#{KOS_BASE}/addons/include", "#{KOS_BASE}/../kos-ports/include"]
+    cc.flags << ["-O2", "-fomit-frame-pointer", "-fno-builtin", "-ml", "-m4-single-only", "-ffunction-sections", "-fdata-sections", "-matomic-model=soft-imask", "-ftls-model=local-exec", "-Wall", "-g"]
+    cc.compile_options = %Q[%{flags} -o "%{outfile}" -c "%{infile}"]
+    cc.defines << %w(_arch_dreamcast)
+    cc.defines << %w(_arch_sub_pristine)
+  end
+
+  # C++ compiler
+  conf.cxx do |cxx|
+    cxx.command = conf.cc.command.dup
+    cxx.include_paths = conf.cc.include_paths.dup
+    cxx.flags = conf.cc.flags.dup
+    cxx.flags << %w(-fno-operator-names)
+    cxx.defines = conf.cc.defines.dup
+    cxx.compile_options = conf.cc.compile_options.dup
+  end
+
+  # Linker
+  conf.linker do |linker|
+    linker.command = "#{KOS_CC_BASE}/bin/sh-elf-gcc"
+    linker.flags << ["-Wl,-Ttext=0x8c010000", "-Wl,--gc-sections", "-T#{KOS_BASE}/utils/ldscripts/shlelf.xc", "-nodefaultlibs", "-Wl,--start-group -lkallisti -lc -lgcc -Wl,--end-group"]
+    linker.library_paths << ["#{KOS_BASE}/lib/dreamcast", "#{KOS_BASE}/addons/lib/dreamcast", "#{KOS_BASE}/../kos-ports/lib"]
+  end
+
+  # Archiver
+  conf.archiver do |archiver|
+    archiver.command = "#{KOS_CC_BASE}/bin/sh-elf-ar"
+    archiver.archive_options = 'rcs "%{outfile}" %{objs}'
+  end
+
+  # No executables needed for KallistiOS
+  conf.bins = []
+
+  # Do not build test binaries
+  conf.build_mrbtest_lib_only
+
+  # Gemboxes
+  conf.gembox "default-no-stdio"
+  conf.gembox "stdlib-ext"
+  conf.gembox "metaprog"
+
+  # Additional Gems
+  # Currently unsupported on KallistiOS: "mruby-io", "mruby-dir", "mruby-socket"
+  conf.gem :core => "mruby-binding"
+  conf.gem :core => "mruby-catch"
+  conf.gem :core => "mruby-enum-chain"
+  conf.gem :core => "mruby-errno"
+  conf.gem :core => "mruby-error"
+  conf.gem :core => "mruby-exit"
+  conf.gem :core => "mruby-os-memsize"
+  conf.gem :core => "mruby-proc-binding"
+  conf.gem :core => "mruby-sleep"
+end

build_config/emscripten-cxx.rb

@@ -0,0 +1,12 @@
+# Make sure to add these compile options:
+#   build/emscripten-cxx/host-bin/mruby-config --cxxflags
+#
+# Make sure to add these link options:
+#   build/emscripten-cxx/host-bin/mruby-config --ldflags --libs
+MRuby::CrossBuild.new('emscripten-cxx') do |conf|
+  conf.toolchain :emscripten
+
+  conf.gembox 'default'
+
+  conf.enable_cxx_abi
+end

build_config/emscripten.rb

@@ -0,0 +1,10 @@
+# Make sure to add these compile options:
+#   build/emscripten/host-bin/mruby-config --cflags
+#
+# Make sure to add these link options:
+#   build/emscripten/host-bin/mruby-config --ldflags --libs
+MRuby::CrossBuild.new('emscripten') do |conf|
+  conf.toolchain :emscripten
+
+  conf.gembox 'default'
+end

build_config/gameboyadvance.rb

@@ -0,0 +1,72 @@
+# Cross Compiling configuration for the Nintendo GameBoyAdvance.
+# This configuration requires devkitARM
+# https://devkitpro.org/wiki/Getting_Started/devkitARM
+#
+# Tested only on GNU/Linux
+#
+MRuby::CrossBuild.new("gameboyadvance") do |conf|
+  toolchain :gcc
+
+  DEVKITPRO_PATH = "/opt/devkitpro"
+  BIN_PATH = "#{DEVKITPRO_PATH}/devkitARM/bin"
+
+  # C compiler
+  conf.cc do |cc|
+    cc.command = "#{BIN_PATH}/arm-none-eabi-gcc"
+    cc.flags << ["-mthumb-interwork", "-mthumb", "-O2"]
+    cc.compile_options = %(%{flags} -o "%{outfile}" -c "%{infile}")
+  end
+
+  # C++ compiler
+  conf.cxx do |cxx|
+    cxx.command = "#{BIN_PATH}/arm-none-eabi-g++"
+    cxx.include_paths = conf.cc.include_paths.dup
+    cxx.flags = conf.cc.flags.dup
+    cxx.flags << %w[-fno-rtti -fno-exceptions]
+    cxx.defines = conf.cc.defines.dup
+    cxx.compile_options = conf.cc.compile_options.dup
+  end
+
+  # Linker
+  conf.linker do |linker|
+    linker.command = "#{BIN_PATH}/arm-none-eabi-gcc"
+    linker.flags << ["-mthumb-interwork", "-mthumb", "-specs=gba.specs"]
+  end
+
+  # No executables
+  conf.bins = []
+
+  # Do not build executable test
+  conf.build_mrbtest_lib_only
+
+  # Disable C++ exception
+  conf.disable_cxx_exception
+
+  # Gems from core
+  # removing mruby-io
+  conf.gem core: "mruby-metaprog"
+  conf.gem core: "mruby-pack"
+  conf.gem core: "mruby-sprintf"
+  conf.gem core: "mruby-math"
+  conf.gem core: "mruby-time"
+  conf.gem core: "mruby-struct"
+  conf.gem core: "mruby-compar-ext"
+  conf.gem core: "mruby-enum-ext"
+  conf.gem core: "mruby-string-ext"
+  conf.gem core: "mruby-numeric-ext"
+  conf.gem core: "mruby-array-ext"
+  conf.gem core: "mruby-hash-ext"
+  conf.gem core: "mruby-range-ext"
+  conf.gem core: "mruby-proc-ext"
+  conf.gem core: "mruby-symbol-ext"
+  conf.gem core: "mruby-random"
+  conf.gem core: "mruby-object-ext"
+  conf.gem core: "mruby-objectspace"
+  conf.gem core: "mruby-fiber"
+  conf.gem core: "mruby-enumerator"
+  conf.gem core: "mruby-enum-lazy"
+  conf.gem core: "mruby-toplevel-ext"
+  conf.gem core: "mruby-kernel-ext"
+  conf.gem core: "mruby-class-ext"
+  conf.gem core: "mruby-compiler"
+end

build_config/helpers/wine_runner.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+# Wrapper for running tests for cross-compiled Windows builds in Wine.
+
+require 'open3'
+
+DOSROOT = 'z:'
+
+# Rewrite test output to replace DOS-isms with Unix-isms.
+def clean(output, stderr = false)
+  ends_with_newline = !!(output =~ /\n$/)
+  executable = ARGV[0].gsub(/\.exe\z/i, '')
+
+  # Fix line-ends
+  output = output.gsub(/\r\n/, "\n")
+
+  # Strip out Wine messages
+
+
+  results = output.split(/\n/).map do |line|
+    # Fix file paths
+    if line =~ /#{DOSROOT}\\/i
+      line.gsub!(/#{DOSROOT}([^:]*)/i) { |path|
+        path.gsub!(/^#{DOSROOT}/i, '')
+        path.gsub!(%r{\\}, '/')
+        path
+      }
+    end
+
+    # strip '.exe' off the end of the executable's name if needed
+    line.gsub!(/(#{Regexp.escape executable})\.exe/i, '\1')
+
+    line
+  end
+
+  result_text = results.join("\n")
+  result_text += "\n" if ends_with_newline
+  result_text
+end
+
+
+def main
+  if ARGV.empty? || ARGV[0] =~ /^- (-?) (\?|help|h) $/x
+    puts "#{$0} <command-line>"
+    exit 0
+  end
+
+  # For simplicity, just read all of stdin into memory and pass that
+  # as an argument when invoking wine. (Skipped if STDIN was not
+  # redirected.)
+  if !STDIN.tty?
+    input = STDIN.read
+  else
+    input = ""
+  end
+
+  # Disable all Wine messages so they don't interfere with the output
+  ENV['WINEDEBUG'] = 'err-all,warn-all,fixme-all,trace-all'
+
+  # Run the program in wine and capture the output
+  output, errormsg, status = Open3.capture3('wine', *ARGV, :stdin_data => input)
+
+  # Clean and print the results.
+  STDOUT.write clean(output)
+  STDERR.write clean(errormsg)
+
+  exit(status.exitstatus)
+end
+
+
+main()

build_config/host-cxx.rb

@@ -0,0 +1,12 @@
+MRuby::Build.new do |conf|
+  conf.toolchain
+
+  # include the default GEMs
+  conf.gembox 'default'
+
+  # C compiler settings
+  conf.cc.defines = %w(MRB_USE_DEBUG_HOOK)
+  conf.enable_debug
+  conf.enable_cxx_abi
+  conf.enable_test
+end

build_config/host-debug.rb

@@ -0,0 +1,20 @@
+MRuby::Build.new('host') do |conf|
+  # load specific toolchain settings
+  conf.toolchain
+
+  conf.enable_debug
+
+  # include the default GEMs
+  conf.gembox 'full-core'
+
+  # C compiler settings
+  conf.cc.defines = %w(MRB_USE_DEBUG_HOOK MRB_NO_BOXING)
+
+  # Generate mruby debugger command (require mruby-eval)
+  conf.gem :core => "mruby-bin-debugger"
+
+  # test
+  conf.enable_test
+  # bintest
+  conf.enable_bintest
+end

build_config/host-f32.rb

@@ -0,0 +1,14 @@
+MRuby::Build.new do |conf|
+  # load specific toolchain settings
+  toolchain :gcc
+
+  # include the GEM box
+  conf.gembox 'full-core'
+
+  conf.cc.defines << 'MRB_USE_FLOAT32'
+
+  # Turn on `enable_debug` for better debugging
+  conf.enable_debug
+  conf.enable_test
+  conf.enable_bintest
+end

build_config/host-gprof.rb

@@ -0,0 +1,14 @@
+MRuby::Build.new do |conf|
+  # load specific toolchain settings
+  toolchain :gcc
+
+  # include the GEM box
+  conf.gembox 'full-core'
+
+  conf.cc.flags << '-pg'
+  conf.linker.flags << '-pg'
+
+  # Turn on `enable_debug` for better debugging
+  conf.enable_debug
+  conf.enable_test
+end

build_config/host-m32.rb

@@ -0,0 +1,15 @@
+MRuby::Build.new do |conf|
+  # load specific toolchain settings
+  toolchain :gcc
+
+  # include the GEM box
+  conf.gembox 'full-core'
+
+  conf.cc.flags << '-m32'
+  conf.linker.flags << '-m32'
+
+  # Turn on `enable_debug` for better debugging
+  conf.enable_debug
+  conf.enable_test
+  conf.enable_bintest
+end

build_config/host-nofloat.rb

@@ -0,0 +1,22 @@
+MRuby::Build.new do |conf|
+  # load specific toolchain settings
+  toolchain :gcc
+
+  # include the GEM box
+  conf.gembox "stdlib"
+  conf.gembox "stdlib-ext"
+  conf.gembox "stdlib-io"
+  conf.gembox "metaprog"
+
+  conf.gem :core => 'mruby-bin-mruby'
+  conf.gem :core => 'mruby-bin-mirb'
+
+  # Add configuration
+  conf.compilers.each do |c|
+    c.defines << "MRB_NO_FLOAT"
+  end
+
+  conf.enable_debug
+  conf.enable_test
+  conf.enable_bintest
+end

build_config/host-shared.rb

@@ -0,0 +1,36 @@
+# NOTE: Currently, this configuration file does not support VisualC++!
+#       Your help is needed!
+
+MRuby::Build.new do |conf|
+  # load specific toolchain settings
+  conf.toolchain
+
+  # include the GEM box
+  conf.gembox 'default'
+
+  # C compiler settings
+  conf.compilers.each do |cc|
+    cc.flags << '-fPIC'
+  end
+
+  conf.archiver do |archiver|
+    archiver.command = cc.command
+    archiver.archive_options = '-shared -o %{outfile} %{objs}'
+  end
+
+  # file extensions
+  conf.exts do |exts|
+    exts.library = '.so'
+  end
+
+  # file separator
+  # conf.file_separator = '/'
+
+  # enable this if better compatibility with C++ is desired
+  #conf.enable_cxx_exception
+
+  # Turn on `enable_debug` for better debugging
+  conf.enable_debug
+  conf.enable_bintest
+  conf.enable_test
+end

build_config/i586-pc-msdosdjgpp.rb

@@ -0,0 +1,76 @@
+# Cross Compiling configuration for MS-DOS
+#
+# Requires DJGPP cross-compiler, see
+# https://github.com/andrewwutw/build-djgpp/releases
+
+MRuby::CrossBuild.new("i586-pc-msdosdjgpp") do |conf|
+  toolchain :gcc
+
+  # If DJGPP is not in the PATH, set this to the bin directory
+  DJGPP_PATH = nil
+
+  GCC = 'i586-pc-msdosdjgpp-gcc'
+  GXX = 'i586-pc-msdosdjgpp-g++'
+  AR  = 'i586-pc-msdosdjgpp-ar'
+
+  conf.cc do |cc|
+    cc.command = DJGPP_PATH ? File.join(DJGPP_PATH, GCC) : GCC
+    cc.defines << 'MRB_NO_IO_PREAD_PWRITE'
+    cc.defines << 'MRB_UTF8_STRING'
+  end
+
+  conf.cxx do |cxx|
+    cxx.command = DJGPP_PATH ? File.join(DJGPP_PATH, GXX) : GXX
+    cxx.defines << 'MRB_NO_IO_PREAD_PWRITE'
+    cxx.defines << 'MRB_UTF8_STRING'
+  end
+
+  conf.linker do |linker|
+    linker.command = DJGPP_PATH ? File.join(DJGPP_PATH, GXX) : GXX
+    linker.libraries = %w(m)
+  end
+
+  conf.archiver do |archiver|
+    archiver.command = DJGPP_PATH ? File.join(DJGPP_PATH, AR) : AR
+  end
+
+  # All provided gems that can be reasonably made to compile:
+  # default.gembox, minus mruby-socket and replacing mruby-cmath with mruby-cmath-alt
+  conf.gembox "stdlib"
+  conf.gembox "stdlib-ext"
+
+  conf.gem :core => 'mruby-io'              # stdlib-io.gembox <- default.gembox
+# No socket support in DJGPP
+# conf.gem :core => 'mruby-socket'          # stdlib-io.gembox <- default.gembox
+  conf.gem :core => 'mruby-errno'           # stdlib-io.gembox <- default.gembox
+  conf.gem :core => 'mruby-dir'             # stdlib-io.gembox <- default.gembox
+
+  conf.gem :core => 'mruby-bigint'          # math.gembox <- default.gembox
+  conf.gem :core => 'mruby-complex'         # math.gembox <- default.gembox
+  conf.gem :core => 'mruby-math'            # math.gembox <- default.gembox
+  conf.gem :core => 'mruby-rational'        # math.gembox <- default.gembox
+  # Alternative implementation of cmath, not requiring <complex.h>
+# conf.gem :github => 'chasonr/mruby-cmath-alt' # math.gembox <- default.gembox
+
+  conf.gembox "metaprog"
+
+  conf.gem :core => 'mruby-bin-mrbc'        # default.gembox
+  conf.gem :core => 'mruby-bin-debugger'    # default.gembox
+  conf.gem :core => 'mruby-bin-mirb'        # default.gembox
+  conf.gem :core => 'mruby-bin-mruby'       # default.gembox
+  conf.gem :core => 'mruby-bin-strip'       # default.gembox
+  conf.gem :core => 'mruby-bin-config'      # default.gembox
+
+  # Other compilable gems
+  conf.gem :core => 'mruby-binding'
+  conf.gem :core => 'mruby-catch'
+  conf.gem :core => 'mruby-enum-chain'
+  conf.gem :core => 'mruby-error'
+  conf.gem :core => 'mruby-exit'
+  conf.gem :core => 'mruby-os-memsize'
+  conf.gem :core => 'mruby-proc-binding'
+  conf.gem :core => 'mruby-sleep'
+
+  # For Onigmo regular expression support
+  conf.gem :github => 'mattn/mruby-onig-regexp'
+end

build_config/luckfox_pico.rb

@@ -0,0 +1,106 @@
+# Cross Compiling configuration for Luckfox Pico embedded SBC.
+#
+# To build on Ubuntu x86_64: rake MRUBY_CONFIG=build_config/luckfox_pico.rb
+# Uses Buildroot SDK for this board. Binaries run on the corresponding Linux image.
+# Requires: https://github.com/LuckfoxTECH/luckfox-pico
+#
+# NOTE: default config includes all standard mrbgems, EXCEPT: mruby-cmath
+#
+MRuby::CrossBuild.new("luckfox_pico") do |conf|
+  # Clone the luckfox-pico repo above next to (same directory level) as mruby.
+  SDK_BASE = File.realpath(File.expand_path("../../../", File.expand_path(__FILE__)) + "/luckfox-pico")
+  TOOLCHAIN_BASE = "#{SDK_BASE}/tools/linux/toolchain/arm-rockchip830-linux-uclibcgnueabihf"
+  SYSROOT = "#{TOOLCHAIN_BASE}/arm-rockchip830-linux-uclibcgnueabihf/sysroot"
+
+  toolchain :gcc
+
+  # C compiler settings
+  conf.cc do |cc|
+    cc.command = "#{TOOLCHAIN_BASE}/bin/arm-rockchip830-linux-uclibcgnueabihf-gcc"
+
+    cc.include_paths << "#{TOOLCHAIN_BASE}/lib/gcc/arm-rockchip830-linux-uclibcgnueabihf/8.3.0/include"
+    cc.include_paths << "#{TOOLCHAIN_BASE}/lib/gcc/arm-rockchip830-linux-uclibcgnueabihf/8.3.0/include-fixed"
+    cc.include_paths << "#{TOOLCHAIN_BASE}/arm-rockchip830-linux-uclibcgnueabihf/include/c++/8.3.0/arm-rockchip830-linux-uclibcgnueabihf"
+    cc.include_paths << "#{SYSROOT}/usr/include"
+
+    # Flags taken from the SDK's Makefile
+    cc.flags << ["-march=armv7-a", "-mfpu=neon", "-mfloat-abi=hard"]
+    cc.flags << ["-D_LARGEFILE_SOURCE", "-D_LARGEFILE64_SOURCE", "-D_FILE_OFFSET_BITS=64", "-ffunction-sections", "-fdata-sections"]
+    cc.flags << ["-O2", "-fPIC"]
+    cc.flags << ["-Wl,--copy-dt-needed-entries", "-Wl,-lc,-lgcc_s"]
+  end
+
+  # Linker settings
+  conf.linker do |linker|
+    linker.command = cc.command
+    linker.library_paths << "#{TOOLCHAIN_BASE}/arm-rockchip830-linux-uclibcgnueabihf/lib"
+    linker.flags = cc.flags
+  end
+
+  # Archiver settings
+  conf.archiver do |archiver|
+    archiver.command = "#{TOOLCHAIN_BASE}/bin/arm-rockchip830-linux-uclibcgnueabihf-ar"
+  end
+
+  # Do not build executable test
+  conf.build_mrbtest_lib_only
+
+  # Disable C++ exception
+  conf.disable_cxx_exception
+
+  # All standard gems.
+  conf.gem 'mrbgems/mruby-array-ext/'
+  conf.gem 'mrbgems/mruby-bigint/'
+  conf.gem 'mrbgems/mruby-bin-config/'
+  conf.gem 'mrbgems/mruby-bin-debugger/'
+  conf.gem 'mrbgems/mruby-bin-mirb/'
+  conf.gem 'mrbgems/mruby-bin-mrbc/'
+  conf.gem 'mrbgems/mruby-bin-mruby/'
+  conf.gem 'mrbgems/mruby-bin-strip/'
+  conf.gem 'mrbgems/mruby-binding/'
+  conf.gem 'mrbgems/mruby-catch/'
+  conf.gem 'mrbgems/mruby-class-ext/'
+  # SDK doesn't include complex math for uClibc
+  # conf.gem 'mrbgems/mruby-cmath/'
+  conf.gem 'mrbgems/mruby-compar-ext/'
+  conf.gem 'mrbgems/mruby-compiler/'
+  conf.gem 'mrbgems/mruby-complex/'
+  conf.gem 'mrbgems/mruby-data/'
+  conf.gem 'mrbgems/mruby-dir/'
+  conf.gem 'mrbgems/mruby-enum-chain/'
+  conf.gem 'mrbgems/mruby-enum-ext/'
+  conf.gem 'mrbgems/mruby-enum-lazy/'
+  conf.gem 'mrbgems/mruby-enumerator/'
+  conf.gem 'mrbgems/mruby-errno/'
+  conf.gem 'mrbgems/mruby-error/'
+  conf.gem 'mrbgems/mruby-eval/'
+  conf.gem 'mrbgems/mruby-exit/'
+  conf.gem 'mrbgems/mruby-fiber/'
+  conf.gem 'mrbgems/mruby-hash-ext/'
+  conf.gem 'mrbgems/mruby-io/'
+  conf.gem 'mrbgems/mruby-kernel-ext/'
+  conf.gem 'mrbgems/mruby-math/'
+  conf.gem 'mrbgems/mruby-metaprog/'
+  conf.gem 'mrbgems/mruby-method/'
+  conf.gem 'mrbgems/mruby-numeric-ext/'
+  conf.gem 'mrbgems/mruby-object-ext/'
+  conf.gem 'mrbgems/mruby-objectspace/'
+  conf.gem 'mrbgems/mruby-os-memsize/'
+  conf.gem 'mrbgems/mruby-pack/'
+  conf.gem 'mrbgems/mruby-proc-binding/'
+  conf.gem 'mrbgems/mruby-proc-ext/'
+  conf.gem 'mrbgems/mruby-random/'
+  conf.gem 'mrbgems/mruby-range-ext/'
+  conf.gem 'mrbgems/mruby-rational/'
+  conf.gem 'mrbgems/mruby-set/'
+  conf.gem 'mrbgems/mruby-sleep/'
+  conf.gem 'mrbgems/mruby-socket/'
+  conf.gem 'mrbgems/mruby-sprintf/'
+  conf.gem 'mrbgems/mruby-string-ext/'
+  conf.gem 'mrbgems/mruby-struct/'
+  conf.gem 'mrbgems/mruby-symbol-ext/'
+  # conf.gem 'mrbgems/mruby-test-inline-struct/'
+  # conf.gem 'mrbgems/mruby-test/'
+  conf.gem 'mrbgems/mruby-time/'
+  conf.gem 'mrbgems/mruby-toplevel-ext/'
+end

build_config/milkv_duo.rb

@@ -0,0 +1,106 @@
+# Cross Compiling configuration for Milk-V Duo.
+# To build (on Ubuntu 24.04): rake MRUBY_CONFIG=build_config/milkv_duo.rb
+#
+# Requires: https://github.com/milkv-duo/duo-sdk
+#
+MRuby::CrossBuild.new("milkv_duo") do |conf|
+  # Set this string to match your board: milkv_duo, milkv_duo256m, milkv_duos
+  MILKV_DUO_VARIANT = "milkv_duo256m"
+
+  # Expect duo-sdk directory is same level as (next to) mruby top-level directory.
+  SDK_BASE = File.expand_path("../../../", File.expand_path(__FILE__)) + "/duo-sdk"
+  TOOLCHAIN_BASE = "#{SDK_BASE}/riscv64-linux-musl-x86_64"
+  SYSROOT = "#{SDK_BASE}/rootfs"
+
+  toolchain :gcc
+
+  # C compiler settings
+  conf.cc do |cc|
+    cc.command = "#{TOOLCHAIN_BASE}/bin/riscv64-unknown-linux-musl-gcc"
+    cc.include_paths << "#{TOOLCHAIN_BASE}/lib/gcc/riscv64-unknown-linux/musl/10.2.0/include-fixed"
+    cc.include_paths << "#{TOOLCHAIN_BASE}/lib/gcc/riscv64-unknown-linux/musl/10.2.0/include"
+    cc.include_paths << "#{TOOLCHAIN_BASE}/riscv64-unknown-linux/include"
+    cc.include_paths << "#{TOOLCHAIN_BASE}/include"
+    cc.include_paths << "#{SYSROOT}/usr/include"
+    cc.flags << ["-mcpu=c906fdv", "-march=rv64imafdcv0p7xthead", "-mcmodel=medany", "-mabi=lp64d"]
+    cc.flags << ["-D_LARGEFILE_SOURCE", "-D_LARGEFILE64_SOURCE", "-D_FILE_OFFSET_BITS=64"]
+    cc.flags << ["-Wl,--copy-dt-needed-entries", "-Wl,-lc,-lgcc_s,-lwiringx"]
+    cc.defines << "MILKV_DUO_VARIANT=_#{MILKV_DUO_VARIANT}"
+  end
+
+  # Linker settings
+  conf.linker do |linker|
+    linker.command = cc.command
+    linker.library_paths << ["#{SYSROOT}/lib", "#{SYSROOT}/usr/lib"]
+    linker.flags = cc.flags
+  end
+
+  # Archiver settings
+  conf.archiver do |archiver|
+    archiver.command = "#{TOOLCHAIN_BASE}/bin/riscv64-unknown-linux-musl-gcc-ar"
+  end
+
+  # Do not build executable test
+  conf.build_mrbtest_lib_only
+
+  # Disable C++ exception
+  conf.disable_cxx_exception
+
+  # All standard gems.
+  conf.gem 'mrbgems/mruby-array-ext/'
+  conf.gem 'mrbgems/mruby-bigint/'
+  conf.gem 'mrbgems/mruby-bin-config/'
+  conf.gem 'mrbgems/mruby-bin-debugger/'
+  conf.gem 'mrbgems/mruby-bin-mirb/'
+  conf.gem 'mrbgems/mruby-bin-mrbc/'
+  conf.gem 'mrbgems/mruby-bin-mruby/'
+  conf.gem 'mrbgems/mruby-bin-strip/'
+  conf.gem 'mrbgems/mruby-binding/'
+  conf.gem 'mrbgems/mruby-catch/'
+  conf.gem 'mrbgems/mruby-class-ext/'
+  conf.gem 'mrbgems/mruby-cmath/'
+  conf.gem 'mrbgems/mruby-compar-ext/'
+  conf.gem 'mrbgems/mruby-compiler/'
+  conf.gem 'mrbgems/mruby-complex/'
+  conf.gem 'mrbgems/mruby-data/'
+  conf.gem 'mrbgems/mruby-dir/'
+  conf.gem 'mrbgems/mruby-enum-chain/'
+  conf.gem 'mrbgems/mruby-enum-ext/'
+  conf.gem 'mrbgems/mruby-enum-lazy/'
+  conf.gem 'mrbgems/mruby-enumerator/'
+  conf.gem 'mrbgems/mruby-errno/'
+  conf.gem 'mrbgems/mruby-error/'
+  conf.gem 'mrbgems/mruby-eval/'
+  conf.gem 'mrbgems/mruby-exit/'
+  conf.gem 'mrbgems/mruby-fiber/'
+  conf.gem 'mrbgems/mruby-hash-ext/'
+  conf.gem 'mrbgems/mruby-io/'
+  conf.gem 'mrbgems/mruby-kernel-ext/'
+  conf.gem 'mrbgems/mruby-math/'
+  conf.gem 'mrbgems/mruby-metaprog/'
+  conf.gem 'mrbgems/mruby-method/'
+  conf.gem 'mrbgems/mruby-numeric-ext/'
+  conf.gem 'mrbgems/mruby-object-ext/'
+  conf.gem 'mrbgems/mruby-objectspace/'
+  conf.gem 'mrbgems/mruby-os-memsize/'
+  conf.gem 'mrbgems/mruby-pack/'
+  conf.gem 'mrbgems/mruby-proc-binding/'
+  conf.gem 'mrbgems/mruby-proc-ext/'
+  conf.gem 'mrbgems/mruby-random/'
+  conf.gem 'mrbgems/mruby-range-ext/'
+  conf.gem 'mrbgems/mruby-rational/'
+  conf.gem 'mrbgems/mruby-set/'
+  conf.gem 'mrbgems/mruby-sleep/'
+  conf.gem 'mrbgems/mruby-socket/'
+  conf.gem 'mrbgems/mruby-sprintf/'
+  conf.gem 'mrbgems/mruby-string-ext/'
+  conf.gem 'mrbgems/mruby-struct/'
+  conf.gem 'mrbgems/mruby-symbol-ext/'
+  # conf.gem 'mrbgems/mruby-test-inline-struct/'
+  # conf.gem 'mrbgems/mruby-test/'
+  conf.gem 'mrbgems/mruby-time/'
+  conf.gem 'mrbgems/mruby-toplevel-ext/'
+
+  # GPIO, ADC, PWM, I2C and SPI support for Milk-V Duo
+  # conf.gem :github => 'denko-rb/mruby-milkv-duo'
+end

build_config/minimal.rb

@@ -0,0 +1,4 @@
+MRuby::CrossBuild.new('minimal') do |conf|
+  conf.toolchain :gcc
+  conf.cc.defines << 'MRB_NO_STDIO'
+end

build_config/mrbc.rb

@@ -0,0 +1,11 @@
+MRuby::Build.new do |conf|
+  if ENV['VisualStudioVersion'] || ENV['VSINSTALLDIR']
+    conf.toolchain :visualcpp
+  else
+    conf.toolchain :gcc
+  end
+
+  conf.build_mrbc_exec
+  conf.disable_libmruby
+  conf.disable_presym
+end

build_config/nintendo_switch.rb

@@ -0,0 +1,73 @@
+# Cross Compiling configuration for the Nintendo Switch, it requires Nintendo SDK
+# Tested on windows
+MRuby::CrossBuild.new('nintendo_switch_32bit') do |conf|
+  conf.toolchain :clang
+  NINTENDO_SDK_PATH = ENV['NINTENDO_SDK_ROOT']
+
+  include_paths = [
+    "#{NINTENDO_SDK_PATH}/Include",
+    "#{NINTENDO_SDK_PATH}/Common/Configs/Targets/NX-NXFP2-a32/Include"
+  ]
+
+  conf.cc do |cc|
+    cc.command = "#{NINTENDO_SDK_PATH}/Compilers/NX/bin/nx-clang++"
+    cc.include_paths += include_paths
+    cc.flags += ['-fpic -fno-short-enums -ffunction-sections -fdata-sections -fno-common -fno-strict-aliasing -fomit-frame-pointer -fno-vectorize -funsigned-char -O2 -g -mno-implicit-float']
+    cc.defines += 'NN_SDK_BUILD_RELEASE'
+  end
+
+  conf.cxx do |cxx|
+    cxx.command = "#{NINTENDO_SDK_PATH}/Compilers/NX/bin/nx-clang++"
+    cxx.include_paths += include_paths
+    cxx.flags += ['-fpic -fno-short-enums -ffunction-sections -fdata-sections -fno-common -fno-strict-aliasing -fomit-frame-pointer -fno-vectorize -funsigned-char -O2 -g -mno-implicit-float']
+    cxx.defines += 'NN_SDK_BUILD_RELEASE'
+  end
+
+  conf.archiver do |archiver|
+    archiver.command = "#{NINTENDO_SDK_PATH}/Compilers/NX/nx/armv7l/bin/llvm-ar"
+  end
+
+  conf.linker do |linker|
+    linker.command = "#{NINTENDO_SDK_PATH}/Compilers/NX/nx/armv7l/bin/clang++"
+    linker.libraries = []
+  end
+
+  # Add your mrbgems
+end
+
+MRuby::CrossBuild.new('nintendo_switch_64bit') do |conf|
+  conf.toolchain :clang
+  NINTENDO_SDK_PATH = ENV['NINTENDO_SDK_ROOT']
+
+  include_paths = [
+    "#{NINTENDO_SDK_PATH}/Include",
+    "#{NINTENDO_SDK_PATH}/Common/Configs/Targets/NX-NXFP2-a64/Include"
+  ]
+
+  conf.cc do |cc|
+    cc.command = "#{NINTENDO_SDK_PATH}/Compilers/NX/bin/nx-clang++"
+    cc.include_paths += include_paths
+    cc.flags += ['-fpic -fno-short-enums -ffunction-sections -fdata-sections -fno-common -fno-strict-aliasing -fomit-frame-pointer -fno-vectorize -funsigned-char -O2 -g -mno-implicit-float']
+    cc.flags << '--target=aarch64-nintendo-nx-elf'
+    cc.defines += 'NN_SDK_BUILD_RELEASE'
+  end
+
+  conf.cxx do |cxx|
+    cxx.command = "#{NINTENDO_SDK_PATH}/Compilers/NX/bin/nx-clang++"
+    cxx.include_paths += include_paths
+    cxx.flags += ['-fpic -fno-short-enums -ffunction-sections -fdata-sections -fno-common -fno-strict-aliasing -fomit-frame-pointer -fno-vectorize -funsigned-char -O2 -g -mno-implicit-float']
+    cxx.flags << '--target=aarch64-nintendo-nx-elf'
+    cxx.defines += 'NN_SDK_BUILD_RELEASE'
+  end
+
+  conf.archiver do |archiver|
+    archiver.command = "#{NINTENDO_SDK_PATH}/Compilers/NX/nx/aarch64/bin/llvm-ar"
+  end
+
+  conf.linker do |linker|
+    linker.command = "#{NINTENDO_SDK_PATH}/Compilers/NX/nx/aarch64/bin/clang++"
+    linker.libraries = []
+  end
+
+  # Add your mrbgems
+end

build_config/nintendo_wii.rb

@@ -0,0 +1,95 @@
+# Cross Compiling configuration for the Nintendo Wii
+# This configuration requires devkitPPC
+# https://devkitpro.org/wiki/Getting_Started
+#
+#
+MRuby::CrossBuild.new("wii") do |conf|
+  toolchain :gcc
+
+  DEVKITPRO_PATH = "/opt/devkitpro"
+  BIN_PATH = "#{DEVKITPRO_PATH}/devkitPPC/bin"
+
+  # C compiler
+  conf.cc do |cc|
+    cc.command = "#{BIN_PATH}/powerpc-eabi-gcc"
+    cc.compile_options = %(%{flags} -o "%{outfile}" -c "%{infile}")
+  end
+
+  # C++ compiler
+  conf.cxx do |cxx|
+    cxx.command = "#{BIN_PATH}/powerpc-eabi-g++"
+    cxx.include_paths = conf.cc.include_paths.dup
+    cxx.flags = conf.cc.flags.dup
+    cxx.defines = conf.cc.defines.dup
+    cxx.compile_options = conf.cc.compile_options.dup
+  end
+
+  # Linker
+  conf.linker do |linker|
+    linker.command = "#{BIN_PATH}/powerpc-eabi-gcc"
+  end
+
+  # No executables
+  conf.bins = []
+
+  # Do not build executable test
+  conf.build_mrbtest_lib_only
+
+  # Disable C++ exception
+  conf.disable_cxx_exception
+
+  # All current core gems with ones with build issues commented out
+  conf.gem 'mrbgems/mruby-array-ext/'
+  conf.gem 'mrbgems/mruby-bigint/'
+  conf.gem 'mrbgems/mruby-bin-config/'
+  conf.gem 'mrbgems/mruby-bin-debugger/'
+  conf.gem 'mrbgems/mruby-bin-mirb/'
+  conf.gem 'mrbgems/mruby-bin-mrbc/'
+  conf.gem 'mrbgems/mruby-bin-mruby/'
+  conf.gem 'mrbgems/mruby-bin-strip/'
+  conf.gem 'mrbgems/mruby-binding/'
+  conf.gem 'mrbgems/mruby-catch/'
+  conf.gem 'mrbgems/mruby-class-ext/'
+  conf.gem 'mrbgems/mruby-cmath/'
+  conf.gem 'mrbgems/mruby-compar-ext/'
+  conf.gem 'mrbgems/mruby-compiler/'
+  conf.gem 'mrbgems/mruby-complex/'
+  conf.gem 'mrbgems/mruby-data/'
+  #conf.gem 'mrbgems/mruby-dir/'
+  conf.gem 'mrbgems/mruby-enum-chain/'
+  conf.gem 'mrbgems/mruby-enum-ext/'
+  conf.gem 'mrbgems/mruby-enum-lazy/'
+  conf.gem 'mrbgems/mruby-enumerator/'
+  conf.gem 'mrbgems/mruby-errno/'
+  conf.gem 'mrbgems/mruby-error/'
+  conf.gem 'mrbgems/mruby-eval/'
+  conf.gem 'mrbgems/mruby-exit/'
+  conf.gem 'mrbgems/mruby-fiber/'
+  conf.gem 'mrbgems/mruby-hash-ext/'
+  #conf.gem 'mrbgems/mruby-io/'
+  conf.gem 'mrbgems/mruby-kernel-ext/'
+  conf.gem 'mrbgems/mruby-math/'
+  conf.gem 'mrbgems/mruby-metaprog/'
+  conf.gem 'mrbgems/mruby-method/'
+  conf.gem 'mrbgems/mruby-numeric-ext/'
+  conf.gem 'mrbgems/mruby-object-ext/'
+  conf.gem 'mrbgems/mruby-objectspace/'
+  conf.gem 'mrbgems/mruby-os-memsize/'
+  conf.gem 'mrbgems/mruby-pack/'
+  conf.gem 'mrbgems/mruby-proc-binding/'
+  conf.gem 'mrbgems/mruby-proc-ext/'
+  conf.gem 'mrbgems/mruby-random/'
+  conf.gem 'mrbgems/mruby-range-ext/'
+  conf.gem 'mrbgems/mruby-rational/'
+  conf.gem 'mrbgems/mruby-set/'
+  conf.gem 'mrbgems/mruby-sleep/'
+  #conf.gem 'mrbgems/mruby-socket/'
+  conf.gem 'mrbgems/mruby-sprintf/'
+  conf.gem 'mrbgems/mruby-string-ext/'
+  conf.gem 'mrbgems/mruby-struct/'
+  conf.gem 'mrbgems/mruby-symbol-ext/'
+  conf.gem 'mrbgems/mruby-test-inline-struct/'
+  #conf.gem 'mrbgems/mruby-test/'
+  conf.gem 'mrbgems/mruby-time/'
+  conf.gem 'mrbgems/mruby-toplevel-ext/'
+end

build_config/no-float.rb

@@ -0,0 +1,17 @@
+# Define cross build settings
+MRuby::CrossBuild.new('no-float') do |conf|
+  conf.toolchain
+
+  # Add configuration
+  conf.compilers.each do |c|
+    c.defines << "MRB_NO_FLOAT"
+  end
+
+  conf.gem :core => "mruby-bin-mruby"
+
+  conf.test_runner.command = 'env'
+
+  conf.enable_debug
+#  conf.enable_bintest
+  conf.enable_test
+end

build_config/playstationportable.rb

@@ -0,0 +1,78 @@
+# Cross Compiling configuration for the Sony PlayStation Portable.
+# This configuration requires toolchain from https://github.com/pspdev
+
+MRuby::CrossBuild.new("playstationportable") do |conf|
+  toolchain :gcc
+
+  PSPDEV_PATH = "#{ENV['PSPDEV']}"
+  BIN_PATH = "#{PSPDEV_PATH}/bin"
+
+  # C compiler
+  conf.cc do |cc|
+    cc.command = "#{BIN_PATH}/psp-gcc"
+    cc.flags << ["-O2", "-D_PSP_FW_VERSION=600"]
+    cc.include_paths << ["#{PSPDEV_PATH}/psp/include", "#{PSPDEV_PATH}/psp/sdk/include"]
+    cc.compile_options = %(%{flags} -o "%{outfile}" -c "%{infile}")
+  end
+
+  # C++ compiler
+  conf.cxx do |cxx|
+    cxx.command = "#{BIN_PATH}/psp-g++"
+    cxx.include_paths = conf.cc.include_paths.dup
+    cxx.flags = conf.cc.flags.dup
+    cxx.flags << %w[-fno-rtti -fno-exceptions]
+    cxx.defines = conf.cc.defines.dup
+    cxx.compile_options = conf.cc.compile_options.dup
+  end
+
+  # Linker
+  conf.linker do |linker|
+    linker.command = "#{BIN_PATH}/psp-gcc"
+    linker.flags << ["-Wl,-zmax-page-size=128"]
+  end
+
+  # No executables
+  conf.bins = []
+
+  # Do not build executable test
+  conf.build_mrbtest_lib_only
+
+  # Gems from core
+  conf.gem :core => "mruby-metaprog"
+  conf.gem :core => "mruby-pack"
+  conf.gem :core => "mruby-sprintf"
+  conf.gem :core => "mruby-math"
+  conf.gem :core => "mruby-time"
+  conf.gem :core => "mruby-struct"
+  conf.gem :core => "mruby-compar-ext"
+  conf.gem :core => "mruby-enum-ext"
+  conf.gem :core => "mruby-string-ext"
+  conf.gem :core => "mruby-numeric-ext"
+  conf.gem :core => "mruby-array-ext"
+  conf.gem :core => "mruby-hash-ext"
+  conf.gem :core => "mruby-range-ext"
+  conf.gem :core => "mruby-proc-ext"
+  conf.gem :core => "mruby-symbol-ext"
+  conf.gem :core => "mruby-random"
+  conf.gem :core => "mruby-object-ext"
+  conf.gem :core => "mruby-objectspace"
+  conf.gem :core => "mruby-fiber"
+  conf.gem :core => "mruby-enumerator"
+  conf.gem :core => "mruby-enum-lazy"
+  conf.gem :core => "mruby-toplevel-ext"
+  conf.gem :core => "mruby-kernel-ext"
+  conf.gem :core => "mruby-class-ext"
+  conf.gem :core => "mruby-compiler"
+  conf.gem :core => "mruby-binding"
+  conf.gem :core => "mruby-catch"
+  conf.gem :core => "mruby-enum-chain"
+  conf.gem :core => "mruby-errno"
+  conf.gem :core => "mruby-error"
+  conf.gem :core => "mruby-exit"
+  conf.gem :core => "mruby-os-memsize"
+  conf.gem :core => "mruby-proc-binding"
+  conf.gem :core => "mruby-sleep"
+  conf.gem :core => "mruby-io"
+  conf.gem :core => "mruby-dir"
+  #conf.gem :core => "mruby-socket" unsupported
+end

build_config/serenity.rb

@@ -0,0 +1,26 @@
+# Cross compiling configuration for SerenityOS
+# Graphical Unix-like operating system for x86 computers.
+# https://github.com/SerenityOS/serenity
+#
+# Should be built using the SerenityOS Ports system
+# https://github.com/SerenityOS/serenity/tree/master/Ports
+#
+# As of 2021/08/20, SERENITY_ARCH is defined in the SerenityOS Ports
+# build script to always be either "i686" or "x86_64"
+
+MRuby::CrossBuild.new('serenity') do |conf|
+  conf.toolchain :gcc
+
+  conf.archiver.command = "#{ENV['SERENITY_ARCH']}-pc-serenity-ar"
+  conf.linker.command = "#{ENV['SERENITY_ARCH']}-pc-serenity-g++"
+
+  conf.cxx.command = "#{ENV['SERENITY_ARCH']}-pc-serenity-g++"
+  conf.cxx.defines << (ENV['SERENITY_ARCH'].include?('64') ? 'MRB_64BIT' : 'MRB_32BIT')
+
+  conf.cc.command = "#{ENV['SERENITY_ARCH']}-pc-serenity-gcc"
+  conf.cc.defines << (ENV['SERENITY_ARCH'].include?('64') ? 'MRB_64BIT' : 'MRB_32BIT')
+
+  conf.gembox 'full-core'
+
+  conf.test_runner.command = 'env'
+end

doc/guides/compile.md

@@ -1,3 +1,5 @@
+<!-- summary: About the Compile -->
+
 # Compile
 
 mruby uses Rake to compile and cross-compile all libraries and
@@ -6,45 +8,54 @@ binaries.
 ## Prerequisites
 
 To compile mruby out of the source code you need the following tools:
-* C Compiler (e.g. `gcc` or `clang`)
-* Linker (e.g. `gcc` or `clang`)
-* Archive utility (e.g. `ar`)
-* Parser generator (e.g. `bison`)
-* Ruby 2.0 or later (e.g. `ruby` or `jruby`)
 
-Note that `bison` bundled with MacOS is too old to compile `mruby`.
-Try `brew install bison` and follow the instuction shown to update
-the `$PATH` to compile `mruby`.
+- C Compiler (e.g. `gcc` or `clang`)
+- Linker (e.g. `gcc` or `clang`)
+- Archive utility (e.g. `ar`)
+- Ruby 2.5 or later (e.g. `ruby` or `jruby`)
 
 Optional:
-* GIT (to update mruby source and integrate mrbgems easier)
-* C++ compiler (to use GEMs which include \*.cpp, \*.cxx, \*.cc)
-* Assembler (to use GEMs which include \*.asm)
 
-## Usage
+- Git (to update mruby source and integrate mrbgems easier)
+- C++ compiler (to use mrbgems which include `*.cpp`, `*.cxx`, `*.cc`)
+- Bison (to compile `mrbgems/mruby-compiler/core/parse.y`)
+- gperf (to compile `mrbgems/mruby-compiler/core/keywords`)
+
+Note that `bison` bundled with macOS is too old to compile `mruby`.
+Try `brew install bison` and follow the instruction shown to update
+the `$PATH` to compile `mruby`. We also encourage you to upgrade `ruby`
+on macOS in similar manner.
+
+## Build
+
+To compile `mruby` with the default build configuration, just invoke `rake`
+inside of the mruby source root. To generate and execute the test tools call
+`rake test`. To clean all build files call `rake clean`. To see full command
+line on build, call `rake -v`.
+
+You can specify your own configuration file by the `MRUBY_CONFIG` environment
+variable (you can use `CONFIG` for shorthand for `MRUBY_CONFIG`). If the path
+doesn't exist, `build_config/${MRUBY_CONFIG}.rb` is used. The default
+configuration is defined in the `build_config/default.rb` file.
+
+Those build configuration files contain the build configuration of mruby, for
+example:
 
-Inside of the root directory of the mruby source a file exists
-called *build_config.rb*. This file contains the build configuration
-of mruby and looks like this for example:
 ```ruby
 MRuby::Build.new do |conf|
-  toolchain :gcc
+  conf.toolchain :gcc
 end
 ```
 
-All tools necessary to compile mruby can be set or modified here. In case
-you want to maintain an additional *build_config.rb* you can define a
-customized path using the *$MRUBY_CONFIG* environment variable.
-
-To compile just call `rake` inside of the mruby source root. To
-generate and execute the test tools call `rake test`. To clean
-all build files call `rake clean`. To see full command line on
-build, call `rake -v`.
+All tools necessary to compile mruby can be set or modified here.
 
 ## Build Configuration
 
-Inside of the *build_config.rb* the following options can be configured
-based on your environment.
+We wish you submit a pull-request to `build_config/PLATFORM.rb`, once you
+created a new configuration for a new platform.
+
+Inside the configuration file, the following options can be
+configured based on your environment.
 
 ### Toolchains
 
@@ -54,32 +65,36 @@ configure the build environment for specific compiler infrastructures.
 #### GCC
 
 Toolchain configuration for the GNU C Compiler.
+
 ```ruby
-toolchain :gcc
+conf.toolchain :gcc
 ```
 
 #### clang
 
 Toolchain configuration for the LLVM C Compiler clang. Mainly equal to the
 GCC toolchain.
+
 ```ruby
-toolchain :clang
+conf.toolchain :clang
 ```
 
 #### Visual Studio 2010, 2012 and 2013
 
 Toolchain configuration for Visual Studio on Windows. If you use the
-[Visual Studio Command Prompt](http://msdn.microsoft.com/en-us/library/ms229859\(v=vs.110\).aspx),
+[Visual Studio Command Prompt](<https://msdn.microsoft.com/en-us/library/ms229859(v=vs.110).aspx>),
 you normally do not have to specify this manually, since it gets automatically detected by our build process.
+
 ```ruby
-toolchain :visualcpp
+conf.toolchain :visualcpp
 ```
 
 #### Android
 
 Toolchain configuration for Android.
+
 ```ruby
-toolchain :android
+conf.toolchain :android
 ```
 
 Requires the custom standalone Android NDK and the toolchain path
@@ -88,27 +103,56 @@ in `ANDROID_STANDALONE_TOOLCHAIN`.
 ### Binaries
 
 It is possible to select which tools should be compiled during the compilation
-process. The following tools can be selected:
-* mruby (mruby interpreter)
-* mirb (mruby interactive shell)
+process. For example,
 
-To select them declare conf.gem as follows:
-```ruby
-conf.gem "#{root}/mrbgems/mruby-bin-mruby"
-conf.gem "#{root}/mrbgems/mruby-bin-mirb"
-```
+- `mruby`
+- `mirb`
+
+The configuration are done via `mrbgems`. See `Mrbgems` section.
 
 ### File Separator
 
 Some environments require a different file separator character. It is possible to
 set the character via `conf.file_separator`.
+
 ```ruby
 conf.file_separator = '/'
 ```
 
+### Name of library directory
+
+In some environments, the `libmruby.a` file requires a different directory name than `lib`.
+You can be changed to any name by the `conf.libdir_name` accessor.
+
+```ruby
+conf.libdir_name = 'lib64'
+```
+
+Alternatively, it can be changed via the environment variable `MRUBY_SYSTEM_LIBDIR_NAME` when
+the `rake` command is run.
+
+```console
+$ export MRUBY_SYSTEM_LIBDIR_NAME=lib64
+$ rake clean all
+```
+
+NOTES:
+
+- This environment variable `MRUBY_SYSTEM_LIBDIR_NAME` does not affect `MRuby::CrossBuild`.
+  In other words, if you want to change it for `MRuby::CrossBuild`, you must set it with `MRuby::CrossBuild#libdir_name=`.
+- If you want to switch this environment variable `MRUBY_SYSTEM_LIBDIR_NAME`, you must do `rake clean`.
+
+  A bad usage example is shown below.
+
+  ```console
+  $ rake clean all
+  $ rake MRUBY_SYSTEM_LIBDIR_NAME=lib64 install
+  ```
+
 ### C Compiler
 
 Configuration of the C compiler binary, flags and include paths.
+
 ```ruby
 conf.cc do |cc|
   cc.command = ...
@@ -123,19 +167,21 @@ end
 
 C Compiler has header searcher to detect installed library.
 
-If you need a include path of header file use `search_header_path`:
+If you need an include path of header file use `search_header_path`:
+
 ```ruby
-# Searches ```iconv.h```.
+# Searches `iconv.h`.
 # If found it will return include path of the header file.
-# Otherwise it will return nil .
+# Otherwise it will return nil.
 fail 'iconv.h not found' unless conf.cc.search_header_path 'iconv.h'
 ```
 
-If you need a full file name of header file use `search_header`:
+If you need a full filename of header file use `search_header`:
+
 ```ruby
-# Searches ```iconv.h```.
+# Searches `iconv.h`.
 # If found it will return full path of the header file.
-# Otherwise it will return nil .
+# Otherwise it will return nil.
 iconv_h = conf.cc.search_header 'iconv.h'
 print "iconv.h found: #{iconv_h}\n"
 ```
@@ -145,6 +191,7 @@ When you are using GCC toolchain (including clang toolchain since its base is gc
 it will use compiler specific include paths too. (For example `/usr/local/include`, `/usr/include`)
 
 If you need a special header search paths define a singleton method `header_search_paths` to C compiler:
+
 ```ruby
 def conf.cc.header_search_paths
   ['/opt/local/include'] + include_paths
@@ -154,6 +201,7 @@ end
 ### Linker
 
 Configuration of the Linker binary, flags and library paths.
+
 ```ruby
 conf.linker do |linker|
   linker.command = ...
@@ -161,7 +209,7 @@ conf.linker do |linker|
   linker.flags_before_libraries = ...
   linker.libraries = ...
   linker.flags_after_libraries = ...
-  linker.library_paths = ....
+  linker.library_paths = ...
   linker.option_library = ...
   linker.option_library_path = ...
   linker.link_options = ...
@@ -171,6 +219,7 @@ end
 ### Archiver
 
 Configuration of the Archiver binary and flags.
+
 ```ruby
 conf.archiver do |archiver|
   archiver.command = ...
@@ -181,6 +230,7 @@ end
 ### Parser Generator
 
 Configuration of the Parser Generator binary and flags.
+
 ```ruby
 conf.yacc do |yacc|
   yacc.command = ...
@@ -191,6 +241,7 @@ end
 ### GPerf
 
 Configuration of the GPerf binary and flags.
+
 ```ruby
 conf.gperf do |gperf|
   gperf.command = ...
@@ -199,6 +250,7 @@ end
 ```
 
 ### File Extensions
+
 ```ruby
 conf.exts do |exts|
   exts.object = ...
@@ -207,26 +259,52 @@ conf.exts do |exts|
 end
 ```
 
+### Preallocated Symbols
+
+By far, preallocated symbols are highly compatible with the previous versions, so
+we expect you won't see any problem with them. But just in case you face any
+issue, you can disable preallocated symbols by specifying `conf.disable_presym`.
+
+In the build process, `mrbc` under cross compiling environment will be compiled
+with this configuration.
+
 ### Mrbgems
 
-Integrate GEMs in the build process.
-```ruby
-# Integrate GEM with additional configuration
-conf.gem 'path/to/gem' do |g|
-  g.cc.flags << ...
-end
+`mruby` comes with the (sort of) packaging system named `mrbgems`. To
+specify `gem`, you can use `conf.gem` in the configuration file.
 
-# Integrate GEM without additional configuration
-conf.gem 'path/to/another/gem'
+```ruby
+# Integrate a bundled Gem you see in `mrbgems` directory
+conf.gem :core => 'mruby-something'
+
+# Integrate a Gem from GitHub
+conf.gem :github => 'someone/mruby-another'
+
+# Integrate a mruby binary Gem
+conf.gem :core => 'mruby-bin-mruby'
+
+# Integrate a interactive mruby binary Gem
+conf.gem :core => 'mruby-bin-mirb'
+
+# Integrate GemBox (set of Gems)
+conf.gembox "default"
 ```
 
-See doc/mrbgems/README.md for more option about mrbgems.
+A GemBox is a set of Gems defined in `mrbgems/default.gembox` for example.
+It's just a set of `mrbgem` configurations.
+
+There is a `RubyGem` (gem for CRuby) named `mgem` that help you to
+manage `mrbgems`. Try `gem install mgem`. `mgem` can show you the list
+of registered `mrbgems`.
+
+See [doc/guides/mrbgems.md](mrbgems.md) for more option about mrbgems.
 
 ### Mrbtest
 
 Configuration Mrbtest build process.
 
-If you want mrbtest.a only, You should set `conf.build_mrbtest_lib_only`
+If you want `mrbtest.a` only, You should set `conf.build_mrbtest_lib_only`
+
 ```ruby
 conf.build_mrbtest_lib_only
 ```
@@ -234,11 +312,12 @@ conf.build_mrbtest_lib_only
 ### Bintest
 
 Tests for mrbgem tools using CRuby.
-To have bintests place \*.rb scripts to `bintest/` directory of mrbgems.
+To have bintests place `*.rb` scripts to `bintest/` directory of mrbgems.
 See `mruby-bin-*/bintest/*.rb` if you need examples.
 If you want a temporary files use `tempfile` module of CRuby instead of `/tmp/`.
 
 You can enable it with following:
+
 ```ruby
 conf.enable_bintest
 ```
@@ -257,58 +336,65 @@ files are compiled by C++ compiler.
 
 When you mix C++ code, C++ exception would be enabled automatically.
 If you need to enable C++ exception explicitly add the following:
+
 ```ruby
 conf.enable_cxx_exception
 ```
 
-#### C++ exception disabling.
+#### C++ exception disabling
 
-If your compiler does not support C++ and you want to ensure
+If your compiler does not support C++, and you want to ensure
 you don't use mrbgem written in C++, you can explicitly disable
 C++ exception, add following:
+
 ```ruby
 conf.disable_cxx_exception
 ```
+
 and you will get an error when you try to use C++ gem.
 Note that it must be called before `enable_cxx_exception` or `gem` method.
 
 ### Debugging mode
 
 To enable debugging mode add the following:
+
 ```ruby
 conf.enable_debug
 ```
 
 When debugging mode is enabled
-* Macro `MRB_DEBUG` would be defined.
-	* Which means `mrb_assert()` macro is enabled.
-* Debug information of irep would be generated by `mrbc`.
-	* Because `-g` flag would be added to `mrbc` runner.
-    * You can have better backtrace of mruby scripts with this.
+
+- Macro `MRB_DEBUG` would be defined.
+  - Which means `mrb_assert()` macro is enabled.
+- Debug information of irep would be generated by `mrbc`.
+  - Because `-g` flag would be added to `mrbc` runner.
+    - You can have better backtrace of mruby scripts with this.
 
 ## Cross-Compilation
 
-mruby can also be cross-compiled from one platform to another. To
-achieve this the *build_config.rb* needs to contain an instance of
-`MRuby::CrossBuild`. This instance defines the compilation
-tools and flags for the target platform. An example could look
-like this:
+mruby can also be cross-compiled from one platform to another. To achieve
+cross-compilation, the build configuration needs to contain an instance of
+`MRuby::CrossBuild`. This instance defines the compilation tools and flags
+for the target platform. An example could look like this:
+
 ```ruby
 MRuby::CrossBuild.new('32bit') do |conf|
-  toolchain :gcc
+  conf.toolchain :gcc
 
   conf.cc.flags << "-m32"
   conf.linker.flags << "-m32"
 end
 ```
 
-All configuration options of `MRuby::Build` can also be used
-in `MRuby::CrossBuild`.
+All configuration options of `MRuby::Build` can also be used in
+`MRuby::CrossBuild`. You can find examples under the `build_config`
+directory.
 
 ### Mrbtest in Cross-Compilation
 
-In cross compilation, you can run `mrbtest` on emulator if
+In cross compilation, you can run `mrbtest` on an emulator if
 you have it by changing configuration of test runner.
+
 ```ruby
 conf.test_runner do |t|
   t.command = ... # set emulator. this value must be non nil or false
@@ -322,48 +408,44 @@ end
 
 ## Build process
 
-During the build process the directory *build* will be created in the
+During the build process the `build` directory will be created in the
 root directory. The structure of this directory will look like this:
 
-	+- build
-	   |
-	   +-  host
-	       |
-	       +- bin          <- Binaries (mirb, mrbc and mruby)
-	       |
-	       +- lib          <- Libraries (libmruby.a and libmruby_core.a)
-	       |
-	       +- mrblib
-	       |
-	       +- src
-	       |
-	       +- test         <- mrbtest tool
-	       |
-	       +- tools
-	          |
-	          +- mirb
-	          |
-	          +- mrbc
-	          |
-	          +- mruby
+```
++- build
+    |
+    +- host
+        |
+        +- LEGAL        <- License description
+        |
+        +- bin          <- Binaries (mirb, mrbc and mruby)
+        |
+        +- lib          <- Libraries (libmruby.a and libmruby_core.a)
+        |
+        +- mrbc         <- Minimal mrbc place
+        |
+        +- mrbgems      <- Compilation result from mrbgems
+        |
+        +- mrblib       <- Compilation result from mrblib
+        |
+        +- src          <- Compilation result from C sources
+```
 
 The compilation workflow will look like this:
-* compile all files under *src* (object files will be stored
-in *build/host/src*)
-* generate parser grammar out of *src/parse.y* (generated
-result will be stored in *build/host/src/y.tab.c*)
-* compile  *build/host/src/y.tab.c* to  *build/host/src/y.tab.o*
-* create *build/host/lib/libmruby_core.a* out of all object files (C only)
-* create `build/host/bin/mrbc` by compiling *tools/mrbc/mrbc.c* and
-linking with *build/host/lib/libmruby_core.a*
-* create *build/host/mrblib/mrblib.c* by compiling all \*.rb files
-under *mrblib* with `build/host/bin/mrbc`
-* compile *build/host/mrblib/mrblib.c* to *build/host/mrblib/mrblib.o*
-* create *build/host/lib/libmruby.a* out of all object files (C and Ruby)
-* create `build/host/bin/mruby` by compiling *mrbgems/mruby-bin-mruby/tools/mruby/mruby.c* and
-linking with *build/host/lib/libmruby.a*
-* create `build/host/bin/mirb` by compiling *mrbgems/mruby-bin-mirb/tools/mirb/mirb.c* and
-linking with *build/host/lib/libmruby.a*
+
+- compile minimal `mrbc` from `src` and `mrblib` sources
+  - compile all files under `src` (object files will be stored in `build/host/mrbc/src`)
+  - compile `mruby-compiler` gem
+  - create `build/host/mrbc/lib/libmruby_core.a` out of all object files (C only)
+  - create `build/host/mrbc/bin/mrbc` via `mruby-bin-mrbc` gem
+- compile all files under `src` and store result in `build/host/src`
+- create `build/host/mrblib/mrblib.c` by compiling all `*.rb` files under `mrblib` with `build/host/mrbc/bin/mrbc`
+- compile `build/host/mrblib/mrblib.c` to `build/host/mrblib/mrblib.o`
+- create `build/host/lib/libmruby.a` out of all object files (C and Ruby)
+- compile (normal) mrbgems specified in the configuration file
+- create `build/host/lib/libmruby.a` from object files from gems and `libmruby_core.a`
+- create binary commands according to binary gems (e.g. `mirb` and `mruby`)
+- copy binaries under `build/host/bin` to `bin` directory
 
 ```
  _____    _____    ______    ____    ____    _____    _____    ____
@@ -374,73 +456,54 @@ linking with *build/host/lib/libmruby.a*
 
 ### Cross-Compilation
 
-In case of a cross-compilation to *i386* the *build* directory structure looks
+In case of a cross-compilation to `i386` the `build` directory structure looks
 like this:
 
-	+- build
-	   |
-	   +-  host
-	   |   |
-	   |   +- bin           <- Native Binaries
-	   |   |
-	   |   +- lib           <- Native Libraries
-	   |   |
-	   |   +- mrblib
-	   |   |
-	   |   +- src
-	   |   |
-	   |   +- test          <- Native mrbtest tool
-	   |   |
-	   |   +- tools
-	   |      |
-	   |      +- mirb
-	   |      |
-	   |      +- mrbc
-	   |      |
-	   |      +- mruby
-	   +- i386
-	      |
-	      +- bin            <- Cross-compiled Binaries
-	      |
-	      +- lib            <- Cross-compiled Libraries
-	      |
-	      +- mrblib
-	      |
-	      +- src
-	      |
-	      +- test           <- Cross-compiled mrbtest tool
-	      |
-	      +- tools
-	         |
-	         +- mirb
-	         |
-	         +- mrbc
-	         |
-	         +- mruby
+```
++- build
+    |
+    +- host
+    |   |
+    |   +- bin           <- Native Binaries
+    |   |
+    |   +- lib           <- Native Libraries
+    |   |
+    |   +- mrbgems
+    |   |
+    |   +- src
+    |
+    +- i386
+        |
+        +- bin            <- Cross-compiled Binaries
+        |
+        +- include        <- Header Directory
+        |
+        +- lib            <- Cross-compiled Libraries
+        |
+        +- mrbgems
+        |
+        +- mrblib
+        |
+        +- src
+```
 
 An extra directory is created for the target platform. In case you
-compile for *i386* a directory called *i386* is created under the
+compile for `i386` a directory called `i386` is created under the
 build directory.
 
 The cross compilation workflow starts in the same way as the normal
-compilation by compiling all *native* libraries and binaries.
-Afterwards the cross compilation process proceeds like this:
-* cross-compile all files under *src* (object files will be stored
-in *build/i386/src*)
-* generate parser grammar out of *src/parse.y* (generated
-result will be stored in *build/i386/src/y.tab.c*)
-* cross-compile *build/i386/src/y.tab.c* to *build/i386/src/y.tab.o*
-* create *build/i386/mrblib/mrblib.c* by compiling all \*.rb files
-under *mrblib* with the native `build/host/bin/mrbc`
-* cross-compile *build/host/mrblib/mrblib.c* to *build/host/mrblib/mrblib.o*
-* create *build/i386/lib/libmruby.a* out of all object files (C and Ruby)
-* create `build/i386/bin/mruby` by cross-compiling *mrbgems/mruby-bin-mruby/tools/mruby/mruby.c* and
-linking with *build/i386/lib/libmruby.a*
-* create `build/i386/bin/mirb` by cross-compiling *mrbgems/mruby-bin-mirb/tools/mirb/mirb.c* and
-linking with *build/i386/lib/libmruby.a*
-* create *build/i386/lib/libmruby_core.a* out of all object files (C only)
-* create `build/i386/bin/mrbc` by cross-compiling *tools/mrbc/mrbc.c* and
-linking with *build/i386/lib/libmruby_core.a*
+compilation by compiling all _native_ libraries and binaries, except
+for we don't have `host/mrbc` directory (`host` directory itself works
+as placeholder for `mrbc`). Afterwards the cross compilation process
+proceeds like this:
+
+- cross-compile all files under `src` and store result in `build/i386/src`
+- create `build/i386/lib/libmruby_core.a` out of C object files
+- create `build/i386/mrblib/mrblib.c` by compiling all `*.rb` files under `mrblib` with native `build/host/bin/mrbc`
+- cross-compile `build/i386/mrblib/mrblib.c` to `build/i386/mrblib/mrblib.o`
+- create `build/i386/lib/libmruby.a` from object files from gems and `libmruby_core.a`
+- create binary commands according to binary gems (e.g. `mirb` and `mruby`)
+- copy binaries under `build/host/bin` to `bin` directory
 
 ```
  _______________________________________________________________
@@ -471,22 +534,138 @@ feature due to the reason that there are functions (e.g. stdio) which
 can't be disabled for the main build.
 
 ```ruby
-MRuby::CrossBuild.new('Minimal') do |conf|
-  toolchain :gcc
-
-  conf.cc.defines = %w(MRB_DISABLE_STDIO)
-  conf.bins = []
+MRuby::CrossBuild.new('minimal') do |conf|
+  conf.toolchain :gcc
+  conf.cc.defines << 'MRB_NO_STDIO'
 end
 ```
 
-This configuration defines a cross compile build called 'Minimal' which
+This configuration defines a cross compile build called 'minimal' which
 is using the GCC and compiles for the host machine. It also disables
-all usages of stdio and doesn't compile any binaries (e.g. mrbc).
+all usages of stdio and doesn't compile any binaries (e.g. `mrbc`).
 
 ## Test Environment
 
 mruby's build process includes a test environment. In case you start the testing
 of mruby, a native binary called `mrbtest` will be generated and executed.
-This binary contains all test cases which are defined under *test/t*. In case
-of a cross-compilation an additional cross-compiled *mrbtest* binary is
+This binary contains all test cases which are defined under `test/t`. In case
+of a cross-compilation an additional cross-compiled `mrbtest` binary is
 generated. You can copy this binary and run on your target system.
+
+## Embedding `mruby` in Your Application
+
+After the build, you will get `libmruby.a`. You can link it to your application.
+
+For compiler options and library path, you can use `mruby-config` command for
+convenience. `mruby-config` command prints the configuration used for `libmruby.a`.
+
+```console
+$ mruby-config --help
+Usage: mruby-config [switches]
+  switches:
+  --cc                        print compiler name
+  --cflags                    print flags passed to compiler
+  --ld                        print linker name
+  --ldflags                   print flags passed to linker
+  --ldflags-before-libs       print flags passed to linker before linked libraries
+  --libs                      print linked libraries
+  --libmruby-path             print libmruby path
+  --help                      print this help
+```
+
+For example, when you have a C source file (`c.c`) and try to
+compile and link it with `libmruby.a`, you can run the following command,
+
+```
+`mruby-config --cc --cflags` c.c `mruby-config --ldflags --libs`
+```
+
+When you use `make`, add following lines in `Makefile`
+
+```
+MRB_CONFIG = <path-to-mruby-config>
+CFLAGS = `$(MRB_CONFIG) --cflags`
+LDFLAGS = `$(MRB_CONFIG) --ldflags`
+LIBS = `$(MRB_CONFIG) --libs`
+```
+
+## Install
+
+To install the files in the `bin`, `include` and `lib` directories generated by the "host" build target into a system directory, do the following:
+
+```console
+$ rake install
+```
+
+If there are multiple build targets in the build configuration file, to install the products of all build targets, do the following:
+
+```console
+$ rake install:full
+```
+
+To install only one of several build targets, e.g., the "its-mine" build target, do the following:
+
+```console
+$ rake install:full:its-mine
+```
+
+To install only the executable files, do the following:
+
+```console
+$ rake install_bin              # only "host" build target
+$ rake install:bin              # all build targets
+$ rake install:bin:its-mine     # only "its-mine" build target
+```
+
+### Installation Directory
+
+The installation directory is `/usr/local` for the "host" build target and `/usr/local/mruby/<build-name>` for the others.
+To change them, you can set the environment variable `PREFIX` or use `MRuby::Build#install_prefix = dir` in your build configuration file.
+
+The `PREFIX` environment variable affects all build targets and changes the `/usr/local` part.
+
+The `MRuby::Build#install_prefix` can be set for each individual build target.
+In this case, the environment variable `PREFIX` is ignored.
+
+Also, if the environment variable `DESTDIR` is set, it will prepend to the path obtained by `install_prefix` to determine the final write directory.
+This is intended for temporary file expansion by the user's package work.
+
+---
+
+To summarize:
+
+- The default value of the environment variable `PREFIX` is `/usr/local`.
+- For the "host" build target, the default value of `MRuby::Build#install_prefix` is `<PREFIX>`.
+- For a build target other than "host", the default value of `MRuby::Build#install_prefix` is `<PREFIX>/mruby/<build-name>`.
+- If the environment variable `DESTDIR` is set, the actual write directory is `<DESTDIR>/<MRuby::Build#install_prefix>`.
+
+### Excluded files
+
+In some cases there are files that you do not want to install.
+In such cases, add a file path filter to the array object `MRuby::Build#install_excludes` to exclude them.
+
+The following is an object that can be defined as a file path filter.
+The `path` variable that appears is a relative path based on `MRuby::Build#build_dir`.
+
+- string objects: files matched by `string.match?(path)` are excluded.
+- regexp object: files matched by `regexp.match?(path)` are excluded.
+- proc object: files which return true with `proc.call(path)` are excluded.
+
+```ruby
+# exclude bin/mrbc
+conf.install_excludes << exefile("bin/mrbc")
+
+# exclude all files under lib/ directory
+conf.install_excludes << %r(^lib/)
+
+# exclude bin/mrbtest, but in this case it is recommended to use string instead of proc
+conf.install_excludes << proc { |path|
+  path == exefile("bin/mrbtest")
+}
+```
+
+By default, it contains only a proc object to exclude `libmruby_core`.
+
+## Tips
+
+- If you see compilation troubles, try `rake clean` first.

doc/guides/debugger.md

@@ -1,3 +1,5 @@
+<!-- summary: About the Debugger with the `mrdb` Command -->
+
 # How to Use the mruby Debugger
 
 copyright (c) 2014 Specified Non-Profit Corporation mruby Forum
@@ -38,7 +40,7 @@ To confirm mrdb was installed properly, run mrdb with the `--version` option:
 
 ```bash
 $ mrdb --version
-mruby 2.1.2 (2020-07-10)
+mruby 3.4.0 (2025-04-20)
 ```
 
 ## 2.2 Basic Operation
@@ -50,7 +52,7 @@ To invoke the mruby debugger, just type `mrdb`.
 To specify the script file:
 
 ```bash
-$ mrdb [option] file name
+$ mrdb [option] filename
 ```
 
 For example: Debugging sample.rb
@@ -61,20 +63,20 @@ $ mrdb sample.rb
 
 You can execute the shell commands listed below:
 
-|command|description|
-|:-:|:--|
-|run|execute programs|
-|step|execute stepping|
-|continue|execute continuing program|
-|break|configure the breaking point|
-|delete|deleting the breaking points|
-|disable|disabling the breaking points|
-|enable|enabling the breaking points|
-|info breakpoints|showing list of the breaking points|
-|print|evaluating and printing the values of the mruby expressions in the script|
-|list|displaying the source cords|
-|help|showing help|
-|quit|terminating the mruby debugger|
+|     command      | description                                                               |
+| :--------------: | :------------------------------------------------------------------------ |
+|       run        | execute programs                                                          |
+|       step       | execute stepping                                                          |
+|     continue     | execute continuing program                                                |
+|      break       | configure the breaking point                                              |
+|      delete      | deleting the breaking points                                              |
+|     disable      | disabling the breaking points                                             |
+|      enable      | enabling the breaking points                                              |
+| info breakpoints | showing list of the breaking points                                       |
+|      print       | evaluating and printing the values of the mruby expressions in the script |
+|       list       | displaying the source cords                                               |
+|       help       | showing help                                                              |
+|       quit       | terminating the mruby debugger                                            |
 
 ### 2.2.2 Debugging mruby Binary Files (mrb file) with mrdb
 
@@ -82,8 +84,8 @@ You can debug the mruby binary files.
 
 #### 2.2.2.1 Debugging the binary files
 
-* notice
-To debug mruby binary files, you need to compile mruby files with option `-g`.
+- notice
+  To debug mruby binary files, you need to compile mruby files with option `-g`.
 
 ```bash
 $ mrbc -g sample.rb
@@ -114,12 +116,12 @@ b [class:]method
 The breakpoint will be ordered in serial from 1.
 The number, which was given to the deleted breakpoint, will never be given to another breakpoint again.
 
-You can give multiple breakpoints to specified the line number and method.
-Be ware that breakpoint command will not check the validity of the class name and method name.
+You can give multiple breakpoints to the specified the line number and method.
+Be aware that the breakpoint command will not check the validity of the class name and method name.
 
 You can get the current breakpoint information by the following options.
 
-breakpoint breakpoint number : file name. line number
+breakpoint breakpoint number : filename. line number
 
 breakpoint breakpoint number : [class name,] method name
 
@@ -165,7 +167,7 @@ Example:
 (foo.rb:1) delete
 ```
 
-This will delete all of the breakpoints.
+This will delete all the breakpoints.
 
 ```
 (foo.rb:1) delete 1 3
@@ -192,7 +194,7 @@ Example:
 (foo.rb:1) disable
 ```
 
-Use `disable` if you would like to disable all of the breakpoints.
+Use `disable` if you would like to disable all the breakpoints.
 
 ```
 (foo.rb:1) disable 1 3
@@ -220,6 +222,7 @@ Example:
 ```
 
 Enabling all breakpoints
+
 ```
 (foo.rb:1) enable 1 3
 ```
@@ -263,8 +266,8 @@ Example:
 
 ```
 (sample.rb:1) info breakpoints
-Num     Type           Enb What  
-1       breakpoint     y   at sample.rb:3                      -> file name,line number
+Num     Type           Enb What
+1       breakpoint     y   at sample.rb:3                      -> filename,line number
 2       breakpoint     n   in Sample_class:sample_class_method -> [class:]method name
 3       breakpoint     y   in sample_global_method
 ```
@@ -273,8 +276,8 @@ Displaying the specified breakpoint number:
 
 ```
 (foo.rb:1) info breakpoints 1 3
-Num     Type           Enb What  
-1       breakpoint     y   at sample.rb:3  
+Num     Type           Enb What
+1       breakpoint     y   at sample.rb:3
 3       breakpoint     y   in sample_global_method
 ```
 
@@ -298,11 +301,11 @@ When you do not specify both the `first` and `last` options, you will receive th
 Example:
 
 ```
-Specifying file name and first row number
+Specifying filename and first row number
 sample.rb:1) list sample2.rb:5
 ```
 
-Specifying the file name and the first and last row number:
+Specifying the filename and the first and last row number:
 
 ```
 (sample.rb:1) list sample2.rb:6,7
@@ -323,7 +326,7 @@ expr: expression
 
 The expression is mandatory.
 The displayed expressions will be serially ordered from 1.
-If an exception occurs, the exception information will be displayed and the debugging will be continued.
+If an exception occurs, the exception information will be displayed, and the debugging will be continued.
 
 Example:
 
@@ -366,5 +369,5 @@ r
 #### Step Command
 
 This will run the program step by step.
-When the method and the block are invoked, the program will be stop at the first row.
+When the method and the block are invoked, the program will stop at the first row.
 The program, which is developed in C, will be ignored.

doc/guides/gc-arena-howto.md

@@ -1,25 +1,28 @@
+<!-- summary: About GC Arena -->
+
 # How to use `mrb_gc_arena_save()`/`mrb_gc_arena_restore()`/`mrb_gc_protect()`
 
 _This is an English translation of [Matz's blog post][matz blog post]
 written in Japanese._
 _Some parts are updated to reflect recent changes._
-[matz blog post]: http://www.rubyist.net/~matz/20130731.html
+
+[matz blog post]: https://www.rubyist.net/~matz/20130731.html
 
 When you are extending mruby using C language, you may encounter
 mysterious "arena overflow error" or memory leak or very slow
-execution speed.  This is an error indicating overflow of "GC arena"
+execution speed. This is an error indicating overflow of "GC arena"
 implementing "conservative GC".
 
 GC (garbage collector) must ensure that object is "alive", in other
-words, that it is referenced by somewhere from program.  This can be
+words, that it is referenced by somewhere from the program. This can be
 determined by checking if the object can be directly or indirectly
-referenced by root.  The local variables, global variables and
-constants etc are root.
+referenced by root. The local variables, global variables and
+constants etc. are root.
 
 If program execution is performed inside mruby VM, there is nothing to
-worry about because GC can access all roots owned by VM.
+worry about because GC can access all roots owned by the VM.
 
-The problem arises when executing C functions.  The object referenced
+The problem arises when executing C functions. The object referenced
 by C variable is also "alive", but mruby GC cannot aware of this, so
 it might mistakenly recognize the objects referenced by only C
 variables as dead.
@@ -27,18 +30,18 @@ variables as dead.
 This can be a fatal bug if the GC tries to collect a live object.
 
 In CRuby, we scan C stack area, and use C variable as root to check
-whether object is alive or not.  Of course, because we are accessing C
+whether object is alive or not. Of course, because we are accessing C
 stack just as memory region, we never know it is an integer or a
-pointer.  We workaround this by assuming that if it looks like a
-pointer, then assume it as a pointer.  We call it "conservative".
+pointer. We work around this by assuming that if it looks like a
+pointer, then assume it as a pointer. We call it "conservative".
 
 By the way, CRuby's "conservative GC" has some problems.
 
 The biggest problem is we have no way to access to the stack area in
-portable way.  Therefore, we cannot use this method if we'd like to
+portable way. Therefore, we cannot use this method if we'd like to
 implement highly portable runtime, like mruby.
 
-So we came up with an another plan to implement "conservative GC" in mruby.
+So we came up with another plan to implement "conservative GC" in mruby.
 
 Again, the problem is when an object which was created in C function, becomes
 no longer referenced in the Ruby world, and cannot be treated as garbage.
@@ -46,7 +49,7 @@ no longer referenced in the Ruby world, and cannot be treated as garbage.
 In mruby, we recognize all objects created in C function are alive.
 Then we have no problem such as confusing a live object as dead.
 
-This means that because we cannot collect truly dead object, we may
+This means that because we cannot collect a truly dead object, we may
 lose efficiency, but as a trade-off the GC itself is highly portable.
 We can say goodbye to the problem that GC deletes live objects due to
 optimization which sometimes occurs in CRuby.
@@ -62,17 +65,17 @@ memory leak.
 
 As of this writing, mruby automatically extend arena to remember
 objects (See `MRB_GC_FIXED_ARENA` and `MRB_GC_ARENA_SIZE` in
-doc/guides/mrbconf.md).
+[doc/guides/mrbconf.md](mrbconf.md)).
 
 If you create many objects in C functions, memory usage will increase, since
-GC never kick in.  This memory usage may look like memory leak, but will also
+GC never kicks in. This memory usage may look like memory leaks, but will also
 make execution slower as more memory will need to be allocated.
 
 With the build time configuration, you can limit the maximum size of
-arena (e.g., 100).  Then if you create many objects, arena overflows,
+arena (e.g., 100). Then if you create many objects, arena overflows,
 thus you will get an "arena overflow error".
 
-To workaround these problems, we have `mrb_gc_arena_save()` and
+To work around these problems, we have `mrb_gc_arena_save()` and
 `mrb_gc_arena_restore()` functions.
 
 `int mrb_gc_arena_save(mrb)` returns the current position of the stack
@@ -93,7 +96,7 @@ In mruby, C function calls are surrounded by this save/restore, but we
 can further optimize memory usage by surrounding save/restore, and can
 avoid creating arena overflow bugs.
 
-Let's take a real example.  Here is the source code of `Array#inspect`:
+Let's take a real example. Here is the source code of `Array#inspect`:
 
 ```c
 static mrb_value
@@ -106,7 +109,7 @@ inspect_ary(mrb_state *mrb, mrb_value ary, mrb_value list)
   char tail[] = { ']' };
 
   /* check recursive */
-  for(i=0; i<RARRAY_LEN(list); i++) {
+  for (i=0; i<RARRAY_LEN(list); i++) {
     if (mrb_obj_equal(mrb, ary, RARRAY_PTR(list)[i])) {
       return mrb_str_new(mrb, "[...]", 5);
     }
@@ -117,7 +120,7 @@ inspect_ary(mrb_state *mrb, mrb_value ary, mrb_value list)
   arystr = mrb_str_new_capa(mrb, 64);
   mrb_str_cat(mrb, arystr, head, sizeof(head));
 
-  for(i=0; i<RARRAY_LEN(ary); i++) {
+  for (i=0; i<RARRAY_LEN(ary); i++) {
     int ai = mrb_gc_arena_save(mrb);
 
     if (i > 0) {
@@ -140,29 +143,29 @@ inspect_ary(mrb_state *mrb, mrb_value ary, mrb_value list)
 }
 ```
 
-This is a real example, so a little bit complicated, but bear with me.
+This is a real example, so slightly complicated, but bear with me.
 The essence of `Array#inspect` is that after stringifying each element
 of array using `inspect` method, we join them together so that we can
 get `inspect` representation of the entire array.
 
 After the `inspect` representation is created, we no longer require the
-individual string representation.  This means that we don't have to register
+individual string representation. This means that we don't have to register
 these temporal objects into GC arena.
 
 Therefore, in order to keep the arena size small; the `ary_inspect()` function
 will do the following:
 
-* save the position of the stack top using `mrb_gc_arena_save()`.
-* get `inspect` representation of each element.
-* append it to the constructing entire `inspect` representation of array.
-* restore stack top position using `mrb_gc_arena_restore()`.
+- save the position of the stack top using `mrb_gc_arena_save()`.
+- get `inspect` representation of each element.
+- append it to the constructing entire `inspect` representation of array.
+- restore stack top position using `mrb_gc_arena_restore()`.
 
 Please note that the final `inspect` representation of entire array
-was created before the call of `mrb_gc_arena_restore()`.  Otherwise,
+was created before the call of `mrb_gc_arena_restore()`. Otherwise,
 required temporal object may be deleted by GC.
 
-We may have a usecase where after creating many temporal objects, we'd
-like to keep some of them.  In this case, we cannot use the same idea
+We may have an usecase where after creating many temporal objects, we'd
+like to keep some of them. In this case, we cannot use the same idea
 in `ary_inspect()` like appending objects to existing one.
 Instead, after `mrb_gc_arena_restore()`, we must re-register the objects we
 want to keep in the arena using `mrb_gc_protect(mrb, obj)`.

doc/guides/hier.md

@@ -0,0 +1,62 @@
+<!-- summary: About the mruby directory structure -->
+
+# The mruby directory structure
+
+```text
++- 💎 mruby/                    The top directory of mruby.
+    |
+    +- 📁 .github/              GitHub configuration files for mruby project management.
+    |
+    +- 📁 benchmark/            Benchmarking files for mruby.
+    |
+    +- 📁 bin/                  Links to temporary executables after build. Auto-created.
+    |
+    +- 📁 build/                Default build output destination for mruby. Auto-created.
+    |   |
+    |   +- 📁 repos/            The git clone destination directory for GEMs that depend on the build configuration.
+    |   |
+    |   +- 📁 host/             The "host" build output directory.
+    |
+    +- 📁 build_config/         Build configuration files for various environments.
+    |
+    +- 📁 doc/                  Documentation for mruby.
+    |   |
+    |   +- 📁 guides/           Documentation for general users.
+    |   |
+    |   +- 📁 internal/         Documentation for internal implementations for developers.
+    |
+    +- 📁 examples/             Examples of mruby usages.
+    |   |
+    |   +- 📁 mrbgems/          Examples for creating custom GEM for mruby.
+    |
+    +- 📁 include/              C header files required when using mruby.
+    |
+    +- 📁 lib/                  Ruby scripts used for building mruby.
+    |
+    +- 📁 mrbgems/              A library collection of features not provided by mruby core only.
+    |   |                       See doc/guides/mrbgems.md file
+    |   |
+    |   +- 📁 mruby-*/          The directory of each GEMs.
+    |   |
+    |   +- 📃 *.gembox          A collection of GEMs grouped by features and purposes.
+    |
+    +- 📁 mrblib/               The core Ruby scripts that makes up the main body of mruby.
+    |
+    +- 📁 oss-fuzz/             Source code for The fuzzing-test.
+    |                           See https://github.com/google/oss-fuzz
+    |
+    +- 📁 src/                  The core C source code that makes up the main body of mruby.
+    |
+    +- 📁 tasks/                Rake tasks at build-time.
+    |   |
+    |   +- 📁 toolchains/       Definitions for the compiler, linker, archiver, etc. for each toolchain.
+    |
+    +- 📁 test/                 Ruby scripts needed for testing mruby.
+    |   |
+    |   +- 📁 t/                mruby test cases.
+    |
+    +- 📁 tools/                External programs used for the mruby project.
+        |
+        +- 📁 lrama/            LALR parser generator as an alternative to bison.
+                                Import from https://github.com/ruby/lrama
+```

doc/guides/link.md

@@ -0,0 +1,85 @@
+<!-- summary: About Linking with `libmruby` -->
+
+# Linking `libmruby` to your application
+
+You have two ways to link `libmruby` to your application.
+
+- using executable gem.
+- using normal compilation process
+
+## Executable Gems
+
+If your application is relatively small, `mrbgem` is an easier way to
+create the executable. By tradition, the gem name start with
+`mruby-bin-`, e.g. `mruby-bin-debugger`.
+
+### `mrbgem.rake` file
+
+The executable name is specified in `mrbgem.rake` file at the top of
+your `mrbgem` directory.
+
+```ruby
+MRuby::Gem::Specification.new('mruby-bin-example') do |spec|
+  spec.license = 'MIT'
+  spec.author  = 'mruby developers'
+  spec.summary = 'Example for executable command gem'
+  spec.bins = %w(mruby-example)    # <- this is binary name
+end
+```
+
+### Source tree structure
+
+The source file for the gem executable should be in
+`<gem-name>/tools/<bin-name>`. Currently, we support C or C++ source code
+(`.c`, `.cpp`, `.cxx`, `.cc`) for the executable. Ruby source files are not
+supported. Put the functionality in the different gem and specify dependency to
+it in `mrbgem.rake`.
+
+## Normal compilation process
+
+The `libmruby` is a normal library so that you can just link it to your
+application. Specify proper compiler options (`-I` etc.) and linker options
+(`-lmruby` etc.) to compile and link your application. Specify those options in
+your build script (e.g. `Makefile`).
+
+### Compiler options
+
+You need to specify compiler options that are compatible to mruby configuration,
+for example:
+
+- `-I` to specify the place for mruby header files
+- `-D` to specify mruby configuration macros
+
+To retrieve compiler options used to build `mruby`, you can use `mruby-config`
+command with following options:
+
+- `--cc` compiler name
+- `--cflags` options passed to compiler
+
+```console
+$ mruby-config --cflags
+-std=gnu99 -g -O3 -Wall -DMRB_GC_FIXED_ARENA -I/home/matz/work/mruby/include -I/home/matz/work/mruby/build/host/include
+```
+
+### Linker options
+
+Just like compiler options, you need to specify linker options that are
+compatible to mruby configuration.
+
+To retrieve linker options, you can use `mruby-config` with following options:
+
+- `--ld` linker name
+- `--ldflags` options passed to linker
+- `--ldflags-before-libs` options passed to linker before linked libraries
+- `--libs` linked libraries
+
+```console
+$ mruby-config --ldflags
+-L/home/matz/work/mruby/build/host/lib
+
+$ mruby-config --ldflags-before-libs
+# <nothing in this case>
+
+$ mruby-config --libs
+-lmruby -lm
+```

doc/guides/memory.md

@@ -0,0 +1,120 @@
+<!-- summary: About Memory Allocator Customization -->
+
+# Memory Allocation
+
+In mruby, you can customize how memory is allocated in two ways:
+
+1. **Provide your own `malloc()`/`realloc()`/`free()`**
+2. **Override `mrb_basic_alloc_func()`**
+
+---
+
+## 1. Provide your own `malloc()`/`realloc()`/`free()`
+
+On platforms without a full C standard library —such as many microcontrollers— you may need to supply your own implementations of `malloc()`, `realloc()`, and `free()`. mruby’s allocator calls directly into these functions, so replacing them lets you control **every** allocation and deallocation performed by your entire program, including any third‑party libraries you link against.
+
+Keep in mind:
+
+- Calling `realloc(NULL, size)` must behave like `malloc(size)`.
+- Calling `free(NULL)` must be a no‑op.
+
+Simply define these three functions in your code (or link against a library that provides them), and mruby — along with all other code in your process — will use your versions automatically.
+
+## 2. Override `mrb_basic_alloc_func()`
+
+Inside mruby, all of its own memory allocations go through a single function called mrb_basic_alloc_func() (formerly mrb_default_allocf()). By defining this function in your application before linking, you can intercept and handle **only** the memory operations initiated by mruby itself without affecting other libraries or parts of your program.
+
+```c
+// Example signature:
+// void* mrb_basic_alloc_func(void* ptr, size_t size);
+```
+
+Implement mrb_basic_alloc_func() in your code, and mruby will invoke it for every internal allocation, reallocation, and free request.
+
+### Expected behavior
+
+- `mrb_basic_alloc_func(NULL, size)` should allocate `size` bytes, just like `malloc(size)`.
+- `mrb_basic_alloc_func(ptr, size)` should resize the existing block at `ptr` to `size` bytes, just like `realloc(ptr, size)`.
+- `mrb_basic_alloc_func(ptr, 0)` should free the block at `ptr`, just like `free(ptr)`.
+
+---
+
+## Summary of effects:
+
+- **Custom `malloc`/`realloc`/`free`**: replaces allocation behavior globally (mruby + all other code and third‑party libraries).
+
+- **Custom `mrb_basic_alloc_func()`**: replaces allocation behavior only for mruby’s internal use, leaving other libraries’ allocations untouched.
+
+## Migration note
+
+If you are moving from the old API:
+
+1. **Removal of `mrb_open_allocf()`**
+
+   - \_Old:
+
+     ```c
+     mrb_state *mrb = mrb_open_allocf(my_allocf, ud);
+     ```
+
+   - \_New:
+
+     ```c
+     // No allocf parameter; set up your hook via mrb_basic_alloc_func definition.
+     mrb_state *mrb = mrb_open_core();
+     ```
+
+2. **`mrb_open_core()` takes no arguments**
+
+   - Simply drop any allocf or user-data arguments, and redefine `mrb_basic_alloc_func` as you need.
+
+3. **No more `mrb_allocf` type**
+
+   - Definitions using the `mrb_allocf` typedef can be removed; implement `mrb_basic_alloc_func()` with the signature below:
+
+     ```c
+     void* mrb_basic_alloc_func(void *ptr, size_t size);
+     ```
+
+4. **`mrb_basic_alloc_func` signature change**
+
+   - _Old:_
+
+     ```c
+     void* mrb_default_allocf(mrb_state *mrb, void *ptr, size_t size, void *ud);
+     ```
+
+   - _New:_
+
+     ```c
+     void* mrb_basic_alloc_func(void *ptr, size_t size);
+     ```
+
+---
+
+### Code examples
+
+- **Old style**:
+
+  ```c
+  static void*
+  my_allocf(mrb_state *mrb, void *ud, void *ptr, size_t size)
+  {
+    // ...custom logic...
+  }
+
+  mrb_state *mrb = mrb_open_allocf(my_allocf, some_ud);
+  ```
+
+- **New style**:
+
+  ```c
+  // Define your hook before creating the state:
+  void*
+  mrb_basic_alloc_func(void *ptr, size_t size)
+  {
+    // ...custom logic...
+  }
+
+  mrb_state *mrb = mrb_open_core();
+  ```

doc/guides/mrbconf.md

@@ -1,181 +1,248 @@
-# mruby configuration macros.
+<!-- summary: About Build-time Configurations -->
 
-## How to use these macros.
-You can use mrbconfs with following ways:
-* Write them in `mrbconf.h`.
- * Using compiler flags is preferred  when building a cross binaries or multiple mruby binaries
- since it's easier to use different mrbconf per each `MRuby::Build`.
- * Most flags can be enabled by just commenting in.
-* Pass them as compiler flags.
- * Make sure you pass the same flags to all compilers since some mrbconf(e.g., `MRB_GC_FIXED_ARENA`)
- changes `struct` layout and cause memory access error when C and other language(e.g., C++) is mixed.
+# mruby configuration macros
 
-## stdio setting.
-`MRB_DISABLE_STDIO`
-* When defined `<stdio.h>` functions won't be used.
-* Some features will be disabled when this is enabled:
-  * `mrb_irep` load/dump from/to file.
-  * Compiling mruby script from file.
-  * Printing features in **src/print.c**.
+## The configuration file
 
-## Debug macros.
-`MRB_ENABLE_DEBUG_HOOK`
-* When defined code fetch hook and debug OP hook will be enabled.
-* When using any of the hook set function pointer `code_fetch_hook` and/or `debug_op_hook` of `mrb_state`.
-* Fetch hook will be called before any OP.
-* Debug OP hook will be called when dispatching `OP_DEBUG`.
+You can do the build configuration in the build configuration file. The default
+configuration file is `build_config/default.rb`.
+
+You can specify your own configuration file by the `MRUBY_CONFIG` environment
+variable (you can use `CONFIG` for shorthand for `MRUBY_CONFIG`). If the path
+doesn't exist, `build_config/${MRUBY_CONFIG}.rb` is used.
+
+## How to use these macros
+
+Just add the configuration value to the `MRuby::Build#defines` attribute.
+This is the same for `MRuby::CrossBuild`.
+
+```ruby
+# build_config.rb
+
+MRuby::Build.new do |conf|
+  ...
+  conf.defines << 'MRB_GC_FIXED_ARENA'
+  conf.defines << 'MRB_NO_METHOD_CACHE'
+  ...
+end
+```
+
+**_NOTE_**
+
+- Use common definitions (`conf.defines`) instead of per-compiler definitions (e.g., `conf.cc.defines`) unless there is a special reason not to.
+- It is now deprecated to edit the `include/mruby/mrbconf.h` file or give it directly as a compiler flag, as was the case before.
+
+## stdio setting
+
+`MRB_NO_STDIO`
+
+- When defined `<stdio.h>` functions won't be used.
+- Some features will be disabled when this is enabled:
+  - `mrb_irep` load/dump from/to file.
+  - Compiling mruby script from a file.
+  - Printing features in **src/print.c**.
+
+## Debug macros
+
+`MRB_USE_DEBUG_HOOK`
+
+- When defined code fetch hook and debug OP hook will be enabled.
+- When using any of the hook set function pointer `code_fetch_hook` and/or `debug_op_hook` of `mrb_state`.
+- Fetch hook will be called before any OP.
+- Debug OP hook will be called when dispatching `OP_DEBUG`.
 
 `MRB_DEBUG`
-* When defined `mrb_assert*` macro will be defined with macros from `<assert.h>`.
-* Could be enabled via `enable_debug` method of `MRuby::Build`.
+
+- When defined `mrb_assert*` macro will be defined with macros from `<assert.h>`.
+- Could be enabled via `enable_debug` method of `MRuby::Build`.
 
 ## Stack configuration
 
 `MRB_STACK_EXTEND_DOUBLING`
-* If defined doubles the stack size when extending it.
-* Else extends stack with `MRB_STACK_GROWTH`.
+
+- If defined doubles the stack size when extending it.
+- Otherwise extends stack with `MRB_STACK_GROWTH`.
 
 `MRB_STACK_GROWTH`
-* Default value is `128`.
-* Used in stack extending.
-* Ignored when `MRB_STACK_EXTEND_DOUBLING` is defined.
+
+- Default value is `128`.
+- Used in stack extending.
+- Ignored when `MRB_STACK_EXTEND_DOUBLING` is defined.
 
 `MRB_STACK_MAX`
-* Default value is `0x40000 - MRB_STACK_GROWTH`.
-* Raises `RuntimeError` when stack size exceeds this value.
 
-## Primitive type configuration.
+- Default value is `0x40000 - MRB_STACK_GROWTH`.
+- Raises `RuntimeError` when stack size exceeds this value.
 
-`MRB_USE_FLOAT`
-* When defined single precision floating point type(C type `float`) is used as `mrb_float`.
-* Else double precision floating point type(C type `double`) is used as `mrb_float`.
+## Primitive type configuration
 
-`MRB_WITHOUT_FLOAT`
-* When defined removes floating point numbers from mruby.
-* It makes mruby easier to handle in "Microcontroller without FPU" and "Kernel Space".
+`MRB_USE_FLOAT32`
+
+- When defined single-precision floating-point type(C type `float`) is used as `mrb_float`.
+- Otherwise, double-precision floating-point type(C type `double`) is used as `mrb_float`.
+
+`MRB_NO_FLOAT`
+
+- When defined removes floating-point numbers from mruby.
+- It makes mruby easier to handle in "Micro-controller without FPU" and "Kernel Space".
 
 `MRB_INT32`
-* When defined, or `MRB_INT64` are not defined on 32-bit CPU mode, `mrb_int` will be defined as `int32_t`.
-* Conflicts with `MRB_INT64`.
+
+- When defined, or `MRB_INT64` are not defined on 32-bit CPU mode, `mrb_int` will be defined as `int32_t`.
+- Conflicts with `MRB_INT64`.
 
 `MRB_INT64`
-* When defined, or `MRB_INT32` are not defined on 64-bit CPU mode, `mrb_int` will be defined as `int64_t`.
-* Conflicts with `MRB_INT32`.
 
-## Garbage collector configuration.
+- When defined, or `MRB_INT32` are not defined on 64-bit CPU mode, `mrb_int` will be defined as `int64_t`.
+- Conflicts with `MRB_INT32`.
+
+## Garbage collector configuration
 
 `MRB_GC_STRESS`
-* When defined full GC is emitted per each `RBasic` allocation.
-* Mainly used in memory manager debugging.
+
+- When defined full GC is emitted per each `RBasic` allocation.
+- Mainly used in memory manager debugging.
+- If defined at the same time as `MRB_DEBUG`, full GC is emitted also per each heap allocation (`mrb_malloc()` or etc.).
+  This configuration slows down mruby execution by a factor of 2 to 3 or even more.
 
 `MRB_GC_TURN_OFF_GENERATIONAL`
-* When defined turns generational GC by default.
+
+- When defined turns generational GC off by default.
 
 `MRB_GC_FIXED_ARENA`
-* When defined used fixed size GC arena.
-* Raises `RuntimeError` when this is defined and GC arena size exceeds `MRB_GC_ARENA_SIZE`.
-* Useful tracking unnecessary mruby object allocation.
+
+- When defined used fixed size GC arena.
+- Raises `RuntimeError` when this is defined and GC arena size exceeds `MRB_GC_ARENA_SIZE`.
+- Useful tracking unnecessary mruby object allocation.
 
 `MRB_GC_ARENA_SIZE`
-* Default value is `100`.
-* Ignored when `MRB_GC_FIXED_ARENA` isn't defined.
-* Defines fixed GC arena size.
+
+- Default value is `100`.
+- Ignored when `MRB_GC_FIXED_ARENA` isn't defined.
+- Defines fixed GC arena size.
 
 `MRB_HEAP_PAGE_SIZE`
-* Defines value is `1024`.
-* Specifies number of `RBasic` per each heap page.
 
-## Memory pool configuration.
+- Default value is `1024`.
+- Specifies number of `RBasic` per each heap page.
+- To calculate the number of bytes per heap page, it is "(size of management data per heap page) + (size per object) \* `MRB_HEAP_PAGE_SIZE`".
+  In mruby 3.1.0, the "size of management data per heap page" is 6 words, also "size per object" is 6 words.
+  For a 32-bit CPU, `(6 * 4) + (6 * 4) * MRB_HEAP_PAGE_SIZE` gives the bytes of size per heap page.
+  Conversely, for example, to keep the size per heap page to 4 Ki bytes,
+  calculate `(4096 - (6 * 4)) / (6 * 4)` to specify `MRB_HEAP_PAGE_SIZE=169`.
+
+## Memory pool configuration
 
 `POOL_ALIGNMENT`
-* Default value is `4`.
-* If you're allocating data types that requires alignment more than default value define the
-largest value of required alignment.
+
+- Default value is `4`.
+- If you're allocating data types that requires alignment more than default value define the
+  largest value of required alignment.
 
 `POOL_PAGE_SIZE`
-* Default value is `16000`.
-* Specifies page size of pool page.
-* Smaller the value is increases memory overhead.
 
-## State atexit configuration.
+- Default value is `16000`.
+- Specifies page size of pool page.
+- Smaller the value is increases memory overhead.
+
+## State atexit configuration
 
 `MRB_FIXED_STATE_ATEXIT_STACK`
-* If defined enables fixed size `mrb_state` atexit stack.
-* Raises `RuntimeError` when `mrb_state_atexit` call count to same `mrb_state` exceeds
-`MRB_FIXED_STATE_ATEXIT_STACK_SIZE`'s value.
+
+- If defined enables fixed size `mrb_state` atexit stack.
+- Raises `RuntimeError` when `mrb_state_atexit` call count to same `mrb_state` exceeds
+  `MRB_FIXED_STATE_ATEXIT_STACK_SIZE`'s value.
 
 `MRB_FIXED_STATE_ATEXIT_STACK_SIZE`
-* Default value is `5`.
-* If `MRB_FIXED_STATE_ATEXIT_STACK` isn't defined this macro is ignored.
 
-## `mrb_value` configuration.
+- Default value is `5`.
+- If `MRB_FIXED_STATE_ATEXIT_STACK` isn't defined this macro is ignored.
+
+## `mrb_value` configuration
 
 `MRB_ENDIAN_BIG`
-* If defined compiles mruby for big endian machines.
-* Used in `MRB_NAN_BOXING`.
-* Some mrbgem use this mrbconf.
+
+- If defined compiles mruby for big endian machines.
+- Used in `MRB_NAN_BOXING`.
+- Some mrbgem use this mrbconf.
 
 `MRB_NAN_BOXING`
-* If defined represent `mrb_value` in boxed `double`.
-* Conflicts with `MRB_USE_FLOAT` and `MRB_WITHOUT_FLOAT`.
+
+- If defined represent `mrb_value` in boxed `double`.
+- Conflicts with `MRB_USE_FLOAT32` and `MRB_NO_FLOAT`.
 
 `MRB_WORD_BOXING`
-* If defined represent `mrb_value` as a word.
-* If defined `Float` will be a mruby object with `RBasic`.
 
-## Instance variable configuration.
-`MRB_IV_SEGMENT_SIZE`
-* Default value is `4`.
-* Specifies size of each segment in segment list.
+- If defined represent `mrb_value` as a word.
+- If defined `Float` will be a mruby object with `RBasic`.
 
-## Reduce heap memory configuration.
+## Reduce heap memory configuration
 
-`MRB_USE_LINK_TIME_RO_DATA_P`
-* Only available on ELF platforms.
-* If you specify the address of a read-only section when creating a symbol or string, that string will be used as it is.
-* Heap memory can be saved.
-* Uses `__ehdr_start` and `__init_array_start`.
-* It must be `__ehdr_start < data_addr < __init_array_start`.
+`MRB_USE_ETEXT_RO_DATA_P`
+
+- Use `etext` and `edata` section addresses defined by the linker to detect read-only data.
+- Those addresses are widely available, but not portable, nor standardized.
+- This macro is defined by default on User-mode Linux.
+
+`MRB_NO_DEFAULT_RO_DATA_P`
+
+- Define this macro when the default `mrb_ro_data_p()` does not work for any reason.
 
 `MRB_USE_CUSTOM_RO_DATA_P`
-* Takes precedence over `MRB_USE_LINK_TIME_RO_DATA_P`.
-* Please try if `MRB_USE_LINK_TIME_RO_DATA_P` is not available.
-* The `mrb_ro_data_p()` function is implemented by the user in an arbitrary file.
-* The prototype declaration is `mrb_bool mrb_ro_data_p(const char *ptr)`.
-* Return `TRUE` if `ptr` is in read-only section, otherwise return `FALSE`.
 
-## Other configuration.
+- Please try if `MRB_USE_LINK_TIME_RO_DATA_P` is not available.
+- The `mrb_ro_data_p()` function is implemented by the user in an arbitrary file.
+- The prototype declaration is `mrb_bool mrb_ro_data_p(const char *ptr)`.
+- Return `TRUE` if `ptr` is in the read-only section, otherwise return `FALSE`.
+
+## Other configuration
+
+`MRB_MALLOC_TRIM`
+
+- call `malloc_trim(0)` for each `mrb_full_gc()` call
+
 `MRB_UTF8_STRING`
-* Adds UTF-8 encoding support to character-oriented String instance methods.
-* If it isn't defined, they only support the US-ASCII encoding.
+
+- Adds UTF-8 encoding support to character-oriented String instance methods.
+- If it isn't defined, they only support the US-ASCII encoding.
+
+`MRB_STR_LENGTH_MAX`
+
+- The maximum length of strings (default 1MB)
+- set this value to zero to skip the check
+
+`MRB_ARY_LENGTH_MAX`
+
+- The maximum length of arrays (default 1MB)
+- set this value to zero to skip the check
 
 `MRB_FUNCALL_ARGC_MAX`
-* Default value is `16`.
-* Specifies 4th argument(`argc`) max value of `mrb_funcall`.
-* Raises `ArgumentError` when the `argc` argument is bigger then this value `mrb_funcall`.
+
+- Default value is `16`.
+- Specifies 4th argument(`argc`) max value of `mrb_funcall`.
+- Raises `ArgumentError` when the `argc` argument is bigger then this value `mrb_funcall`.
 
 `KHASH_DEFAULT_SIZE`
-* Default value is `32`.
-* Specifies default size of khash table bucket.
-* Used in `kh_init_ ## name` function.
 
-`MRB_STR_BUF_MIN_SIZE`
-* Default value is `128`.
-* Specifies initial capacity of `RString` created by `mrb_str_buf_new` function..
+- Default value is `32`.
+- Specifies default size of khash table bucket.
+- Used in `kh_init_ ## name` function.
 
-`MRB_METHOD_CACHE`
-* Improve performance for method dispatch.
+`MRB_NO_METHOD_CACHE`
+
+- Disable method cache to save memory.
 
 `MRB_METHOD_CACHE_SIZE`
-* Default value is `128`.
-* Ignored if `MRB_METHOD_CACHE` is not defined.
-* Need to be the power of 2.
 
-`MRB_METHOD_T_STRUCT`
-* Use C struct to represent `mrb_method_t`
-* No `MRB_METHOD_T_STRUCT` requires highest 2 bits of function pointers to be zero
-* Define this macro on machines that use higher bits of pointers
+- Default value is `256`.
+- Ignored if `MRB_NO_METHOD_CACHE` is defined.
+- Need to be the power of 2.
 
-`MRB_ENABLE_ALL_SYMBOLS`
-* Make it available `Symbols.all_symbols` in `mrbgems/mruby-symbol-ext`
-* Increase heap memory usage.
+`MRB_USE_ALL_SYMBOLS`
+
+- Make it available `Symbol.all_symbols` in `mrbgems/mruby-symbol-ext`
+- Increase heap memory usage.
+
+`MRB_USE_VM_SWITCH_DISPATCH`
+
+- Turn on switch dispatch in VM loop