* lib/irb.rb, lib/irb/context.rb: Add documentation on how to enable

  auto-indentation and autocompletion using irbrc and irb_context
  [ruby-core:51209] [Bug #7642] and [ruby-core:51348] [Bug #7680]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@39048 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

2 files changed, 31 insertions, 6 deletions

diff --git a/lib/irb.rb b/lib/irb.rb
index 6c7a9d1eab..755fb050ae 100644
--- a/lib/irb.rb
+++ b/lib/irb.rb
@@ -105,6 +105,18 @@ STDOUT.sync = true
 #     IRB.conf[:PROMPT] = {...}
 #     IRB.conf[:DEBUG_LEVEL]=0
 #
+# === Auto indentation
+#
+# To enable auto-indent mode in irb, add the following to your +.irbrc+:
+#
+#     IRB.conf[:AUTO_INDENT] = true
+#
+# === Autocompletion
+#
+# To enable autocompletion for irb, add the following to your +.irbrc+:
+#
+#     require 'irb/completion'
+#
 # == Customizing the IRB Prompt
 #
 # In order to customize the prompt, you can change the following Hash:
@@ -114,19 +126,18 @@ STDOUT.sync = true
 # This example can be used in your +.irbrc+
 #
 #     IRB.conf[:PROMPT][:MY_PROMPT] = { # name of prompt mode
+#       :AUTO_INDENT => true            # enables auto-indent mode
 #       :PROMPT_I => nil,		# normal prompt
 #       :PROMPT_S => nil,		# prompt for continuated strings
 #       :PROMPT_C => nil,		# prompt for continuated statement
 #       :RETURN => "    ==>%s\n"	# format to return value
 #     }
 #
-# Then, invoke irb with the above prompt mode by:
-#
-#     irb --prompt my-prompt
+#     IRB.conf[:PROMPT_MODE] = :MY_PROMPT
 #
-# Or, add the following in your +.irbrc+:
+# Or, invoke irb with the above prompt mode by:
 #
-#     IRB.conf[:PROMPT_MODE] = :MY_PROMPT
+#     irb --prompt my-prompt
 #
 # Constants +PROMPT_I+, +PROMPT_S+ and +PROMPT_C+ specify the format. In the
 # prompt specification, some special strings are available:
diff --git a/lib/irb/context.rb b/lib/irb/context.rb
index d6dfa1847a..72b36307d5 100644
--- a/lib/irb/context.rb
+++ b/lib/irb/context.rb
@@ -161,8 +161,22 @@ module IRB
     attr_accessor :prompt_c
     # See IRB@Customizing+the+IRB+Prompt for more information.
     attr_accessor :prompt_n
-    # Can be either the deafult <code>IRB.conf[:AUTO_INDENT]</code>, or the
+    # Can be either the default <code>IRB.conf[:AUTO_INDENT]</code>, or the
     # mode set by #prompt_mode=
+    #
+    # To enable auto-indentation in irb:
+    #
+    #     IRB.conf[:AUTO_INDENT] = true
+    #
+    # or
+    #
+    #     irb_context.auto_indent_mode = true
+    #
+    # or
+    #
+    #     IRB.CurrentContext.auto_indent_mode = true
+    #
+    # See IRB@Configuration for more information.
     attr_accessor :auto_indent_mode
     # The format of the return statement, set by #prompt_mode= using the
     # +:RETURN+ of the +mode+ passed to set the current #prompt_mode.