From 66c06dc602594b263225b5481d2abba653a3b5e8 Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin
Date: Tue, 12 May 2015 11:21:20 +0200
Subject: ssh: Align "=" sign in type declarations to decided policy
---
lib/ssh/doc/src/ssh.xml | 43 +++++++++++++++++-----------------
lib/ssh/doc/src/ssh_channel.xml | 32 ++++++++++++-------------
lib/ssh/doc/src/ssh_client_key_api.xml | 20 ++++++++--------
lib/ssh/doc/src/ssh_connection.xml | 42 ++++++++++++++++-----------------
lib/ssh/doc/src/ssh_server_key_api.xml | 24 +++++++++----------
lib/ssh/doc/src/ssh_sftp.xml | 4 ++--
lib/ssh/doc/src/ssh_sftpd.xml | 16 ++++++-------
7 files changed, 90 insertions(+), 91 deletions(-)
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index d49d3ac2a7..7cca84432e 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -57,29 +57,28 @@
this module, or abstractions to indicate the intended use of the data
type, or both:
- boolean()
- = true | false
- string()
- = [byte()]
- ssh_daemon_ref()
- Opaque to the user,
- returned by ssh:daemon/[1,2,3]
- ssh_connection_ref()
- Opaque to the user,
- returned by ssh:connect/3
- ip_address()
+ boolean() =
+ true | false
+ string() =
+ [byte()]
+ ssh_daemon_ref() =
+ opaque() -
+ as returned by ssh:daemon/[1,2,3]
+ ssh_connection_ref() =
+ opaque() - as returned by ssh:connect/3
+ ip_address() =
inet::ip_address
- subsystem_spec()
- = {subsystem_name(),
- {channel_callback(), channel_init_args()}}
- subsystem_name()
- = string()
- channel_callback()
- = atom() - Name of the Erlang module
- implementing the subsystem using the ssh_channel behavior, see
- ssh_channel(3)
- channel_init_args()
- = list()
+ subsystem_spec() =
+ {subsystem_name(),
+ {channel_callback(), channel_init_args()}}
+ subsystem_name() =
+ string()
+ channel_callback() =
+ atom() - Name of the Erlang module
+ implementing the subsystem using the ssh_channel behavior, see
+ ssh_channel(3)
+ channel_init_args() =
+ list()
diff --git a/lib/ssh/doc/src/ssh_channel.xml b/lib/ssh/doc/src/ssh_channel.xml
index b8a03c350a..2fdecf9072 100644
--- a/lib/ssh/doc/src/ssh_channel.xml
+++ b/lib/ssh/doc/src/ssh_channel.xml
@@ -62,22 +62,22 @@
type, or both:
- boolean()
- = true | false
- string()
- = list of ASCII characters
- timeout()
- = infinity | integer() in milliseconds
- ssh_connection_ref()
- Opaque to the user, returned by
- ssh:connect/3 or sent to an SSH channel process
- ssh_channel_id()
- = integer()
- ssh_data_type_code()
- = 1 ("stderr") | 0 ("normal") are
- the valid values,
- see RFC 4254
- Section 5.2
+ boolean() =
+ true | false
+ string() =
+ list of ASCII characters
+ timeout() =
+ infinity | integer() in milliseconds
+ ssh_connection_ref() =
+ opaque() -as returned by
+ ssh:connect/3 or sent to an SSH channel process
+ ssh_channel_id() =
+ integer()
+ ssh_data_type_code() =
+ 1 ("stderr") | 0 ("normal") are
+ the valid values,
+ see RFC 4254
+ Section 5.2
diff --git a/lib/ssh/doc/src/ssh_client_key_api.xml b/lib/ssh/doc/src/ssh_client_key_api.xml
index a8dda042c9..9a892d71fd 100644
--- a/lib/ssh/doc/src/ssh_client_key_api.xml
+++ b/lib/ssh/doc/src/ssh_client_key_api.xml
@@ -50,16 +50,16 @@
public_key user's guide:
- boolean()
- = true | false
- string()
- = [byte()]
- public_key()
- = #'RSAPublicKey'{}| {integer(), #'Dss-Parms'{}}| term()
- private_key()
- = #'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()
- public_key_algorithm()
- = 'ssh-rsa'| 'ssh-dss' | atom()
+ boolean() =
+ true | false
+ string() =
+ [byte()]
+ public_key() =
+ #'RSAPublicKey'{}| {integer(), #'Dss-Parms'{}}| term()
+ private_key() =
+ #'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()
+ public_key_algorithm() =
+ 'ssh-rsa'| 'ssh-dss' | atom()
diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml
index 669a361db9..5422633dc3 100644
--- a/lib/ssh/doc/src/ssh_connection.xml
+++ b/lib/ssh/doc/src/ssh_connection.xml
@@ -56,29 +56,29 @@
type, or both:
- boolean()
- = true | false
- string()
- = list of ASCII characters
- timeout()
- = infinity | integer() in milliseconds
- ssh_connection_ref()
- Opaque to the user, returned by
- ssh:connect/3 or sent to an SSH channel processes
- ssh_channel_id()
- = integer()
- ssh_data_type_code()
- = 1 ("stderr") | 0 ("normal") are
+ boolean() =
+ true | false
+ string() =
+ list of ASCII characters
+ timeout() =
+ infinity | integer() in milliseconds
+ ssh_connection_ref() =
+ opaque() -as returned by
+ ssh:connect/3 or sent to an SSH channel processes
+ ssh_channel_id() =
+ integer()
+ ssh_data_type_code() =
+ 1 ("stderr") | 0 ("normal") are
valid values, see
RFC 4254 Section 5.2.
- ssh_request_status() ssh_request_status()
- = success | failure
- event()
- = {ssh_cm, ssh_connection_ref(), ssh_event_msg()}
- ssh_event_msg()
- = data_events() | status_events() | terminal_events()
- reason()
- = timeout | closed
+ ssh_request_status() =
+ success | failure
+ event() =
+ {ssh_cm, ssh_connection_ref(), ssh_event_msg()}
+ ssh_event_msg() =
+ data_events() | status_events() | terminal_events()
+ reason() =
+ timeout | closed
diff --git a/lib/ssh/doc/src/ssh_server_key_api.xml b/lib/ssh/doc/src/ssh_server_key_api.xml
index 34ce7f7660..73dd90c962 100644
--- a/lib/ssh/doc/src/ssh_server_key_api.xml
+++ b/lib/ssh/doc/src/ssh_server_key_api.xml
@@ -50,20 +50,20 @@
public_key user's guide.
-
- boolean()
- = true | false
- string()
- = [byte()]
- public_key()
- = #'RSAPublicKey'{}| {integer(), #'Dss-Parms'{}}| term()
- private_key()
- = #'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()
- public_key_algorithm()
- = 'ssh-rsa'| 'ssh-dss' | atom()
+
+ boolean() =
+ true | false
+ string() =
+ [byte()]
+ public_key() =
+ #'RSAPublicKey'{}| {integer(), #'Dss-Parms'{}}| term()
+ private_key() =
+ #'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()
+ public_key_algorithm() =
+ 'ssh-rsa'| 'ssh-dss' | atom()
-
+
Module:host_key(Algorithm, DaemonOptions) ->
diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index 643130fe6b..fc418bc934 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -43,8 +43,8 @@
- ssh_connection_ref()
- Opaque to the user, returned by ssh:connect/3
+ ssh_connection_ref() =
+ opaque() - as returned by ssh:connect/3
timeout()
= infinity | integer() in milliseconds. Default infinity.
diff --git a/lib/ssh/doc/src/ssh_sftpd.xml b/lib/ssh/doc/src/ssh_sftpd.xml
index bc2660f595..8b2497e6a3 100644
--- a/lib/ssh/doc/src/ssh_sftpd.xml
+++ b/lib/ssh/doc/src/ssh_sftpd.xml
@@ -37,16 +37,16 @@
DATA TYPES
- subsystem_spec()
- = {subsystem_name(), {channel_callback(), channel_init_args()}}
- subsystem_name()
- = "sftp"
- channel_callback()
- = atom() - Name of the Erlang module implementing the subsystem using the
+ subsystem_spec() =
+ {subsystem_name(), {channel_callback(), channel_init_args()}}
+ subsystem_name() =
+ "sftp"
+ channel_callback() =
+ atom() - Name of the Erlang module implementing the subsystem using the
ssh_channel behavior, see the
ssh_channel(3) manual page.
- channel_init_args()
- = list() - The one given as argument to function subsystem_spec/1.
+ channel_init_args() =
+ list() - The one given as argument to function subsystem_spec/1.
--
cgit v1.2.3