summaryrefslogtreecommitdiffhomepage
path: root/doc/guides
AgeCommit message (Collapse)Author
2021-10-14Fix grammar in doc/guides/mrbgems.mdJohn Bampton
2021-09-09doc/guides/mrbconf.rb: add `RO_DATA` configuration description; #5547Yukihiro "Matz" Matsumoto
2021-08-26value.h: reconstruct `mrb_ro_data_p()`.Yukihiro "Matz" Matsumoto
* use predefined `mrb_ro_data_p()` for user-mode Linux and macOS * define `MRB_LINK_TIME_RO_DATA_P` if predefined one is used * configure macro `MRB_USE_LINK_TIME_RO_DATA_P` is no longer used * contributions for new platforms are welcome
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-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-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-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-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-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-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-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-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
2020-11-22Remove `mrb_str_buf_new()` and `MRB_STR_BUF_MIN_SIZE`; close #5171Yukihiro "Matz" Matsumoto
2020-11-21Rename `MRB_{ENABLE,DISABLE}_` to `MRB_{USE,NO}_`; close #5163KOBAYASHI Shuji
| Previous Name | New Name | |------------------------------|-------------------------| | MRB_ENABLE_ALL_SYMBOLS | MRB_USE_ALL_SYMBOLS | | MRB_ENABLE_SYMBOLL_ALL | MRB_USE_ALL_SYMBOLS | | MRB_ENABLE_CXX_ABI | MRB_USE_CXX_ABI | | MRB_ENABLE_CXX_EXCEPTION | MRB_USE_CXX_EXCEPTION | | MRB_ENABLE_DEBUG_HOOK | MRB_USE_DEBUG_HOOK | | MRB_DISABLE_DIRECT_THREADING | MRB_NO_DIRECT_THREADING | | MRB_DISABLE_STDIO | MRB_NO_STDIO | | ENABLE_LINENOISE | MRB_USE_LINENOISE | | ENABLE_READLINE | MRB_USE_READLINE | | DISABLE_MIRB_UNDERSCORE | MRB_NO_MIRB_UNDERSCORE | | DISABLE_GEMS | MRB_NO_GEMS | * `MRB_ENABLE_SYMBOLL_ALL` seems to be a typo, so it is fixed. * `MRB_` prefix is added to those without. * The previous names can also be used for compatibility.
2020-11-02Search gem from `MRUBY_ROOT` if build config is in `build_config`.Yukihiro "Matz" Matsumoto
2020-10-29Fix typo in `doc/guides/compile.md` [ci skip]KOBAYASHI Shuji
2020-10-29Move `build_config.rb` -> `build_config/default.rb`; ref #5098Yukihiro "Matz" Matsumoto
In addition, update the documents referring `build_config.rb` which is no longer used. The new `build_config.rb` describes the new configuration structure in the comment.
2020-10-19Revert `MRUBY_TARGET` mechanism; ref #5096KOBAYASHI Shuji
* In explanation of mruby, the expression `build_config.rb` is frequently used including official documents, so I think that it will not make sense if the file is no longer used. * The `MRUBY_TARGET` mechanism seems to have little improvement, so I don't think it should be changed to avoid unnecessary confusion. * `MRUBY_TARGET` and `MRuby.targets` represent somewhat different things, so using the same term "target" is a bit confusing. The mechanism that can be written short when using a file under `build_config` (renamed from `target`) directory remains (`build_config/${MRUBY_CONFIG}.rb` is used if the path specified in `MRUBY_CONFIG` doesn't exist).
2020-10-12Rename float configuration option names.Yukihiro "Matz" Matsumoto
- `MRB_WITHOUT_FLOAT` => `MRB_NO_FLOAT` - `MRB_USE_FLOAT` => `MRB_USE_FLOAT32` The former is to use `USE_XXX` naming convention. The latter is to make sure `float` is 32bit float and not floating point number in general.
2020-10-12Rename `MRB_METHOD_T_STRUCT` to `MRB_USE_METHOD_T_STRUCT`.Yukihiro "Matz" Matsumoto
It's the first change of renaming configuration options to `MRB_XXX` to `MRB_USE_XXX` or `MRB_NO_XXX`.
2020-10-12Enable method cache by default.Yukihiro "Matz" Matsumoto
Introduced `MRB_NO_METHOD_CACHE` which is inverse of `MRB_METHOD_CACHE` that should be enabled intestinally. In addition, the default cache is made bigger (128 -> 256).
2020-10-12Update the build instruction.Yukihiro "Matz" Matsumoto
2020-08-06Update release date.2.1.2Hiroshi Mimaki
2020-07-01Update version to `2.1.2`. (mruby 2.1.2 RC)2.1.2-rcHiroshi Mimaki
generated by cgit v1.2.3 (git 2.39.1) at 2026-04-15 04:42:12 +0000