#LyX 2.2 created this file. For more info see http://www.lyx.org/
-\lyxformat 499
+\lyxformat 501
\begin_document
\begin_header
-\origin unavailable
-\textclass scrbook
-\options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
+\origin /systemlyxdir/doc/
+\textclass scrartcl
+\options BCOR8mm,captions=tableheading
\use_default_options false
\begin_modules
logicalmkup
-theorems-ams
-theorems-ams-extended
-multicol
-shapepar
\end_modules
\maintain_unincluded_children false
\begin_local_layout
\language_package default
\inputencoding auto
\fontencoding global
-\font_roman default
-\font_sans default
-\font_typewriter default
-\font_math auto
+\font_roman "lmodern" "default"
+\font_sans "lmss" "default"
+\font_typewriter "lmtt" "default"
+\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
-\font_sf_scale 100
-\font_tt_scale 100
+\font_sf_scale 100 100
+\font_tt_scale 100 100
\graphics default
\default_output_format default
\output_sync 0
\end_layout
-\begin_layout Chapter
+\begin_layout Section
Introduction
\end_layout
development, you may find some interesting information.
\end_layout
-\begin_layout Chapter
+\begin_layout Section
File formats
\end_layout
tion.
\end_layout
-\begin_layout Section
+\begin_layout Subsection
File Format Numbers
\end_layout
-\begin_layout Section
+\begin_layout Subsection
When is an update of the .lyx file format number needed?
\begin_inset CommandInset label
LatexCommand label
If you are still unsure, please ask on the development list.
\end_layout
-\begin_layout Section
+\begin_layout Subsection
How to update the file format number of .lyx files
\end_layout
\begin_layout Enumerate
It would be nice if you could create a .lyx test file which contains instances
of all changed or added features.
- This could then be used to test lyxl2yx and tex2lyx.
+ This could then be used to test lyx2lyx and tex2lyx.
Unfortunately it has not yet been decided how to collect such examples,
so please ask on the development list if you want to create one.
\end_layout
-\begin_layout Section
+\begin_layout Subsection
Backporting new styles to the stable version
\end_layout
version.
\end_layout
-\begin_layout Chapter
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
+\end_layout
+
+\begin_layout Section
Tests
\end_layout
easily, and some tests of this kind exist.
\end_layout
-\begin_layout Section
+\begin_layout Subsection
\SpecialChar LyX
tests
\end_layout
source code distribution.
\end_layout
-\begin_layout Subsection
+\begin_layout Subsubsection
Running the tests
\end_layout
subfolder of the build directory.
\end_layout
-\begin_layout Section
+\begin_layout Subsection
tex2lyx tests
\end_layout
This may be useful for roundtrip comparisons.
\end_layout
-\begin_layout Subsection
+\begin_layout Subsubsection
Running the tests
\end_layout
are output in unified diff format.
\end_layout
-\begin_layout Subsection
+\begin_layout Subsubsection
Updating test references
\begin_inset CommandInset label
LatexCommand label
\end_inset
- subdirectory of the build directory
+ subdirectory of the build directory.
\begin_inset Foot
status collapsed
\end_inset
+ On Windows do the following:
+\end_layout
+
+\begin_layout Itemize
+Assure that the path to the python.exe is in your system PATH variable.
+\end_layout
+
+\begin_layout Itemize
+Double-click on the file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+updatetex2lyxtests.vcxproj
+\end_layout
+
+\end_inset
+
+ in the build directory or in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+src/tex2lyx/test
+\end_layout
+
+\end_inset
+
+ subdirectory of your build directory.
+\end_layout
+
+\begin_layout Itemize
+In the appearing MSVC program right-click on the project
+\family sans
+updatetex2lyxtests
+\family default
+ in the project explorer and chose
+\family sans
+Create
+\family default
.
- For convenience, these commands also produce re-exported roundtrip .lyx.tex
+\end_layout
+
+\begin_layout Standard
+For convenience, these commands also produce re-exported roundtrip .lyx.tex
files.
Please examine the changed output carefully before committing the changed
files to the repository: Since the test machinery does not do a roundtrip
regarding insignificant whitespace and line breaks.
\end_layout
-\begin_layout Subsection
+\begin_layout Subsubsection
Adding a new test
\end_layout
list and ask for committing if you do not have commit rights.
\end_layout
-\begin_layout Section
+\begin_layout Subsection
Export tests
\end_layout
e it is important to keep them up-to-date and understand how they work.
\end_layout
-\begin_layout Subsection
+\begin_layout Subsubsection
Expectations of LyX developers
\end_layout
.
\end_layout
-\begin_layout Subsection
+\begin_layout Subsubsection
Configuring the tests
\end_layout
).
\end_layout
-\begin_layout Subsection
+\begin_layout Subsubsection
Running the tests
\end_layout
status collapsed
\begin_layout Plain Layout
-ctest --print-labels
+ctest \SpecialChar nobreakdash
+\SpecialChar nobreakdash
+print-labels
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
---show-only
+\SpecialChar nobreakdash
+\SpecialChar nobreakdash
+show-only
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
---parallel <jobs>
+\SpecialChar nobreakdash
+\SpecialChar nobreakdash
+parallel <jobs>
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
---timeout <seconds>
+\SpecialChar nobreakdash
+\SpecialChar nobreakdash
+timeout <seconds>
\end_layout
\end_inset
command.
\end_layout
-\begin_layout Subsection
+\begin_layout Subsubsection
\begin_inset CommandInset label
LatexCommand label
name "subsec:Interpreting-export-tests"
file lists the times that it took to run the tests.
\end_layout
-\begin_layout Section
+\begin_layout Subsubsection
+Suspended tests
+\end_layout
+
+\begin_layout Standard
+Some inverted tests are 'suspended'.
+ This means, they are not executed using
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ctest -L export
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ctest -L reverted
+\end_layout
+
+\end_inset
+
+.
+ From time to time they still have to be checked.
+\end_layout
+
+\begin_layout Standard
+These tests are suspended, because they fail 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
+
+\begin_layout Standard
+For ctest commands without the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+-L
+\end_layout
+
+\end_inset
+
+ parameter nothing changes.
+ Suspended or not, tests will be executed depending only on the regexes
+ parameters given to the ctest command.
+\end_layout
+
+\begin_layout Subsection
check_load tests
\end_layout
.
\end_layout
-\begin_layout Section
+\begin_layout Subsection
URL tests
\end_layout
not be taken too seriously.
\end_layout
-\begin_layout Chapter
+\begin_layout Section
Development policies
\end_layout
.
\end_layout
-\begin_layout Section
+\begin_layout Subsection
When to set a fixed milestone?
\end_layout
For all other bugs, do not set a milestone at all.
\end_layout
-\begin_layout Section
+\begin_layout Subsection
Can we add rc entries in stable branch?
\end_layout
We are supposed to increase the prefs2prefs version number with such things.
\end_layout
-\begin_layout Chapter
+\begin_layout Section
Documentation policies
\end_layout
projects / lyx.git / blobdiff