\lyxformat 503
\begin_document
\begin_header
-\origin unavailable
+\origin /systemlyxdir/doc/
\textclass scrartcl
\options BCOR8mm,captions=tableheading
\use_default_options false
logicalmkup
\end_modules
\maintain_unincluded_children false
-\begin_local_layout
-Format 7
-InsetLayout CharStyle:MenuItem
-LyxType charstyle
-LabelString menu
-LatexType command
-LatexName menuitem
-Font
-Family Sans
-EndFont
-Preamble
-\newcommand*{\menuitem}[1]{{\sffamily #1}}
-EndPreamble
-End
-\end_local_layout
\language english
\language_package default
\inputencoding auto
\font_sf_scale 100 100
\font_tt_scale 100 100
\graphics default
-\default_output_format default
+\default_output_format pdf2
\output_sync 0
\bibtex_command default
\index_command default
\papersides 2
\paperpagestyle headings
\tracking_changes false
-\output_changes false
\html_math_output 0
\html_css_as_file 0
+\output_changes false
\html_be_strict true
\end_header
source code distribution.
This document is not translated, since the development language of \SpecialChar LyX
is
- english.
+ English.
If you want to use \SpecialChar LyX
you don't need to read this manual.
However, if you want to learn more about how \SpecialChar LyX
package Any new math package that is automatically loaded needs a file format
update.
The reason for this is that there is no true ERT inset for math formulas:
- Each command is parsed, and if a user happens to defne a local command
+ Each command is parsed, and if a user happens to define a local command
with the same name as a command that triggers an automatic load of a package,
he needs to be able to switch off the automatic loading of that package.
This switch is stored by the
\begin_layout Subsection
How to update the file format number of .lyx files
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:update_lyx_files"
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
so please ask on the development list if you want to create one.
\end_layout
+\begin_layout Enumerate
+\begin_inset CommandInset label
+LatexCommand label
+name "enu:updatefiles"
+
+\end_inset
+
+Update LyX's .lyx documentation files to the new format.
+ The developer who makes the change knows best what changes to expect when
+ inspecting the resulting diff.
+ Because of this, you might be able to catch a bug in the lyx2lyx code that
+ updates the format just by taking a quick scan through the large diff that
+ is the result
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+Another advantage is that if later we suspect a bug in lyx2lyx we can easily
+ see which layout update made an unexpected change by looking at the git
+ log of a .lyx file that suffers the problem.
+\end_layout
+
+\end_inset
+
+.
+ To do this, first make sure that there are no changes to the git repository
+ that you will not want to commit (this is needed because it will be convenient
+ to commit with the command
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+git commit -a
+\end_layout
+
+\end_inset
+
+).
+ Then run the following command in the root folder of the source:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+python development/tools/updatedocs.py
+\end_layout
+
+\end_inset
+
+.
+ Then, revert the change to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LFUNs.lyx
+\end_layout
+
+\end_inset
+
+ because that file is meant to be generated separately:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+git checkout lib/doc/LFUNs.lyx
+\end_layout
+
+\end_inset
+
+
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+TODO: this step should be done within updatedocs.py
+\end_layout
+
+\end_inset
+
+.
+ Look at the resulting changes using the command
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+git diff
+\end_layout
+
+\end_inset
+
+.
+ If anything looks surprising, please investigate.
+ Finally, commit using
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+git commit -a
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection
+Updating the file format number of layout files
+\end_layout
+
+\begin_layout Standard
+See step
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "enu:updatefiles"
+
+\end_inset
+
+ in section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:update_lyx_files"
+
+\end_inset
+
+ but instead of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+updatedocs.py
+\end_layout
+
+\end_inset
+
+ command, use this command:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+python development/tools/updatelayouts.py
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Note that we do not update the local layout of our
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.lyx
+\end_layout
+
+\end_inset
+
+ files because users would then not be able to export to older formats.
+ For example, if a 2.2.0 user exported a template to 2.1.x format and tried
+ to open the file in LyX 2.1.x, there would be an error because the file would
+ contain a local layout whose format is too new.
+ The root reason for this is that we do not support converting layouts to
+ older layout formats, as we do for the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.lyx
+\end_layout
+
+\end_inset
+
+ file format.
+\end_layout
+
+\begin_layout Subsection
+Updating the file format number of bind/ui files
+\end_layout
+
+\begin_layout Standard
+See step
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "enu:updatefiles"
+
+\end_inset
+
+ in section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:update_lyx_files"
+
+\end_inset
+
+ but instead of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+updatedocs.py
+\end_layout
+
+\end_inset
+
+ command, use this command:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+bash development/tools/updatelfuns.sh
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
\begin_layout Subsection
Backporting new styles to the stable version
\end_layout
\end_layout
\begin_layout Subsection
-\SpecialChar LyX
- tests
+unit tests
\end_layout
\begin_layout Standard
-Some tests are located in the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-development/autotests
-\end_layout
-
-\end_inset
-
- subfolder of the \SpecialChar LyX
- source code distribution.
-\end_layout
-
-\begin_layout Subsubsection
-Running the tests
+There are attempts to set up a suite of unit tests for LyX.
\end_layout
\begin_layout Standard
-cmake is required to run the \SpecialChar LyX
- tests, running them is not implemented for
- autotools.
- The \SpecialChar LyX
- tests can be run by the commands
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-ctest
-\end_layout
-
-\end_inset
-
- (all platforms) or
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-make test
-\end_layout
-
-\end_inset
-
- (when using a make based build system and not MSVC) in the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-autotests
-\end_layout
-
-\end_inset
-
- subfolder of the build directory.
+TODO: describe what is done and what is still to do.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Subsection
-Export tests (cmake only)
+ctest automatic tests (cmake only)
\end_layout
\begin_layout Standard
-The export tests are integration tests.
- They take longer to run and are more likely to break than the tex2lyx tests.
- Nevertheless, they have caught many regressions and without a better alternativ
-e it is important to keep them up-to-date and understand how they work.
-\end_layout
+Some tests are located in the
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsubsection
-Expectations of LyX developers
+\begin_layout Plain Layout
+development/autotests
\end_layout
-\begin_layout Standard
-Because the export tests are integration tests and take a long time to run,
- LyX developers are rarely expected to run all of the tests.
- Here are some good practices to follow by developers:
-\end_layout
+\end_inset
-\begin_layout Itemize
-When making a non-trivial change to a .layout file, run the export and layout
- tests corresponding with that .layout file.
+ subfolder of the \SpecialChar LyX
+ source code distribution.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cmake
\end_layout
-\begin_layout Itemize
-When making non-trivial changes to a .lyx file, run the export tests correspondin
-g to that .lyx file.
+\end_inset
+
+ is required to run the automatic \SpecialChar LyX
+ tests, running them is not implemented
+ for autotools.
+
\end_layout
-\begin_layout Itemize
-When making non-trivial changes to LyX's LaTeX export code (e.g.
+\begin_layout Standard
+The \SpecialChar LyX
+ tests can be run by the commands
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ctest
+\end_layout
+
+\end_inset
+
+ (all platforms) or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+make test
+\end_layout
+
+\end_inset
+
+ (when using a make based build system and not MSVC) in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+autotests
+\end_layout
+
+\end_inset
+
+ subfolder of the build directory.
+\end_layout
+
+\begin_layout Subsubsection
+Export tests
+\end_layout
+
+\begin_layout Standard
+The export tests are integration tests.
+ They take longer to run and are more likely to break than the tex2lyx tests.
+ Nevertheless, they have caught many regressions and without a better alternativ
+e it is important to keep them up-to-date and understand how they work.
+\end_layout
+
+\begin_layout Standard
+The export tests
+\begin_inset Quotes eld
+\end_inset
+
+reuse
+\begin_inset Quotes erd
+\end_inset
+
+ documentation, template, and example files trying to export them to all
+ supported output formats.
+ In addition, there are a number of dedicated sample documents under
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+autotests/export/
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Paragraph
+Expectations of LyX developers
+\end_layout
+
+\begin_layout Standard
+Because the export tests are integration tests and take a long time to run,
+ LyX developers are rarely expected to run all of the tests.
+ Here are some good practices to follow by developers:
+\end_layout
+
+\begin_layout Itemize
+When making a non-trivial change to a .layout file, run the export and layout
+ tests corresponding with that .layout file.
+\end_layout
+
+\begin_layout Itemize
+When making non-trivial changes to a .lyx file, run the export tests correspondin
+g to that .lyx file.
+\end_layout
+
+\begin_layout Itemize
+When making non-trivial changes to LyX's \SpecialChar LaTeX
+ export code (e.g.
touching the encoding code or package handling code that you expect will
- change the exported LaTeX in some way), consider running all of the export
- tests before and after your change.
+ change the exported \SpecialChar LaTeX
+ in some way):
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+\paragraph_spacing single
+Consider running all of the export tests before and after your change.
If there are differences, please reconcile these (i.e.
fix the bug or fix the tests)
\emph on
before
\emph default
committing.
- Ask for help if you're not sure what to do or if you do not want to run
- the tests, post the patch on the list and others will run the tests.
+ Ask for help if you're not sure what to.
+\end_layout
+
+\begin_layout Standard
+If you do not want to run the tests,
+\end_layout
+
+\begin_layout Itemize
+post the patch on the list and others will run the tests and eventually
+ ask for fixes, or
\end_layout
+\begin_layout Itemize
+commit, but be prepared to fix eventually arising problems or to revert
+ the commit if there is no easy fix.
+\end_layout
+
+\end_deeper
\begin_layout Itemize
Understand how to interpret test failures.
If your commit is found to have broken a test, you should be able to interpret
.
\end_layout
-\begin_layout Subsubsection
-Configuring the tests
+\begin_layout Paragraph
+\begin_inset CommandInset label
+LatexCommand label
+name "par:Configuring-ctests"
+
+\end_inset
+
+Configuring the tests
\end_layout
\begin_layout Standard
-To enable these tests, add the
+To enable the export autotests, add the
\begin_inset Flex Code
status collapsed
).
\end_layout
-\begin_layout Subsubsection
+\begin_layout Paragraph
Running the tests
\end_layout
\end_inset
.
- To run only some of the tests, use the command
+
+\end_layout
+
+\begin_layout Standard
+To run only some of the tests, use command line options:
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring -R
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+-R <pattern>
\end_layout
\end_inset
-, where
+ Run only the tests whose names match the given regular expression.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring -R
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<pattern>
\end_layout
\end_inset
- is a regular expression that matches test names.
- To run only the export tests, you can use
+ Run only the tests whose labels match the given regular expression.
+ A test may have more that one label.
+
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+For example, to run only the export tests, you can use
\begin_inset Flex Code
status collapsed
\end_inset
.
- For the list of test categories available in addition to
-\begin_inset Quotes eld
-\end_inset
-
-export
-\begin_inset Quotes erd
-\end_inset
+\end_layout
-, run
+\end_deeper
+\begin_layout Labeling
+\labelwidthstring -R
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ctest \SpecialChar nobreakdash
-\SpecialChar nobreakdash
-print-labels
+-E <pattern>
\end_layout
\end_inset
-.
- It is often useful to list the tests without running them (e.g.
- if you want to know how many tests there are or whether your
+ Exclude the tests whose names match the given regular expression.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring -R
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<pattern>
\end_layout
\end_inset
- regular expression did what you expected).
- This can be done with the
+ Exclude the tests whose labels match the given regular expression.
+\end_layout
+
+\begin_layout Standard
+The following options help to find good selection patterns:
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring -R
\begin_inset Flex Code
status collapsed
\end_inset
- or
+ List the tests that would be run but not actually run them.
+
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+Useful in conjunction with the -R, -L, -E and -LE options, e.g., if you want
+ to know how many tests there are or whether your
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\SpecialChar nobreakdash
-\SpecialChar nobreakdash
-show-only
+<pattern>
\end_layout
\end_inset
- argument.
- We are still working on getting the tests to run in parallel which is supported
- by the
+ regular expression did what you expected.
+\end_layout
+
+\end_deeper
+\begin_layout Labeling
+\labelwidthstring -R
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ctest
+\SpecialChar nobreakdash
+\SpecialChar nobreakdash
+print-labels
\end_layout
\end_inset
- command with the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
--j <jobs>
+ print the list of all labels associated with the test set.
+ Can also be combined with -R, -L, -E, ...
+
\end_layout
-\end_inset
+\begin_layout Standard
+Other relevant options are:
+\end_layout
- or
+\begin_layout Labeling
+\labelwidthstring -R
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\SpecialChar nobreakdash
-\SpecialChar nobreakdash
-parallel <jobs>
+-j <jobs>
\end_layout
\end_inset
- argument.
+ Run the tests in parallel using the given number of jobs.
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+We are still working on getting the tests to run in parallel.
However, when running the tests in parallel, sometimes tests fail that
pass when run sequentially.
A reasonable approach is to first run the tests in parallel and then run
the failed tests sequentially.
- For example, to run 8 jobs at a time:
+
+\end_layout
+
+\begin_layout Standard
+For example, to run 8 jobs at a time:
\end_layout
\begin_layout Standard
CMake property.
\end_layout
-\begin_layout Standard
-In some situations the option
+\end_deeper
+\begin_layout Labeling
+\labelwidthstring -R
\begin_inset Flex Code
status collapsed
\end_inset
- is useful.
- There have been bugs in LyX and in LaTeX which cause compilation to hang,
- and without a timeout a test might never stop (in one case there was even
- a memory leak).
+ Set a global timeout on all tests that do not already have a timeout set
+ on them.
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+There have been bugs in LyX and in \SpecialChar LaTeX
+ which cause compilation to hang, and
+ without a timeout a test might never stop (in one case there was even a
+ memory leak).
If a test times out, the
\begin_inset Flex Code
status collapsed
command.
\end_layout
-\begin_layout Subsubsection
+\end_deeper
+\begin_layout Standard
+See the manual (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+man ctest
+\end_layout
+
+\end_inset
+
+) the full list of command line options.
+\end_layout
+
+\begin_layout Paragraph
\begin_inset CommandInset label
LatexCommand label
name "subsec:Interpreting-export-tests"
\begin_layout Enumerate
A dependency is not met (e.g.
- the LaTeX class file).
+ the \SpecialChar LaTeX
+ class file).
One hint that this is the case is that the corresponding
\begin_inset Flex Code
-status open
+status collapsed
\begin_layout Plain Layout
check_load
\end_layout
\begin_layout Enumerate
-An export that previously failed to compile now compiles.
+An inverted test fails to fail (i.e.
+ export that previously failed now works).
\end_layout
\begin_layout Enumerate
An external dependency was updated (e.g.
- TeX Live).
+ \SpecialChar TeX
+ Live).
\end_layout
\begin_layout Enumerate
\end_inset
-A change in a document exposed the incompatibility of that class with an
- export format (e.g.
- LuaTeX).
+A change in a document exposed a previously unknown bug or an incompatibility
+ with an export format (e.g.
+ Lua\SpecialChar LaTeX
+).
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-development/autotests/revertedTests
+development/autotests/suspiciousTests
\end_layout
\end_inset
was introduced in LyX and not because a document-specific change was made
that is not supported by the route.
In other words, there is a high signal/noise ratio in the export tests
- for the non-default formats.
+ for some non-default formats.
+
+\end_layout
+
+\begin_layout Standard
+What action should you take if a test fails? This depends:
+\end_layout
+
+\begin_layout Standard
+Generally, if a change breaks compilation for the target format (for the
+ manuals pdf2) without solving some important other issue, fix or revert
+ the commit that led to failure.
+ If a change breaks compilation for some non-target format (for the manuals
+ everything except pdf2), invert the test.
\end_layout
\begin_layout Standard
-What action should you take if a test fails? First, check manually that
- when the compilation succeeded before the resulting PDF was good.
- In fact, sometimes it is an improvement when a test fails.
- If you check manually, it might be the case that the export was succeeding
- before but showing garbled text in a PDF output.
+A special case is given, if the export was succeeding before but showing
+ garbled text in the PDF output.
+ Try to establish, that when the compilation succeeded before the resulting
+ PDF was good.
+ Otherwise, it is in fact an improvement when a test fails.
Now it might fail with a clear message of "language xyz not supported".
It is always good to check manually why something fails and if it passes
if the PDF output is good.
\end_layout
\begin_layout Standard
-Sometimes a test is fixed by accident.
+Sometimes a test is fixed as side-effect of some change.
We should uninvert a test (remove it from the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-revertedTests
+suspiciousTests
\end_layout
\end_inset
file lists the times that it took to run the tests.
\end_layout
-\begin_layout Subsubsection
+\begin_layout Paragraph
Inverted tests
\end_layout
\begin_layout Standard
-These tests are expected to always fail.
+These tests fail if the export does
+\emph on
+not
+\emph default
+ return an error.
+
\end_layout
\begin_layout Description
-reverted These tests are expected to fail, but are subject to be examined.
- It is expected that they will pass in a foreseeable future.
- They are labeled 'reverted'.
+inverted Export fails, but the test cases are subject to be examined.
+ It is expected that the export will work in a foreseeable future.
+ They are labeled 'inverted'.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ctest -L reverted
+ctest -L inverted
\end_layout
\end_inset
\begin_deeper
\begin_layout Standard
-These tests are suspended, because they fail for known reasons which cannot
- ATM be resolved.
+These tests are suspended, because the export fails for known reasons which
+ cannot ATM be resolved.
But it is expected the reason might disappear in the future.
Be it new TL or better handling in \SpecialChar LyX
.
\end_layout
\end_deeper
-\begin_layout Subsubsection
+\begin_layout Paragraph
Unreliable tests
\end_layout
-\begin_layout Description
-nonstandard In primary sense such test means "requires non-standard ressources
- (LaTeX packages and document classes, fonts, ...
- that are not a requirement for running this test suite".
+\begin_layout Standard
+These tests are not executed using
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ctest -L export
\end_layout
-\begin_deeper
-\begin_layout Standard
-In a wider sense, it is currently used also for "not to be expected to succeed
- on every site that runs this test suite".
- This wider definition includes tests that have "arbitrary" result depending
- on local configuration, OS, TeX distribution, package versions, or the
- phase of the moon.
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ctest -L inverted
+\end_layout
+
+\end_inset
+
+.
+
\end_layout
\begin_layout Standard
-These tests are labeled as
-\family typewriter
-'nonstandard'.
+They pass or fail for various reasons not related to LyX (nonstandard, erratic)
+ or pass but should rather fail (wrong output).
\end_layout
-\end_deeper
\begin_layout Description
-erratic Tests depending on local configuration, OS, TeX distribution, package
- versions, or the phase of the moon.
+nonstandard Documents with additional requirements, e.g.
+ a class or package file not on CTAN.
+
+\begin_inset Note Note
+status open
+
+\begin_layout Plain Layout
+TODO: rename to "extra"?
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_deeper
\begin_layout Standard
These tests are labeled as
\family typewriter
-'erratic'.
+'nonstandard'.
\end_layout
\end_deeper
-\begin_layout Subsection
-check_load tests
-\end_layout
-
-\begin_layout Standard
-These tests check whether a .lyx file loads without any terminal messages.
- They correspond to the manual operations of simply opening a .lyx file on
+\begin_layout Description
+erratic Tests depending on local configuration, OS, TeX distribution, package
+ versions, or the phase of the moon.
+
+\begin_inset Note Note
+status open
+
+\begin_layout Plain Layout
+TODO: use
+\emph on
+erratic
+\emph default
+ only for the phase-of-moon dependency.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+These tests are labeled as
+\family typewriter
+'erratic'.
+\end_layout
+
+\end_deeper
+\begin_layout Description
+wrong
+\begin_inset space ~
+\end_inset
+
+output Export does not fail but the resulting document has errors.
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+\paragraph_spacing single
+These tests are actually not
+\emph on
+unreliable
+\emph default
+ but
+\emph on
+invalid
+\emph default
+ (not measuring what they should measure).
+\end_layout
+
+\end_deeper
+\begin_layout Paragraph
+Export test filtering
+\end_layout
+
+\begin_layout Standard
+The assignment of a label to a test is controlled by a set of files with
+ regular expressions that are matched against the test names.
+\end_layout
+
+\begin_layout Description
+ignoredTests (small file)
+\begin_inset Newline newline
+\end_inset
+
+Tests selected here are withdrawn in the configuration step (cf.
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "par:Configuring-ctests"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_deeper
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Input Test of any export combination
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Output Stop if tests not selected here
+\end_layout
+
+\end_deeper
+\begin_layout Description
+unreliableTests: Tests selected either pass or fail, but that is dependent
+ on the system where the test is run.
+ Selected tests gain the label 'unreliable'.
+\end_layout
+
+\begin_deeper
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Input Each test which passed 'ignoredTests'
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Output Stop if test selected, gain label 'unreliable'.
+\end_layout
+
+\end_deeper
+\begin_layout Description
+suspiciousTests
+\begin_inset space \space{}
+\end_inset
+
+
+\end_layout
+
+\begin_deeper
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Input Each test which passed 'unreliableTests'
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Output Stop if not selected.
+\end_layout
+
+\begin_layout Standard
+The following file is meant as subselections of 'suspiciousTests'.
+ If neither subselection applies, test gains labels 'export' and 'inverted'
+\end_layout
+
+\begin_layout Description
+suspendedTests Tests selected here gain the label 'suspended' but _not_
+ 'export' or 'inverted', although in ctest they remain inverted.
+ ('ctest' knows only 'inverted' or not, labels are used only for test selection)
+\end_layout
+
+\begin_deeper
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Input Each test selected by 'suspiciousTests'
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Output Selected test gains label 'suspended'.
+
+\end_layout
+
+\end_deeper
+\end_deeper
+\begin_layout Standard
+The following table may clarify label assignement
+\end_layout
+
+\begin_layout Standard
+\begin_inset Tabular
+<lyxtabular version="3" rows="7" columns="12">
+<features tabularvalignment="middle">
+<column alignment="left" valignment="top" width="0pt">
+<column alignment="left" valignment="top" width="0pt">
+<column alignment="left" valignment="top" width="0pt">
+<column alignment="left" valignment="top" width="0pt">
+<column alignment="center" valignment="top">
+<column alignment="center" valignment="top">
+<column alignment="center" valignment="top">
+<column alignment="center" valignment="top">
+<column alignment="center" valignment="top">
+<column alignment="center" valignment="top">
+<column alignment="center" valignment="top">
+<column alignment="center" valignment="top">
+<row>
+<cell multicolumn="1" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Test found in file:
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Marked in ctest, Assigned label
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="center" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Ignored
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Unreliable
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Suspicious
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Suspended
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+export
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+unreliable
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+inverted
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+suspended
+\end_layout
+
+\end_inset
+</cell>
+<cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Yes
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+No
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Yes
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
++
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell multirow="4" alignment="left" valignment="middle" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+No
+\end_layout
+
+\end_inset
+</cell>
+<cell multirow="3" alignment="left" valignment="middle" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Yes
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Yes
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
++
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
++
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+No
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
++
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
++
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
++
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+No
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
++
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+check_load tests
+\end_layout
+
+\begin_layout Standard
+These tests check whether a .lyx file loads without any terminal messages.
+ They correspond to the manual operations of simply opening a .lyx file on
the terminal, exiting LyX once the file is loaded, and then checking whether
there is any output from the terminal.
These tests are useful for catching malformed .lyx files and parsing bugs.
Under cmake, the tests are labeled as 'load'.
\end_layout
-\begin_layout Subsection
-URL tests (cmake only)
+\begin_layout Subsubsection
+lyx21 tests
+\end_layout
+
+\begin_layout Standard
+These tests combine lyx2lyx tests with check_load tests.
+ They fail if either fails.
+\end_layout
+
+\begin_layout Subsubsection
+URL tests
\end_layout
\begin_layout Standard
'url'.
\end_layout
-\begin_layout Subsubsection
+\begin_layout Paragraph
Running URL tests
\end_layout
\begin_inset Newline newline
\end_inset
-runns all tests with label
+runs all tests with label
\family typewriter
'url'
\end_layout
\begin_inset Newline newline
\end_inset
-runns the tests 'check_accessible_urls'
+runs the tests 'check_accessible_urls'
\end_layout
\begin_layout Standard
of the form 'LastFailed.*URLS.log'
\end_layout
-\begin_layout Subsection
-Test labels (cmake only)
+\begin_layout Subsubsection
+Test labels
\end_layout
\begin_layout Standard
\begin_inset space ~
\end_inset
-labelname executes all tests to which this label is asigned to.
+labelname executes all tests to which this label is assigned to.
A test may have more that one label.
\end_layout
projects / lyx.git / blobdiff