ssh2: document five previously undocumented functions#5688
Open
lacatoire wants to merge 1 commit into
Open
Conversation
Add reference pages for functions that are registered by the ssh2 extension but had no documentation, and register them in versions.xml: - ssh2_keepalive_config / ssh2_keepalive_send (PECL ssh2 >= 1.5.0) - ssh2_send_signal (PECL ssh2 >= 1.5.0) - ssh2_set_timeout (PECL ssh2 >= 1.5.0) - ssh2_shell_resize (PECL ssh2 >= 1.4) Signatures, parameter types (session vs channel/shell stream), return values and libssh availability requirements were taken from the ssh2 1.5.0 C sources and config.m4.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Adds reference pages for five functions registered by the ssh2 extension that had no documentation, and registers them in
versions.xml.ssh2_keepalive_config,ssh2_keepalive_send(PECL ssh2 >= 1.5.0)ssh2_send_signal(PECL ssh2 >= 1.5.0)ssh2_set_timeout(PECL ssh2 >= 1.5.0)ssh2_shell_resize(PECL ssh2 >= 1.4)Signatures, parameter types, return values and libssh availability requirements were derived from the ssh2 1.5.0 C sources and
config.m4; introduction versions from the extension changelog. Pages follow the style of the existing ssh2 function pages.