Inherit "Provides color" in *-article.layout

[lyx.git] / lib / doc / Development.lyx

diff --git a/lib/doc/Development.lyx b/lib/doc/Development.lyx
index 2f71706bfb50c6bd0bc0ffae3c74c710f18f249b..11711a26e6bfe545e35a71d4062221cff7ced806 100644 (file)
--- a/lib/doc/Development.lyx
+++ b/lib/doc/Development.lyx
@@ -1547,8 +1547,8 @@ status collapsed
 \end_inset
 
  command line option.
- The test checks for errors reported by LyX (However, error-free export
- is no guarantee for an error-free output document.)
+ The tests checks for errors reported by LyX.
+ (However, error-free export is no guarantee for an error-free output document.)
 \end_layout
 
 \begin_layout Paragraph
@@ -1569,6 +1569,67 @@ When making a non-trivial change to a .layout file, run the export and layout
 \begin_layout Itemize
 When making non-trivial changes to a .lyx file, run the export tests correspondin
 g to that .lyx file.
+ 
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+This rule is due to revision.
+ 
+\end_layout
+
+\begin_layout Plain Layout
+There is an objection from the documentation maintainer that working on
+ the documentation must not be complicated by having to consider non-standard
+ exports.
+\end_layout
+
+\begin_layout Itemize
+successful compiling/testing an edited documentation file with pdflatex
+ suffices to ensure it can be commited, not tests with other exports are
+ required.
+\end_layout
+
+\begin_layout Plain Layout
+If sudden failures with other exports due to “half-tested” documentation
+ updates are a problem for the test maintainer, the test suite should use
+ copies that are 
+\end_layout
+
+\begin_layout Itemize
+copied to a cache dir (autotests/samples/doc/, say) but not changed,
+\end_layout
+
+\begin_layout Itemize
+updated regularely (but on a time chosen by the test suite maintainer) from
+ the originals in lib/doc/
+\end_layout
+
+\begin_layout Plain Layout
+This way, 
+\end_layout
+
+\begin_layout Itemize
+no test will fail due to ongoing work on documentation,
+\end_layout
+
+\begin_layout Itemize
+the documentation is still tested in full (with some delay),
+\end_layout
+
+\begin_layout Itemize
+failures with non-default export can be examined and handled accordingly
+ in one run with the cache update,
+\end_layout
+
+\begin_layout Itemize
+“interesting failures” (like the nested-language+polyglossia problem in
+ es/Customization can be separated and moved into dedicated test samples.
+\end_layout
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Itemize
@@ -1906,6 +1967,17 @@ ctest
 
 \end_inset
 
+.
+ A full, up-to-date TeXLive installation is recommended to run the tests.
+ Otherwise, some tests will fail.
+ Tests with additional requirements are labeled 
+\begin_inset Quotes eld
+\end_inset
+
+unreliable:nonstandard
+\begin_inset Quotes erd
+\end_inset
+
 .
  
 \end_layout
@@ -2062,7 +2134,6 @@ We are still working on getting the tests to run in parallel.
  pass when run sequentially.
  A reasonable approach is to first run the tests in parallel and then run
  the failed tests sequentially.
- 
 \end_layout
 
 \begin_layout Standard
@@ -2097,6 +2168,35 @@ rerun-failed
 
 \end_layout
 
+\begin_layout Standard
+When specifying a subset of the tests (e.g.
+ using 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+\SpecialChar nobreakdash
+R <pattern>
+\end_layout
+
+\end_inset
+
+), the same subset must be specified when using the 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+\SpecialChar nobreakdash
+\SpecialChar nobreakdash
+rerun-failed
+\end_layout
+
+\end_inset
+
+ option because it is the test numbers that are used to index which tests
+ failed on the previous run.
+\end_layout
+
 \begin_layout Standard
 \noindent
 Note that some tests cannot be run in parallel.
@@ -2545,6 +2645,20 @@ reference "par:Unreliable-tests"
 ).
 \end_layout
 
+\begin_layout Itemize
+In case of tests failing due to missing requirements (when only a subset
+ of TeXLive is installed or a test labeled 
+\begin_inset Quotes eld
+\end_inset
+
+unreliable:nonstandard
+\begin_inset Quotes erd
+\end_inset
+
+ fails), ignore the failure, ask for someone else to run the test, or install
+ the missing ressources and try again.
+\end_layout
+
 \begin_layout Paragraph
 \begin_inset CommandInset label
 LatexCommand label