summaryrefslogtreecommitdiff
path: root/smoketest
diff options
context:
space:
mode:
authorHossein <hossein.ir@gmail.com>2021-03-29 21:55:26 +0430
committerAdolfo Jayme Barrientos <fitojb@ubuntu.com>2021-04-07 17:47:16 +0200
commitea5641baeef73af60d025d185901a303844e2d85 (patch)
tree94b343b35e7b8805beb9a1745fe1de2f382574fb /smoketest
parent33da78c21f4243a3e469fb7df79ed1745df70078 (diff)
Updated README.md files to represent current code / use Markdown format
Previously, all of the README files have been renamed to README.md and now, the contents of these files were changed to use Markdown format. Other than format inconsistency, some README.md files lacked information about modules, or were out of date. By using LibreOffice / OpenOffice wiki and other documentation websites, these files were updated. Now every README.md file has a title, and some description. The top-level README.md file is changed to add links to the modules. The result of processing the Markdown format README.md files can be seen at: https://docs.libreoffice.org/ Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424 Tested-by: Jenkins Reviewed-by: Michael Stahl <michael.stahl@allotropia.de> Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
Diffstat (limited to 'smoketest')
-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`.