summaryrefslogtreecommitdiffstats
path: root/smoketest/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'smoketest/README.md')
-rw-r--r--smoketest/README.md21
1 files changed, 11 insertions, 10 deletions
diff --git a/smoketest/README.md b/smoketest/README.md
index 30dceb678ff0..5cd48ecb38f9 100644
--- a/smoketest/README.md
+++ b/smoketest/README.md
@@ -1,18 +1,19 @@
+# Smoke Test
Smoke test for each component of LibreOffice.
-* smoketest:
+* `smoketest`:
- The main smoketest.cxx is launched connects via binary UNO
+The main `smoketest.cxx` is launched connects via binary UNO
over a socket to a remote LibreOffice instance. This loads a document
-which is zipped at build time into the workdir/ from the data/
+which is zipped at build time into the `workdir/` from the `data/`
directory. This in turn contains a set of macros in
-data/Basic/Standard.
+`data/Basic/Standard`.
- Smoketest.cxx does a remote the StartTestWithDefaultOptions
-macro and waits for a dispatchFinished from the macro's execution. To
-debug this best load workdir/Zip/smoketestdoc.sxw - and hit 'start
-smoketest' - this will launch a number of components and build a
+`smoketest.cxx` does a remote the `StartTestWithDefaultOptions`
+macro and waits for a `dispatchFinished` from the macro's execution. To
+debug this best load `workdir/Zip/smoketestdoc.sxw` - and hit `start
+smoketest` - this will launch a number of components and build a
suitable report in the form of a table.
- The StarBasic smoketests also log their output, this ends up
-in instdir/user/temp/smoketest.log.
+The StarBasic smoketests also log their output, this ends up
+in `instdir/user/temp/smoketest.log`.