[#8815] Segfault in libc strlen, via rb_str_new2 — "Sean E. Russell" <ser@...>

Howdy,

12 messages 2006/09/09
[#8817] Re: Segfault in libc strlen, via rb_str_new2 — Eric Hodel <drbrain@...7.net> 2006/09/09

On Sep 8, 2006, at 10:10 PM, Sean E. Russell wrote:

Getting docs out of README.EXT

From: Hugh Sasse <hgs@...>
Date: 2006-09-18 14:54:49 UTC
List: ruby-core #8892
I've been trying to find the easiest way to get README.EXT into
html, and finally found that the best way was to use RDoc.  This
patch is against 1.9.  It seems to work OK, but there's a couple of
issues.

REAME.EXT is picked up, but nothing from it appears in the ri docs,
and to be honest, I don't know how I should locate it if it did.  A
`grep -ri README .` in the ri directory turns up nothing.  This also
shows that at present we have no make target for HTML docs, which is
probably where this sort of thing should naturally live.  I was
hoping that with a bit of extra markup we could make this README.EXT
very browser friendly, with a table of contents, for example.  At
the moment I've not added in anything along those lines, and it
would seem pointless till we have an HTML target.  I'm not sure what
to do about adding an HTML target, because that necessitates having
a sensible place for the HTML, and declaring it up front, and there
will be no useful sensible place for it that is applicable to all
users of ruby.

Does anyone have any suggestions as a good way to make this [more]
useful?

        Hugh

--- ./.document.orig	2006-09-18 12:41:30.061686000 +0100
+++ ./.document	2006-09-18 12:46:27.031056000 +0100
@@ -6,6 +6,9 @@
 # Process all the C source files
 *.c
 
+# And make README.EXT processable. Note: need to use -E EXT=rb
+README.EXT
+
 # the lib/ directory (which has its own .document file)
 
 lib
--- ./README.EXT.orig	2006-09-18 12:41:30.386806000 +0100
+++ ./README.EXT	2006-09-18 12:47:06.066492000 +0100
@@ -1,3 +1,4 @@
+=begin rdoc
 .\" README.EXT -  -*- Text -*- created at: Mon Aug  7 16:45:54 JST 1995
 
 This document explains how to make extension libraries for Ruby.
@@ -1157,3 +1158,4 @@
  * fill-column: 70
  * end:
  */
+=end
--- ./common.mk.orig	2006-09-18 12:42:49.786618000 +0100
+++ ./common.mk	2006-09-18 12:56:56.914292000 +0100
@@ -233,7 +233,7 @@
 
 rdoc: $(PROGRAM) PHONY
 	@echo Generating RDoc documentation
-	$(RUNRUBY) "$(srcdir)/bin/rdoc" --all --ri --op "$(RDOCOUT)" "$(srcdir)"
+	$(RUNRUBY) "$(srcdir)/bin/rdoc" --all --ri -E EXT=rb --op "$(RDOCOUT)" "$(srcdir)"
 
 pre-install-doc:: PHONY
 

In This Thread

Prev Next