68 Commits

Author SHA1 Message Date
git
cc68d692f8 * remove trailing spaces. [ci skip] 2023-03-17 19:20:53 +00:00
Matt Valentine-House
4f5e29f930 Document the declarative marking api 2023-03-17 19:20:40 +00:00
Nobuyoshi Nakada
bb60e4615f [DOC] Un-capitalize headings 2022-12-26 20:29:56 +09:00
Nobuyoshi Nakada
cb820bff33 [DOC] Update extension.rdoc
Refine the uses of word "Data", which were often ambiguous.  Also,
that word now refers the new class unrelated to `T_DATA`.
2022-12-26 20:29:56 +09:00
Nobuyoshi Nakada
529c98ab90
[DOC] mention macros for public headers 2022-05-04 01:23:26 +09:00
Nobuyoshi Nakada
f801386f0c
[DOC] Describe append_{c,cpp,ld}flags 2022-04-03 13:38:31 +09:00
Benoit Daloze
ca97001a94 Make the Ractor-safe section more fluent 2022-01-10 13:08:59 +01:00
Trey Evans
b4d0d07e2c Clarify ractor documentation meaning and formatting. 2022-01-10 13:04:31 +01:00
Nobuyoshi Nakada
65a8d52212
Revert "[DOC] Mention RBOOL in extension.rdoc [Feature #13125]"
This reverts commit 9ad34da47ff7d71446e667897559047ed5635b60, as
`RBOOL` is not defined publicly yet.
2022-01-09 19:17:48 +09:00
Lars Kanis
fff058a8d6 Add description of ruby header files to extension.rdoc 2021-12-16 20:10:55 +09:00
Nobuyoshi Nakada
9ad34da47f
[DOC] Mention RBOOL in extension.rdoc [Feature #13125] 2021-12-13 13:21:53 +09:00
Jemma Issroff
b859397e1b
[DOC] Stop recommending Qfalse==0 assumption to C extensions
Encourage use of RTEST(), direct Qfalse comparison, and remove references to
Qfalse == 0 in extension documentation.

See [Bug #18397] for detail.
[ci skip]
2021-12-09 11:23:51 -05:00
furunkel
1dcfcb6bc5 Fix typo 2021-11-24 23:06:28 +09:00
Nobuyoshi Nakada
f51a6ace06
[DOC] prefer RUBY_DEFAULT_FREE to a magic number [ci skip] 2021-08-21 16:50:51 +09:00
Nobuyoshi Nakada
8f755ad6c8
[DOC] mention rb_define_alloc_func [ci skip] 2021-08-21 16:48:13 +09:00
Ryuta Kamizono
33f2ff3bab Fix some typos by spell checker 2021-04-26 10:07:41 +09:00
Kenichi Kamiya
31ae931e16
[Doc] Update regex engine to Onigumo in doc/extension.* [ci skip]
regex.c has been removed in 8e65234086a15f90585bc09cce82dbad2aa647d7
2021-03-27 17:22:57 +09:00
Lars Kanis
09c74a1702 [DOC] Fix copy+paste mistake [ci skip]
It was introduced in commit 089b7a84606925e885fe91050483a352735aa91e .
2021-02-23 10:48:31 +09:00
Lars Kanis
089b7a8460
Improve extension docs, remove deprecated rb_cData [ci skip]
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.
2021-02-22 12:18:16 +09:00
Marcus Stollsteimer
3108ad7bf3 [DOC] Fix grammar: "is same as" -> "is the same as" 2021-01-05 15:13:53 +01:00
Koichi Sasada
9aca51e8a5 add about Ractor into extension.rdoc [ci skip] 2020-12-24 12:10:17 +09:00
Lars Kanis
92b2d5816a Add documentation to "dcompact" callback and "parent" member 2020-08-25 10:50:51 -07:00
Jeremy Evans
d2c48705ae Update extension.rdoc for Ruby 3 keyword argument separation [ci skip]
This removes the discussion of behavior removed in Ruby 3.
2020-06-01 15:18:50 -07:00
Jeremy Evans
ea32715e00 Add backwards compatibility example macro for rb_eval_cmd_kwd [ci skip] 2020-02-11 08:52:14 -08:00
Takashi Kokubun
afd3f64f8c
Redmine /projects/ruby-trunk is now redirected
to /projects/ruby-master
2019-12-31 22:06:19 -08:00
Nobuyoshi Nakada
db16629008
Fixed misspellings
Fixed misspellings reported at [Bug #16437], only in ruby and rubyspec.
2019-12-20 09:32:42 +09:00
Jeremy Evans
3a0de05bee Remove mention of $SAFE and taint from doc [ci skip] 2019-11-18 01:00:25 +02:00
Jeremy Evans
59c3b1c9c8 Add section to extension.rdoc for backwards compatibility macros [ci skip]
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-07 13:51:28 -07:00
Jeremy Evans
c0eae130b1 Note RB_PASS_EMPTY_KEYWORDS and RB_SCAN_ARGS_EMPTY_KEYWORDS will be removed
There is no need for these in Ruby 3.0, and the plan is to
remove them.
2019-10-07 13:51:21 -07:00
Jeremy Evans
9f24e8fdbb Document *_kw functions added to include/ruby/ruby.h [ci skip]
Also documents the non-*_kw functions if they were not already
documented.
2019-10-03 14:13:27 -07:00
nobu
7a86165d43 [DOC] mention rb_str_modify
[ruby-core:91134] [Bug #15543]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66861 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2019-01-18 02:36:14 +00:00
nobu
576aaec6f9 Mention rb_gc_register_mark_object [ci skip]
[Feature #9894]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66534 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2018-12-25 01:17:37 +00:00
nobu
5e9ea3c75f doc/extension.rdoc: Fix small copy+paste mistake
[Fix GH-1884]

From: Lars Kanis <lars@greiz-reinsdorf.de>

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@63622 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2018-06-10 06:00:45 +00:00
nobu
b9031d7088 Show rb_data_type_t definition [ci skip]
[Fix GH-1707]
Author:    hkdnet <hkdnet@users.noreply.github.com>

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60037 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-09-26 23:28:07 +00:00
yui-knk
28c02b9e08 Fix types of function argument
* 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-08-10 14:46:51 +00:00
normal
ed831a6c5b doc/extension.rdoc: start documenting threading and IO APIs
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-18 02:10:50 +00:00
normal
d15cc7a6a3 doc/extension.rdoc: update wikipedia link to HTTPS
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-07-12 18:31:07 +00:00
stomar
2c6cbcde84 doc/extension.rdoc: rb_str_append grammar fix
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58307 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-04-10 17:28:18 +00:00
nobu
9adc876393 extension.rdoc: rb_str_append [ci skip]
* 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-10 15:34:37 +00:00
nobu
85f62055c4 extension.rdoc: fix rb_enc_str_new_literal
* doc/extension.rdoc: Add missing enc arg to rb_enc_str_new_literal.

[ci skip]
[Fix GH-1577]
Author:    Dylan Thacker-Smith <Dylan.Smith@shopify.com>

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58303 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-04-10 15:26:48 +00:00
kazu
7010dc6f68 extension.rdoc: add document title
* 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 <sto.mar@web.de>

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57665 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-02-20 12:20:22 +00:00
hsbt
17ee91960f Fix function name for DBM on extension document.
Patch by Yuji Yaginuma, @y-yagi <yuuji.yaginuma@gmail.com>
  [ci skip][fix GH-1519]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57423 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-01-26 07:09:58 +00:00
a_matsuda
992b0148ca s/SaveStringValue/SafeStringValue/
Fix a typo in extension.rdoc.

Signed-off-by: Akira Matsuda <ronnie@dio.jp>

closes #1512

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57335 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-01-15 13:45:12 +00:00
kazu
f573eee225 extension.rdoc: add ANYARGS to method definitions
* 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 <unseductable@gmail.com>
[Fix GH-1473]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57028 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-12-08 12:58:26 +00:00
kazu
adef6efcde untabify [ci skip]
based on the patch by W <wolf@wolfsden.cz>
[Fix GH-1497]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57006 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-12-06 15:33:49 +00:00
nobu
b62e322017 extension.rdoc: fix rb_get_kwargs [ci skip]
* 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-12-04 08:50:28 +00:00
nobu
d97b8d0d6c extension.rdoc: update rb_ensure description
* 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
2016-11-02 00:50:05 +00:00
nobu
564cb1a0a8 extension.rdoc: update rb_rescue description
* doc/extension.rdoc: set ANYARGS as arguments for func1 and func2.

* doc/extension.rdoc: mention the exception object which is passed
  to func2 as the second argument.  [Fix GH-1471]

[ci skip]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56544 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-11-01 23:45:50 +00:00
normal
43112104df doc/extension.rdoc: wording fix w.r.t. volatile vs RB_GC_GUARD
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56411 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-10-13 01:40:21 +00:00
kazu
caa9083451 Fix typo [ci skip]
Replace "You can defined hooked variables" with "You can define hooked variables"

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56407 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-10-12 15:28:06 +00:00