From 3448e2aa81a01244458824aae94d3e746a9a4c24 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Sat, 5 Jan 2013 09:26:34 +0100 Subject: Fix some FOP warnings Examples overflowing the width of PDF pages have been fixed. The remaining warnings are due to table cells, and require more work. --- lib/common_test/doc/src/common_test_app.xml | 11 ++++-- lib/common_test/doc/src/ct_hooks_chapter.xml | 27 ++++++------- lib/common_test/doc/src/run_test_chapter.xml | 6 ++- lib/common_test/doc/src/write_test_chapter.xml | 52 +++++++++++++------------- lib/dialyzer/doc/src/dialyzer.xml | 8 +++- lib/dialyzer/doc/src/dialyzer_chapter.xml | 6 ++- lib/erl_docgen/doc/src/doc-build.xml | 5 ++- lib/inets/doc/src/http_uri.xml | 5 ++- lib/kernel/doc/src/inet.xml | 5 ++- lib/odbc/doc/src/odbc.xml | 12 ++++-- lib/orber/doc/src/ch_idl_to_erlang_mapping.xml | 5 ++- lib/public_key/doc/src/public_key.xml | 7 ++-- lib/reltool/doc/src/reltool.xml | 5 ++- lib/runtime_tools/doc/src/dbg.xml | 5 ++- lib/ssh/doc/src/using_ssh.xml | 12 ++++-- lib/stdlib/doc/src/zip.xml | 4 +- lib/xmerl/doc/src/motorcycles_dtd.txt | 3 +- 17 files changed, 104 insertions(+), 74 deletions(-) (limited to 'lib') diff --git a/lib/common_test/doc/src/common_test_app.xml b/lib/common_test/doc/src/common_test_app.xml index b6d4a633cb..151159ad69 100644 --- a/lib/common_test/doc/src/common_test_app.xml +++ b/lib/common_test/doc/src/common_test_app.xml @@ -4,7 +4,7 @@
- 20032012 + 20032013 Ericsson AB. All Rights Reserved. @@ -170,7 +170,9 @@ UserData = term() Conns = [atom()] CSSFile = string() - CTHs = [CTHModule | {CTHModule, CTHInitArgs} | {CTHModule, CTHInitArgs, CTHPriority}] + CTHs = [CTHModule | +         {CTHModule, CTHInitArgs} | +         {CTHModule, CTHInitArgs, CTHPriority}] CTHModule = atom() CTHInitArgs = term() @@ -297,8 +299,9 @@ UserData = term() Conns = [atom()] CSSFile = string() - CTHs = [CTHModule | {CTHModule, CTHInitArgs} | - {CTHModule, CTHInitArgs, CTHPriority}] + CTHs = [CTHModule | +         {CTHModule, CTHInitArgs} | +         {CTHModule, CTHInitArgs, CTHPriority}] CTHModule = atom() CTHInitArgs = term() diff --git a/lib/common_test/doc/src/ct_hooks_chapter.xml b/lib/common_test/doc/src/ct_hooks_chapter.xml index 27d56fd47d..fe871eb516 100644 --- a/lib/common_test/doc/src/ct_hooks_chapter.xml +++ b/lib/common_test/doc/src/ct_hooks_chapter.xml @@ -4,7 +4,7 @@
- 20112012 + 20112013 Ericsson AB. All Rights Reserved. @@ -439,14 +439,14 @@ terminate(State) -> - CTH Name - Is Built-in - Description + CTH Name + Is Built-in + Description - cth_log_redirect - yes - Captures all error_logger and SASL logging events and prints them + cth_log_redirect + yes + Captures all error_logger and SASL logging events and prints them to the current test case log. If an event can not be associated with a testcase it will be printed in the common test framework log. This will happen for testcases which are run in parallel and events which occur @@ -455,9 +455,9 @@ terminate(State) -> using the normal SASL mechanisms. - cth_surefire - no -

Captures all test results and outputs them as surefire + cth_surefire + no +

Captures all test results and outputs them as surefire XML into a file. The file which is created is by default called junit_report.xml. The file name can be changed by setting the path option for this hook, e.g.

@@ -467,13 +467,14 @@ terminate(State) ->

If the url_base option is set, an additional attribute named url will be added to each testsuite and testcase XML element. The value will - be a constructed from the url_base and a relative path + be constructed from the url_base and a relative path to the test suite or test case log respectively, e.g.

- -ct_hooks cth_surefire [{url_base,"http://myserver.com/"}] + -ct_hooks cth_surefire [{url_base, "http://myserver.com/"}]

will give a url attribute value similar to

- "http://myserver.com/ct_run.ct@myhost.2012-12-12_11.19.39/x86_64-unknown-linux-gnu.my_test.logs/run.2012-12-12_11.19.39/suite.log.html" + "http://myserver.com/ct_run.ct@myhost.2012-12-12_11.19.39/ +x86_64-unknown-linux-gnu.my_test.logs/run.2012-12-12_11.19.39/suite.log.html"

Surefire XML can for instance be used by Jenkins to display test results.

 diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml index b804f134c6..d5f5d89e05 100644 --- a/lib/common_test/doc/src/run_test_chapter.xml +++ b/lib/common_test/doc/src/run_test_chapter.xml @@ -4,7 +4,7 @@
- 20032012 + 20032013 Ericsson AB. All Rights Reserved. @@ -752,7 +752,9 @@ PrivDirOption = auto_per_run | auto_per_tc | manual_per_tc EventHandlers = atom() | [atom()] InitArgs = [term()] - CTHModules = [CTHModule | {CTHModule, CTHInitArgs} | {CTHModule, CTHInitArgs, CTHPriority}] + CTHModules = [CTHModule | + {CTHModule, CTHInitArgs} | + {CTHModule, CTHInitArgs, CTHPriority}] CTHModule = atom() CTHInitArgs = term() Dir = string() diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml index 248d7de8b6..cc8d913994 100644 --- a/lib/common_test/doc/src/write_test_chapter.xml +++ b/lib/common_test/doc/src/write_test_chapter.xml @@ -4,7 +4,7 @@
- 20032012 + 20032013 Ericsson AB. All Rights Reserved. @@ -982,38 +982,36 @@

Example:

+   Some printouts during test case execution:
 
-      Some printouts during test case execution:
+     io:format("1. Standard IO, importance = ~w~n", [?STD_IMPORTANCE]),
+     ct:log("2. Uncategorized, importance = ~w", [?STD_IMPORTANCE]),
+     ct:log(info, "3. Categorized info, importance = ~w", [?STD_IMPORTANCE]]),
+     ct:log(info, ?LOW_IMPORTANCE, "4. Categorized info, importance = ~w", [?LOW_IMPORTANCE]),
+     ct:log(error, "5. Categorized error, importance = ~w", [?HI_IMPORTANCE]),
+     ct:log(error, ?HI_IMPORTANCE, "6. Categorized error, importance = ~w", [?MAX_IMPORTANCE]),
 
-        io:format("1. Standard IO, importance = ~w~n", [?STD_IMPORTANCE]),
-        ct:log("2. Uncategorized, importance = ~w", [?STD_IMPORTANCE]),
-        ct:log(info, "3. Categorized info, importance = ~w", [?STD_IMPORTANCE]]),
-        ct:log(info, ?LOW_IMPORTANCE, "4. Categorized info, importance = ~w", [?LOW_IMPORTANCE]),
-        ct:log(error, "5. Categorized error, importance = ~w", [?HI_IMPORTANCE]),
-        ct:log(error, ?HI_IMPORTANCE, "6. Categorized error, importance = ~w", [?MAX_IMPORTANCE]),
+   If starting the test without specifying any verbosity levels:
 
-      If starting the test without specifying any verbosity levels:
+     $ ct_run ...
 
-        $ ct_run ...
+   the following gets printed:
 
-      the following gets printed:
-      
-        1. Standard IO, importance = 50
-        2. Uncategorized, importance = 50
-        3. Categorized info, importance = 50
-        5. Categorized error, importance = 75
-        6. Categorized error, importance = 99
-
-      If starting the test with:
-        
-        $ ct_run -verbosity 1 and info 75
-      
-      the following gets printed:
+     1. Standard IO, importance = 50
+     2. Uncategorized, importance = 50
+     3. Categorized info, importance = 50
+     5. Categorized error, importance = 75
+     6. Categorized error, importance = 99
+
+   If starting the test with:
+
+     $ ct_run -verbosity 1 and info 75
+
+   the following gets printed:
 
-        3. Categorized info, importance = 50
-	4. Categorized info, importance = 25
-        6. Categorized error, importance = 99
-
+ 3. Categorized info, importance = 50 + 4. Categorized info, importance = 25 + 6. Categorized error, importance = 99

How categories can be mapped to CSS tags is documented in the Running Tests diff --git a/lib/dialyzer/doc/src/dialyzer.xml b/lib/dialyzer/doc/src/dialyzer.xml index 4080dfdf77..5e0c9b51e3 100644 --- a/lib/dialyzer/doc/src/dialyzer.xml +++ b/lib/dialyzer/doc/src/dialyzer.xml @@ -4,7 +4,7 @@

- 20062011 + 20062013 Ericsson AB. All Rights Reserved. @@ -288,7 +288,11 @@ Option :: {files, [Filename :: string()]} | {include_dirs, [DirName :: string()]} | {output_file, FileName :: string()} | {output_plt, FileName :: string()} - | {analysis_type, 'succ_typings' | 'plt_add' | 'plt_build' | 'plt_check' | 'plt_remove'} + | {analysis_type, 'succ_typings' | + 'plt_add' | + 'plt_build' | + 'plt_check' | + 'plt_remove'} | {warnings, [WarnOpts]} | {get_warnings, bool()} diff --git a/lib/dialyzer/doc/src/dialyzer_chapter.xml b/lib/dialyzer/doc/src/dialyzer_chapter.xml index d15069991e..be75f1cc65 100644 --- a/lib/dialyzer/doc/src/dialyzer_chapter.xml +++ b/lib/dialyzer/doc/src/dialyzer_chapter.xml @@ -4,7 +4,7 @@
- 20062009 + 20062013 Ericsson AB. All Rights Reserved. @@ -140,7 +140,9 @@ - dialyzer --build_plt -r $ERL_TOP/lib/stdlib/ebin $ERL_TOP/lib/kernel/ebin $ERL_TOP/lib/mnesia/ebin + dialyzer --build_plt -r $ERL_TOP/lib/stdlib/ebin\ + $ERL_TOP/lib/kernel/ebin \ + $ERL_TOP/lib/mnesia/ebin

Dialyzer will look if there is an environment variable called diff --git a/lib/erl_docgen/doc/src/doc-build.xml b/lib/erl_docgen/doc/src/doc-build.xml index 08410a1539..ae1b17dff5 100644 --- a/lib/erl_docgen/doc/src/doc-build.xml +++ b/lib/erl_docgen/doc/src/doc-build.xml @@ -4,7 +4,7 @@

- 19972011 + 19972013 Ericsson AB. All Rights Reserved. @@ -56,7 +56,8 @@

- 1> escript $(ERL_TOP)/lib/erl_docgen/priv/bin/codeline_preprocessing.escript ex1.xmlsrc ex1.xml + 1> escript $(ERL_TOP)/lib/erl_docgen/priv/bin/codeline_preprocessing.escript \ + ex1.xmlsrc ex1.xml diff --git a/lib/inets/doc/src/http_uri.xml b/lib/inets/doc/src/http_uri.xml index bd31ae42d2..d9e8587bbf 100644 --- a/lib/inets/doc/src/http_uri.xml +++ b/lib/inets/doc/src/http_uri.xml @@ -4,7 +4,7 @@
- 20122012 + 20122013 Ericsson AB. All Rights Reserved. @@ -55,7 +55,8 @@ string() = list of ASCII characters

For more information about URI, see RFC 3986.

Gets one or more statistic options for a socket.

+

getstat(Socket) is equivalent to - getstat(Socket, [recv_avg, recv_cnt, recv_dvi, recv_max, recv_oct, send_avg, send_cnt, send_dvi, send_max, send_oct])

+ getstat(Socket, [recv_avg, recv_cnt, recv_dvi, + recv_max, recv_oct, send_avg, send_cnt, send_dvi, send_max, + send_oct]).

The following options are available:

recv_avg diff --git a/lib/odbc/doc/src/odbc.xml b/lib/odbc/doc/src/odbc.xml index 0e3386b11f..a984bf4485 100644 --- a/lib/odbc/doc/src/odbc.xml +++ b/lib/odbc/doc/src/odbc.xml @@ -4,7 +4,7 @@
- 19992011 + 19992013 Ericsson AB. All Rights Reserved. @@ -105,8 +105,14 @@ odbc_data_type() = sql_integer | sql_smallint | sql_tinyint | {sql_decimal, precision(), scale()} | {sql_numeric, precision(), scale()} | - {sql_char, size()} | {sql_wchar, size()} | {sql_varchar, size()} | {sql_wvarchar, size()}| {sql_float, precision()} | - {sql_wlongvarchar, size()} | {sql_float, precision()} | sql_real | sql_double | sql_bit | atom() + {sql_char, size()} | + {sql_wchar, size()} | + {sql_varchar, size()} | + {sql_wvarchar, size()}| + {sql_float, precision()} | + {sql_wlongvarchar, size()} | + {sql_float, precision()} | + sql_real | sql_double | sql_bit | atom() precision() = integer() diff --git a/lib/orber/doc/src/ch_idl_to_erlang_mapping.xml b/lib/orber/doc/src/ch_idl_to_erlang_mapping.xml index 964ae3e92d..1fd2f644cb 100644 --- a/lib/orber/doc/src/ch_idl_to_erlang_mapping.xml +++ b/lib/orber/doc/src/ch_idl_to_erlang_mapping.xml @@ -4,7 +4,7 @@
- 19972010 + 19972013 Ericsson AB. All Rights Reserved. @@ -1142,7 +1142,8 @@ handle_info(_Info, State) -> module, and lookup in DB_Administrator_impl.erlandDB_CommonUser_impl.erl. But wait, is that really necessary? Actually, it is not. We simple use the IC compile option impl:

-$ erlc +'{{impl, "DB::CommonUser"}, "DBUser_impl"}'  +'{{impl, "DB::Administrator"}, "DBUser_impl"}' DB.idl
+$ erlc +'{{impl, "DB::CommonUser"}, "DBUser_impl"}'\
+ +'{{impl, "DB::Administrator"}, "DBUser_impl"}' DB.idl
 $ erlc *.erl

Instead of creating, and not the least, maintaining two call-back modules, diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml index 2ec1fcff9d..b240d53571 100644 --- a/lib/public_key/doc/src/public_key.xml +++ b/lib/public_key/doc/src/public_key.xml @@ -5,7 +5,7 @@

2008 - 2012 + 2013 Ericsson AB, All Rights Reserved @@ -60,8 +60,9 @@

string = [bytes()]

-

pki_asn1_type() = 'Certificate' | 'RSAPrivateKey'| 'RSAPublicKey' - 'DSAPrivateKey' | 'DSAPublicKey' | 'DHParameter' | 'SubjectPublicKeyInfo'| 'PrivateKeyInfo' | 'CertificationRequest'

+

pki_asn1_type() = 'Certificate' | 'RSAPrivateKey'| 'RSAPublicKey' | + 'DSAPrivateKey' | 'DSAPublicKey' | 'DHParameter' | 'SubjectPublicKeyInfo' | + 'PrivateKeyInfo' | 'CertificationRequest'

pem_entry () = {pki_asn1_type(), binary(), %% DER or encrypted DER not_encrypted | cipher_info()}

diff --git a/lib/reltool/doc/src/reltool.xml b/lib/reltool/doc/src/reltool.xml index fbe29753be..8437b7a623 100644 --- a/lib/reltool/doc/src/reltool.xml +++ b/lib/reltool/doc/src/reltool.xml @@ -5,7 +5,7 @@
2009 - 2012 + 2013 Ericsson AB, All Rights Reserved @@ -274,7 +274,8 @@

Example:

-

erl -sasl releases_dir \"mytarget/releases\" -boot mytarget/releases/1.0/myrel -boot_var RELTOOL_EXT_LIB mytarget/lib

+

erl -sasl releases_dir \"mytarget/releases\" -boot mytarget/releases/1.0/myrel\ + -boot_var RELTOOL_EXT_LIB mytarget/lib

incl_sys_filters diff --git a/lib/runtime_tools/doc/src/dbg.xml b/lib/runtime_tools/doc/src/dbg.xml index c7c5cd4ff0..d8c82b2459 100644 --- a/lib/runtime_tools/doc/src/dbg.xml +++ b/lib/runtime_tools/doc/src/dbg.xml @@ -4,7 +4,7 @@
- 19962011 + 19962013 Ericsson AB. All Rights Reserved. @@ -101,7 +101,8 @@ allowed:

 4> dbg:fun2ms(fun([M,N]) when N > X, is_atomm(M)  -> return_trace() end).
-Error: fun containing local erlang function calls ('is_atomm' called in guard) cannot be translated into match_spec
+Error: fun containing local erlang function calls ('is_atomm' called in guard)\
+ cannot be translated into match_spec
 {error,transform_error}
 5> dbg:fun2ms(fun([M,N]) when N > X, is_atom(M)  -> return_trace() end).
 [{['$1','$2'],[{'>','$2',{const,3}},{is_atom,'$1'}],[{return_trace}]}]
diff --git a/lib/ssh/doc/src/using_ssh.xml b/lib/ssh/doc/src/using_ssh.xml index 1a54f3f964..87b811d591 100644 --- a/lib/ssh/doc/src/using_ssh.xml +++ b/lib/ssh/doc/src/using_ssh.xml @@ -5,6 +5,7 @@
2012 + 2013 Ericsson AB. All Rights Reserved. @@ -102,7 +103,8 @@

Use the openssh client from a shell to connect to the Erlang ssh daemon.

- $bash> ssh tarlop -p 8989 -i /tmp/otptest_user/.ssh/id_rsa -o UserKnownHostsFile=/tmp/otptest_user/.ssh/known_hosts + $bash> ssh tarlop -p 8989 -i /tmp/otptest_user/.ssh/id_rsa\ + -o UserKnownHostsFile=/tmp/otptest_user/.ssh/known_hosts The authenticity of host 'tarlop' can't be established. RSA key fingerprint is 14:81:80:50:b1:1f:57:dd:93:a8:2d:2f:dd:90:ae:a8. Are you sure you want to continue connecting (yes/no)? yes @@ -174,8 +176,9 @@ 1> ssh:start(). ok - 2> ssh:daemon(8989, [{system_dir, "/tmp/ssh_daemon"}, {user_dir, "/tmp/otptest_user/.ssh"}, - {subsystems, [ssh_sftpd:subsystem_spec([{cwd, "/tmp/sftp/example"}])]}]). + 2> ssh:daemon(8989, [{system_dir, "/tmp/ssh_daemon"}, + {user_dir, "/tmp/otptest_user/.ssh"}, + {subsystems, [ssh_sftpd:subsystem_spec([{cwd, "/tmp/sftp/example"}])]}]). {ok,<0.54.0>} 3> @@ -183,7 +186,8 @@

Run the openssh sftp client

- $bash> sftp -oPort=8989 -o IdentityFile=/tmp/otptest_user/.ssh/id_rsa -o UserKnownHostsFile=/tmp/otptest_user/.ssh/known_hosts tarlop + $bash> sftp -oPort=8989 -o IdentityFile=/tmp/otptest_user/.ssh/id_rsa\ + -o UserKnownHostsFile=/tmp/otptest_user/.ssh/known_hosts tarlop Connecting to tarlop... sftp> pwd Remote working directory: /tmp/sftp/example diff --git a/lib/stdlib/doc/src/zip.xml b/lib/stdlib/doc/src/zip.xml index cf0d581352..61f49f5940 100644 --- a/lib/stdlib/doc/src/zip.xml +++ b/lib/stdlib/doc/src/zip.xml @@ -217,7 +217,7 @@ {uncompress, What}

Controls what types of files will be uncompressed. It is by - default set to [".Z",".zip",".zoo",".arc",".lzh",".arj"]. + default set to [".Z", ".zip", ".zoo", ".arc", ".lzh", ".arj"]. The following values of What are allowed:

all @@ -355,7 +355,7 @@ {ok,{"dummy.zip", <<80,75,3,4,20,0,0,0,0,0,74,152,97,60,171,39,212,26,3,0, 0,0,3,0,0,...>>}} -> catch zip:foldl(fun("foo", _, B, _) -> throw(B()); (_, _, _, Acc) -> Acc end, [], {Name, Bin}). +> catch zip:foldl(fun("foo", _, B, _) -> throw(B()); (_,_,_,Acc) -> Acc end, [], {Name, Bin}). <<"FOO">> diff --git a/lib/xmerl/doc/src/motorcycles_dtd.txt b/lib/xmerl/doc/src/motorcycles_dtd.txt index bab0d563f0..62ad4ac5fe 100644 --- a/lib/xmerl/doc/src/motorcycles_dtd.txt +++ b/lib/xmerl/doc/src/motorcycles_dtd.txt @@ -15,4 +15,5 @@ + condition (useless | bad | serviceable | moderate | good | + excellent | new | outstanding) "excellent" > -- cgit v1.2.3