summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosh Heidenreich <josh.sickmate@gmail.com>2012-02-09 18:34:00 +1030
committerMichael Meeks <michael.meeks@suse.com>2012-02-09 12:12:08 +0000
commitf27df97df57f9e02736d8058fd69bac35d83d5f1 (patch)
tree70c4bfe5697b466724f26643506ff0d425eee9bc
parent306287528a76e0db1e71ef008dec47f5fe39b100 (diff)
Added and improved READMEs for modules in sdk and testing
-rw-r--r--autodoc/README3
-rw-r--r--cosv/README3
-rw-r--r--odk/README3
-rw-r--r--qadevOOo/README1
-rw-r--r--smoketestoo_native/README1
-rw-r--r--testtools/README (renamed from testtools/readme.txt)22
-rw-r--r--udm/README3
7 files changed, 25 insertions, 11 deletions
diff --git a/autodoc/README b/autodoc/README
new file mode 100644
index 000000000000..c32411a6b406
--- /dev/null
+++ b/autodoc/README
@@ -0,0 +1,3 @@
+Create HTML pages from C++, Java and IDL inline documentation.
+
+Part of the SDK; to build you need to add --enable-odk.
diff --git a/cosv/README b/cosv/README
new file mode 100644
index 000000000000..6f0df4c23787
--- /dev/null
+++ b/cosv/README
@@ -0,0 +1,3 @@
+"Common Services" part of autodoc.
+
+Part of the SDK; to build you need to add --enable-odk.
diff --git a/odk/README b/odk/README
new file mode 100644
index 000000000000..8af3eed6ef2e
--- /dev/null
+++ b/odk/README
@@ -0,0 +1,3 @@
+Office development kit - implements the first step on the way to the LibreOffice SDK tarball.
+
+Part of the SDK; to build you need to add --enable-odk.
diff --git a/qadevOOo/README b/qadevOOo/README
new file mode 100644
index 000000000000..78ea5f91700c
--- /dev/null
+++ b/qadevOOo/README
@@ -0,0 +1 @@
+Testsuite.
diff --git a/smoketestoo_native/README b/smoketestoo_native/README
new file mode 100644
index 000000000000..1027041c8c4c
--- /dev/null
+++ b/smoketestoo_native/README
@@ -0,0 +1 @@
+Smoke test for each component of LibreOffice.
diff --git a/testtools/readme.txt b/testtools/README
index d418da006603..c71e4c8b607d 100644
--- a/testtools/readme.txt
+++ b/testtools/README
@@ -1,29 +1,29 @@
-How to check compatibility between compilers
-============================================
+Testing tools
+
+== How to check compatibility between compilers ==
Since the interfaces used in the cpp bridgetest are not changed often
one can just build the cppobj.uno.dll and the constructors.uno.dll
-(testtools/source/bridgetest) in an
-old environment and then use them in the new environment. That is the files
-are copied into the testtools/wntmsciXX.pro folder which corresponds to the
+(testtools/source/bridgetest) in an
+old environment and then use them in the new environment. That is the files
+are copied into the testtools/wntmsciXX.pro folder which corresponds to the
new environment.
-On Windows this test will typically fail because the tests use the
-cppu::getCaughtException function, which only works when all libs are build
+On Windows this test will typically fail because the tests use the
+cppu::getCaughtException function, which only works when all libs are build
using the same runtime.
-This part of the test can switched off. To do this go into the
+This part of the test can switched off. To do this go into the
testtools/source/bridgetest folder and call
dmake compcheck=1
-This will add a new compiler define (-DCOMPCHECK) and will be used in the
+This will add a new compiler define (-DCOMPCHECK) and will be used in the
bridgetest.cxx to switch off the code which uses the getCaughtException function.
However, there is still a test which causes the test component to throw
and IllegalArgumentException. This still works.
-Using source/bridgetest for stress testing
-==========================================
+== Using source/bridgetest for stress testing ==
Start a modified bridgetest_server (with the final "--singleaccept" argument
removed from the uno executable call) or a modified bridgetest_javaserver (with
diff --git a/udm/README b/udm/README
new file mode 100644
index 000000000000..71e4c8dd9fe8
--- /dev/null
+++ b/udm/README
@@ -0,0 +1,3 @@
+Forms part of autodoc.
+
+Part of the SDK; to build you need to add --enable-odk.