From ed440c79f3640259a9912e97f29b91284c8c2292 Mon Sep 17 00:00:00 2001 From: Jonathan Robie Date: Wed, 23 Jun 2010 13:44:50 +0000 Subject: Changed README to README.txt throughout the project for consistency. Removed gentools/README.txt, which described Velocity. git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@957201 13f79535-47bb-0310-9956-ffa450edef68 --- cpp/README | 38 ------------------------- cpp/README.txt | 38 +++++++++++++++++++++++++ cpp/boost-1.32-support/README | 8 ------ cpp/boost-1.32-support/README.txt | 8 ++++++ cpp/examples/xml-exchange/README | 53 ----------------------------------- cpp/examples/xml-exchange/README.txt | 53 +++++++++++++++++++++++++++++++++++ cpp/rubygen/README | 17 ------------ cpp/rubygen/README.txt | 17 ++++++++++++ cpp/src/tests/README | 54 ------------------------------------ cpp/src/tests/README.txt | 54 ++++++++++++++++++++++++++++++++++++ 10 files changed, 170 insertions(+), 170 deletions(-) delete mode 100644 cpp/README create mode 100644 cpp/README.txt delete mode 100644 cpp/boost-1.32-support/README create mode 100644 cpp/boost-1.32-support/README.txt delete mode 100644 cpp/examples/xml-exchange/README create mode 100644 cpp/examples/xml-exchange/README.txt delete mode 100644 cpp/rubygen/README create mode 100644 cpp/rubygen/README.txt delete mode 100644 cpp/src/tests/README create mode 100644 cpp/src/tests/README.txt (limited to 'cpp') diff --git a/cpp/README b/cpp/README deleted file mode 100644 index a16dec09c4..0000000000 --- a/cpp/README +++ /dev/null @@ -1,38 +0,0 @@ - Qpid/C++ - ======== - -Table of Contents -================= -1. Introduction -2. Available Documentation -3. Quick start - - -1. Introduction -=============== -Qpid/C++ is a C++ implementation of the AMQP protcol described at -http://amqp.org/ - -This release of Qpid/C++ implements the AMQP 0-10. -It will not inter-operate with AMQP 0-8/0-9 implementations. - -For additional software or information on the Qpid project go to: -http://cwiki.apache.org/qpid/ - - -2. Available Documentation -========================== - - INSTALL - How to install Qpid/C++. - - SSL - How to setup SSL - - RELEASE_NOTES - Release notes. - - DESIGN - Qpid/C++ implementation. - - LICENSE - Apache license. - - NOTICE - Corresponds to the section 4 d of - the Apache License, Version 2.0. - -3. Quick start -============== -If you are impatient to get on, ./configure && make will usually be -sufficient to compile. Running make check will run tests, make install -will install the client and daemon. For more detailed information, -please see the INSTALL notes. diff --git a/cpp/README.txt b/cpp/README.txt new file mode 100644 index 0000000000..a16dec09c4 --- /dev/null +++ b/cpp/README.txt @@ -0,0 +1,38 @@ + Qpid/C++ + ======== + +Table of Contents +================= +1. Introduction +2. Available Documentation +3. Quick start + + +1. Introduction +=============== +Qpid/C++ is a C++ implementation of the AMQP protcol described at +http://amqp.org/ + +This release of Qpid/C++ implements the AMQP 0-10. +It will not inter-operate with AMQP 0-8/0-9 implementations. + +For additional software or information on the Qpid project go to: +http://cwiki.apache.org/qpid/ + + +2. Available Documentation +========================== + - INSTALL - How to install Qpid/C++. + - SSL - How to setup SSL + - RELEASE_NOTES - Release notes. + - DESIGN - Qpid/C++ implementation. + - LICENSE - Apache license. + - NOTICE - Corresponds to the section 4 d of + the Apache License, Version 2.0. + +3. Quick start +============== +If you are impatient to get on, ./configure && make will usually be +sufficient to compile. Running make check will run tests, make install +will install the client and daemon. For more detailed information, +please see the INSTALL notes. diff --git a/cpp/boost-1.32-support/README b/cpp/boost-1.32-support/README deleted file mode 100644 index 3c0edc8697..0000000000 --- a/cpp/boost-1.32-support/README +++ /dev/null @@ -1,8 +0,0 @@ -For example: - -$ cd qpid/cpp/boost-1.32-support # The directory containing this file -$ make apply -[Some untarring and patching] -$ cd .. - -And then build using the normal methods. diff --git a/cpp/boost-1.32-support/README.txt b/cpp/boost-1.32-support/README.txt new file mode 100644 index 0000000000..3c0edc8697 --- /dev/null +++ b/cpp/boost-1.32-support/README.txt @@ -0,0 +1,8 @@ +For example: + +$ cd qpid/cpp/boost-1.32-support # The directory containing this file +$ make apply +[Some untarring and patching] +$ cd .. + +And then build using the normal methods. diff --git a/cpp/examples/xml-exchange/README b/cpp/examples/xml-exchange/README deleted file mode 100644 index 85caebe352..0000000000 --- a/cpp/examples/xml-exchange/README +++ /dev/null @@ -1,53 +0,0 @@ -This example shows how to program a simple application -using the XML Exchange. - -[Note: The XML Exchange is not a standard AMQP exchange type. To run -this example you need to have a broker that has support for the xml -exchange. If you are compiling the broker from source please refer to -the INSTALL notes from qpid.] - -To run the example, execute the programs in the -following order: - -1 ./declare_queues -2 ./listener -3 ./message_producer (in a separate window) - -The XML Exchange must be explicitly declared. Bindings -are established using queries in XQuery. These queries -can reference message content, message application -properties (which are declared as external variables -in the XQuery), or both. - -Once this is done, message producers publish to the -exchange using the exchange name and a routing key, -just as for other exchange types. Message consumers -read from the queues to which messages are routed. -If a message does not have XML content, or is -missing message application properties needed by -the query, the query is not routed. - -Queries can use message application headers to -provide functionality similar to JMS selectors. -If a query does not use the content of a message, -the message content is not parsed, and need not -be XML. - -The XQuery processor, XQilla, does path-based -document projection, so once the portion of -a document needed to evaluate a query has -been read, it stops parsing the document. -Suppose a long document has a header section. -You can indicate in the query that only -one header section needs to be queried, -and there is no need to parse the entire -document to see if there are further header -sections, using a path like this: - -./message/header[1]/date - -If you used a path like this, all children -of the message element would be read to -see if there are further headers: - -./message/header/date diff --git a/cpp/examples/xml-exchange/README.txt b/cpp/examples/xml-exchange/README.txt new file mode 100644 index 0000000000..85caebe352 --- /dev/null +++ b/cpp/examples/xml-exchange/README.txt @@ -0,0 +1,53 @@ +This example shows how to program a simple application +using the XML Exchange. + +[Note: The XML Exchange is not a standard AMQP exchange type. To run +this example you need to have a broker that has support for the xml +exchange. If you are compiling the broker from source please refer to +the INSTALL notes from qpid.] + +To run the example, execute the programs in the +following order: + +1 ./declare_queues +2 ./listener +3 ./message_producer (in a separate window) + +The XML Exchange must be explicitly declared. Bindings +are established using queries in XQuery. These queries +can reference message content, message application +properties (which are declared as external variables +in the XQuery), or both. + +Once this is done, message producers publish to the +exchange using the exchange name and a routing key, +just as for other exchange types. Message consumers +read from the queues to which messages are routed. +If a message does not have XML content, or is +missing message application properties needed by +the query, the query is not routed. + +Queries can use message application headers to +provide functionality similar to JMS selectors. +If a query does not use the content of a message, +the message content is not parsed, and need not +be XML. + +The XQuery processor, XQilla, does path-based +document projection, so once the portion of +a document needed to evaluate a query has +been read, it stops parsing the document. +Suppose a long document has a header section. +You can indicate in the query that only +one header section needs to be queried, +and there is no need to parse the entire +document to see if there are further header +sections, using a path like this: + +./message/header[1]/date + +If you used a path like this, all children +of the message element would be read to +see if there are further headers: + +./message/header/date diff --git a/cpp/rubygen/README b/cpp/rubygen/README deleted file mode 100644 index a1fd6cfec8..0000000000 --- a/cpp/rubygen/README +++ /dev/null @@ -1,17 +0,0 @@ -RUBY CODE GENERATOR - -Run ./generate for usage. -Examples in samples/ - -For example: - ./generate . ../../specs/amqp.0-9.xml samples/Proxy.rb -will generate - - - - - - - - - diff --git a/cpp/rubygen/README.txt b/cpp/rubygen/README.txt new file mode 100644 index 0000000000..a1fd6cfec8 --- /dev/null +++ b/cpp/rubygen/README.txt @@ -0,0 +1,17 @@ +RUBY CODE GENERATOR + +Run ./generate for usage. +Examples in samples/ + +For example: + ./generate . ../../specs/amqp.0-9.xml samples/Proxy.rb +will generate + + + + + + + + + diff --git a/cpp/src/tests/README b/cpp/src/tests/README deleted file mode 100644 index 0f4edee493..0000000000 --- a/cpp/src/tests/README +++ /dev/null @@ -1,54 +0,0 @@ -= Running Qpid C++ tests = - -General philosophy is that "make check" run all tests by default, but -developers can run tests selectively as explained below. - -== Valgrind == - -By default we run tests under valgrind to detect memory errors if valgrind -is present. ./configure --disable-valgrind will disable it. - -Default valgrind options are specified in .valgrindrc-default, which a -checked-in file. The actual options used are in .valgrindrc which is a -local file. Normally it is a copy of valgrindrc-default but you can -modify at will. - -Supressed errors are listed in .valgrind.supp. If you want to change -suppressions for local testing, just modify .valgrindrc to point to a -different file. Do NOT add suppressions to .valgrindrc.supp unless -they are known problems outside of Qpid that can't reasonably be -worked around in Qpid. - - -== Unit Tests == -Unit tests use the boost test framework, and are compiled to rogram - unit_test -There are several options to control how test results are displayed, -see - http://www.boost.org/doc/libs/1_35_0/libs/test/doc/components/utf/parameters/index.html - -NOTE: some unit tests are written as CppUnit plug-ins, we are moving away -from CppUnit so new tests should use the boost framework. - -CppUnit tests are run by the script run-unit-tests. - -== System Tests == - -System tests are self contained AMQP client executables or scripts. -They are listed in the TESTS make variable, which can be over-ridden. - -The ./start_broker "test" launches the broker, ./stop_broker" stops it. -Tests in between assume the broker is running. - -./python_tests: runs ../python/run_tests. This is the main set of -system testss for the broker. - -Other C++ client test executables and scripts under client/test are -system tests for the client. - -By setting TESTS in a make command you can run a different subset of tests -against an already-running broker. - - - - diff --git a/cpp/src/tests/README.txt b/cpp/src/tests/README.txt new file mode 100644 index 0000000000..0f4edee493 --- /dev/null +++ b/cpp/src/tests/README.txt @@ -0,0 +1,54 @@ += Running Qpid C++ tests = + +General philosophy is that "make check" run all tests by default, but +developers can run tests selectively as explained below. + +== Valgrind == + +By default we run tests under valgrind to detect memory errors if valgrind +is present. ./configure --disable-valgrind will disable it. + +Default valgrind options are specified in .valgrindrc-default, which a +checked-in file. The actual options used are in .valgrindrc which is a +local file. Normally it is a copy of valgrindrc-default but you can +modify at will. + +Supressed errors are listed in .valgrind.supp. If you want to change +suppressions for local testing, just modify .valgrindrc to point to a +different file. Do NOT add suppressions to .valgrindrc.supp unless +they are known problems outside of Qpid that can't reasonably be +worked around in Qpid. + + +== Unit Tests == +Unit tests use the boost test framework, and are compiled to rogram + unit_test +There are several options to control how test results are displayed, +see + http://www.boost.org/doc/libs/1_35_0/libs/test/doc/components/utf/parameters/index.html + +NOTE: some unit tests are written as CppUnit plug-ins, we are moving away +from CppUnit so new tests should use the boost framework. + +CppUnit tests are run by the script run-unit-tests. + +== System Tests == + +System tests are self contained AMQP client executables or scripts. +They are listed in the TESTS make variable, which can be over-ridden. + +The ./start_broker "test" launches the broker, ./stop_broker" stops it. +Tests in between assume the broker is running. + +./python_tests: runs ../python/run_tests. This is the main set of +system testss for the broker. + +Other C++ client test executables and scripts under client/test are +system tests for the client. + +By setting TESTS in a make command you can run a different subset of tests +against an already-running broker. + + + + -- cgit v1.2.1