1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
8 \options BCOR8mm,captions=tableheading
9 \use_default_options false
13 \maintain_unincluded_children false
15 \language_package default
18 \font_roman "lmodern" "default"
19 \font_sans "lmss" "default"
20 \font_typewriter "lmtt" "default"
21 \font_math "auto" "auto"
22 \font_default_family default
23 \use_non_tex_fonts false
26 \font_sf_scale 100 100
27 \font_tt_scale 100 100
29 \default_output_format pdf2
31 \bibtex_command default
32 \index_command default
36 \pdf_title "LyX's Development manual"
37 \pdf_author "LyX Team"
38 \pdf_subject "LyX's development documentation"
39 \pdf_keywords "LyX, Documentation, Development"
41 \pdf_bookmarksnumbered true
42 \pdf_bookmarksopen true
43 \pdf_bookmarksopenlevel 1
48 \pdf_pdfusetitle false
49 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
52 \use_package amsmath 1
53 \use_package amssymb 1
56 \use_package mathdots 1
57 \use_package mathtools 0
59 \use_package stackrel 0
60 \use_package stmaryrd 0
61 \use_package undertilde 0
63 \cite_engine_type default
67 \paperorientation portrait
71 \notefontcolor #0000ff
78 \paragraph_separation indent
79 \paragraph_indentation default
80 \quotes_language english
83 \paperpagestyle headings
84 \tracking_changes false
94 Developing \SpecialChar LyX
98 \begin_layout Subtitle
103 by the \SpecialChar LyX
108 \begin_layout Plain Layout
110 If you have comments or error corrections, please send them to the \SpecialChar LyX
113 \begin_inset Flex Code
116 \begin_layout Plain Layout
118 <lyx-docs@lists.lyx.org>
131 \begin_layout Standard
132 \begin_inset CommandInset toc
133 LatexCommand tableofcontents
140 \begin_layout Section
144 \begin_layout Standard
145 This manual documents some aspects of \SpecialChar LyX
147 It is currently rather incomplete, but will hopefully be extended in the
149 Meanwhile, additional information can be found in the
150 \begin_inset Flex Code
153 \begin_layout Plain Layout
159 subfolder of the \SpecialChar LyX
160 source code distribution.
161 This document is not translated, since the development language of \SpecialChar LyX
164 If you want to use \SpecialChar LyX
165 you don't need to read this manual.
166 However, if you want to learn more about how \SpecialChar LyX
167 is developed, or even want
168 to participate in \SpecialChar LyX
169 development, you may find some interesting information.
172 \begin_layout Section
176 \begin_layout Standard
178 uses several custom file formats for configuration files and documents.
179 This chapter contains some background concerning these file formats.
180 Several file formats are also described in detail in the regular user documenta
184 \begin_layout Subsection
188 \begin_layout Subsection
189 When is an update of the .lyx file format number needed?
190 \begin_inset CommandInset label
192 name "sec:When-is-an"
199 \begin_layout Standard
200 When you are working on a new feature you may ask yourself whether it needs
201 an update of the .lyx file format number.
202 Whether an update is needed or not is not always obvious.
203 Below you can find a list of reasons for file format updates with explanations:
206 \begin_layout Description
215 setting Whenever you introduce a new setting that is stored in the document
216 header, a file format update is needed.
217 This is also true if you add a new valid value to an existing setting,
219 \begin_inset space \thinspace{}
223 \begin_inset space \space{}
226 a new language that is stored in
227 \begin_inset Flex Code
230 \begin_layout Plain Layout
241 \begin_layout Description
250 setting If a certain setting becomes obsolete and gets removed, a file format
254 \begin_layout Description
259 inset Of course a new inset requires a file format update.
262 \begin_layout Description
267 style in any layout file or module shipped with \SpecialChar LyX
268 , or new shipped layout
270 These requirements are currently under discussion and might change in the
274 \begin_layout Description
287 package Any new math package that is automatically loaded needs a file format
289 The reason for this is that there is no true ERT inset for math formulas:
290 Each command is parsed, and if a user happens to define a local command
291 with the same name as a command that triggers an automatic load of a package,
292 he needs to be able to switch off the automatic loading of that package.
293 This switch is stored by the
294 \begin_inset Flex Code
297 \begin_layout Plain Layout
306 \begin_layout Standard
307 If you are still unsure, please ask on the development list.
310 \begin_layout Subsection
311 How to update the file format number of .lyx files
312 \begin_inset CommandInset label
314 name "subsec:update_lyx_files"
321 \begin_layout Standard
322 Once you came to the conclusion that a file format update is needed you
323 should use the following procedure to perform the update:
326 \begin_layout Enumerate
327 Implement and test the new feature, including the reading and writing of
329 Note that any file produced at this stage does not use a valid format,
330 so do not use this version of \SpecialChar LyX
331 for working on any important documents.
334 \begin_layout Enumerate
335 \begin_inset CommandInset label
337 name "enu:Describe_format"
341 Describe the new format in
342 \begin_inset Flex Code
345 \begin_layout Plain Layout
354 \begin_layout Enumerate
355 Update the \SpecialChar LyX
356 file format number in
357 \begin_inset Flex Code
360 \begin_layout Plain Layout
369 \begin_layout Enumerate
370 Update the range of file formats in the array
371 \begin_inset Flex Code
374 \begin_layout Plain Layout
381 \begin_inset Flex Code
384 \begin_layout Plain Layout
393 \begin_layout Enumerate
394 \begin_inset CommandInset label
396 name "enu:Add-an-entry"
400 Add an entry to both format lists (for conversion and reversion) in
401 \begin_inset Newline newline
405 \begin_inset Flex Code
408 \begin_layout Plain Layout
409 lib/lyx2lyx/lyx_2_2.py
415 Add a conversion routine if needed (e.
416 \begin_inset space \thinspace{}
420 \begin_inset space \space{}
423 a new header setting always needs a conversion that adds the new setting,
424 a new document language does not need one).
425 Add a reversion routine if needed.
426 While the conversion routine is required to produce a document that is
427 equivalent to the old version, the requirements of the reversion are not
429 If possible, try to produce a proper reversion, using ERT if needed, but
430 for some features this might be too complicated.
431 In this case, the minimum requirement of the reversion routine is that
432 it produces a valid document which can be read by an older \SpecialChar LyX
434 If absolutely needed, even data loss is allowed for the reversion.
437 \begin_layout Enumerate
438 Since tex2lyx has several implicit file format dependencies caused by sharing
439 code with \SpecialChar LyX
440 , updating the file format of .lyx files produced by tex2lyx at
441 the same time as updating the main .lyx file format is strongly recommended.
442 Therefore, a compiler warning will be issued if the \SpecialChar LyX
443 and tex2lyx .lyx file
444 format numbers differ.
445 In many cases the tex2lyx update requires only the first and last item
447 \begin_inset Separator parbreak
454 \begin_layout Enumerate
455 Update the tex2lyx file format number in
456 \begin_inset Flex Code
459 \begin_layout Plain Layout
468 \begin_layout Enumerate
469 If the lyx2lyx conversion from the old to the new format is empty, or if
470 tex2lyx does not yet output the changed feature, you do not need any further
472 Otherwise, search for the changed feature in tex2lyx, and adjust the output
473 according to the lyx2lyx changes.
476 \begin_layout Enumerate
477 Update the tex2lyx test references as described in
478 \begin_inset CommandInset ref
479 LatexCommand formatted
480 reference "sec:Updating-test-references"
488 \begin_layout Enumerate
489 If you did not implement full tex2lyx support of the new feature, add a
491 \begin_inset Flex Code
494 \begin_layout Plain Layout
500 describing the missing bits.
501 Note that it is perfectly fine if you do not add full tex2lyx support for
502 a new feature: The updating recommendation above is only issued for the
503 syntax of the produced .lyx file.
504 It is no problem if some features supported by \SpecialChar LyX
505 are still output as ERT
506 by tex2lyx, since the problems in the past that resulted in the update
507 recommendation were related to mixed version syntax, not ERT.
510 \begin_layout Enumerate
511 It would be nice if you could create a .lyx test file which contains instances
512 of all changed or added features.
513 This could then be used to test lyx2lyx and tex2lyx.
514 Unfortunately it has not yet been decided how to collect such examples,
515 so please ask on the development list if you want to create one.
518 \begin_layout Enumerate
519 \begin_inset CommandInset label
521 name "enu:updatefiles"
525 Update LyX's .lyx documentation files to the new format.
526 The developer who makes the change knows best what changes to expect when
527 inspecting the resulting diff.
528 Because of this, you might be able to catch a bug in the lyx2lyx code that
529 updates the format just by taking a quick scan through the large diff that
531 \begin_inset Note Note
534 \begin_layout Plain Layout
535 Another advantage is that if later we suspect a bug in lyx2lyx we can easily
536 see which layout update made an unexpected change by looking at the git
537 log of a .lyx file that suffers the problem.
543 To do this, first make sure that there are no changes to the git repository
544 that you will not want to commit (this is needed because it will be convenient
545 to commit with the command
546 \begin_inset Flex Code
549 \begin_layout Plain Layout
556 Then run the following command in the root folder of the source:
557 \begin_inset Flex Code
560 \begin_layout Plain Layout
561 python development/tools/updatedocs.py
567 Look at the resulting changes using the command
568 \begin_inset Flex Code
571 \begin_layout Plain Layout
578 If anything looks surprising, please investigate.
579 Keep in mind that the case of
580 \begin_inset Flex Code
583 \begin_layout Plain Layout
589 is special, because it is first generated with
590 \begin_inset Flex Code
593 \begin_layout Plain Layout
599 before being converted to the latest format.
600 Finally, commit using
601 \begin_inset Flex Code
604 \begin_layout Plain Layout
613 \begin_layout Subsection
614 Updating the file format number of layout files
617 \begin_layout Standard
619 \begin_inset CommandInset ref
621 reference "enu:updatefiles"
626 \begin_inset CommandInset ref
628 reference "subsec:update_lyx_files"
633 \begin_inset Flex Code
636 \begin_layout Plain Layout
642 command, use this command:
643 \begin_inset Flex Code
646 \begin_layout Plain Layout
647 python development/tools/updatelayouts.py
655 \begin_layout Standard
656 Note that we do not update the local layout of our
657 \begin_inset Flex Code
660 \begin_layout Plain Layout
666 files because users would then not be able to export to older formats.
667 For example, if a 2.2.0 user exported a template to 2.1.x format and tried
668 to open the file in LyX 2.1.x, there would be an error because the file would
669 contain a local layout whose format is too new.
670 The root reason for this is that we do not support converting layouts to
671 older layout formats, as we do for the
672 \begin_inset Flex Code
675 \begin_layout Plain Layout
684 \begin_layout Subsection
685 Updating the file format number of bind/ui files
688 \begin_layout Standard
689 A change to the functionality of existing LFUNs can require a conversion
691 \begin_inset Flex Code
694 \begin_layout Plain Layout
701 \begin_inset Flex Code
704 \begin_layout Plain Layout
710 files, and therefore an increment of the LFUN format, as well as a conversion
712 \begin_inset Flex Code
715 \begin_layout Plain Layout
722 The latter cannot be done automatically and requires also a \SpecialChar LyX
725 someone who might have made a set of \SpecialChar LyX
726 teaching manuals for use in their
731 \begin_layout Plain Layout
732 \begin_inset Flex URL
735 \begin_layout Plain Layout
737 http://www.lyx.org/trac/ticket/9794
750 \begin_layout Enumerate
751 Increment the LFUN file format number in
752 \begin_inset Flex Code
755 \begin_layout Plain Layout
764 \begin_layout Enumerate
765 Implement the LFUN conversion in
766 \begin_inset Flex Code
769 \begin_layout Plain Layout
770 lib/scripts/prefs2prefs_lfuns.py
778 \begin_layout Enumerate
780 \begin_inset CommandInset ref
782 reference "enu:updatefiles"
787 \begin_inset CommandInset ref
789 reference "subsec:update_lyx_files"
794 \begin_inset Flex Code
797 \begin_layout Plain Layout
803 command, use this command:
804 \begin_inset Flex Code
807 \begin_layout Plain Layout
808 bash development/tools/updatelfuns.sh
816 \begin_layout Enumerate
817 Update Info insets in
818 \begin_inset Flex Code
821 \begin_layout Plain Layout
828 To do so, increment the \SpecialChar LyX
829 format and proceed as in
830 \begin_inset CommandInset ref
832 reference "subsec:update_lyx_files"
837 \begin_inset CommandInset ref
839 reference "enu:Describe_format"
844 \begin_inset CommandInset ref
846 reference "enu:updatefiles"
851 In the lyx2lyx implementation (
852 \begin_inset CommandInset ref
854 reference "enu:Add-an-entry"
858 th step), implement a conversion similar to the one in
859 \begin_inset Flex Code
862 \begin_layout Plain Layout
868 above, as well as a corresponding reversion; for this one can use
869 \begin_inset Flex Code
872 \begin_layout Plain Layout
879 \begin_inset Flex Code
882 \begin_layout Plain Layout
883 lib/lyx2lyx/lyx2lyx_tools.py
892 \begin_layout Subsection
893 Backporting new styles to the stable version
896 \begin_layout Standard
897 Starting with the stable \SpecialChar LyX
898 2.1 branch, there is a mechanism in place to backport
899 new styles to the stable version without the need to update the file format.
900 The basic idea is that the new style definition is automatically copied
901 to the document preamble, so that it can even be used by older minor revisions
902 that did not yet include the style.
903 To backport a new style to the stable version, the following steps are
907 \begin_layout Enumerate
909 \begin_inset Flex Code
912 \begin_layout Plain Layout
918 to the style definition in the development version.
921 \begin_layout Enumerate
922 Copy the style definition to the stable version, but use
923 \begin_inset Flex Code
926 \begin_layout Plain Layout
933 If needed adjust the format to the one used by the stable version (see
934 the customization manual for details of the layout file format).
937 \begin_layout Enumerate
938 For each update of the style in a later stable version, increase the argument
940 \begin_inset Flex Code
943 \begin_layout Plain Layout
949 by one (in the stable version, the development version should not be touched).
952 \begin_layout Standard
953 For details about the
954 \begin_inset Flex Code
957 \begin_layout Plain Layout
963 flag see the customization manual.
965 \begin_inset Flex Code
968 \begin_layout Plain Layout
974 support is needed for backported styles: Since the style of the development
975 version has an infinite version number, it will always be used.
976 Furthermore, since its version number is less than one, the style will
977 not be written anymore to the document header for files saved by the new
981 \begin_layout Standard
982 \begin_inset Newpage newpage
988 \begin_layout Section
992 \begin_layout Standard
993 Automated tests are an important tool to detect bugs and regressions in
994 software development.
995 Some projects like gcc even require each bug fix to be accompanied by a
996 test case for the automatic test suite, that would detect this bug.
997 Testing interactive features automatically is of course very hard, but
998 core functionality like document import and export can be tested quite
999 easily, and some tests of this kind exist.
1002 \begin_layout Subsection
1006 \begin_layout Standard
1007 There are attempts to set up a suite of unit tests for LyX.
1010 \begin_layout Standard
1011 TODO: describe what is done and what is still to do.
1014 \begin_layout Subsection
1018 \begin_layout Standard
1019 The tex2lyx tests are located in the
1020 \begin_inset Flex Code
1023 \begin_layout Plain Layout
1029 subfolder of the \SpecialChar LyX
1030 source code distribution.
1031 The actual testing is performed by the simple python script
1032 \begin_inset Flex Code
1035 \begin_layout Plain Layout
1036 src/tex2lyx/test/runtests.py
1042 Each test consists of two files:
1043 \begin_inset Flex Code
1046 \begin_layout Plain Layout
1052 contains the \SpecialChar LaTeX
1053 code that should be tested.
1055 \begin_inset Flex Code
1058 \begin_layout Plain Layout
1064 contains the expected output of tex2lyx.
1065 When a test is run, the actual produced output is compared with the stored
1067 The test passes if both are identical.
1068 The test machinery is also able to generate a file
1069 \begin_inset Flex Code
1072 \begin_layout Plain Layout
1078 by exporting the produced .lyx file with \SpecialChar LyX
1080 This may be useful for roundtrip comparisons.
1083 \begin_layout Subsubsection
1087 \begin_layout Standard
1088 The tex2lyx tests can be run in several ways.
1090 \begin_inset Flex Code
1093 \begin_layout Plain Layout
1099 subfolder of the build directory, the commands
1100 \begin_inset Flex Code
1103 \begin_layout Plain Layout
1109 (cmake, all platforms),
1110 \begin_inset Flex Code
1113 \begin_layout Plain Layout
1119 (cmake, when using a make based build system and not MSVC) or
1120 \begin_inset Flex Code
1123 \begin_layout Plain Layout
1129 (autotools) will run the tex2lyx tests.
1130 Alternatively, in the root of the build directory, the command
1131 \begin_inset Flex Code
1134 \begin_layout Plain Layout
1140 runs all tests whose names match the regex
1141 \begin_inset Quotes eld
1145 \begin_inset Quotes erd
1149 Another way to run the tex2lyx tests in the root build directory is to
1150 instead use the command
1151 \begin_inset Flex Code
1154 \begin_layout Plain Layout
1155 ctest -L '(cmplyx|roundtrip)'
1160 , which runs all tests categorized with the label
1161 \begin_inset Quotes eld
1165 \begin_inset Quotes erd
1169 \begin_inset Quotes eld
1173 \begin_inset Quotes erd
1177 If a test fails, the differences between the expected and actual results
1178 are output in unified diff format.
1181 \begin_layout Subsubsection
1182 Updating test references
1183 \begin_inset CommandInset label
1185 name "sec:Updating-test-references"
1192 \begin_layout Standard
1193 In some cases a changed tex2lyx output is not a test failure, but wanted,
1195 \begin_inset space \thinspace{}
1199 \begin_inset space \space{}
1202 if a tex2lyx bug was fixed, or a new feature was added.
1203 In these cases the stored references need to be updated.
1204 To do so if using autotools, call
1205 \begin_inset Flex Code
1208 \begin_layout Plain Layout
1215 \begin_inset Flex Code
1218 \begin_layout Plain Layout
1224 subdirectory of the build directory.
1225 If instead using CMake, call
1226 \begin_inset Flex Code
1229 \begin_layout Plain Layout
1230 make updatetex2lyxtests
1235 in the build directory or in the
1236 \begin_inset Flex Code
1239 \begin_layout Plain Layout
1245 subdirectory of the build directory.
1249 \begin_layout Plain Layout
1250 Note that this is a case where a make target in the build directory can
1251 affect the source directory, which might not be advisable.
1256 On Windows do the following:
1259 \begin_layout Itemize
1260 Assure that the path to the python.exe is in your system PATH variable.
1263 \begin_layout Itemize
1264 Double-click on the file
1265 \begin_inset Flex Code
1268 \begin_layout Plain Layout
1269 updatetex2lyxtests.vcxproj
1274 in the build directory or in the
1275 \begin_inset Flex Code
1278 \begin_layout Plain Layout
1284 subdirectory of your build directory.
1287 \begin_layout Itemize
1288 In the appearing MSVC program right-click on the project
1292 in the project explorer and chose
1299 \begin_layout Standard
1300 For convenience, these commands also produce re-exported roundtrip .lyx.tex
1302 Please examine the changed output carefully before committing the changed
1303 files to the repository: Since the test machinery does not do a roundtrip
1305 \begin_inset Formula $\Rightarrow$
1309 \begin_inset Formula $\Rightarrow$
1312 .tex, and does not compare the produced dvi or pdf output, it assumes that
1313 the stored .lyx reference produces correct output if processed by \SpecialChar LyX
1315 There is only one chance to detect wrong output: before committing a new
1317 Once it is committed, it is quite difficult to verify whether it is correct.
1320 \begin_layout Standard
1325 update the test references by opening them with \SpecialChar LyX
1326 or directly running lyx2lyx
1328 This would not work, since lyx2lyx and \SpecialChar LyX
1329 produce slightly different files
1330 regarding insignificant whitespace and line breaks.
1333 \begin_layout Subsubsection
1337 \begin_layout Standard
1338 In many cases tests for new features may be added to one of the existing
1339 test files, but sometimes this is not possible or not wanted.
1340 Then a new test file needs to be added:
1343 \begin_layout Enumerate
1345 \begin_inset Flex Code
1348 \begin_layout Plain Layout
1349 src/tex2lyx/test/<test name>.tex
1354 and run tex2lyx in roundtrip mode to produce the file
1355 \begin_inset Flex Code
1358 \begin_layout Plain Layout
1359 src/tex2lyx/test/<test name>.lyx.lyx
1365 This file will be the new reference.
1368 \begin_layout Enumerate
1369 Once you confirmed that the tex2lyx output is correct, add the new files
1370 to the corresponding lists in
1371 \begin_inset Flex Code
1374 \begin_layout Plain Layout
1375 src/tex2lyx/test/runtests.py
1381 \begin_inset Flex Code
1384 \begin_layout Plain Layout
1385 src/tex2lyx/Makefile.am
1391 \begin_inset Flex Code
1394 \begin_layout Plain Layout
1395 src/tex2lyx/test/CMakeLists.txt
1403 \begin_layout Enumerate
1404 Commit the changes to the repository, or send a patch to the development
1405 list and ask for committing if you do not have commit rights.
1408 \begin_layout Subsection
1409 ctest automatic tests
1412 \begin_layout Standard
1413 Some tests are located in the
1414 \begin_inset Flex Code
1417 \begin_layout Plain Layout
1418 development/autotests/
1423 subfolder of the \SpecialChar LyX
1424 source code distribution.
1429 \begin_layout Plain Layout
1430 The README document in this folder only describes the
1431 \begin_inset Quotes eld
1435 \begin_inset Quotes erd
1438 subset of autotests!
1446 \begin_layout Standard
1447 These tests can be run by the commands
1448 \begin_inset Flex Code
1451 \begin_layout Plain Layout
1461 (all platforms) or (when using a make based build system and not MSVC)
1463 \begin_inset Flex Code
1466 \begin_layout Plain Layout
1473 \begin_inset Flex Code
1476 \begin_layout Plain Layout
1487 The test logs are written to the
1488 \begin_inset Flex Code
1491 \begin_layout Plain Layout
1505 \begin_layout Subsubsection
1509 \begin_layout Standard
1510 The export tests are integration tests.
1511 They take longer to run and are more likely to break than the tex2lyx tests.
1512 Nevertheless, they have caught many regressions and without a better alternativ
1513 e it is important to keep them up-to-date and understand how they work.
1516 \begin_layout Standard
1518 \begin_inset Quotes eld
1522 \begin_inset Quotes erd
1525 documentation, template, and example documents.
1526 In addition, there are a number of dedicated sample documents in the
1527 \begin_inset Flex Code
1530 \begin_layout Plain Layout
1536 subfolder of the \SpecialChar LyX
1537 source code distribution.
1538 All samples are (after copying and eventual processing by scripts) exported
1539 to various output formats via the
1540 \begin_inset Flex Code
1543 \begin_layout Plain Layout
1549 command line option.
1550 The test checks for errors reported by LyX (However, error-free export
1551 is no guarantee for an error-free output document.)
1554 \begin_layout Paragraph
1555 Expectations of LyX developers
1558 \begin_layout Standard
1559 Because the export tests are integration tests and take a long time to run,
1560 LyX developers are rarely expected to run all of the tests.
1561 Here are some good practices to follow by developers:
1564 \begin_layout Itemize
1565 When making a non-trivial change to a .layout file, run the export and layout
1566 tests corresponding with that .layout file.
1569 \begin_layout Itemize
1570 When making non-trivial changes to a .lyx file, run the export tests correspondin
1571 g to that .lyx file.
1574 \begin_layout Itemize
1575 When making non-trivial changes to LyX's \SpecialChar LaTeX
1577 touching the encoding code or package handling code that you expect will
1578 change the exported \SpecialChar LaTeX
1583 \begin_layout Standard
1584 \paragraph_spacing single
1585 Consider running all of the export tests before and after your change.
1586 If there are differences, please reconcile these (i.e.
1587 fix the bug or fix the tests)
1592 Ask for help if you're not sure what to.
1595 \begin_layout Standard
1596 If you do not want to run the tests,
1599 \begin_layout Itemize
1600 post the patch on the list and others will run the tests and eventually
1604 \begin_layout Itemize
1605 commit, but be prepared to fix eventually arising problems or to revert
1606 the commit if there is no easy fix.
1610 \begin_layout Itemize
1611 Understand how to interpret test failures.
1612 If your commit is found to have broken a test, you should be able to interpret
1613 the test results when made aware of them.
1615 \begin_inset CommandInset ref
1617 reference "subsec:Interpreting-export-tests"
1624 \begin_layout Paragraph
1625 \begin_inset CommandInset label
1627 name "par:export-test-output-formats"
1634 \begin_layout Standard
1635 The following output formats are currently tested for each sample document
1637 \begin_inset CommandInset ref
1639 reference "par:Export-test-filtering"
1646 \begin_layout Labeling
1647 \labelwidthstring 00.00.0000
1652 \begin_layout Labeling
1653 \labelwidthstring 00.00.0000
1654 lyx16 LyX 1.6 file format (lyx2lyx)
1657 \begin_layout Labeling
1658 \labelwidthstring 00.00.0000
1659 lyx21 LyX 2.1 file format (lyx2lyx)
1662 \begin_layout Labeling
1663 \labelwidthstring 00.00.0000
1664 xhtml LyXHTML (native LyX HTML export)
1668 \begin_layout Labeling
1669 \labelwidthstring 00.00.0000
1671 \begin_inset space ~
1675 \begin_inset space ~
1682 \begin_layout Labeling
1683 \labelwidthstring pdf5msystemFM
1684 dvi DVI (8-bit latex)
1687 \begin_layout Labeling
1688 \labelwidthstring pdf5msystemFM
1689 dvi3_texF DVI (LuaTeX with 8-bit TeX fonts)
1692 \begin_layout Labeling
1693 \labelwidthstring pdf5msystemFM
1694 dvi3_systemF DVI (LuaTeX with Unicode fonts)
1697 \begin_layout Labeling
1698 \labelwidthstring pdf5msystemFM
1702 \begin_layout Labeling
1703 \labelwidthstring pdf5msystemFM
1704 pdf4_texF PDF (XeTeX with 8-bit TeX fonts)
1707 \begin_layout Labeling
1708 \labelwidthstring pdf5msystemFM
1709 pdf4_systemF PDF (XeTeX with Unicode fonts)
1712 \begin_layout Labeling
1713 \labelwidthstring pdf5msystemFM
1714 pdf5_texF PDF (LuaTeX with 8-bit TeX fonts)
1717 \begin_layout Labeling
1718 \labelwidthstring pdf5msystemFM
1719 pdf5_systemF PDF (LuaTeX with Unicode fonts)
1723 \begin_layout Labeling
1724 \labelwidthstring 00.00.0000
1726 \begin_inset space ~
1730 \begin_inset space ~
1734 \begin_inset space ~
1738 \begin_inset space ~
1745 \begin_layout Labeling
1746 \labelwidthstring pdf5msystemFM
1747 pdf DVI -> PS (dvips) -> PDF (ps2pdf)
1750 \begin_layout Labeling
1751 \labelwidthstring pdf5msystemFM
1752 pdf3 DVI -> PDF (dvipdfm)
1756 \begin_layout Labeling
1757 \labelwidthstring 00.00.0000
1759 \begin_inset space ~
1762 tested: (or only if set as default output format in the document source)
1766 \begin_layout Labeling
1767 \labelwidthstring pdf5msystemFM
1771 \begin_layout Labeling
1772 \labelwidthstring pdf5msystemFM
1773 luatex LaTeX (LuaTeX)
1776 \begin_layout Labeling
1777 \labelwidthstring pdf5msystemFM
1778 dviluatex LaTeX (dviluatex)
1781 \begin_layout Labeling
1782 \labelwidthstring pdf5msystemFM
1783 pdflatex LaTeX (pdflatex)
1786 \begin_layout Labeling
1787 \labelwidthstring pdf5msystemFM
1788 platex LaTeX (pLaTeX)
1791 \begin_layout Labeling
1792 \labelwidthstring pdf5msystemFM
1796 \begin_layout Labeling
1797 \labelwidthstring pdf5msystemFM
1798 eps3 EPS (encapsulated Postscript) (cropped)
1801 \begin_layout Labeling
1802 \labelwidthstring pdf5msystemFM
1803 ps DVI -> Postscript (dvips)
1806 \begin_layout Labeling
1807 \labelwidthstring pdf5msystemFM
1811 \begin_layout Labeling
1812 \labelwidthstring pdf5msystemFM
1813 text (nor text2, ..., text4)
1816 \begin_layout Labeling
1817 \labelwidthstring pdf5msystemFM
1821 \begin_layout Labeling
1822 \labelwidthstring pdf5msystemFM
1826 \begin_layout Labeling
1827 \labelwidthstring pdf5msystemFM
1831 \begin_layout Labeling
1832 \labelwidthstring pdf5msystemFM
1837 \begin_layout Paragraph
1838 \begin_inset CommandInset label
1840 name "par:Configuring-ctests"
1844 Configuring the tests
1847 \begin_layout Standard
1848 To enable the export autotests, add the
1849 \begin_inset Flex Code
1852 \begin_layout Plain Layout
1853 -DLYX_ENABLE_EXPORT_TESTS=ON
1862 \begin_layout Standard
1863 \begin_inset Flex Code
1866 \begin_layout Plain Layout
1867 cmake -DLYX_ENABLE_EXPORT_TESTS=ON /path/to/source
1875 \begin_layout Standard
1877 This flag will increase the time for the cmake command by several seconds,
1878 mainly because of the process of inverting tests (see Section
1879 \begin_inset CommandInset ref
1881 reference "subsec:Interpreting-export-tests"
1888 \begin_layout Paragraph
1889 \begin_inset CommandInset label
1891 name "par:ctest-options"
1898 \begin_layout Standard
1899 To run all tests, in the build directory simply run the command
1900 \begin_inset Flex Code
1903 \begin_layout Plain Layout
1913 \begin_layout Standard
1914 To run only some of the tests, use command line options (see examples below):
1917 \begin_layout Labeling
1918 \labelwidthstring -R
1919 \begin_inset Flex Code
1922 \begin_layout Plain Layout
1928 Run only the tests whose names match the given regular expression.
1931 \begin_layout Labeling
1932 \labelwidthstring -R
1933 \begin_inset Flex Code
1936 \begin_layout Plain Layout
1942 Run only the tests whose labels match the given regular expression.
1943 A test may have more that one label.
1947 \begin_layout Labeling
1948 \labelwidthstring -R
1949 \begin_inset Flex Code
1952 \begin_layout Plain Layout
1958 Exclude the tests whose names match the given regular expression.
1961 \begin_layout Labeling
1962 \labelwidthstring -R
1963 \begin_inset Flex Code
1966 \begin_layout Plain Layout
1972 Exclude the tests whose labels match the given regular expression.
1973 Cannot be combined with
1974 \begin_inset Flex Code
1977 \begin_layout Plain Layout
1986 \begin_layout Standard
1987 The following options help to find good selection patterns:
1990 \begin_layout Labeling
1991 \labelwidthstring -R
1992 \begin_inset Flex Code
1995 \begin_layout Plain Layout
2001 List the tests that would be run but not actually run them.
2006 \begin_layout Standard
2007 Useful in conjunction with the -R, -L, -E and -LE options, e.g., if you want
2008 to know how many tests there are or whether your
2009 \begin_inset Flex Code
2012 \begin_layout Plain Layout
2018 regular expression did what you expected.
2022 \begin_layout Labeling
2023 \labelwidthstring -R
2024 \begin_inset Flex Code
2027 \begin_layout Plain Layout
2028 \SpecialChar nobreakdash
2029 \SpecialChar nobreakdash
2035 print the list of all labels associated with the test set.
2036 Can also be combined with -R, -L, -E, ...
2040 \begin_layout Standard
2041 Other useful options are:
2044 \begin_layout Labeling
2045 \labelwidthstring -R
2046 \begin_inset Flex Code
2049 \begin_layout Plain Layout
2055 Run the tests in parallel using the given number of jobs.
2059 \begin_layout Standard
2060 We are still working on getting the tests to run in parallel.
2061 However, when running the tests in parallel, sometimes tests fail that
2062 pass when run sequentially.
2063 A reasonable approach is to first run the tests in parallel and then run
2064 the failed tests sequentially.
2067 \begin_layout Standard
2068 For example, to run 8 jobs at a time:
2071 \begin_layout Standard
2072 \begin_inset Flex Code
2075 \begin_layout Plain Layout
2084 \begin_layout Standard
2085 \begin_inset Flex Code
2088 \begin_layout Plain Layout
2089 ctest \SpecialChar nobreakdash
2090 \SpecialChar nobreakdash
2099 \begin_layout Standard
2100 When specifying a subset of the tests (e.g.
2102 \begin_inset Flex Code
2105 \begin_layout Plain Layout
2106 \SpecialChar nobreakdash
2112 ), the same subset must be specified when using the
2113 \begin_inset Flex Code
2116 \begin_layout Plain Layout
2117 \SpecialChar nobreakdash
2118 \SpecialChar nobreakdash
2124 option because it is the test numbers that are used to index which tests
2125 failed on the previous run.
2128 \begin_layout Standard
2130 Note that some tests cannot be run in parallel.
2131 These tests are marked in the code with the
2132 \begin_inset Flex Code
2135 \begin_layout Plain Layout
2146 \begin_layout Labeling
2147 \labelwidthstring -R
2148 \begin_inset Flex Code
2151 \begin_layout Plain Layout
2152 \SpecialChar nobreakdash
2153 \SpecialChar nobreakdash
2159 Set a global timeout on all tests that do not already have a timeout set
2164 \begin_layout Standard
2165 There have been bugs in LyX and in \SpecialChar LaTeX
2166 which cause compilation to hang, and
2167 without a timeout a test might never stop (in one case there was even a
2169 If a test times out, the
2170 \begin_inset Flex Code
2173 \begin_layout Plain Layout
2179 command exits with error, but you can distinguish between a timed out test
2180 and a failed test in the output reported at the end of the
2181 \begin_inset Flex Code
2184 \begin_layout Plain Layout
2194 \begin_layout Standard
2196 \begin_inset Flex Code
2199 \begin_layout Plain Layout
2205 ) the full list of command line options.
2208 \begin_layout Paragraph
2212 \begin_layout Itemize
2213 run only the export tests:
2214 \begin_inset Flex Code
2217 \begin_layout Plain Layout
2226 \begin_layout Itemize
2228 \begin_inset Flex Code
2231 \begin_layout Plain Layout
2232 ctest -L "inverted|suspended"
2240 \begin_layout Itemize
2241 list all export tests which match any of the labelling patterns:
2242 \begin_inset Flex Code
2245 \begin_layout Plain Layout
2256 \begin_layout Itemize
2257 exclude rarely used output formats and post-processing tests
2258 \begin_inset Flex Code
2261 \begin_layout Plain Layout
2262 ctest -L export -E "_(texF|dvi3|pdf3?)"
2270 \begin_layout Paragraph
2271 \begin_inset CommandInset label
2273 name "subsec:Interpreting-export-tests"
2277 Interpreting the export test results
2280 \begin_layout Standard
2281 A test can fail for several reasons, not all of them bad.
2284 \begin_layout Enumerate
2285 A new or edited sample document may be incompatible with some output formats.
2288 \begin_layout Enumerate
2289 A dependency is not met (e.g.
2290 the \SpecialChar LaTeX
2292 One hint that this is the case is that the corresponding
2293 \begin_inset Flex Code
2296 \begin_layout Plain Layout
2302 test will likely also fail.
2305 \begin_layout Enumerate
2306 An inverted test fails to fail (i.e.
2307 export that previously failed now works).
2310 \begin_layout Enumerate
2311 An external dependency was updated (e.g.
2316 \begin_layout Enumerate
2317 A recent code change introduced a bug.
2320 \begin_layout Enumerate
2321 \begin_inset CommandInset label
2327 A change in a document exposed a previously unknown bug or an incompatibility
2328 with an export format (e.g.
2329 Lua\SpecialChar LaTeX
2333 \begin_layout Standard
2334 Because the .lyx files are exported in several formats, it is not surprising
2335 that many of the exports fail.
2336 This expectation of failure is addressed by
2337 \begin_inset Quotes eld
2341 \begin_inset Quotes erd
2344 the tests, that is, by marking the test as
2345 \begin_inset Quotes eld
2349 \begin_inset Quotes erd
2352 if the export exits with error and as
2353 \begin_inset Quotes eld
2357 \begin_inset Quotes erd
2360 if the export succeeds
2365 It follows that these expected failures will not show up as failed tests
2366 in the test results and thus will not pollute the
2367 \begin_inset Quotes eld
2371 \begin_inset Quotes erd
2375 If the export actually succeeds, then the test will fail.
2376 The purpose of this failure is to get your attention—something has changed,
2377 possibly for the better.
2380 \begin_layout Standard
2381 We try to document why a test is inverted or ignored.
2382 See the comment (prefixed with
2383 \begin_inset Flex Code
2386 \begin_layout Plain Layout
2392 ) above the block in which the test is listed as inverted or ignored in
2394 \begin_inset Flex Code
2397 \begin_layout Plain Layout
2398 development/autotests/suspiciousTests
2404 \begin_inset Flex Code
2407 \begin_layout Plain Layout
2408 development/autotests/unreliableTests
2414 \begin_inset Flex Code
2417 \begin_layout Plain Layout
2418 development/autotests/ignoredTests
2427 \begin_layout Standard
2428 A good question is why do we enable the tests for non-default formats? The
2429 answer is that if a non-default route is broken it is often because a bug
2430 was introduced in LyX and not because a document-specific change was made
2431 that is not supported by the route.
2432 In other words, there is a high signal/noise ratio in the export tests
2433 for some non-default formats.
2437 \begin_layout Standard
2438 When a test or several tests fail, consider checking the files in the
2439 \begin_inset Flex Code
2442 \begin_layout Plain Layout
2448 subdirectory of your build directory.
2449 In this subdirectory are three files: the file
2450 \begin_inset Flex Code
2453 \begin_layout Plain Layout
2459 simply lists the tests that failed on your last
2460 \begin_inset Flex Code
2463 \begin_layout Plain Layout
2470 \begin_inset Flex Code
2473 \begin_layout Plain Layout
2479 file contains the output from the tests (and often has details explaining
2480 why a test failed); and the
2481 \begin_inset Flex Code
2484 \begin_layout Plain Layout
2490 file lists the times that it took to run the tests.
2493 \begin_layout Paragraph
2494 What action should you take if a test fails?
2497 \begin_layout Standard
2498 \paragraph_spacing single
2499 It is always good to check manually why something fails and if it passes
2500 if the PDF output is good.
2503 \begin_layout Itemize
2504 Generally, if a change breaks compilation for the target format (for the
2505 manuals pdf2) without solving some important other issue,
2507 fix or revert the commit
2509 that led to failure.
2512 \begin_layout Itemize
2513 If it is not possible to (immediately) fix the failure but there are reasons
2514 not to revert the commit (e.g.
2515 it fixes another more important issue),
2519 the failing test case (see
2520 \begin_inset CommandInset ref
2522 reference "par:Inverted-tests"
2529 \begin_layout Itemize
2534 test case fails because the export now works,
2538 the test by removing the labeling pattern from
2539 \begin_inset Quotes eld
2543 \begin_inset Quotes erd
2547 \begin_inset CommandInset ref
2549 reference "par:Inverted-tests"
2556 \begin_layout Itemize
2557 If the export did not fail previously but led to wrong output (PDF, say),
2558 it is in fact an improvement when the test now fails, label it as
2559 \begin_inset Quotes eld
2562 unreliable:wrong:output
2563 \begin_inset Quotes erd
2567 \begin_inset CommandInset ref
2569 reference "par:Unreliable-tests"
2576 \begin_layout Paragraph
2577 \begin_inset CommandInset label
2579 name "par:Inverted-tests"
2586 \begin_layout Standard
2587 Test cases whose name matches a pattern in the file
2588 \begin_inset Flex Code
2591 \begin_layout Plain Layout
2592 development/autotests/suspiciousTests
2602 They get also the test property
2603 \begin_inset Flex Code
2606 \begin_layout Plain Layout
2613 they are reported as failing if the export works without error
2614 \begin_inset Flex URL
2617 \begin_layout Plain Layout
2619 https://cmake.org/cmake/help/v3.0/command/set_tests_properties.html
2627 \begin_layout Standard
2628 Add failing cases to this file, if they cannot be solved
2629 \begin_inset Quotes eld
2633 \begin_inset Quotes erd
2636 but it is expected that the export will work in a foreseeable future, e.g.
2637 low priority issues like failures to export to a non-target format (for
2638 the manuals everything except pdf2).
2641 \begin_layout Standard
2642 The following sublabels are currently present in
2643 \begin_inset Flex Code
2646 \begin_layout Plain Layout
2655 \begin_layout Description
2656 todo test failures that require attention:
2660 \begin_layout Itemize
2661 minor issues to explore and properly sort later,
2664 \begin_layout Itemize
2668 \begin_layout Itemize
2669 LyX bugs to report at trac (move pattern to section "lyxbugs" once done).
2673 \begin_layout Description
2674 lyxbugs LyX bugs with a Trac number.
2677 \begin_layout Description
2678 ert Export failures due to "raw" LaTeX use in ERT or preamble code.
2682 \begin_layout Standard
2683 "Wontfix" if demonstrating correct use and OK in the default output format.
2687 \begin_layout Description
2688 texissues Export fails due to LaTeX limitations like non-ASCII characters
2689 in verbatim or listings, incompatible packages, ...
2693 \begin_layout Standard
2694 "Wontfix" if documents demonstrate correct use in the default output format:
2697 \begin_layout Itemize
2698 If the source can be made more robust without becoming "hackish", fix the
2702 \begin_layout Itemize
2703 if LyX could be enhanced to care for a permanent TeX limitation, file a
2704 ticket at trac and add a pattern under lyxbugs,
2707 \begin_layout Itemize
2708 otherwise, add a pattern here.
2712 \begin_layout Description
2713 attic Documents in the attic.
2714 (Kept for reference and format conversion test.)
2717 \begin_layout Subparagraph
2721 \begin_layout Standard
2722 Test cases whose name additionally matches a pattern in the file
2723 \begin_inset Flex Code
2726 \begin_layout Plain Layout
2727 development/autotests/suspendedTests
2745 This means they are not executed using
2746 \begin_inset Flex Code
2749 \begin_layout Plain Layout
2756 \begin_inset Flex Code
2759 \begin_layout Plain Layout
2766 However, they also get the test property
2767 \begin_inset Flex Code
2770 \begin_layout Plain Layout
2777 they are reported as failing if the export works without error.
2778 From time to time they still have to be checked using
2779 \begin_inset Flex Code
2782 \begin_layout Plain Layout
2791 \begin_layout Standard
2792 These tests are suspended, because the export fails for known reasons which
2793 cannot ATM be resolved.
2794 But it is expected the reason might disappear in the future.
2795 Be it new TL or better handling in \SpecialChar LyX
2799 \begin_layout Standard
2800 For ctest commands without the
2801 \begin_inset Flex Code
2804 \begin_layout Plain Layout
2810 parameter nothing changes.
2811 Suspended or not, tests will be executed depending only on the selecting
2812 regular expression given to the ctest command (see
2813 \begin_inset CommandInset ref
2815 reference "par:ctest-options"
2822 \begin_layout Paragraph
2823 \begin_inset CommandInset label
2825 name "par:Unreliable-tests"
2832 \begin_layout Standard
2833 Test cases whose name matches a pattern in the file
2834 \begin_inset Flex Code
2837 \begin_layout Plain Layout
2838 development/autotests/unreliableTests
2850 \begin_layout Standard
2851 These tests are not executed using
2852 \begin_inset Flex Code
2855 \begin_layout Plain Layout
2862 \begin_inset Flex Code
2865 \begin_layout Plain Layout
2875 \begin_layout Standard
2876 They pass or fail for various reasons not related to LyX (nonstandard, erratic)
2877 or pass but should rather fail (wrong output).
2879 \begin_inset Note Note
2882 \begin_layout Plain Layout
2883 *invalid* tests (wrong output) are not *unreliable*.
2884 # Use "unfit" or "unapplicable" as better label and name of pattern file?
2893 \begin_layout Description
2894 nonstandard Documents with additional requirements, e.g.
2895 a class or package file not in TeXLive.
2897 \begin_inset Note Note
2900 \begin_layout Plain Layout
2901 TODO: rename to "extra"?
2910 \begin_layout Standard
2911 These tests are labeled as
2917 \begin_layout Description
2918 erratic Tests depending on local configuration, OS, TeX distribution, package
2919 versions, or the phase of the moon.
2921 \begin_inset Note Note
2924 \begin_layout Plain Layout
2929 only for the phase-of-moon dependency?
2938 \begin_layout Standard
2939 These tests are labeled as
2945 \begin_layout Description
2947 \begin_inset space ~
2950 output Export does not fail but the resulting document has errors.
2954 \begin_layout Standard
2955 \paragraph_spacing single
2956 \begin_inset Note Note
2959 \begin_layout Plain Layout
2960 \paragraph_spacing single
2961 These tests are actually not
2969 (not measuring what they should measure).
2978 \begin_layout Paragraph
2979 \begin_inset CommandInset label
2981 name "par:Export-test-filtering"
2985 Export test filtering
2988 \begin_layout Standard
2989 The assignment of a label to a test is controlled by a set of files with
2990 regular expressions that are matched against the test names.
2993 \begin_layout Description
2994 ignoredTests (small file)
2995 \begin_inset Newline newline
2998 Tests selected here are withdrawn in the configuration step (cf.
3000 \begin_inset CommandInset ref
3002 reference "par:Configuring-ctests"
3010 \begin_layout Labeling
3011 \labelwidthstring 00.00.0000
3012 Input Test of any export combination
3015 \begin_layout Labeling
3016 \labelwidthstring 00.00.0000
3017 Output Stop if tests not selected here
3021 \begin_layout Description
3022 unreliableTests: Tests selected either pass or fail, but that is dependent
3023 on the system where the test is run.
3024 Selected tests gain the label 'unreliable'.
3028 \begin_layout Labeling
3029 \labelwidthstring 00.00.0000
3030 Input Each test which passed 'ignoredTests'
3033 \begin_layout Labeling
3034 \labelwidthstring 00.00.0000
3035 Output Stop if test selected, gain label 'unreliable'.
3039 \begin_layout Description
3041 \begin_inset space \space{}
3048 \begin_layout Labeling
3049 \labelwidthstring 00.00.0000
3050 Input Each test which passed 'unreliableTests'
3053 \begin_layout Labeling
3054 \labelwidthstring 00.00.0000
3055 Output Stop if not selected.
3058 \begin_layout Standard
3059 The following file is meant as subselections of 'suspiciousTests'.
3060 If neither subselection applies, test gains labels 'export' and 'inverted'
3063 \begin_layout Description
3064 suspendedTests Tests selected here gain the label 'suspended' but _not_
3065 'export' or 'inverted', although in ctest they remain inverted.
3066 ('ctest' knows only 'inverted' or not, labels are used only for test selection)
3070 \begin_layout Labeling
3071 \labelwidthstring 00.00.0000
3072 Input Each test selected by 'suspiciousTests'
3075 \begin_layout Labeling
3076 \labelwidthstring 00.00.0000
3077 Output Selected test gains label 'suspended'.
3083 \begin_layout Standard
3084 The following table may clarify label assignement
3087 \begin_layout Standard
3088 \begin_inset Tabular
3089 <lyxtabular version="3" rows="7" columns="12">
3090 <features tabularvalignment="middle">
3091 <column alignment="left" valignment="top" width="0pt">
3092 <column alignment="left" valignment="top" width="0pt">
3093 <column alignment="left" valignment="top" width="0pt">
3094 <column alignment="left" valignment="top" width="0pt">
3095 <column alignment="center" valignment="top">
3096 <column alignment="center" valignment="top">
3097 <column alignment="center" valignment="top">
3098 <column alignment="center" valignment="top">
3099 <column alignment="center" valignment="top">
3100 <column alignment="center" valignment="top">
3101 <column alignment="center" valignment="top">
3102 <column alignment="center" valignment="top">
3104 <cell multicolumn="1" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3107 \begin_layout Plain Layout
3113 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3116 \begin_layout Plain Layout
3122 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3125 \begin_layout Plain Layout
3131 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3134 \begin_layout Plain Layout
3140 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3143 \begin_layout Plain Layout
3144 Marked in ctest, Assigned label
3149 <cell multicolumn="2" alignment="center" valignment="top" usebox="none">
3152 \begin_layout Plain Layout
3158 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3161 \begin_layout Plain Layout
3167 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3170 \begin_layout Plain Layout
3176 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3179 \begin_layout Plain Layout
3185 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3188 \begin_layout Plain Layout
3194 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3197 \begin_layout Plain Layout
3203 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
3206 \begin_layout Plain Layout
3214 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3217 \begin_layout Plain Layout
3223 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3226 \begin_layout Plain Layout
3232 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3235 \begin_layout Plain Layout
3241 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3244 \begin_layout Plain Layout
3250 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3253 \begin_layout Plain Layout
3259 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
3262 \begin_layout Plain Layout
3268 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3271 \begin_layout Plain Layout
3277 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
3280 \begin_layout Plain Layout
3286 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3289 \begin_layout Plain Layout
3295 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
3298 \begin_layout Plain Layout
3304 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3307 \begin_layout Plain Layout
3313 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
3316 \begin_layout Plain Layout
3324 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3327 \begin_layout Plain Layout
3333 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3336 \begin_layout Plain Layout
3342 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3345 \begin_layout Plain Layout
3351 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3354 \begin_layout Plain Layout
3360 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3363 \begin_layout Plain Layout
3369 <cell alignment="center" valignment="top" topline="true" usebox="none">
3372 \begin_layout Plain Layout
3378 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3381 \begin_layout Plain Layout
3387 <cell alignment="center" valignment="top" topline="true" usebox="none">
3390 \begin_layout Plain Layout
3396 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3399 \begin_layout Plain Layout
3405 <cell alignment="center" valignment="top" topline="true" usebox="none">
3408 \begin_layout Plain Layout
3414 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3417 \begin_layout Plain Layout
3423 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
3426 \begin_layout Plain Layout
3434 <cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3437 \begin_layout Plain Layout
3443 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3446 \begin_layout Plain Layout
3452 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3455 \begin_layout Plain Layout
3461 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3464 \begin_layout Plain Layout
3470 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3473 \begin_layout Plain Layout
3479 <cell alignment="center" valignment="top" topline="true" usebox="none">
3482 \begin_layout Plain Layout
3488 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3491 \begin_layout Plain Layout
3497 <cell alignment="center" valignment="top" topline="true" usebox="none">
3500 \begin_layout Plain Layout
3506 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3509 \begin_layout Plain Layout
3515 <cell alignment="center" valignment="top" topline="true" usebox="none">
3518 \begin_layout Plain Layout
3524 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3527 \begin_layout Plain Layout
3533 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
3536 \begin_layout Plain Layout
3544 <cell multirow="4" alignment="left" valignment="middle" topline="true" leftline="true" usebox="none">
3547 \begin_layout Plain Layout
3553 <cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3556 \begin_layout Plain Layout
3562 <cell multirow="3" alignment="left" valignment="middle" topline="true" bottomline="true" leftline="true" usebox="none">
3565 \begin_layout Plain Layout
3571 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3574 \begin_layout Plain Layout
3580 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3583 \begin_layout Plain Layout
3589 <cell alignment="center" valignment="top" topline="true" usebox="none">
3592 \begin_layout Plain Layout
3598 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3601 \begin_layout Plain Layout
3607 <cell alignment="center" valignment="top" topline="true" usebox="none">
3610 \begin_layout Plain Layout
3616 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3619 \begin_layout Plain Layout
3625 <cell alignment="center" valignment="top" topline="true" usebox="none">
3628 \begin_layout Plain Layout
3634 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3637 \begin_layout Plain Layout
3643 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
3646 \begin_layout Plain Layout
3654 <cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3657 \begin_layout Plain Layout
3663 <cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3666 \begin_layout Plain Layout
3672 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3675 \begin_layout Plain Layout
3681 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3684 \begin_layout Plain Layout
3690 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3693 \begin_layout Plain Layout
3699 <cell alignment="center" valignment="top" topline="true" usebox="none">
3702 \begin_layout Plain Layout
3708 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3711 \begin_layout Plain Layout
3717 <cell alignment="center" valignment="top" topline="true" usebox="none">
3720 \begin_layout Plain Layout
3726 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3729 \begin_layout Plain Layout
3735 <cell alignment="center" valignment="top" topline="true" usebox="none">
3738 \begin_layout Plain Layout
3744 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3747 \begin_layout Plain Layout
3753 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
3756 \begin_layout Plain Layout
3764 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3767 \begin_layout Plain Layout
3773 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3776 \begin_layout Plain Layout
3782 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3785 \begin_layout Plain Layout
3791 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3794 \begin_layout Plain Layout
3800 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3803 \begin_layout Plain Layout
3809 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
3812 \begin_layout Plain Layout
3818 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3821 \begin_layout Plain Layout
3827 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
3830 \begin_layout Plain Layout
3836 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3839 \begin_layout Plain Layout
3845 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
3848 \begin_layout Plain Layout
3854 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3857 \begin_layout Plain Layout
3863 <cell alignment="center" valignment="top" topline="true" bottomline="true" rightline="true" usebox="none">
3866 \begin_layout Plain Layout
3880 \begin_layout Subsubsection
3884 \begin_layout Standard
3885 These tests check whether a .lyx file loads without any terminal messages.
3886 They correspond to the manual operations of simply opening a .lyx file on
3887 the terminal, exiting LyX once the file is loaded, and then checking whether
3888 there is any output from the terminal.
3889 These tests are useful for catching malformed .lyx files and parsing bugs.
3890 They can also be used to find a .lyx file in which an instance of something
3892 To do this, compile LyX with a local patch that outputs something to the
3893 terminal when an instance is found, and then run the check_load tests to
3894 see if any fail, which would mean that the situation occurs in the LyX
3895 documentation files corresponding to the failed tests.
3896 These tests are expectedly fragile: any LyX diagnostic message, which is
3897 not necessarily an error, would cause the tests to fail.
3898 Similarly, any message output by a library (e.g.
3899 Qt) would also cause failure.
3900 There are some messages that the check_load tests are instructed to ignore,
3901 which are stored in the file
3902 \begin_inset Flex Code
3905 \begin_layout Plain Layout
3906 development/autotests/filterCheckWarnings
3914 \begin_layout Standard
3915 Under cmake, the tests are labeled as 'load'.
3918 \begin_layout Subsubsection
3922 \begin_layout Standard
3923 Automated tests based on the "MonKey Testing" keytest program.
3924 They are documented in the README document in
3925 \begin_inset Flex Code
3928 \begin_layout Plain Layout
3929 development/autotests
3934 subfolder of the \SpecialChar LyX
3935 source code distribution.
3939 \begin_layout Subsubsection
3943 \begin_layout Standard
3944 These tests combine lyx2lyx tests with check_load tests.
3945 They fail if either fails.
3948 \begin_layout Subsubsection
3952 \begin_layout Standard
3953 The URL tests are enabled with the
3954 \begin_inset Flex Code
3957 \begin_layout Plain Layout
3958 -DLYX_ENABLE_URLTESTS=ON
3963 CMake flag and are useful for finding broken links in our documentation
3965 If a URL test fails, to see which link in particular was reported as broken,
3967 \begin_inset Flex Code
3970 \begin_layout Plain Layout
3977 These tests are extremely fragile (e.g.
3978 a test can depend on your Internet connection) and a failed URL test should
3979 not be taken too seriously.
3980 URL tests are labeled as
3985 \begin_layout Paragraph
3989 \begin_layout Standard
3990 cmake is required to run the \SpecialChar LyX
3991 tests, running them is not implemented for
3995 \begin_layout Standard
3996 The appropriate commands are:
3999 \begin_layout Itemize
4005 \begin_inset Newline newline
4008 runs all tests with label
4013 \begin_layout Itemize
4016 ctest -R 'check_.*urls'
4019 \begin_inset Newline newline
4022 runs the tests 'check_accessible_urls'
4025 \begin_layout Standard
4026 Associated test results can be examined in ctest-log directory in files
4027 of the form 'LastFailed.*URLS.log'
4030 \begin_layout Section
4031 Development policies
4034 \begin_layout Standard
4035 This chapter lists some guidelines that should be followed.
4036 This list is not complete, and many guidelines are in separate chapters,
4038 \begin_inset Quotes eld
4041 When is an update of the .lyx file format number needed?
4042 \begin_inset Quotes erd
4046 \begin_inset CommandInset ref
4048 reference "sec:When-is-an"
4055 \begin_layout Subsection
4056 When to set a fixed milestone?
4059 \begin_layout Standard
4060 Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following
4064 \begin_layout Enumerate
4065 Somebody is actively working on a fix.
4068 \begin_layout Enumerate
4069 The bug is so severe that it would block the release if it is not fixed.
4072 \begin_layout Standard
4073 If a bug is important, but nobody is working on it, and it is no showstopper,
4074 use a milestone like 2.1.x or 2.2.x.
4075 For all other bugs, do not set a milestone at all.
4078 \begin_layout Subsection
4079 Can we add rc entries in stable branch?
4082 \begin_layout Standard
4084 We are supposed to increase the prefs2prefs version number with such things.
4087 \begin_layout Section
4088 Documentation policies
4091 \begin_layout Standard
4092 The main documentation consists of these files:
4095 \begin_layout Description
4096 splash.lyx it is the first file you see after an installation.
4097 We assume that a new user sees this.
4098 It is therefore designed to be as simple as possible.
4099 Therefore please don't add any new formatting, only fix typos etc.
4100 Splash.lyx is up to date for \SpecialChar LyX
4101 2.1.x, currently maintained by Uwe Stöhr.
4104 \begin_layout Description
4105 Intro.lyx This is the manual new users will read to learn \SpecialChar LyX
4107 It therefore uses a limited set of formatting.
4108 For example a standard document class.
4109 Since new users will first learn about the formatting possibilities of
4111 please keep this file that simple.
4112 Intro.lyx is up to date for \SpecialChar LyX
4113 2.1.x, currently maintained by Uwe Stöhr.
4116 \begin_layout Description
4117 Tutorial.lyx our tutorial.
4118 It must be always up to date.
4119 Normally there is nothing to add since we don't want to overwhelm new users
4120 with too much details.
4121 The will learn these details while using \SpecialChar LyX
4122 and we have special manuals.
4123 Tutorial.lyx is up to date for \SpecialChar LyX
4124 2.1.x, currently maintained by Uwe Stöhr.
4127 \begin_layout Description
4128 UserGuide.lyx our main user guide.
4129 It covers a mixture of basic and detailed information.
4130 Some information is also in the Math and EmbeddedObjects manual so that
4131 the UserGuide refers to these files.
4132 UserGuide.lyx is up to date for \SpecialChar LyX
4133 2.1.x, currently maintained by Uwe Stöhr.
4136 \begin_layout Description
4137 EmbeddedObjects.lyx a special manual to explain things like tables floats
4140 EmbeddedObjects.lyx is up to date for \SpecialChar LyX
4141 2.1.x, currently maintained by Uwe
4145 \begin_layout Description
4146 Math.lyx a special manual to explain everything regarding math in all detail.
4147 Math.lyx is up to date for \SpecialChar LyX
4148 2.1.x, currently maintained by Uwe Stöhr.
4151 \begin_layout Description
4152 Additional.lyx this manual covers information that would be too much detail
4153 for the UserGuide or would make the UserGuide uncompilable or only compilable
4154 when installing a lot of special \SpecialChar LaTeX
4156 What should be in the UserGuide or better in Additional is a matter of
4158 it is up to you to decide that.
4159 Additional.lyx is not completely up to date for \SpecialChar LyX
4162 \begin_inset space ~
4165 8 is up to date and currently maintained by Uwe Stöhr.
4166 It certainly needs a rewrite and update.
4167 For example many info in chapter
4168 \begin_inset space ~
4171 2 and 3 are already covered by the UserGuide and/or the EmbeddedObjects
4175 \begin_layout Description
4176 Customization.lyx this manual covers information how to customize \SpecialChar LyX
4178 output formats, operating systems, languages etc.
4179 It is currently completely out of date and needs a major rewrite and update.
4180 If you do this please assure that your information are given for all OSes
4181 and \SpecialChar LaTeX
4182 distributions (meaning be as objective as possible).
4185 \begin_layout Standard
4187 \begin_inset space ~
4190 rules in editing the docs:
4193 \begin_layout Enumerate
4194 If you are not the maintainer of a doc file or a chapter/section, you MUST
4195 use change tracking so that the maintainer could review your changes
4198 \begin_layout Enumerate
4199 Respect the formatting of the document.
4200 The different files use different formatting styles.
4201 That is OK and has historic reasons nobody fully know ;-).
4202 But it is important to be consistent within one file.
4205 \begin_layout Enumerate
4206 All changes you make to a file in one language MUST also go the file in
4207 the other actively maintained languages.
4208 Normally the maintainer does this for you, if you are the maintainer, you
4209 must do this by copying or changing the changed or added text to the other
4210 files so that the translators sees the blue underlined text and know what
4211 they have to translate and what was changed.
4214 \begin_layout Enumerate
4215 You MUST assure that the document is compilable as
4216 \begin_inset Quotes eld
4220 \begin_inset Quotes erd