summaryrefslogtreecommitdiff
path: root/doc/extension.rdoc
AgeCommit message (Collapse)Author
2023-11-30Add `RUBY_REFERENCES`Nobuyoshi Nakada
Instead of `RUBY_REFERENCES_START` and `RUBY_REFERENCES_END`, so that auto-indent works well.
2023-11-30Prefix `REF_EDGE` and `REFS_LIST_PTR` with `RUBY_`Nobuyoshi Nakada
Also move `struct` so that `typedef`-ed names can be used.
2023-11-26[DOC] Fix markup in declarative marking API documentNobuyoshi Nakada
- RDoc is not markdown, use `+` and `_` for code and variables respectively, instead of backquotes. - Remove useless backslashes.
2023-03-17* remove trailing spaces. [ci skip]git
2023-03-17Document the declarative marking apiMatt Valentine-House
Notes: Merged: https://github.com/ruby/ruby/pull/7153
2022-12-26[DOC] Un-capitalize headingsNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/7027
2022-12-26[DOC] Update extension.rdocNobuyoshi Nakada
Refine the uses of word "Data", which were often ambiguous. Also, that word now refers the new class unrelated to `T_DATA`. Notes: Merged: https://github.com/ruby/ruby/pull/7027
2022-05-04[DOC] mention macros for public headersNobuyoshi Nakada
2022-04-03[DOC] Describe append_{c,cpp,ld}flagsv3_2_0_preview1Nobuyoshi Nakada
2022-01-10Make the Ractor-safe section more fluentBenoit Daloze
2022-01-10Clarify ractor documentation meaning and formatting.Trey Evans
Notes: Merged: https://github.com/ruby/ruby/pull/5421
2022-01-09Revert "[DOC] Mention RBOOL in extension.rdoc [Feature #13125]"Nobuyoshi Nakada
This reverts commit 9ad34da47ff7d71446e667897559047ed5635b60, as `RBOOL` is not defined publicly yet.
2021-12-16Add description of ruby header files to extension.rdocLars Kanis
Notes: Merged: https://github.com/ruby/ruby/pull/4882
2021-12-13[DOC] Mention RBOOL in extension.rdoc [Feature #13125]Nobuyoshi Nakada
2021-12-09[DOC] Stop recommending Qfalse==0 assumption to C extensionsJemma Issroff
Encourage use of RTEST(), direct Qfalse comparison, and remove references to Qfalse == 0 in extension documentation. See [Bug #18397] for detail. [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/5230 Merged-By: XrXr
2021-11-24Fix typofurunkel
Notes: Merged: https://github.com/ruby/ruby/pull/5107
2021-08-21[DOC] prefer RUBY_DEFAULT_FREE to a magic number [ci skip]Nobuyoshi Nakada
2021-08-21[DOC] mention rb_define_alloc_func [ci skip]Nobuyoshi Nakada
2021-04-26Fix some typos by spell checkerRyuta Kamizono
Notes: Merged: https://github.com/ruby/ruby/pull/4414
2021-03-27[Doc] Update regex engine to Onigumo in doc/extension.* [ci skip]Kenichi Kamiya
regex.c has been removed in 8e65234086a15f90585bc09cce82dbad2aa647d7 Notes: Merged: https://github.com/ruby/ruby/pull/4306 Merged-By: nobu <[email protected]>
2021-02-23[DOC] Fix copy+paste mistake [ci skip]Lars Kanis
It was introduced in commit 089b7a84606925e885fe91050483a352735aa91e . Notes: Merged: https://github.com/ruby/ruby/pull/4211
2021-02-22Improve extension docs, remove deprecated rb_cData [ci skip]Lars Kanis
rb_cData is deprecated and the characteristic alloc_func was already removed in ruby-3.0. So this updates the recommendation accordingly. It also adds fdbm_alloc() in order to show the allocation process and to gives TypedData_Make_Struct() more context. Moreover it describes fdbm_aref(), so that the relation to rb_define_method() is shown. And fdbm_aref() makes use of GetDBM() now, to show how this macro might be used. Notes: Merged: https://github.com/ruby/ruby/pull/4208 Merged-By: nobu <[email protected]>
2021-01-05[DOC] Fix grammar: "is same as" -> "is the same as"Marcus Stollsteimer
2020-12-24add about Ractor into extension.rdoc [ci skip]Koichi Sasada
2020-08-25Add documentation to "dcompact" callback and "parent" memberLars Kanis
Notes: Merged: https://github.com/ruby/ruby/pull/3396
2020-06-01Update extension.rdoc for Ruby 3 keyword argument separation [ci skip]Jeremy Evans
This removes the discussion of behavior removed in Ruby 3.
2020-02-11Add backwards compatibility example macro for rb_eval_cmd_kwd [ci skip]Jeremy Evans
2019-12-31Redmine /projects/ruby-trunk is now redirectedTakashi Kokubun
to /projects/ruby-master
2019-12-20Fixed misspellingsNobuyoshi Nakada
Fixed misspellings reported at [Bug #16437], only in ruby and rubyspec.
2019-11-18Remove mention of $SAFE and taint from doc [ci skip]Jeremy Evans
Notes: Merged: https://github.com/ruby/ruby/pull/2476
2019-10-07Add section to extension.rdoc for backwards compatibility macros [ci skip]Jeremy Evans
These macros should make it easier to C extensions to switch to the Ruby 2.7 C-API *_kw functions, but still have the code work correctly on older Ruby versions.
2019-10-07Note RB_PASS_EMPTY_KEYWORDS and RB_SCAN_ARGS_EMPTY_KEYWORDS will be removedJeremy Evans
There is no need for these in Ruby 3.0, and the plan is to remove them.
2019-10-03Document *_kw functions added to include/ruby/ruby.h [ci skip]Jeremy Evans
Also documents the non-*_kw functions if they were not already documented.
2019-01-18[DOC] mention rb_str_modifynobu
[ruby-core:91134] [Bug #15543] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66861 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2018-12-25Mention rb_gc_register_mark_object [ci skip]nobu
[Feature #9894] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66534 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2018-06-10doc/extension.rdoc: Fix small copy+paste mistakenobu
[Fix GH-1884] From: Lars Kanis <[email protected]> git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@63622 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-09-26Show rb_data_type_t definition [ci skip]nobu
[Fix GH-1707] Author: hkdnet <[email protected]> git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60037 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-08-10Fix types of function argumentyui-knk
* doc/extension.ja.rdoc: Fix types of rb_ary_aref argument * doc/extension.rdoc: ditto git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59571 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-07-18doc/extension.rdoc: start documenting threading and IO APIsnormal
This will hopefully be useful for folks writing C extensions. * doc/extension.rdoc: start documenting threading and IO APIs [ruby-core:82016] [Feature #13740] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59353 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-07-12doc/extension.rdoc: update wikipedia link to HTTPSnormal
Avoid the latency for HTTP -> HTTPS redirect * doc/extension.rdoc: update wikipedia link to HTTPS git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59319 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-04-10doc/extension.rdoc: rb_str_append grammar fixstomar
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58307 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-04-10extension.rdoc: rb_str_append [ci skip]nobu
* doc/extension.rdoc: add rb_str_append and fix equivalent for rb_str_catf and rb_str_vcatf from rb_str_cat2. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58306 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-04-10extension.rdoc: fix rb_enc_str_new_literalnobu
* doc/extension.rdoc: Add missing enc arg to rb_enc_str_new_literal. [ci skip] [Fix GH-1577] Author: Dylan Thacker-Smith <[email protected]> git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58303 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-02-20extension.rdoc: add document titlekazu
* doc/extension.rdoc, doc/extension.ja.rdoc: [DOC] add title and adapt subheading levels. * doc/extension.rdoc: [DOC] fix subheading level of section about "Ruby Constants That Can Be Accessed From C". * doc/extension.ja.rdoc: [DOC] add missing subheading. [ruby-core:79590] [Bug #13229] Author: Marcus Stollsteimer <[email protected]> git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57665 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-01-26Fix function name for DBM on extension document.hsbt
Patch by Yuji Yaginuma, @y-yagi <[email protected]> [ci skip][fix GH-1519] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57423 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-01-15s/SaveStringValue/SafeStringValue/a_matsuda
Fix a typo in extension.rdoc. Signed-off-by: Akira Matsuda <[email protected]> closes #1512 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57335 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-12-08extension.rdoc: add ANYARGS to method definitionskazu
* doc/extension.rdoc (rb_define_method, rb_define_singleton_method, rb_define_private_method, rb_define_protected_method, rb_define_module_function, rb_define_global_function): set ANYARGS as arguments to their underlying functions. [ci skip] Patch by: Dmitry Gritsay <[email protected]> [Fix GH-1473] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57028 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-12-06untabify [ci skip]kazu
based on the patch by W <[email protected]> [Fix GH-1497] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57006 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-12-04extension.rdoc: fix rb_get_kwargs [ci skip]nobu
* doc/extension.rdoc: [DOC] optional keyword arguments are defaulted to Qundef. ignored keys are kept in the hash but a new Hash is not created. [ruby-dev:49893] [Bug #13004] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56980 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-11-02extension.rdoc: update rb_ensure descriptionnobu
* doc/extension.rdoc: set ANYARGS as arguments for func1 and func2. [ci skip] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56545 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
generated by cgit v1.2.3 (git 2.25.1) at 2025-05-12 01:02:43 +0000