]> git.wincent.com - wikitext.git/commitdiff
Add release notes to RDoc documentation 1.4.0
authorWincent Colaiuta <win@wincent.com>
Sun, 1 Feb 2009 21:39:18 +0000 (22:39 +0100)
committerWincent Colaiuta <win@wincent.com>
Sun, 1 Feb 2009 21:39:18 +0000 (22:39 +0100)
Seeing as 1.4.0 introduces a backwards-incompatible change, include
release notes in the RDoc documentation.

Signed-off-by: Wincent Colaiuta <win@wincent.com>
Rakefile
doc/RELEASE-NOTES [new file with mode: 0644]

index 9ace54e32f48d45c509670fd656440c6b15af0ff..7cd161c940165e5abaf60c0b4296ede385428674 100644 (file)
--- a/Rakefile
+++ b/Rakefile
@@ -82,7 +82,7 @@ Spec::Rake::SpecTask.new('spec') do |t|
 end
 
 Rake::RDocTask.new do |t|
-  t.rdoc_files.include 'doc/README', 'doc/rdoc.rb'
+  t.rdoc_files.include 'doc/README', 'doc/RELEASE-NOTES', 'doc/rdoc.rb'
   t.options           << '--charset' << 'UTF-8' << '--inline-source'
   t.main              = 'doc/README'
   t.title             = 'Wikitext documentation'
diff --git a/doc/RELEASE-NOTES b/doc/RELEASE-NOTES
new file mode 100644 (file)
index 0000000..6a78ac9
--- /dev/null
@@ -0,0 +1,7 @@
+= Changes in 1.4.0
+
+* "special links" inside internal link spans (double square
+  brackets) are no longer supported; instead use external link
+  spans: where previously you used <tt>[[issues/210 | ticket 210]]</tt>
+  you should now use <tt>[/issues/210 ticket 210]</tt>
+* relatedly, the +treat_slash_as_special+ attribute has been removed