Repository navigation
Conversation
ruby/ruby's ext/.document lists every openssl/ossl_*.c file one by one. That list is not part of this repository, so new source files are silently left out of Ruby's documentation. ossl_provider.c (added in 2023) and ossl_hpke.c are missing, and as a result OpenSSL::Provider has no entry in Ruby's ri/HTML docs. Ship a .document in ext/openssl so the file list travels with the sync, as ruby/io-console does in ext/io/console/.document. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
|
Thanks for the catch! I hadn't realized However, I feel this would be better fixed in ruby/ruby, since the file is not used in this repository. (Could ruby/ruby's |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ruby's documentation is built from ruby/ruby's
ext/.document, which currently lists eachopenssl/ossl_*.cfile explicitly. That file lives only in ruby/ruby, so source files added here are not picked up unless someone also updates ruby/ruby by hand.This has already happened twice:
ossl_provider.cis missing fromext/.documenton bothruby_4_0andmaster, soOpenSSL::ProviderandOpenSSL::Provider::ProviderErrorhave no documentation in Ruby 4.0 (ri OpenSSL::Provider→ "Nothing known about OpenSSL::Provider"), even though the C source has doc comments.ossl_hpke.cis missing onmasteras well.This PR adds
ext/openssl/.documentwith:It is synced to ruby/ruby along with the rest of
ext/openssl. After that, theopenssl/...entries in ruby/ruby'sext/.documentcan be replaced with a singleopenssl/line, and RDoc will follow this file. ruby/io-console uses the same layout (ext/io/console/.document, ruby/ruby@c7731b35eb).Notes:
librefers toext/openssl/libin the ruby/ruby tree. It does not exist in this repository, and RDoc ignores it here. io-console's.documentalso listslib/size.rb, which only exists in the ruby/ruby tree.*.cmatches the current explicit list exactly (.h,extconf.rbanddependstay excluded), and covers future files automatically.rake rdocpasses file globs directly (ext/**/*.c), so it is not affected.I checked this on a
ruby_4_0tree with RDoc 8.1.0. With this file in place andext/.documentchanged toopenssl/, the generated ri data is identical to addingopenssl/ossl_provider.cto the current list, and includesOpenSSL::Provider.Follow-up in ruby/ruby (after sync)
🤖 Generated with Claude Code