summaryrefslogtreecommitdiffhomepage
path: root/doc
AgeCommit message (Collapse)Author
2021-07-03ops.h: made terms consistent.Yukihiro "Matz" Matsumoto
- `Lit` -> `Pool` - `SEQ` -> `Irep`
2021-07-03doc/opcode.md: table reformatted.Yukihiro "Matz" Matsumoto
2021-07-03vm.c: `OP_DEF` to push a symbol to `a` register.Yukihiro "Matz" Matsumoto
The code generator no longer need to emit `OP_LOADSYM` after `OP_DEF`. `doc/opcode.md` is also updated.
2021-06-30Revert "Remove `OP_EXT[123]` from operands."Yukihiro "Matz" Matsumoto
This reverts commit fd10c7231906ca48cb35892d2a86460004b62249. I thought it was OK to restrict index value within 1 byte, but in some cases index value could be 16 bits (2 bytes). I had several ideas to address the issue, but reverting `fd10c72` is the easiest way. The biggest reason is `mruby/c` still supports `OP_EXT[123]`, so that they don't need any additional work.
2021-06-22Enable markdownlint rules MD003,MD005,MD007John Bampton
Lint Markdown https://github.com/DavidAnson/markdownlint#rules--aliases
2021-06-19Enable markdownlint rule MD046 code-block-styleJohn Bampton
Fix C Markdown code block style
2021-06-17Standardize commands inside backticksJohn Bampton
Remove whitespace
2021-06-16Run pre-commit with GitHub ActionsJohn Bampton
Running pre-commit with GitHub Actions now gives us more tests and coverage Remove duplicate GitHub Actions for merge conflicts and trailing whitespace Remove duplicate checks for markdownlint and yamllint from the GitHub Super-Linter Add new custom pre-commit hook running with a shell script to sort alphabetically and uniquify codespell.txt Add new pre-commit hook to check spelling with codespell https://github.com/codespell-project/codespell Fix spelling
2021-05-11Remove the obsolete term `Fixnum`.Yukihiro "Matz" Matsumoto
Except for compatibility code.
2021-05-10doc/limitation.md: update the limitation.Yukihiro "Matz" Matsumoto
- `puts` behavior changed as CRuby - fix wrong behavior in re-raising in `rescue`
2021-05-05Extend the tab with 8 whitespacedearblue
This work was done as follows: - check: `git grep $'\011' -- :^oss-fuzz` - convert: `ruby -pi -e 'nil while $_.sub!(/^(.*?)\t/) { $1 + " " * (8 - $1.size % 8) }'` The `doc/guide/{compile,mrbgems}.md` file adds and removes whitespace to make the directory tree look the same. In `mrbgems/mruby-socket/src/socket.c`, there is a part where the indent is changed from 4 to 2 at the same time as the tab is changed.
2021-05-02Enclose the table contents of `opcode.md` as codedearblue
2021-04-28doc/opcode.md: stop reversed link syntax check from markdownlint.Yukihiro "Matz" Matsumoto
2021-04-16feat(CI): add the GitHub Super LinterJohn Bampton
The GitHub Super Linter is a more robust and better supported tool than the current GitHub Actions we are using. Running these checks: ERROR_ON_MISSING_EXEC_BIT: true VALIDATE_BASH: true VALIDATE_BASH_EXEC: true VALIDATE_EDITORCONFIG: true VALIDATE_MARKDOWN: true VALIDATE_SHELL_SHFMT: true VALIDATE_YAML: true https://github.com/marketplace/actions/super-linter https://github.com/github/super-linter Added the GitHub Super Linter badge to the README. Also updated the pre-commit framework and added more documentation on pre-commit. Added one more pre-commit check: check-executables-have-shebangs Added one extra check for merge conflicts to our GitHub Actions. EditorConfig and Markdown linting. Minor grammar and spelling fixes. Update linter.yml
2021-04-06doc/link.md: update `mruby-config` description.Yukihiro "Matz" Matsumoto
2021-04-06Merge pull request #5405 from shuujii/fix-heading-level-in-doc-guides-link.mdYukihiro "Matz" Matsumoto
Fix heading level in `doc/guides/link.md` [ci skip]
2021-04-06Fix heading level in `doc/guides/link.md` [ci skip]KOBAYASHI Shuji
2021-04-06Fix typo in `doc/guides/link.md` [ci skip]KOBAYASHI Shuji
2021-04-05link.md: add new document for linking `libmruby`; ref #5393Yukihiro "Matz" Matsumoto
2021-03-09chore: fix grammarJohn Bampton
2021-03-05Merge pull request #5373 from mruby/stableYukihiro "Matz" Matsumoto
Merge mruby 3.0.0
2021-03-05Update version and release date. (mruby 3.0.0 (2021-03-05))3.0.0mimaki
2021-03-04Update minimal build configuration [ci skip]KOBAYASHI Shuji
2021-02-21Updated `doc/opcode.md` to match `include/mruby/ops.h` [ci skip]dearblue
2021-02-13chore: fix spellingJohn Bampton
Normally a single spell checker can't find all the mistakes or check all types of code. These mistakes were found by another spell checker inside my editor with a more manual sift / find.
2021-02-13Update compile prerequisites in `doc/guides/compile.md` [ci skip]KOBAYASHI Shuji
Bison and gperf are optional.
2021-02-12doc/mruby3.md: use relative path.Yukihiro "Matz" Matsumoto
2021-02-12Update `docs/guides/mrbgems.md`; ref #5210Yukihiro "Matz" Matsumoto
Binary gems description added, along with a few cosmetic changes.
2021-02-12Update `docs/guides/compile.md`.Yukihiro "Matz" Matsumoto
Especially description regarding the build process and `build` directory structures, along with some typo fixes and cosmetic changes.
2021-02-09Upgrade supported Ruby version to 2.5.Yukihiro "Matz" Matsumoto
Ruby 2.5 is the oldest maintained version.
2021-01-28Update `limitation.md` for integer division change in 3.0.Yukihiro "Matz" Matsumoto
2021-01-28Stop mentioning `MRB_NO_PRESYM` in the doc.Yukihiro "Matz" Matsumoto
It's for internal use. Please use `conf.disable_presym`.
2021-01-28Describe disabling preallocated symbols in the doc.Yukihiro "Matz" Matsumoto
2021-01-26Adjust spaces after list markers.Yukihiro "Matz" Matsumoto
2021-01-26Update `doc/mruby3.md`.Yukihiro "Matz" Matsumoto
2021-01-26Add `doc/symbols.md`. [ci skip]Yukihiro "Matz" Matsumoto
To describe how to use symbols, especially preallocated symbols from C.
2021-01-25Add description for `mruby-config` in `compile.md`. [ci skip]Yukihiro "Matz" Matsumoto
For easier compiling and linking of the application embedding `mruby`
2021-01-23Fixed typo; ref #5296Yukihiro "Matz" Matsumoto
2021-01-23Fix typoYevhen Viktorov
2020-12-19refactor: fix case of GitHub and fix missing HTTPS on linkJohn Bampton
- changed `github` to `GitHub`
2020-12-19refactor: remove trailing whitespaceJohn Bampton
2020-12-19feat(CI): add a GitHub Action to lint the MarkdownJohn Bampton
Run on pull request only Using https://www.npmjs.com/package/markdownlint-cli Lint Markdown for rules: - MD009/no-trailing-spaces - MD012/no-multiple-blanks - MD022/blanks-around-headings - MD031/blanks-around-fences - MD032/blanks-around-lists
2020-12-19🔒 Fix missing HTTPS on linksJohn Bampton
2020-12-19🔒 Fix missing HTTPS on linksJohn Bampton
2020-12-13Fix spellingJohn Bampton
2020-12-05Update "Configuration Options Changed" in `doc/mruby3.md` [ci skip]KOBAYASHI Shuji
2020-11-26Create presym files for each build targetKOBAYASHI Shuji
Previously, presym files were always created in `build/{presym,presym.inc}`. However, this constraint is inconvenient because it is common to use multiple build configurations and build targets in a single mruby tree. Therefore, change to create presym file for each build target.
2020-11-26Make `OP_JMP*` operand address to be relative.Yukihiro "Matz" Matsumoto
Jump target address is `operand (16bit)` + `address of next instruction`. In addition, `ilen` was made `uint32_t` so that `iseq` length limitation of 65536 is removed. Only jump target address should be within signed 16bit (-32768 .. 32767).
2020-11-25Fix C source compilation with `MRB_USE_ALL_SYMBOLS`; ref #5187KOBAYASHI Shuji
However, compiling by `mrbc` fails with another issue (#5116).
2020-11-25Remove no longer used `MRB_IV_SEGMENT_SIZE; close #5188 [ci skip]Yukihiro "Matz" Matsumoto