Merge pull request #971 from rhenium/ky/rdoc-remove-dummy-decl

rhenium · web-flow · commit deb87bf33c41 · 2025-11-29T09:04:50.000-08:00
Remove dummy declarations for mOSSL and eOSSLError
diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml
@@ -15,7 +15,7 @@ jobs:
         with:
           ruby-version: ruby
           bundler-cache: true # 'bundle install' and cache gems
-      - run: rake rdoc
+      - run: bundle exec rake rdoc
       - name: Upload GitHub Pages artifact
         uses: actions/upload-pages-artifact@v4
         with:
diff --git a/ext/openssl/ossl_asn1.c b/ext/openssl/ossl_asn1.c
@@ -1288,11 +1288,6 @@ Init_ossl_asn1(void)
     VALUE ary;
     int i;
 
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     sym_UNIVERSAL = ID2SYM(rb_intern_const("UNIVERSAL"));
     sym_CONTEXT_SPECIFIC = ID2SYM(rb_intern_const("CONTEXT_SPECIFIC"));
     sym_APPLICATION = ID2SYM(rb_intern_const("APPLICATION"));
diff --git a/ext/openssl/ossl_bn.c b/ext/openssl/ossl_bn.c
@@ -1202,11 +1202,6 @@ ossl_bn_set_flags(VALUE self, VALUE arg)
 void
 Init_ossl_bn(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
 #ifdef HAVE_RB_EXT_RACTOR_SAFE
     ossl_bn_ctx_key = rb_ractor_local_storage_ptr_newkey(&ossl_bn_ctx_key_type);
 #else
diff --git a/ext/openssl/ossl_cipher.c b/ext/openssl/ossl_cipher.c
@@ -901,11 +901,6 @@ ossl_cipher_set_ccm_data_len(VALUE self, VALUE data_len)
 void
 Init_ossl_cipher(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     /* Document-class: OpenSSL::Cipher
      *
      * Provides symmetric algorithms for encryption and decryption. The
diff --git a/ext/openssl/ossl_config.c b/ext/openssl/ossl_config.c
@@ -413,11 +413,6 @@ Init_ossl_config(void)
     char *path;
     VALUE path_str;
 
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     /* Document-class: OpenSSL::Config
      *
      * Configuration for the openssl library.
diff --git a/ext/openssl/ossl_digest.c b/ext/openssl/ossl_digest.c
@@ -365,11 +365,6 @@ ossl_digest_block_length(VALUE self)
 void
 Init_ossl_digest(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     /* Document-class: OpenSSL::Digest
      *
      * OpenSSL::Digest allows you to compute message digests (sometimes
diff --git a/ext/openssl/ossl_engine.c b/ext/openssl/ossl_engine.c
@@ -466,11 +466,6 @@ ossl_engine_inspect(VALUE self)
 void
 Init_ossl_engine(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     cEngine = rb_define_class_under(mOSSL, "Engine", rb_cObject);
     eEngineError = rb_define_class_under(cEngine, "EngineError", eOSSLError);
 
diff --git a/ext/openssl/ossl_hmac.c b/ext/openssl/ossl_hmac.c
@@ -256,11 +256,6 @@ ossl_hmac_reset(VALUE self)
 void
 Init_ossl_hmac(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     /*
      * Document-class: OpenSSL::HMAC
      *
diff --git a/ext/openssl/ossl_kdf.c b/ext/openssl/ossl_kdf.c
@@ -239,11 +239,6 @@ kdf_hkdf(int argc, VALUE *argv, VALUE self)
 void
 Init_ossl_kdf(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     /*
      * Document-module: OpenSSL::KDF
      *
diff --git a/ext/openssl/ossl_ns_spki.c b/ext/openssl/ossl_ns_spki.c
@@ -378,11 +378,6 @@ ossl_spki_verify(VALUE self, VALUE key)
 void
 Init_ossl_ns_spki(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     mNetscape = rb_define_module_under(mOSSL, "Netscape");
 
     eSPKIError = rb_define_class_under(mNetscape, "SPKIError", eOSSLError);
diff --git a/ext/openssl/ossl_ocsp.c b/ext/openssl/ossl_ocsp.c
@@ -1626,11 +1626,6 @@ ossl_ocspcid_to_der(VALUE self)
 void
 Init_ossl_ocsp(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     /*
      * OpenSSL::OCSP implements Online Certificate Status Protocol requests
      * and responses.
diff --git a/ext/openssl/ossl_pkcs12.c b/ext/openssl/ossl_pkcs12.c
@@ -300,11 +300,6 @@ void
 Init_ossl_pkcs12(void)
 {
 #undef rb_intern
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     /*
      * Defines a file format commonly used to store private keys with
      * accompanying public key certificates, protected with a password-based
diff --git a/ext/openssl/ossl_pkcs7.c b/ext/openssl/ossl_pkcs7.c
@@ -1099,11 +1099,6 @@ void
 Init_ossl_pkcs7(void)
 {
 #undef rb_intern
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     cPKCS7 = rb_define_class_under(mOSSL, "PKCS7", rb_cObject);
     ePKCS7Error = rb_define_class_under(cPKCS7, "PKCS7Error", eOSSLError);
     rb_define_singleton_method(cPKCS7, "read_smime", ossl_pkcs7_s_read_smime, 1);
diff --git a/ext/openssl/ossl_pkey.c b/ext/openssl/ossl_pkey.c
@@ -1658,11 +1658,6 @@ void
 Init_ossl_pkey(void)
 {
 #undef rb_intern
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     /* Document-module: OpenSSL::PKey
      *
      * == Asymmetric Public Key Algorithms
diff --git a/ext/openssl/ossl_pkey_dh.c b/ext/openssl/ossl_pkey_dh.c
@@ -357,12 +357,6 @@ OSSL_PKEY_BN_DEF2(dh, DH, key, pub_key, priv_key)
 void
 Init_ossl_dh(void)
 {
-#if 0
-    mPKey = rb_define_module_under(mOSSL, "PKey");
-    cPKey = rb_define_class_under(mPKey, "PKey", rb_cObject);
-    ePKeyError = rb_define_class_under(mPKey, "PKeyError", eOSSLError);
-#endif
-
     /* Document-class: OpenSSL::PKey::DH
      *
      * An implementation of the Diffie-Hellman key exchange protocol based on
diff --git a/ext/openssl/ossl_pkey_dsa.c b/ext/openssl/ossl_pkey_dsa.c
@@ -334,12 +334,6 @@ OSSL_PKEY_BN_DEF2(dsa, DSA, key, pub_key, priv_key)
 void
 Init_ossl_dsa(void)
 {
-#if 0
-    mPKey = rb_define_module_under(mOSSL, "PKey");
-    cPKey = rb_define_class_under(mPKey, "PKey", rb_cObject);
-    ePKeyError = rb_define_class_under(mPKey, "PKeyError", eOSSLError);
-#endif
-
     /* Document-class: OpenSSL::PKey::DSA
      *
      * DSA, the Digital Signature Algorithm, is specified in NIST's
diff --git a/ext/openssl/ossl_pkey_ec.c b/ext/openssl/ossl_pkey_ec.c
@@ -1526,13 +1526,6 @@ static VALUE ossl_ec_point_mul(int argc, VALUE *argv, VALUE self)
 void Init_ossl_ec(void)
 {
 #undef rb_intern
-#if 0
-    mPKey = rb_define_module_under(mOSSL, "PKey");
-    cPKey = rb_define_class_under(mPKey, "PKey", rb_cObject);
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-    ePKeyError = rb_define_class_under(mPKey, "PKeyError", eOSSLError);
-#endif
-
     /*
      * Document-class: OpenSSL::PKey::EC
      *
diff --git a/ext/openssl/ossl_pkey_rsa.c b/ext/openssl/ossl_pkey_rsa.c
@@ -536,12 +536,6 @@ OSSL_PKEY_BN_DEF3(rsa, RSA, crt_params, dmp1, dmq1, iqmp)
 void
 Init_ossl_rsa(void)
 {
-#if 0
-    mPKey = rb_define_module_under(mOSSL, "PKey");
-    cPKey = rb_define_class_under(mPKey, "PKey", rb_cObject);
-    ePKeyError = rb_define_class_under(mPKey, "PKeyError", eOSSLError);
-#endif
-
     /* Document-class: OpenSSL::PKey::RSA
      *
      * RSA is an asymmetric public key algorithm that has been formalized in
diff --git a/ext/openssl/ossl_provider.c b/ext/openssl/ossl_provider.c
@@ -185,11 +185,6 @@ ossl_provider_inspect(VALUE self)
 void
 Init_ossl_provider(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     cProvider = rb_define_class_under(mOSSL, "Provider", rb_cObject);
     eProviderError = rb_define_class_under(cProvider, "ProviderError", eOSSLError);
 
diff --git a/ext/openssl/ossl_rand.c b/ext/openssl/ossl_rand.c
@@ -175,11 +175,6 @@ ossl_rand_status(VALUE self)
 void
 Init_ossl_rand(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
-
     mRandom = rb_define_module_under(mOSSL, "Random");
 
     eRandomError = rb_define_class_under(mRandom, "RandomError", eOSSLError);
diff --git a/ext/openssl/ossl_ssl.c b/ext/openssl/ossl_ssl.c
@@ -2704,8 +2704,6 @@ void
 Init_ossl_ssl(void)
 {
 #if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
     rb_mWaitReadable = rb_define_module_under(rb_cIO, "WaitReadable");
     rb_mWaitWritable = rb_define_module_under(rb_cIO, "WaitWritable");
 #endif
diff --git a/ext/openssl/ossl_ssl_session.c b/ext/openssl/ossl_ssl_session.c
@@ -305,11 +305,6 @@ static VALUE ossl_ssl_session_to_text(VALUE self)
 
 void Init_ossl_ssl_session(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    mSSL = rb_define_module_under(mOSSL, "SSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-#endif
 #ifndef OPENSSL_NO_SOCK
 	cSSLSession = rb_define_class_under(mSSL, "Session", rb_cObject);
 	eSSLSession = rb_define_class_under(cSSLSession, "SessionError", eOSSLError);
diff --git a/ext/openssl/ossl_ts.c b/ext/openssl/ossl_ts.c
@@ -1298,10 +1298,6 @@ ossl_tsfac_create_ts(VALUE self, VALUE key, VALUE certificate, VALUE request)
 void
 Init_ossl_ts(void)
 {
-    #if 0
-    mOSSL = rb_define_module("OpenSSL"); /* let rdoc know about mOSSL */
-    #endif
-
     /*
      * Possible return value for +Response#failure_info+. Indicates that the
      * timestamp server rejects the message imprint algorithm used in the
diff --git a/ext/openssl/ossl_x509.c b/ext/openssl/ossl_x509.c
@@ -29,10 +29,6 @@ ossl_x509_time_adjust(ASN1_TIME *s, VALUE time)
 void
 Init_ossl_x509(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-#endif
-
     mX509 = rb_define_module_under(mOSSL, "X509");
 
     Init_ossl_x509attr();
diff --git a/ext/openssl/ossl_x509attr.c b/ext/openssl/ossl_x509attr.c
@@ -288,12 +288,6 @@ ossl_x509attr_to_der(VALUE self)
 void
 Init_ossl_x509attr(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-    mX509 = rb_define_module_under(mOSSL, "X509");
-#endif
-
     eX509AttrError = rb_define_class_under(mX509, "AttributeError", eOSSLError);
 
     cX509Attr = rb_define_class_under(mX509, "Attribute", rb_cObject);
diff --git a/ext/openssl/ossl_x509cert.c b/ext/openssl/ossl_x509cert.c
@@ -886,12 +886,6 @@ ossl_x509_load(VALUE klass, VALUE buffer)
 void
 Init_ossl_x509cert(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-    mX509 = rb_define_module_under(mOSSL, "X509");
-#endif
-
     eX509CertError = rb_define_class_under(mX509, "CertificateError", eOSSLError);
 
     /* Document-class: OpenSSL::X509::Certificate
diff --git a/ext/openssl/ossl_x509crl.c b/ext/openssl/ossl_x509crl.c
@@ -506,12 +506,6 @@ ossl_x509crl_add_extension(VALUE self, VALUE extension)
 void
 Init_ossl_x509crl(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-    mX509 = rb_define_module_under(mOSSL, "X509");
-#endif
-
     eX509CRLError = rb_define_class_under(mX509, "CRLError", eOSSLError);
 
     cX509CRL = rb_define_class_under(mX509, "CRL", rb_cObject);
diff --git a/ext/openssl/ossl_x509ext.c b/ext/openssl/ossl_x509ext.c
@@ -441,12 +441,6 @@ void
 Init_ossl_x509ext(void)
 {
 #undef rb_intern
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-    mX509 = rb_define_module_under(mOSSL, "X509");
-#endif
-
     eX509ExtError = rb_define_class_under(mX509, "ExtensionError", eOSSLError);
 
     cX509ExtFactory = rb_define_class_under(mX509, "ExtensionFactory", rb_cObject);
diff --git a/ext/openssl/ossl_x509name.c b/ext/openssl/ossl_x509name.c
@@ -496,12 +496,6 @@ Init_ossl_x509name(void)
 #undef rb_intern
     VALUE utf8str, ptrstr, ia5str, hash;
 
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-    mX509 = rb_define_module_under(mOSSL, "X509");
-#endif
-
     id_aref = rb_intern("[]");
     eX509NameError = rb_define_class_under(mX509, "NameError", eOSSLError);
     cX509Name = rb_define_class_under(mX509, "Name", rb_cObject);
diff --git a/ext/openssl/ossl_x509req.c b/ext/openssl/ossl_x509req.c
@@ -414,12 +414,6 @@ ossl_x509req_add_attribute(VALUE self, VALUE attr)
 void
 Init_ossl_x509req(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-    mX509 = rb_define_module_under(mOSSL, "X509");
-#endif
-
     eX509ReqError = rb_define_class_under(mX509, "RequestError", eOSSLError);
 
     cX509Req = rb_define_class_under(mX509, "Request", rb_cObject);
diff --git a/ext/openssl/ossl_x509revoked.c b/ext/openssl/ossl_x509revoked.c
@@ -267,12 +267,6 @@ ossl_x509revoked_to_der(VALUE self)
 void
 Init_ossl_x509revoked(void)
 {
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-    mX509 = rb_define_module_under(mOSSL, "X509");
-#endif
-
     eX509RevError = rb_define_class_under(mX509, "RevokedError", eOSSLError);
 
     cX509Rev = rb_define_class_under(mX509, "Revoked", rb_cObject);
diff --git a/ext/openssl/ossl_x509store.c b/ext/openssl/ossl_x509store.c
@@ -859,12 +859,6 @@ void
 Init_ossl_x509store(void)
 {
 #undef rb_intern
-#if 0
-    mOSSL = rb_define_module("OpenSSL");
-    eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
-    mX509 = rb_define_module_under(mOSSL, "X509");
-#endif
-
     /* Register ext_data slot for verify callback Proc */
     stctx_ex_verify_cb_idx = X509_STORE_CTX_get_ex_new_index(0, (void *)"stctx_ex_verify_cb_idx", 0, 0, 0);
     if (stctx_ex_verify_cb_idx < 0)

Original file line number	Diff line number	Diff line change
`@@ -901,11 +901,6 @@ ossl_cipher_set_ccm_data_len(VALUE self, VALUE data_len)`
`901`	`901`	`void`
`902`	`902`	`Init_ossl_cipher(void)`
`903`	`903`	`{`
`904`		`-#if 0`
`905`		`- mOSSL = rb_define_module("OpenSSL");`
`906`		`- eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);`
`907`		`-#endif`
`908`		`-`
`909`	`904`	`/* Document-class: OpenSSL::Cipher`
`910`	`905`	`*`
`911`	`906`	`* Provides symmetric algorithms for encryption and decryption. The`
Original file line number	Diff line number	Diff line change
`@@ -365,11 +365,6 @@ ossl_digest_block_length(VALUE self)`
`365`	`365`	`void`
`366`	`366`	`Init_ossl_digest(void)`
`367`	`367`	`{`
`368`		`-#if 0`
`369`		`- mOSSL = rb_define_module("OpenSSL");`
`370`		`- eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);`
`371`		`-#endif`
`372`		`-`
`373`	`368`	`/* Document-class: OpenSSL::Digest`
`374`	`369`	`*`
`375`	`370`	`* OpenSSL::Digest allows you to compute message digests (sometimes`
Original file line number	Diff line number	Diff line change
`@@ -256,11 +256,6 @@ ossl_hmac_reset(VALUE self)`
`256`	`256`	`void`
`257`	`257`	`Init_ossl_hmac(void)`
`258`	`258`	`{`
`259`		`-#if 0`
`260`		`- mOSSL = rb_define_module("OpenSSL");`
`261`		`- eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);`
`262`		`-#endif`
`263`		`-`
`264`	`259`	`/*`
`265`	`260`	`* Document-class: OpenSSL::HMAC`
`266`	`261`	`*`
Original file line number	Diff line number	Diff line change
`@@ -239,11 +239,6 @@ kdf_hkdf(int argc, VALUE *argv, VALUE self)`
`239`	`239`	`void`
`240`	`240`	`Init_ossl_kdf(void)`
`241`	`241`	`{`
`242`		`-#if 0`
`243`		`- mOSSL = rb_define_module("OpenSSL");`
`244`		`- eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);`
`245`		`-#endif`
`246`		`-`
`247`	`242`	`/*`
`248`	`243`	`* Document-module: OpenSSL::KDF`
`249`	`244`	`*`