commit 1a4d5b3ce992c22387e0fe9ba52d147517ee982b
Author: Scott Kostyshak <[email protected]>
Date: Thu Oct 29 22:48:28 2015 -0400
Document why tests are enabled for all formats
Explain why the export tests are enabled for formats that are not
expected to work well with certain document classes, modules, or
packages. The reason is that if a .lyx file goes from compiling
successfully for one format (even if that format is not officially
supported for the combination of features used), if that document
suddenly fails to compile, there is a significant chance that a bug
was introduced in LyX. In other words, there is a high signal/noise
ratio. If it is determined that a test is failing because an
expected incompatibility is exposed, then the test can be inverted.
diff --git a/lib/doc/Development.lyx b/lib/doc/Development.lyx
index d02aa68..63903ca 100644
--- a/lib/doc/Development.lyx
+++ b/lib/doc/Development.lyx
@@ -1300,12 +1300,12 @@ Interpreting the export test results
A test can fail for several reasons, not all of them bad.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
The .lyx file could have been added recently and some formats are not expected
to work well.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
A dependency is not met (e.g.
the LaTeX class file).
One hint that this is the case is that the corresponding
@@ -1321,19 +1321,31 @@ check_load
test will likely also fail.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
An export that previously failed to compile now compiles.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
An external dependency was updated (e.g.
TeX Live).
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
A recent code change introduced a bug.
\end_layout
+\begin_layout Enumerate
+\begin_inset CommandInset label
+LatexCommand label
+name "enu:exposed"
+
+\end_inset
+
+A change in a document exposed the incompatibility of that class with an
+ export format (e.g.
+ LuaTeX).
+\end_layout
+
\begin_layout Standard
Because the .lyx files are exported in several formats, it is not surprising
that many of the exports fail.
@@ -1377,7 +1389,7 @@ good
tests.
If the export actually succeeds, then the test will fail.
- The purpose of this failure is to get your attentions—something has changed,
+ The purpose of this failure is to get your attention—something has changed,
possibly for the better.
\end_layout
@@ -1415,6 +1427,20 @@ development/autotests/ignoredTests
\end_inset
.
+ It is possible that an export goes from succeeding to failing just because
+ the document was changed and the document was never expected to work with
+ a certain export format in the first case.
+ Once this is confirmed to be the situation, the test can be inverted.
+\end_layout
+
+\begin_layout Standard
+A good question is why do we enable the tests for non-default formats? The
+ answer is that if a non-default route is broken it is often because a bug
+ 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.
+
\end_layout
\begin_layout Standard
