Skip to content

doc: extra clarification of historySize option #6397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vsemozhetbyt wants to merge 2 commits into from
Closed

doc: extra clarification of historySize option #6397

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea3c694
doc: extra clarification of historySize option
vsemozhetbyt Apr 26, 2016
73351d5
add missing preposition
vsemozhetbyt Apr 27, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: extra clarification of historySize option 
doc: extra clarification of historySize option

History caching in the `readline` io is active only for terminal
interaction. Appropriate variables are initialized and relevant
`_addHistory()` function is called only if exposed `terminal` option
of `readline.createInterface()` is set `true` by user or internal
output check.

This clarification is useful to assure users there will be now wasted
overhead connected with history caching if `readline` is used not
for terminal interaction (e.g. for reading files line by line).

Particularly this fix is helpful after #6352 landing.
  • Loading branch information
@vsemozhetbyt
vsemozhetbyt committed Apr 26, 2016
commit ea3c6942c95c9ea31604afbb826a0a8adfa5b5c1
4 changes: 3 additions & 1 deletion doc/api/readline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,9 @@ the following values:
Defaults to checking `isTTY` on the `output` stream upon instantiation.

- `historySize` - maximum number of history lines retained. To disable the
history set this value to `0`. Defaults to `30`.
history set this value to `0`. Defaults to `30`. This option makes sense
only if `terminal` is set `true` by user or by internal `output` check,
Copy link
Copy Markdown
Member

@bengl bengl Apr 26, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

is set to `true`

otherwise the history caching mechanism is not initialized at all.

The `completer` function is given the current line entered by the user, and
is supposed to return an Array with 2 entries:
Expand Down