From f11ff34d8f89b5cd10099554c20ee53ac02f30f6 Mon Sep 17 00:00:00 2001
From: zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Mon, 4 Feb 2013 23:04:09 +0000
Subject: * lib/irb.rb, lib/irb/ext/save-history.rb: Add documentation on how
 to   enabled irb history [ruby-core:51347] [Bug #7679]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@39049 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 lib/irb/ext/save-history.rb | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'lib/irb')

diff --git a/lib/irb/ext/save-history.rb b/lib/irb/ext/save-history.rb
index d61fec9ff7..7b3fcbbeec 100644
--- a/lib/irb/ext/save-history.rb
+++ b/lib/irb/ext/save-history.rb
@@ -29,6 +29,13 @@ module IRB
 
     # Sets <code>IRB.conf[:SAVE_HISTORY]</code> to the given +val+ and calls
     # #init_save_history with this context.
+    #
+    # Will store the number of +val+ entries of history in the #history_file
+    #
+    # Add the following to your +.irbrc+ to change the number of history
+    # entries stored to 1000:
+    #
+    #     IRB.conf[:SAVE_HISTORY] = 1000
     def save_history=(val)
       IRB.conf[:SAVE_HISTORY] = val
       if val
-- 
cgit v1.2.3