From aa69482e98b02e99ff8c9dea6434daedf637aee9 Mon Sep 17 00:00:00 2001 From: Bernard Duggan Date: Wed, 23 Feb 2011 16:00:20 +1100 Subject: Various small documentation fixes This change fixes a bunch of small (and a few less small) typos and other errors in various modules that I've spotted throughout my travels. --- lib/crypto/doc/src/crypto.xml | 12 ++++++++---- lib/inets/doc/src/http_server.xml | 8 ++++---- lib/inets/doc/src/httpd.xml | 5 +++-- lib/inets/doc/src/mod_esi.xml | 19 ++++++++++--------- lib/stdlib/doc/src/binary.xml | 2 +- lib/stdlib/doc/src/dict.xml | 6 ++---- lib/webtool/doc/src/webtool_chapter.xml | 4 ++-- 7 files changed, 30 insertions(+), 26 deletions(-) diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml index c407350c47..91b89c8796 100644 --- a/lib/crypto/doc/src/crypto.xml +++ b/lib/crypto/doc/src/crypto.xml @@ -415,7 +415,7 @@ Mpint() = >]]> - blowfish_ecb_encrypt(Key, Text) -> Cipher + blowfish_ecb_encrypt(Key, IVec, Text) -> Cipher Encrypt the first 64 bits of Text using Blowfish in ECB mode Key = Text = iolist() | binary() @@ -424,7 +424,9 @@ Mpint() = >]]>

Encrypts the first 64 bits of Text using Blowfish in ECB mode. Key is the Blowfish key. The length of Text must be at least 64 bits (8 bytes).

 - blowfish_ecb_decrypt(Key, Text) -> Cipher + + + blowfish_ecb_decrypt(Key, IVec, Text) -> Cipher Decrypt the first 64 bits of Text using Blowfish in ECB mode Key = Text = iolist() | binary() @@ -436,7 +438,7 @@ Mpint() = >]]> - blowfish_cbc_encrypt(Key, Text) -> Cipher + blowfish_cbc_encrypt(Key, IVec, Text) -> Cipher Encrypt Text using Blowfish in CBC mode Key = Text = iolist() | binary() @@ -447,7 +449,9 @@ Mpint() = >]]> arbitrary initializing vector. The length of IVec must be 64 bits (8 bytes). The length of Text must be a multiple of 64 bits (8 bytes).

- blowfish_cbc_decrypt(Key, Text) -> Cipher + + + blowfish_cbc_decrypt(Key, IVec, Text) -> Cipher Decrypt Text using Blowfish in CBC mode Key = Text = iolist() | binary() diff --git a/lib/inets/doc/src/http_server.xml b/lib/inets/doc/src/http_server.xml index 47ed9cd229..959386e471 100644 --- a/lib/inets/doc/src/http_server.xml +++ b/lib/inets/doc/src/http_server.xml @@ -63,9 +63,9 @@ technologies such as SOAP.

Allmost all server functionality has been implemented using an - especially crafted server API, it is described in the Erlang Web - Server API. This API can be used to advantage by all who wants - to enhance the server core functionality, for example custom + especially crafted server API which is described in the Erlang Web + Server API. This API can be used to advantage by all who wish + to enhance the core server functionality, for example with custom logging and authentication.

@@ -472,7 +472,7 @@ http://your.server.org/eval?httpd_example:print(atom_to_list(apply(erlang,halt,[ bytes The content-length of the document transferred. -

Internal server errors are recorde in the error log file. The +

Internal server errors are recorded in the error log file. The format of this file is a more ad hoc format than the logs using Common Logfile Format, but conforms to the following syntax:

diff --git a/lib/inets/doc/src/httpd.xml b/lib/inets/doc/src/httpd.xml index 62f4e18f82..6470b6fac7 100644 --- a/lib/inets/doc/src/httpd.xml +++ b/lib/inets/doc/src/httpd.xml @@ -525,12 +525,13 @@ bytes scheme scripts. A matching URL is mapped into a specific module and function. For example: - {erl_script_alias, {"/cgi-bin/example" [httpd_example]} + {erl_script_alias, {"/cgi-bin/example", [httpd_example]} and a request to http://your.server.org/cgi-bin/example/httpd_example:yahoo - would refer to httpd_example:yahoo/2 and + would refer to httpd_example:yahoo/3 or, if that did not exist, + httpd_example:yahoo/2 and http://your.server.org/cgi-bin/example/other:yahoo would not be allowed to execute. diff --git a/lib/inets/doc/src/mod_esi.xml b/lib/inets/doc/src/mod_esi.xml index 3c473d3f94..aa98a8e85c 100644 --- a/lib/inets/doc/src/mod_esi.xml +++ b/lib/inets/doc/src/mod_esi.xml @@ -78,24 +78,24 @@

The Module must be found in the code path and export - Function with an arity of two. An erlScriptAlias must + Function with an arity of three. An erlScriptAlias must also be set up in the configuration file for the Web server.

-

If the HTTP request is a post request and a body is sent +

If the HTTP request is a 'post' request and a body is sent then content_length will be the length of the posted - data. If get is used query_string will be the data after + data. If 'get' is used query_string will be the data after ? in the url.

ParsedHeader is the HTTP request as a key value tuple list. The keys in parsed header will be the in lower case.

SessionID is a identifier - the server use when deliver/2 is called, do not - assume any-thing about the datatype.

+ the server uses when deliver/2 is called; do not + assume anything about the datatype.

Use this callback function to dynamically generate dynamic web content. when a part of the page is generated send the data back to the client through deliver/2. Note that the first chunk of data sent to the client must at least contain all HTTP header fields that the response - will generate. If the first chunk not contains - End of HTTP header that is "\r\n\r\n" + will generate. If the first chunk does not contain the + End of HTTP the header, that is "\r\n\r\n", the server will assume that no HTTP header fields will be generated.

 @@ -106,11 +106,12 @@ Env = [EnvironmentDirectives] ++ ParsedHeader EnvironmentDirectives = {Key,Value} - Key = query_string | content_length | server_software | gateway_interface | server_protocol | server_port | request_method | remote_addr | script_name. <v>Input = string() + Key = query_string | content_length | server_software | gateway_interface | server_protocol | server_port | request_method | remote_addr | script_name. + Input = string() Response = string() -

This callback format consumes quite much memory since the +

This callback format consumes a lot of memory since the whole response must be generated before it is sent to the user. This functions is deprecated and only keept for backwards compatibility. diff --git a/lib/stdlib/doc/src/binary.xml b/lib/stdlib/doc/src/binary.xml index c5eb81a86a..da038bf30c 100644 --- a/lib/stdlib/doc/src/binary.xml +++ b/lib/stdlib/doc/src/binary.xml @@ -485,7 +485,7 @@ 1> Bin = <<1,2,3,4,5,6,7,8,9,10>>. -2> binary:part(Bin,{byte_size(Bin), -5)). +2> binary:part(Bin,{byte_size(Bin), -5)}). <<6,7,8,9,10>> diff --git a/lib/stdlib/doc/src/dict.xml b/lib/stdlib/doc/src/dict.xml index 40e61d7d33..1540a930ba 100644 --- a/lib/stdlib/doc/src/dict.xml +++ b/lib/stdlib/doc/src/dict.xml @@ -55,10 +55,8 @@ dictionary()

This function appends a new Value to the current list - of values associated with Key. An exception is - generated if the initial value associated with Key is - not a list of values.

- + of values associated with Key. + append_list(Key, ValList, Dict1) -> Dict2 diff --git a/lib/webtool/doc/src/webtool_chapter.xml b/lib/webtool/doc/src/webtool_chapter.xml index f72a255b0a..305fbcb8ee 100644 --- a/lib/webtool/doc/src/webtool_chapter.xml +++ b/lib/webtool/doc/src/webtool_chapter.xml @@ -151,7 +151,7 @@ http://Servername:Port/ErlScriptAlias/Mod/Func ]]>

An alias parameter in the configuration function can be an ErlScriptAlias as used in the above URL. The definition of - an ErlScripAlias shall be like this:

+ an ErlScriptAlias shall be like this:

{alias,{erl_alias,Path,[Modules]}}, e.g.

{alias,{erl_alias,"/testtool",[helloworld]}}

The following URL will then cause a call to the function @@ -184,7 +184,7 @@ http://Servername:Port/ErlScriptAlias/Mod/Func ]]> directory /usr/local/otp/lib/myapp-1.0/priv:

{alias,{"/mytool_home","/usr/local/otp/lib/myapp-1.0/priv"}}

See the INETS documentation, especially the module - mod_esi, for a more in depht coverage of Erl Scheme.

+ mod_esi, for a more in depth coverage of the Erl Scheme.

-- cgit v1.2.3 From 30f3f25d7c358ee65444621335692162de24a94f Mon Sep 17 00:00:00 2001 From: Bernard Duggan Date: Wed, 23 Mar 2011 10:55:10 +1100 Subject: Compile fixes for earlier documentation fixes Fixed a couple of compilation errors. Also backed out a tiny change that had already been added by Tuncer Ayaz in his binary-part-typo branch. --- lib/inets/doc/src/mod_esi.xml | 2 +- lib/stdlib/doc/src/binary.xml | 2 +- lib/stdlib/doc/src/dict.xml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/inets/doc/src/mod_esi.xml b/lib/inets/doc/src/mod_esi.xml index aa98a8e85c..e81308a502 100644 --- a/lib/inets/doc/src/mod_esi.xml +++ b/lib/inets/doc/src/mod_esi.xml @@ -106,7 +106,7 @@ Env = [EnvironmentDirectives] ++ ParsedHeader EnvironmentDirectives = {Key,Value} - Key = query_string | content_length | server_software | gateway_interface | server_protocol | server_port | request_method | remote_addr | script_name. + Key = query_string | content_length | server_software | gateway_interface | server_protocol | server_port | request_method | remote_addr | script_name. Input = string() Response = string() diff --git a/lib/stdlib/doc/src/binary.xml b/lib/stdlib/doc/src/binary.xml index da038bf30c..c5eb81a86a 100644 --- a/lib/stdlib/doc/src/binary.xml +++ b/lib/stdlib/doc/src/binary.xml @@ -485,7 +485,7 @@ 1> Bin = <<1,2,3,4,5,6,7,8,9,10>>. -2> binary:part(Bin,{byte_size(Bin), -5)}). +2> binary:part(Bin,{byte_size(Bin), -5)). <<6,7,8,9,10>> diff --git a/lib/stdlib/doc/src/dict.xml b/lib/stdlib/doc/src/dict.xml index 1540a930ba..0cc76e0c78 100644 --- a/lib/stdlib/doc/src/dict.xml +++ b/lib/stdlib/doc/src/dict.xml @@ -55,7 +55,7 @@ dictionary()

This function appends a new Value to the current list - of values associated with Key. + of values associated with Key.

 -- cgit v1.2.3 From 6597f81ec28909d1b3670e1c701f1175394c3fc2 Mon Sep 17 00:00:00 2001 From: Bernard Duggan Date: Fri, 1 Apr 2011 08:45:25 +1100 Subject: Fix mistake in blowfish_ebc_en/decrypt docs --- lib/crypto/doc/src/crypto.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml index 91b89c8796..dfafe67348 100644 --- a/lib/crypto/doc/src/crypto.xml +++ b/lib/crypto/doc/src/crypto.xml @@ -415,22 +415,22 @@ Mpint() = >]]> - blowfish_ecb_encrypt(Key, IVec, Text) -> Cipher + blowfish_ecb_encrypt(Key, Text) -> Cipher Encrypt the first 64 bits of Text using Blowfish in ECB mode Key = Text = iolist() | binary() - IVec = Cipher = binary() + Cipher = binary()

Encrypts the first 64 bits of Text using Blowfish in ECB mode. Key is the Blowfish key. The length of Text must be at least 64 bits (8 bytes).

 - blowfish_ecb_decrypt(Key, IVec, Text) -> Cipher + blowfish_ecb_decrypt(Key, Text) -> Cipher Decrypt the first 64 bits of Text using Blowfish in ECB mode Key = Text = iolist() | binary() - IVec = Cipher = binary() + Cipher = binary()

Decrypts the first 64 bits of Text using Blowfish in ECB mode. Key is the Blowfish key. The length of Text must be at least 64 bits (8 bytes).

-- cgit v1.2.3