~rdoering/ubuntu/karmic/erlang/fix-535090

« back to all changes in this revision

Viewing changes to lib/common_test/doc/src/install_chapter.xml

• browse files at revision 17
• compare with another revision
• download diff
• download tarball
• view history from revision 17

Show diffs side-by-side

added

removed

lib/common_test/doc/src/install_chapter.xml

 

1

<?xml version="1.0" encoding="latin1" ?>

 

2

<!DOCTYPE chapter SYSTEM "chapter.dtd">

 

3

 

 

4

<chapter>

 

5

  <header>

 

6

    <copyright>

 

7

      <year>2007</year>

 

8

      <year>2008</year>

 

9

      <holder>Ericsson AB, All Rights Reserved</holder>

 

10

    </copyright>

 

11

    <legalnotice>

 

12

  The contents of this file are subject to the Erlang Public License,

 

13

  Version 1.1, (the "License"); you may not use this file except in

 

14

  compliance with the License. You should have received a copy of the

 

15

  Erlang Public License along with this software. If not, it can be

 

16

  retrieved online at http://www.erlang.org/.

 

17

 

 

18

  Software distributed under the License is distributed on an "AS IS"

 

19

  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See

 

20

  the License for the specific language governing rights and limitations

 

21

  under the License.

 

22

 

 

23

  The Initial Developer of the Original Code is Ericsson AB.

 

24

    </legalnotice>

 

25

 

 

26

    <title>Installation</title>

 

27

    <prepared>Peter Andersson</prepared>

 

28

    <docno></docno>

 

29

    <date>2007-07-03</date>

 

30

    <rev></rev>

 

31

  </header>

 

32

 

 

33

  <section>

 

34

    <title>Unix</title>

 

35

 

 

36

    <p>Copy the Common Test and Test Server application

 

37

    directories, <c><![CDATA[common_test-<vsn>]]></c> and

 

38

    <c><![CDATA[test_server-<vsn>]]></c>, to a location of your choice. They do

 

39

    not have to be placed among the Erlang applications under the OTP

 

40

    lib directory, nor do they need to have a particular path relative

 

41

    to your test suite modules. In the Common Test directory you

 

42

    find the shell script <c>install.sh</c>. Execute this script

 

43

    to generate the Common Test start script <c>run_test</c> in the

 

44

    sub directory <c><![CDATA[common_test-<vsn>/priv/bin]]></c>.</p>

 

45

 

 

46

    <p><c>install.sh</c> takes one input parameter which specifies the

 

47

    absolute path to the top directory of Common Test and Test

 

48

    Server. (This path is inserted in the <c>run_test</c> script so

 

49

    that when the script starts Erlang, the Erlang code server will be

 

50

    able to load the Common Test and Test Server application

 

51

    modules). Example (assuming Common Test and Test Server have been

 

52

    placed in <c>/usr/local/test_tools</c>):</p>

 

53

 

 

54

    <p><c> 

 

55

    $ install.sh /usr/local/test_tools

 

56

    </c></p>

 

57

 

 

58

    <p>Note that the <c><![CDATA[common_test-<vsn>]]></c> and

 

59

    <c><![CDATA[test_server-<vsn>]]></c> directories must be located under the

 

60

    same top directory for the installation to work properly. Note also

 

61

    that the install script does not e.g. copy files or update environment

 

62

    variables. It only generates the <c>run_test</c> script.</p> 

 

63

    

 

64

    <p>If the directories are later moved, make sure to run <c>install.sh</c>

 

65

    again or edit the <c>run_test</c> script (Bourne shell) manually.</p> 

 

66

 

 

67

    <p>For more information on the <c>run_test</c> script, please see

 

68

    the reference manual.</p>

 

69

    </section>

 

70

 

 

71

  <section>

 

72

    <title>Windows</title>

 

73

 

 

74

    <p>On Windows it is very convenient to use Cygwin (<c>www.cygwin.com</c>)

 

75

    for running Common Test and Erlang, since it enables you to use the

 

76

    <c>run_test</c> script for starting Common Test. If you are a Cygwin

 

77

    user, simply follow the instructions for installing Common Test 

 

78

    on Unix above.</p>

 

79

 

 

80

    <p>If you do not use Cygwin, you have to rely on the API functions

 

81

    in the <c>ct</c> module (instead of <c>run_test</c>) for running

 

82

    Common Test. In this case you do not need to install Common Test

 

83

    (i.e. no need to generate the <c>run_test</c> script). Simply copy the

 

84

    <c><![CDATA[common_test-<vsn>]]></c> and <c><![CDATA[test_server-<vsn>]]></c> 

 

85

    directories to a location of your choice. They do not have to be placed among

 

86

    the Erlang applications under the OTP lib directory, nor do they

 

87

    need to have a particular path relative to your test suite

 

88

    modules.</p>

 

89

 

 

90

    <p>When you start the Erlang node on which you will be running

 

91

    Common Test, make sure the Common Test and Test Server <c>ebin</c> 

 

92

    directories are included in the Erlang code server path (so the

 

93

    application modules can be loaded). If you do copy the application

 

94

    directories to the OTP lib directory, there is no need to

 

95

    explicitly update the code server path as the code server will be

 

96

    able to locate the modules automatically.</p>

 

97

    </section>

 

98

</chapter>

 

99

 

 

100

 

 

101

 

 

102

 

 

103

 

 

104

 

 

105

 

 

106

 

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1