diff options
Diffstat (limited to 'lib/common_test/doc/src')
| -rw-r--r-- | lib/common_test/doc/src/Makefile | 20 | ||||
| -rw-r--r-- | lib/common_test/doc/src/example_chapter.xml | 12 | ||||
| -rw-r--r-- | lib/common_test/doc/src/notes.xml | 85 |
3 files changed, 97 insertions, 20 deletions
diff --git a/lib/common_test/doc/src/Makefile b/lib/common_test/doc/src/Makefile index a6ece5af28..a2c014418d 100644 --- a/lib/common_test/doc/src/Makefile +++ b/lib/common_test/doc/src/Makefile @@ -1,19 +1,19 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2003-2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2003-2010. All Rights Reserved. +# # The contents of this file are subject to the Erlang Public License, # Version 1.1, (the "License"); you may not use this file except in # compliance with the License. You should have received a copy of the # Erlang Public License along with this software. If not, it can be # retrieved online at http://www.erlang.org/. -# +# # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. -# +# # %CopyrightEnd% # @@ -112,18 +112,16 @@ DVIPS_FLAGS += CT_SRC_DIR = $(ERL_TOP)/../internal_tools/common_test/src -EDOC_ARGS=[{preprocess,true},{includes,["$(XMERL_DIR)/include","../../../test_server/include","../../include","../../../../erts/lib/kernel/include","../../../../lib/kernel/include","../../../../erts/lib/snmp/include","../../../../lib/snmp/include"]}] - - $(HTMLDIR)/%.gif: %.gif $(INSTALL_DATA) $< $@ docs: pdf html man $(CT_XML_FILES): - erl -boot start_clean -noshell \ - -eval 'docb_gen:module("../../src/$(@:%.xml=%.erl)",$(EDOC_ARGS))' \ - -s erlang halt + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -preprocess true -i $(XMERL_DIR)/include \ + -i ../../../test_server/include -i ../../include \ + -i ../../../../erts/lib/kernel/include -i ../../../../lib/kernel/include \ + -i ../../../../erts/lib/snmp/include -i ../../../../lib/snmp/include ../../src/$(@:%.xml=%.erl) $(TOP_PDF_FILE): $(XML_FILES) diff --git a/lib/common_test/doc/src/example_chapter.xml b/lib/common_test/doc/src/example_chapter.xml index 028cbf7c8d..f269dba2cd 100644 --- a/lib/common_test/doc/src/example_chapter.xml +++ b/lib/common_test/doc/src/example_chapter.xml @@ -4,7 +4,7 @@ <chapter> <header> <copyright> - <year>2003</year><year>2009</year> + <year>2003</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>Examples and Templates</title> @@ -38,7 +38,7 @@ <code> -module(db_data_type_SUITE). --include("ct.hrl"). +-include_lib("common_test/include/ct.hrl"). %% Test server callbacks -export([suite/0, all/0, @@ -186,7 +186,7 @@ insert_and_lookup(Key, Value, Config) -> %% Note: This directive should only be used in test suites. -compile(export_all). --include("ct.hrl"). +-include_lib("common_test/include/ct.hrl"). %%-------------------------------------------------------------------- %% COMMON TEST CALLBACK FUNCTIONS @@ -394,7 +394,7 @@ my_test_case(_Config) -> -compile(export_all). --include("ct.hrl"). +-include_lib("common_test/include/ct.hrl"). %%-------------------------------------------------------------------- %% Function: suite() -> Info diff --git a/lib/common_test/doc/src/notes.xml b/lib/common_test/doc/src/notes.xml index 3780d8526e..4f5f6caa8c 100644 --- a/lib/common_test/doc/src/notes.xml +++ b/lib/common_test/doc/src/notes.xml @@ -4,7 +4,7 @@ <chapter> <header> <copyright> - <year>2004</year><year>2009</year> + <year>2004</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>Common Test Release Notes</title> @@ -32,6 +32,85 @@ <file>notes.xml</file> </header> +<section><title>Common_Test 1.4.7</title> + + <section><title>Fixed Bugs and Malfunctions</title> + <list> + <item> + <p> + The auto compilation feature of Common Test did not + recognize if a header file included in a test suite was + modified (if the dir start flag/option was used). This + has been fixed.</p> + <p> + Own Id: OTP-8396 Aux Id: seq11488, OTP-8311 </p> + </item> + </list> + </section> + + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + The tc_status value in the Config list for a test case + that has failed because of a timetrap timeout, has + changed from {tc_status,timeout} to + {tc_status,timetrap_timeout}.</p> + <p> + Own Id: OTP-8302</p> + </item> + <item> + <p>The documentation is now possible to build in an open + source environment after a number of bugs are fixed and + some features are added in the documentation build + process. </p> + <p>- The arity calculation is updated.</p> + <p>- The module prefix used in the function names for + bif's are removed in the generated links so the links + will look like + "http://www.erlang.org/doc/man/erlang.html#append_element-2" + instead of + "http://www.erlang.org/doc/man/erlang.html#erlang:append_element-2".</p> + <p>- Enhanced the menu positioning in the html + documentation when a new page is loaded.</p> + <p>- A number of corrections in the generation of man + pages (thanks to Sergei Golovan)</p> + <p>- The legal notice is taken from the xml book file so + OTP's build process can be used for non OTP + applications.</p> + <p> + Own Id: OTP-8343</p> + </item> + <item> + <p> + It is now possible to include the <c>ct.hrl</c> using the + -include_lib directive. (Thanks to Fred Hebert.)</p> + <p> + Own Id: OTP-8379</p> + </item> + <item> + <p> + The telnet client in Common Test sent [IAC,DO,NOP] to the + server in attempt to keep the connection alive. This is + not a valid sequence according to the standard, and some + telnet servers would terminate the connection because of + it. The client has been changed to send [IAC,NOP] every + 10 secs instead, which should be a valid sequence. The + client does not negotiate this type of "keep alive" + message with the server, and if it causes problems, the + user may disable the keep alive feature by adding + {keep_alive,false} to the telnet configuration data for + the server/connection. Please see the ct_telnet and + unix_telnet manual pages for details.</p> + <p> + Own Id: OTP-8450 Aux Id: OTP-8311 </p> + </item> + </list> + </section> + +</section> + <section><title>Common_Test 1.4.6</title> <section><title>Fixed Bugs and Malfunctions</title> |