Correct broken links, add rubyamqp.info links to the old YARD-based g…

…uides
ruby-amqp · Oct 27, 2012 · 05ccf86 · 05ccf86
1 parent 19a0488
commit 05ccf86
Show file tree

Hide file tree

Showing 23 changed files with 97 additions and 25 deletions.
diff --git a/docs/08Migration.textile b/docs/08Migration.textile
@@ -2,6 +2,10 @@
 
 h1. amqp gem 0.8 migration guide
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 
 h2. About this guide
 

diff --git a/docs/AMQP091ModelExplained.textile b/docs/AMQP091ModelExplained.textile
@@ -2,6 +2,11 @@
 
 h1. AMQP 0.9.1 Model Explained
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
+
 h2. About this guide
 
 This guide explains the AMQP 0.9.1 Model used by RabbitMQ. Understanding the AMQP Model will make a lot of other documentation, both for the Ruby amqp gem and

diff --git a/docs/Bindings.textile b/docs/Bindings.textile
@@ -2,6 +2,10 @@
 
 h1. Working With Bindings
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 h2. About this guide
 
 This guide covers bindings in AMQP 0.9.1, what they are, what role do they play and how to accomplish typical operations using

diff --git a/docs/Clustering.textile b/docs/Clustering.textile
@@ -2,6 +2,10 @@
 
 h1. Clustering
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 
 h2. About this guide
 

diff --git a/docs/ConnectingToTheBroker.textile b/docs/ConnectingToTheBroker.textile
@@ -2,6 +2,10 @@
 
 h1. Connecting to the broker, integrating with Ruby on Rails, Merb and Sinatra
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 
 h2. About this guide
 

diff --git a/docs/ConnectionEncryptionWithTLS.textile b/docs/ConnectionEncryptionWithTLS.textile
@@ -2,6 +2,10 @@
 
 h1. Using TLS with Ruby amqp gem
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 
 h2. About this guide
 

diff --git a/docs/DocumentationGuidesIndex.textile b/docs/DocumentationGuidesIndex.textile
@@ -2,6 +2,10 @@
 
 h1. Ruby AMQP gem documentation guides
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 h2. Which versions of the amqp gem do the guides cover?
 
 These guides cover v0.8.0.RC14 and later of the "Ruby amqp gem":http://github.com/ruby-amqp/amqp.

diff --git a/docs/Durability.textile b/docs/Durability.textile
@@ -2,6 +2,10 @@
 
 h1. Durability and related matters
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 
 h2. About this guide
 

diff --git a/docs/ErrorHandling.textile b/docs/ErrorHandling.textile
@@ -2,6 +2,10 @@
 
 h1. Error handling and recovery
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 h2. About this guide
 
 Development of a robust application, be it message publisher or message consumer, involves dealing with multiple kinds of failures: protocol exceptions, network failures, broker failures and so on. Correct error handling and recovery is not easy. This guide explains how amqp gem helps you in dealing with issues like

diff --git a/docs/Exchanges.textile b/docs/Exchanges.textile
@@ -2,6 +2,10 @@
 
 h1. Working with exchanges
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 
 h2. About this guide
 

diff --git a/docs/GettingStarted.textile b/docs/GettingStarted.textile
@@ -2,6 +2,10 @@
 
 h1. Getting started with the Ruby amqp gem
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 
 h2. About this guide
 

diff --git a/docs/PatternsAndUseCases.textile b/docs/PatternsAndUseCases.textile
@@ -1,8 +1,11 @@
 # @title Ruby AMQP gem: Patterns and Use Cases
 
-
 h1. Patterns and Use Cases
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 
 h2. About this guide
 

diff --git a/docs/Queues.textile b/docs/Queues.textile
@@ -2,6 +2,10 @@
 
 h1. Working with queues
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 
 h2. About this guide
 

diff --git a/docs/RabbitMQVersions.textile b/docs/RabbitMQVersions.textile
@@ -2,6 +2,10 @@
 
 h1. Ruby amqp gem and RabbitMQ versions compatibility
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 h2. About this guide
 
 This guide covers compatibility of the "Ruby amqp gem":http://github.com/ruby-amqp/amqp with various versions of "RabbitMQ":http://rabbitmq.com messaging broker.

diff --git a/docs/RunningTests.textile b/docs/RunningTests.textile
@@ -2,6 +2,10 @@
 
 h1. Running amqp gem test suite
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 
 h2. About this guide
 

diff --git a/docs/TestingWithEventedSpec.textile b/docs/TestingWithEventedSpec.textile
@@ -2,6 +2,10 @@
 
 h1. Testing AMQP applications
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 h2. About this guide
 
 This guide covers unit testing of amqp-based applications, primarily using "evented-spec":http://github.com/ruby-amqp/evented-spec.

diff --git a/docs/Troubleshooting.textile b/docs/Troubleshooting.textile
@@ -2,6 +2,10 @@
 
 h1. Troubleshooting and debugging AMQP applications
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 
 h2. About this guide
 

diff --git a/docs/VendorSpecificExtensions.textile b/docs/VendorSpecificExtensions.textile
@@ -2,6 +2,10 @@
 
 h1. Vendor-specific AMQP extensions support in amqp gem
 
+h2. This Documentation Has Moved to rubyamqp.info
+
+amqp gem documentation guides are now hosted on "rubyamqp.info":http://rubyamqp.info.
+
 h2. RabbitMQ extensions
 
 h2. Supported extensions

diff --git a/lib/amqp/channel.rb b/lib/amqp/channel.rb
@@ -7,7 +7,7 @@
 module AMQP
   # h2. What are AMQP channels
   #
-  # To quote {http://bit.ly/hw2ELX AMQP 0.9.1 specification}:
+  # To quote {http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification}:
   #
   # AMQP is a multi-channelled protocol. Channels provide a way to multiplex
   # a heavyweight TCP/IP connection into several light weight connections.
@@ -140,7 +140,7 @@ module AMQP
   # AMQP gem supports several RabbitMQ extensions that extend Channel functionality.
   # Learn more in {file:docs/VendorSpecificExtensions.textile}
   #
-  # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 2.2.5)
+  # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 2.2.5)
   class Channel < AMQ::Client::Channel
 
     #
@@ -373,7 +373,7 @@ def reuse
     # @see Channel#default_exchange
     # @see Exchange
     # @see Exchange#initialize
-    # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 3.1.3.1)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 3.1.3.1)
     #
     # @return [Exchange]
     # @api public
@@ -426,7 +426,7 @@ def direct(name = 'amq.direct', opts = {}, &block)
     #
     #
     # @see Exchange
-    # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 2.1.2.4)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 2.1.2.4)
     #
     # @return [Exchange]
     # @api public
@@ -481,7 +481,7 @@ def default_exchange
     # @see Exchange
     # @see Exchange#initialize
     # @see Channel#default_exchange
-    # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 3.1.3.2)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 3.1.3.2)
     #
     # @return [Exchange]
     # @api public
@@ -597,7 +597,7 @@ def fanout(name = 'amq.fanout', opts = {}, &block)
     # @see Exchange
     # @see Exchange#initialize
     # @see http://www.rabbitmq.com/faq.html#Binding-and-Routing RabbitMQ FAQ on routing & wildcards
-    # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 3.1.3.3)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 3.1.3.3)
     #
     # @return [Exchange]
     # @api public
@@ -703,7 +703,7 @@ def topic(name = 'amq.topic', opts = {}, &block)
     # @see Exchange
     # @see Exchange#initialize
     # @see Channel#default_exchange
-    # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 3.1.3.3)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 3.1.3.3)
     #
     # @return [Exchange]
     # @api public
@@ -804,7 +804,7 @@ def headers(name = 'amq.match', opts = {}, &block)
     #
     # @see Queue
     # @see Queue#initialize
-    # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 2.1.4)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 2.1.4)
     #
     # @return [Queue]
     # @api public
@@ -957,7 +957,7 @@ def close(reply_code = 200, reply_text = DEFAULT_REPLY_TEXT, class_id = 0, metho
     #
     # @param [Boolean] Desired flow state.
     #
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.5.2.3.)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.5.2.3.)
     # @api public
     def flow(active = false, &block)
       super(active, &block)
@@ -998,7 +998,7 @@ def prefetch(count, global = false, &block)
     # @api public
     # @see #reject
     # @see #recover
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.8.3.13.)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.8.3.13.)
     def acknowledge(delivery_tag, multiple = false)
       super(delivery_tag, multiple)
     end # acknowledge(delivery_tag, multiple = false)
@@ -1008,7 +1008,7 @@ def acknowledge(delivery_tag, multiple = false)
     # @api public
     # @see #acknowledge
     # @see #recover
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.8.3.14.)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.8.3.14.)
     def reject(delivery_tag, requeue = true)
       super(delivery_tag, requeue)
     end # reject(delivery_tag, requeue = true)
@@ -1019,7 +1019,7 @@ def reject(delivery_tag, requeue = true)
     # @return [Channel]  self
     #
     # @note RabbitMQ as of 2.3.1 does not support basic.recover with requeue = false.
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.8.3.16.)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.8.3.16.)
     # @see #acknowledge
     # @api public
     def recover(requeue = true, &block)

diff --git a/lib/amqp/consumer.rb b/lib/amqp/consumer.rb
@@ -139,7 +139,7 @@ def on_delivery(&block)
     # @return [Consumer]  self
     #
     # @api public
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.8.3.13.)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.8.3.13.)
     def acknowledge(delivery_tag)
       super(delivery_tag)
     end # acknowledge(delivery_tag)
@@ -148,7 +148,7 @@ def acknowledge(delivery_tag)
     # @return [Consumer]  self
     #
     # @api public
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.8.3.14.)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.8.3.14.)
     def reject(delivery_tag, requeue = true)
       super(delivery_tag, requeue)
     end # reject(delivery_tag, requeue = true)

diff --git a/lib/amqp/exchange.rb b/lib/amqp/exchange.rb
@@ -134,9 +134,9 @@ module AMQP
   # @see Channel#topic
   # @see Channel#headers
   # @see Queue
-  # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 2.1.1)
-  # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 2.1.5)
-  # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 3.1.3)
+  # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 2.1.1)
+  # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 2.1.5)
+  # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 3.1.3)
   class Exchange < AMQ::Client::Exchange
 
     #
@@ -162,7 +162,7 @@ class Exchange < AMQ::Client::Exchange
     #   AMQP::Exchange.default(channel).publish("make clean", routing_key => "tasks")
     #
     # @see Exchange
-    # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 2.1.2.4)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 2.1.2.4)
     # @note Do not confuse default exchange with amq.direct: amq.direct is a pre-defined direct
     #       exchange that doesn't have any special routing semantics.
     # @return [Exchange] An instance that corresponds to the default exchange (of type direct).
@@ -292,7 +292,7 @@ def callback
     # @see Channel#topic
     # @see Channel#headers
     # @see Queue
-    # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 3.1.3)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 3.1.3)
     #
     # @return [Exchange]
     # @api public

diff --git a/lib/amqp/queue.rb b/lib/amqp/queue.rb
@@ -116,7 +116,7 @@ module AMQP
   #       persistence.
   #
   #
-  # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 2.1.1)
+  # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 2.1.1)
   # @see AMQP::Exchange
   class Queue < AMQ::Client::Queue
 

diff --git a/lib/amqp/session.rb b/lib/amqp/session.rb
@@ -110,7 +110,7 @@ def reconnect_to(connection_string_or_options = {}, period = 2)
 
 
     # Properly close connection with AMQ broker, as described in
-    # section 2.2.4 of the {http://bit.ly/hw2ELX AMQP 0.9.1 specification}.
+    # section 2.2.4 of the {http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification}.
     #
     # @api  plugin
     # @see  #close_connection
@@ -129,19 +129,19 @@ def disconnect(reply_code = 200, reply_text = "Goodbye", &block)
     # Server properties (product information, platform, et cetera)
     #
     # @return [Hash]
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.4.2.1.3)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.4.2.1.3)
     attr_reader :server_properties
 
     # Server capabilities (usually used to detect AMQP 0.9.1 extensions like basic.nack, publisher
     # confirms and so on)
     #
     # @return [Hash]
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.4.2.1.3)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.4.2.1.3)
     attr_reader :server_capabilities
 
     # Locales server supports
     #
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.4.2.1.3)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.4.2.1.3)
     attr_reader :server_locales
 
     # @return [AMQP::Broker] Broker this connection is established with