[ruby/etc] [DOC] Add minimal documents for constants

ruby/etc@97a4f798d4
ruby · Dec 27, 2023 · c027dcf · c027dcf
1 parent bc00297
commit c027dcf
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/ext/etc/.document b/ext/etc/.document
@@ -1 +1,2 @@
 etc.c
+constdefs.h
diff --git a/ext/etc/mkconstants.rb b/ext/etc/mkconstants.rb
@@ -35,6 +35,12 @@ def c_str(str)
 
 opt.parse!
 
+CONST_PREFIXES = {
+  'SC' => 'for Etc.sysconf; See <tt>man sysconf</tt>',
+  'CS' => 'for Etc.confstr; See <tt>man constr</tt>',
+  'PC' => 'for IO#pathconf; See <tt>man fpathconf</tt>',
+}
+
 h = {}
 COMMENTS = {}
 
@@ -49,6 +55,13 @@ def c_str(str)
     next
   end
   h[name] = default_value
+  if additional = CONST_PREFIXES[name[/\A_([A-Z]+)_/, 1]]
+    if comment&.match(/\w\z/)
+      comment << " " << additional
+    else
+      (comment ||= String.new) << " " << additional.sub(/\A\w/) {$&.upcase}
+    end
+  end
   COMMENTS[name] = comment if comment
 }
 DEFS = h.to_a
@@ -123,6 +136,9 @@ def each_name(pat)
 static void
 init_constants(VALUE mod)
 {
+#if 0
+    mod = rb_define_module("Etc");
+#endif
 <%= gen_const_defs %>
 }
 EOS