doc: extra clarification of historySize option #6397
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
addaleax
added
doc
| @@ -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, | |||
set `true` -> set to `true`
|
LGTM |
1 similar comment
|
LGTM |
|
@nodejs/documentation |
|
LGTM |
jasnell
pushed a commit
that referenced
this pull request
May 1, 2016
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. PR-URL: #6397 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Alexander Makarenko <estliberitas@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
|
Landed in 563c9f8. Made a couple of minor fixups in the process. Thank you for the contribution! |
Fishrock123
pushed a commit
that referenced
this pull request
May 4, 2016
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. PR-URL: #6397 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Alexander Makarenko <estliberitas@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
This was referenced May 4, 2016
joelostrowski
pushed a commit
to joelostrowski/node
that referenced
this pull request
May 4, 2016
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 nodejs#6352 landing. PR-URL: nodejs#6397 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Alexander Makarenko <estliberitas@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
Affected core subsystem(s)
doc
Description of change
History caching in the
readlineio is active only for terminal interaction. Appropriate variables are initialized and relevant_addHistory()function is called only if exposedterminaloption ofreadline.createInterface()is set totrueby user or internal output check.This clarification is useful to assure users there will be now wasted overhead connected with history caching if
readlineis used not for terminal interaction (e.g. for reading files line by line).Particularly this fix is helpful after #6352 landing.