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 Then, revert the change to
568 \begin_inset Flex Code
571 \begin_layout Plain Layout
577 because that file is meant to be generated separately:
578 \begin_inset Flex Code
581 \begin_layout Plain Layout
582 git checkout lib/doc/LFUNs.lyx
588 \begin_inset Note Note
591 \begin_layout Plain Layout
592 TODO: this step should be done within updatedocs.py
598 Look at the resulting changes using the command
599 \begin_inset Flex Code
602 \begin_layout Plain Layout
609 If anything looks surprising, please investigate.
610 Finally, commit using
611 \begin_inset Flex Code
614 \begin_layout Plain Layout
623 \begin_layout Subsection
624 Updating the file format number of layout files
627 \begin_layout Standard
629 \begin_inset CommandInset ref
631 reference "enu:updatefiles"
636 \begin_inset CommandInset ref
638 reference "subsec:update_lyx_files"
643 \begin_inset Flex Code
646 \begin_layout Plain Layout
652 command, use this command:
653 \begin_inset Flex Code
656 \begin_layout Plain Layout
657 python development/tools/updatelayouts.py
665 \begin_layout Standard
666 Note that we do not update the local layout of our
667 \begin_inset Flex Code
670 \begin_layout Plain Layout
676 files because users would then not be able to export to older formats.
677 For example, if a 2.2.0 user exported a template to 2.1.x format and tried
678 to open the file in LyX 2.1.x, there would be an error because the file would
679 contain a local layout whose format is too new.
680 The root reason for this is that we do not support converting layouts to
681 older layout formats, as we do for the
682 \begin_inset Flex Code
685 \begin_layout Plain Layout
694 \begin_layout Subsection
695 Updating the file format number of bind/ui files
698 \begin_layout Standard
699 A change to the functionality of existing LFUNs can require a conversion
701 \begin_inset Flex Code
704 \begin_layout Plain Layout
711 \begin_inset Flex Code
714 \begin_layout Plain Layout
720 files, and therefore an increment of the LFUN format, as well as a conversion
722 \begin_inset Flex Code
725 \begin_layout Plain Layout
732 The latter cannot be done automatically and requires also a \SpecialChar LyX
735 someone who might have made a set of \SpecialChar LyX
736 teaching manuals for use in their
741 \begin_layout Plain Layout
742 \begin_inset Flex URL
745 \begin_layout Plain Layout
747 http://www.lyx.org/trac/ticket/9794
760 \begin_layout Enumerate
761 Increment the LFUN file format number in
762 \begin_inset Flex Code
765 \begin_layout Plain Layout
774 \begin_layout Enumerate
775 Implement the LFUN conversion in
776 \begin_inset Flex Code
779 \begin_layout Plain Layout
780 lib/scripts/prefs2prefs_lfuns.py
788 \begin_layout Enumerate
790 \begin_inset CommandInset ref
792 reference "enu:updatefiles"
797 \begin_inset CommandInset ref
799 reference "subsec:update_lyx_files"
804 \begin_inset Flex Code
807 \begin_layout Plain Layout
813 command, use this command:
814 \begin_inset Flex Code
817 \begin_layout Plain Layout
818 bash development/tools/updatelfuns.sh
826 \begin_layout Enumerate
827 Update Info insets in
828 \begin_inset Flex Code
831 \begin_layout Plain Layout
838 To do so, increment the \SpecialChar LyX
839 format and proceed as in
840 \begin_inset CommandInset ref
842 reference "subsec:update_lyx_files"
847 \begin_inset CommandInset ref
849 reference "enu:Describe_format"
854 \begin_inset CommandInset ref
856 reference "enu:updatefiles"
861 In the lyx2lyx implementation (
862 \begin_inset CommandInset ref
864 reference "enu:Add-an-entry"
868 th step), implement a conversion similar to the one in
869 \begin_inset Flex Code
872 \begin_layout Plain Layout
878 above, as well as a corresponding reversion; for this one can use
879 \begin_inset Flex Code
882 \begin_layout Plain Layout
889 \begin_inset Flex Code
892 \begin_layout Plain Layout
893 lib/lyx2lyx/lyx2lyx_tools.py
902 \begin_layout Subsection
903 Backporting new styles to the stable version
906 \begin_layout Standard
907 Starting with the stable \SpecialChar LyX
908 2.1 branch, there is a mechanism in place to backport
909 new styles to the stable version without the need to update the file format.
910 The basic idea is that the new style definition is automatically copied
911 to the document preamble, so that it can even be used by older minor revisions
912 that did not yet include the style.
913 To backport a new style to the stable version, the following steps are
917 \begin_layout Enumerate
919 \begin_inset Flex Code
922 \begin_layout Plain Layout
928 to the style definition in the development version.
931 \begin_layout Enumerate
932 Copy the style definition to the stable version, but use
933 \begin_inset Flex Code
936 \begin_layout Plain Layout
943 If needed adjust the format to the one used by the stable version (see
944 the customization manual for details of the layout file format).
947 \begin_layout Enumerate
948 For each update of the style in a later stable version, increase the argument
950 \begin_inset Flex Code
953 \begin_layout Plain Layout
959 by one (in the stable version, the development version should not be touched).
962 \begin_layout Standard
963 For details about the
964 \begin_inset Flex Code
967 \begin_layout Plain Layout
973 flag see the customization manual.
975 \begin_inset Flex Code
978 \begin_layout Plain Layout
984 support is needed for backported styles: Since the style of the development
985 version has an infinite version number, it will always be used.
986 Furthermore, since its version number is less than one, the style will
987 not be written anymore to the document header for files saved by the new
991 \begin_layout Standard
992 \begin_inset Newpage newpage
998 \begin_layout Section
1002 \begin_layout Standard
1003 Automated tests are an important tool to detect bugs and regressions in
1004 software development.
1005 Some projects like gcc even require each bug fix to be accompanied by a
1006 test case for the automatic test suite, that would detect this bug.
1007 Testing interactive features automatically is of course very hard, but
1008 core functionality like document import and export can be tested quite
1009 easily, and some tests of this kind exist.
1012 \begin_layout Subsection
1016 \begin_layout Standard
1017 There are attempts to set up a suite of unit tests for LyX.
1020 \begin_layout Standard
1021 TODO: describe what is done and what is still to do.
1024 \begin_layout Subsection
1028 \begin_layout Standard
1029 The tex2lyx tests are located in the
1030 \begin_inset Flex Code
1033 \begin_layout Plain Layout
1039 subfolder of the \SpecialChar LyX
1040 source code distribution.
1041 The actual testing is performed by the simple python script
1042 \begin_inset Flex Code
1045 \begin_layout Plain Layout
1046 src/tex2lyx/test/runtests.py
1052 Each test consists of two files:
1053 \begin_inset Flex Code
1056 \begin_layout Plain Layout
1062 contains the \SpecialChar LaTeX
1063 code that should be tested.
1065 \begin_inset Flex Code
1068 \begin_layout Plain Layout
1074 contains the expected output of tex2lyx.
1075 When a test is run, the actual produced output is compared with the stored
1077 The test passes if both are identical.
1078 The test machinery is also able to generate a file
1079 \begin_inset Flex Code
1082 \begin_layout Plain Layout
1088 by exporting the produced .lyx file with \SpecialChar LyX
1090 This may be useful for roundtrip comparisons.
1093 \begin_layout Subsubsection
1097 \begin_layout Standard
1098 The tex2lyx tests can be run in several ways.
1100 \begin_inset Flex Code
1103 \begin_layout Plain Layout
1109 subfolder of the build directory, the commands
1110 \begin_inset Flex Code
1113 \begin_layout Plain Layout
1119 (cmake, all platforms),
1120 \begin_inset Flex Code
1123 \begin_layout Plain Layout
1129 (cmake, when using a make based build system and not MSVC) or
1130 \begin_inset Flex Code
1133 \begin_layout Plain Layout
1139 (autotools) will run the tex2lyx tests.
1140 Alternatively, in the root of the build directory, the command
1141 \begin_inset Flex Code
1144 \begin_layout Plain Layout
1150 runs all tests whose names match the regex
1151 \begin_inset Quotes eld
1155 \begin_inset Quotes erd
1159 Another way to run the tex2lyx tests in the root build directory is to
1160 instead use the command
1161 \begin_inset Flex Code
1164 \begin_layout Plain Layout
1165 ctest -L '(cmplyx|roundtrip)'
1170 , which runs all tests categorized with the label
1171 \begin_inset Quotes eld
1175 \begin_inset Quotes erd
1179 \begin_inset Quotes eld
1183 \begin_inset Quotes erd
1187 If a test fails, the differences between the expected and actual results
1188 are output in unified diff format.
1191 \begin_layout Subsubsection
1192 Updating test references
1193 \begin_inset CommandInset label
1195 name "sec:Updating-test-references"
1202 \begin_layout Standard
1203 In some cases a changed tex2lyx output is not a test failure, but wanted,
1205 \begin_inset space \thinspace{}
1209 \begin_inset space \space{}
1212 if a tex2lyx bug was fixed, or a new feature was added.
1213 In these cases the stored references need to be updated.
1214 To do so if using autotools, call
1215 \begin_inset Flex Code
1218 \begin_layout Plain Layout
1225 \begin_inset Flex Code
1228 \begin_layout Plain Layout
1234 subdirectory of the build directory.
1235 If instead using CMake, call
1236 \begin_inset Flex Code
1239 \begin_layout Plain Layout
1240 make updatetex2lyxtests
1245 in the build directory or in the
1246 \begin_inset Flex Code
1249 \begin_layout Plain Layout
1255 subdirectory of the build directory.
1259 \begin_layout Plain Layout
1260 Note that this is a case where a make target in the build directory can
1261 affect the source directory, which might not be advisable.
1266 On Windows do the following:
1269 \begin_layout Itemize
1270 Assure that the path to the python.exe is in your system PATH variable.
1273 \begin_layout Itemize
1274 Double-click on the file
1275 \begin_inset Flex Code
1278 \begin_layout Plain Layout
1279 updatetex2lyxtests.vcxproj
1284 in the build directory or in the
1285 \begin_inset Flex Code
1288 \begin_layout Plain Layout
1294 subdirectory of your build directory.
1297 \begin_layout Itemize
1298 In the appearing MSVC program right-click on the project
1302 in the project explorer and chose
1309 \begin_layout Standard
1310 For convenience, these commands also produce re-exported roundtrip .lyx.tex
1312 Please examine the changed output carefully before committing the changed
1313 files to the repository: Since the test machinery does not do a roundtrip
1315 \begin_inset Formula $\Rightarrow$
1319 \begin_inset Formula $\Rightarrow$
1322 .tex, and does not compare the produced dvi or pdf output, it assumes that
1323 the stored .lyx reference produces correct output if processed by \SpecialChar LyX
1325 There is only one chance to detect wrong output: before committing a new
1327 Once it is committed, it is quite difficult to verify whether it is correct.
1330 \begin_layout Standard
1335 update the test references by opening them with \SpecialChar LyX
1336 or directly running lyx2lyx
1338 This would not work, since lyx2lyx and \SpecialChar LyX
1339 produce slightly different files
1340 regarding insignificant whitespace and line breaks.
1343 \begin_layout Subsubsection
1347 \begin_layout Standard
1348 In many cases tests for new features may be added to one of the existing
1349 test files, but sometimes this is not possible or not wanted.
1350 Then a new test file needs to be added:
1353 \begin_layout Enumerate
1355 \begin_inset Flex Code
1358 \begin_layout Plain Layout
1359 src/tex2lyx/test/<test name>.tex
1364 and run tex2lyx in roundtrip mode to produce the file
1365 \begin_inset Flex Code
1368 \begin_layout Plain Layout
1369 src/tex2lyx/test/<test name>.lyx.lyx
1375 This file will be the new reference.
1378 \begin_layout Enumerate
1379 Once you confirmed that the tex2lyx output is correct, add the new files
1380 to the corresponding lists in
1381 \begin_inset Flex Code
1384 \begin_layout Plain Layout
1385 src/tex2lyx/test/runtests.py
1391 \begin_inset Flex Code
1394 \begin_layout Plain Layout
1395 src/tex2lyx/Makefile.am
1401 \begin_inset Flex Code
1404 \begin_layout Plain Layout
1405 src/tex2lyx/test/CMakeLists.txt
1413 \begin_layout Enumerate
1414 Commit the changes to the repository, or send a patch to the development
1415 list and ask for committing if you do not have commit rights.
1418 \begin_layout Subsection
1419 ctest automatic tests
1422 \begin_layout Standard
1423 Some tests are located in the
1424 \begin_inset Flex Code
1427 \begin_layout Plain Layout
1428 development/autotests/
1433 subfolder of the \SpecialChar LyX
1434 source code distribution.
1439 \begin_layout Plain Layout
1440 The README document in this folder only describes the
1441 \begin_inset Quotes eld
1445 \begin_inset Quotes erd
1448 subset of autotests!
1456 \begin_layout Standard
1457 These tests can be run by the commands
1458 \begin_inset Flex Code
1461 \begin_layout Plain Layout
1471 (all platforms) or (when using a make based build system and not MSVC)
1473 \begin_inset Flex Code
1476 \begin_layout Plain Layout
1483 \begin_inset Flex Code
1486 \begin_layout Plain Layout
1497 The test logs are written to the
1498 \begin_inset Flex Code
1501 \begin_layout Plain Layout
1515 \begin_layout Subsubsection
1519 \begin_layout Standard
1520 The export tests are integration tests.
1521 They take longer to run and are more likely to break than the tex2lyx tests.
1522 Nevertheless, they have caught many regressions and without a better alternativ
1523 e it is important to keep them up-to-date and understand how they work.
1526 \begin_layout Standard
1528 \begin_inset Quotes eld
1532 \begin_inset Quotes erd
1535 documentation, template, and example documents.
1536 In addition, there are a number of dedicated sample documents in the
1537 \begin_inset Flex Code
1540 \begin_layout Plain Layout
1546 subfolder of the \SpecialChar LyX
1547 source code distribution.
1548 All samples are (after copying and eventual processing by scripts) exported
1549 to various output formats via the
1550 \begin_inset Flex Code
1553 \begin_layout Plain Layout
1559 command line option.
1560 The test checks for errors reported by LyX (However, error-free export
1561 is no guarantee for an error-free output document.)
1564 \begin_layout Paragraph
1565 Expectations of LyX developers
1568 \begin_layout Standard
1569 Because the export tests are integration tests and take a long time to run,
1570 LyX developers are rarely expected to run all of the tests.
1571 Here are some good practices to follow by developers:
1574 \begin_layout Itemize
1575 When making a non-trivial change to a .layout file, run the export and layout
1576 tests corresponding with that .layout file.
1579 \begin_layout Itemize
1580 When making non-trivial changes to a .lyx file, run the export tests correspondin
1581 g to that .lyx file.
1584 \begin_layout Itemize
1585 When making non-trivial changes to LyX's \SpecialChar LaTeX
1587 touching the encoding code or package handling code that you expect will
1588 change the exported \SpecialChar LaTeX
1593 \begin_layout Standard
1594 \paragraph_spacing single
1595 Consider running all of the export tests before and after your change.
1596 If there are differences, please reconcile these (i.e.
1597 fix the bug or fix the tests)
1602 Ask for help if you're not sure what to.
1605 \begin_layout Standard
1606 If you do not want to run the tests,
1609 \begin_layout Itemize
1610 post the patch on the list and others will run the tests and eventually
1614 \begin_layout Itemize
1615 commit, but be prepared to fix eventually arising problems or to revert
1616 the commit if there is no easy fix.
1620 \begin_layout Itemize
1621 Understand how to interpret test failures.
1622 If your commit is found to have broken a test, you should be able to interpret
1623 the test results when made aware of them.
1625 \begin_inset CommandInset ref
1627 reference "subsec:Interpreting-export-tests"
1634 \begin_layout Paragraph
1635 \begin_inset CommandInset label
1637 name "par:export-test-output-formats"
1644 \begin_layout Standard
1645 The following output formats are currently tested for each sample document
1647 \begin_inset CommandInset ref
1649 reference "par:Export-test-filtering"
1656 \begin_layout Labeling
1657 \labelwidthstring 00.00.0000
1662 \begin_layout Labeling
1663 \labelwidthstring 00.00.0000
1664 lyx16 LyX 1.6 file format (lyx2lyx)
1667 \begin_layout Labeling
1668 \labelwidthstring 00.00.0000
1669 lyx21 LyX 2.1 file format (lyx2lyx)
1672 \begin_layout Labeling
1673 \labelwidthstring 00.00.0000
1674 xhtml LyXHTML (native LyX HTML export)
1678 \begin_layout Labeling
1679 \labelwidthstring 00.00.0000
1681 \begin_inset space ~
1685 \begin_inset space ~
1692 \begin_layout Labeling
1693 \labelwidthstring pdf5msystemFM
1694 dvi DVI (8-bit latex)
1697 \begin_layout Labeling
1698 \labelwidthstring pdf5msystemFM
1699 dvi3_texF DVI (LuaTeX with 8-bit TeX fonts)
1702 \begin_layout Labeling
1703 \labelwidthstring pdf5msystemFM
1704 dvi3_systemF DVI (LuaTeX with Unicode fonts)
1707 \begin_layout Labeling
1708 \labelwidthstring pdf5msystemFM
1712 \begin_layout Labeling
1713 \labelwidthstring pdf5msystemFM
1714 pdf4_texF PDF (XeTeX with 8-bit TeX fonts)
1717 \begin_layout Labeling
1718 \labelwidthstring pdf5msystemFM
1719 pdf4_systemF PDF (XeTeX with Unicode fonts)
1722 \begin_layout Labeling
1723 \labelwidthstring pdf5msystemFM
1724 pdf5_texF PDF (LuaTeX with 8-bit TeX fonts)
1727 \begin_layout Labeling
1728 \labelwidthstring pdf5msystemFM
1729 pdf5_systemF PDF (LuaTeX with Unicode fonts)
1733 \begin_layout Labeling
1734 \labelwidthstring 00.00.0000
1736 \begin_inset space ~
1740 \begin_inset space ~
1744 \begin_inset space ~
1748 \begin_inset space ~
1755 \begin_layout Labeling
1756 \labelwidthstring pdf5msystemFM
1757 pdf DVI -> PS (dvips) -> PDF (ps2pdf)
1760 \begin_layout Labeling
1761 \labelwidthstring pdf5msystemFM
1762 pdf3 DVI -> PDF (dvipdfm)
1766 \begin_layout Labeling
1767 \labelwidthstring 00.00.0000
1769 \begin_inset space ~
1772 tested: (or only if set as default output format in the document source)
1776 \begin_layout Labeling
1777 \labelwidthstring pdf5msystemFM
1781 \begin_layout Labeling
1782 \labelwidthstring pdf5msystemFM
1783 luatex LaTeX (LuaTeX)
1786 \begin_layout Labeling
1787 \labelwidthstring pdf5msystemFM
1788 dviluatex LaTeX (dviluatex)
1791 \begin_layout Labeling
1792 \labelwidthstring pdf5msystemFM
1793 pdflatex LaTeX (pdflatex)
1796 \begin_layout Labeling
1797 \labelwidthstring pdf5msystemFM
1798 platex LaTeX (pLaTeX)
1801 \begin_layout Labeling
1802 \labelwidthstring pdf5msystemFM
1806 \begin_layout Labeling
1807 \labelwidthstring pdf5msystemFM
1808 eps3 EPS (encapsulated Postscript) (cropped)
1811 \begin_layout Labeling
1812 \labelwidthstring pdf5msystemFM
1813 ps DVI -> Postscript (dvips)
1816 \begin_layout Labeling
1817 \labelwidthstring pdf5msystemFM
1821 \begin_layout Labeling
1822 \labelwidthstring pdf5msystemFM
1823 text (nor text2, ..., text4)
1826 \begin_layout Labeling
1827 \labelwidthstring pdf5msystemFM
1831 \begin_layout Labeling
1832 \labelwidthstring pdf5msystemFM
1836 \begin_layout Labeling
1837 \labelwidthstring pdf5msystemFM
1841 \begin_layout Labeling
1842 \labelwidthstring pdf5msystemFM
1847 \begin_layout Paragraph
1848 \begin_inset CommandInset label
1850 name "par:Configuring-ctests"
1854 Configuring the tests
1857 \begin_layout Standard
1858 To enable the export autotests, add the
1859 \begin_inset Flex Code
1862 \begin_layout Plain Layout
1863 -DLYX_ENABLE_EXPORT_TESTS=ON
1872 \begin_layout Standard
1873 \begin_inset Flex Code
1876 \begin_layout Plain Layout
1877 cmake -DLYX_ENABLE_EXPORT_TESTS=ON /path/to/source
1885 \begin_layout Standard
1887 This flag will increase the time for the cmake command by several seconds,
1888 mainly because of the process of inverting tests (see Section
1889 \begin_inset CommandInset ref
1891 reference "subsec:Interpreting-export-tests"
1898 \begin_layout Paragraph
1899 \begin_inset CommandInset label
1901 name "par:ctest-options"
1908 \begin_layout Standard
1909 To run all tests, in the build directory simply run the command
1910 \begin_inset Flex Code
1913 \begin_layout Plain Layout
1923 \begin_layout Standard
1924 To run only some of the tests, use command line options (see examples below):
1927 \begin_layout Labeling
1928 \labelwidthstring -R
1929 \begin_inset Flex Code
1932 \begin_layout Plain Layout
1938 Run only the tests whose names match the given regular expression.
1941 \begin_layout Labeling
1942 \labelwidthstring -R
1943 \begin_inset Flex Code
1946 \begin_layout Plain Layout
1952 Run only the tests whose labels match the given regular expression.
1953 A test may have more that one label.
1957 \begin_layout Labeling
1958 \labelwidthstring -R
1959 \begin_inset Flex Code
1962 \begin_layout Plain Layout
1968 Exclude the tests whose names match the given regular expression.
1971 \begin_layout Labeling
1972 \labelwidthstring -R
1973 \begin_inset Flex Code
1976 \begin_layout Plain Layout
1982 Exclude the tests whose labels match the given regular expression.
1983 Cannot be combined with
1984 \begin_inset Flex Code
1987 \begin_layout Plain Layout
1996 \begin_layout Standard
1997 The following options help to find good selection patterns:
2000 \begin_layout Labeling
2001 \labelwidthstring -R
2002 \begin_inset Flex Code
2005 \begin_layout Plain Layout
2011 List the tests that would be run but not actually run them.
2016 \begin_layout Standard
2017 Useful in conjunction with the -R, -L, -E and -LE options, e.g., if you want
2018 to know how many tests there are or whether your
2019 \begin_inset Flex Code
2022 \begin_layout Plain Layout
2028 regular expression did what you expected.
2032 \begin_layout Labeling
2033 \labelwidthstring -R
2034 \begin_inset Flex Code
2037 \begin_layout Plain Layout
2038 \SpecialChar nobreakdash
2039 \SpecialChar nobreakdash
2045 print the list of all labels associated with the test set.
2046 Can also be combined with -R, -L, -E, ...
2050 \begin_layout Standard
2051 Other useful options are:
2054 \begin_layout Labeling
2055 \labelwidthstring -R
2056 \begin_inset Flex Code
2059 \begin_layout Plain Layout
2065 Run the tests in parallel using the given number of jobs.
2069 \begin_layout Standard
2070 We are still working on getting the tests to run in parallel.
2071 However, when running the tests in parallel, sometimes tests fail that
2072 pass when run sequentially.
2073 A reasonable approach is to first run the tests in parallel and then run
2074 the failed tests sequentially.
2078 \begin_layout Standard
2079 For example, to run 8 jobs at a time:
2082 \begin_layout Standard
2083 \begin_inset Flex Code
2086 \begin_layout Plain Layout
2095 \begin_layout Standard
2096 \begin_inset Flex Code
2099 \begin_layout Plain Layout
2100 ctest \SpecialChar nobreakdash
2101 \SpecialChar nobreakdash
2110 \begin_layout Standard
2112 Note that some tests cannot be run in parallel.
2113 These tests are marked in the code with the
2114 \begin_inset Flex Code
2117 \begin_layout Plain Layout
2128 \begin_layout Labeling
2129 \labelwidthstring -R
2130 \begin_inset Flex Code
2133 \begin_layout Plain Layout
2134 \SpecialChar nobreakdash
2135 \SpecialChar nobreakdash
2141 Set a global timeout on all tests that do not already have a timeout set
2146 \begin_layout Standard
2147 There have been bugs in LyX and in \SpecialChar LaTeX
2148 which cause compilation to hang, and
2149 without a timeout a test might never stop (in one case there was even a
2151 If a test times out, the
2152 \begin_inset Flex Code
2155 \begin_layout Plain Layout
2161 command exits with error, but you can distinguish between a timed out test
2162 and a failed test in the output reported at the end of the
2163 \begin_inset Flex Code
2166 \begin_layout Plain Layout
2176 \begin_layout Standard
2178 \begin_inset Flex Code
2181 \begin_layout Plain Layout
2187 ) the full list of command line options.
2190 \begin_layout Paragraph
2194 \begin_layout Itemize
2195 run only the export tests:
2196 \begin_inset Flex Code
2199 \begin_layout Plain Layout
2208 \begin_layout Itemize
2210 \begin_inset Flex Code
2213 \begin_layout Plain Layout
2214 ctest -L "inverted|suspended"
2222 \begin_layout Itemize
2223 list all export tests which match any of the labelling patterns:
2224 \begin_inset Flex Code
2227 \begin_layout Plain Layout
2238 \begin_layout Itemize
2239 exclude rarely used output formats and post-processing tests
2240 \begin_inset Flex Code
2243 \begin_layout Plain Layout
2244 ctest -L export -E "_(texF|dvi3|pdf3?)"
2252 \begin_layout Paragraph
2253 \begin_inset CommandInset label
2255 name "subsec:Interpreting-export-tests"
2259 Interpreting the export test results
2262 \begin_layout Standard
2263 A test can fail for several reasons, not all of them bad.
2266 \begin_layout Enumerate
2267 A new or edited sample document may be incompatible with some output formats.
2270 \begin_layout Enumerate
2271 A dependency is not met (e.g.
2272 the \SpecialChar LaTeX
2274 One hint that this is the case is that the corresponding
2275 \begin_inset Flex Code
2278 \begin_layout Plain Layout
2284 test will likely also fail.
2287 \begin_layout Enumerate
2288 An inverted test fails to fail (i.e.
2289 export that previously failed now works).
2292 \begin_layout Enumerate
2293 An external dependency was updated (e.g.
2298 \begin_layout Enumerate
2299 A recent code change introduced a bug.
2302 \begin_layout Enumerate
2303 \begin_inset CommandInset label
2309 A change in a document exposed a previously unknown bug or an incompatibility
2310 with an export format (e.g.
2311 Lua\SpecialChar LaTeX
2315 \begin_layout Standard
2316 Because the .lyx files are exported in several formats, it is not surprising
2317 that many of the exports fail.
2318 This expectation of failure is addressed by
2319 \begin_inset Quotes eld
2323 \begin_inset Quotes erd
2326 the tests, that is, by marking the test as
2327 \begin_inset Quotes eld
2331 \begin_inset Quotes erd
2334 if the export exits with error and as
2335 \begin_inset Quotes eld
2339 \begin_inset Quotes erd
2342 if the export succeeds
2347 It follows that these expected failures will not show up as failed tests
2348 in the test results and thus will not pollute the
2349 \begin_inset Quotes eld
2353 \begin_inset Quotes erd
2357 If the export actually succeeds, then the test will fail.
2358 The purpose of this failure is to get your attention—something has changed,
2359 possibly for the better.
2362 \begin_layout Standard
2363 We try to document why a test is inverted or ignored.
2364 See the comment (prefixed with
2365 \begin_inset Flex Code
2368 \begin_layout Plain Layout
2374 ) above the block in which the test is listed as inverted or ignored in
2376 \begin_inset Flex Code
2379 \begin_layout Plain Layout
2380 development/autotests/suspiciousTests
2386 \begin_inset Flex Code
2389 \begin_layout Plain Layout
2390 development/autotests/unreliableTests
2396 \begin_inset Flex Code
2399 \begin_layout Plain Layout
2400 development/autotests/ignoredTests
2409 \begin_layout Standard
2410 A good question is why do we enable the tests for non-default formats? The
2411 answer is that if a non-default route is broken it is often because a bug
2412 was introduced in LyX and not because a document-specific change was made
2413 that is not supported by the route.
2414 In other words, there is a high signal/noise ratio in the export tests
2415 for some non-default formats.
2419 \begin_layout Standard
2420 When a test or several tests fail, consider checking the files in the
2421 \begin_inset Flex Code
2424 \begin_layout Plain Layout
2430 subdirectory of your build directory.
2431 In this subdirectory are three files: the file
2432 \begin_inset Flex Code
2435 \begin_layout Plain Layout
2441 simply lists the tests that failed on your last
2442 \begin_inset Flex Code
2445 \begin_layout Plain Layout
2452 \begin_inset Flex Code
2455 \begin_layout Plain Layout
2461 file contains the output from the tests (and often has details explaining
2462 why a test failed); and the
2463 \begin_inset Flex Code
2466 \begin_layout Plain Layout
2472 file lists the times that it took to run the tests.
2475 \begin_layout Paragraph
2476 What action should you take if a test fails?
2479 \begin_layout Standard
2480 \paragraph_spacing single
2481 It is always good to check manually why something fails and if it passes
2482 if the PDF output is good.
2485 \begin_layout Itemize
2486 Generally, if a change breaks compilation for the target format (for the
2487 manuals pdf2) without solving some important other issue,
2489 fix or revert the commit
2491 that led to failure.
2494 \begin_layout Itemize
2495 If it is not possible to (immediately) fix the failure but there are reasons
2496 not to revert the commit (e.g.
2497 it fixes another more important issue),
2501 the failing test case (see
2502 \begin_inset CommandInset ref
2504 reference "par:Inverted-tests"
2511 \begin_layout Itemize
2516 test case fails because the export now works,
2520 the test by removing the labeling pattern from
2521 \begin_inset Quotes eld
2525 \begin_inset Quotes erd
2529 \begin_inset CommandInset ref
2531 reference "par:Inverted-tests"
2538 \begin_layout Itemize
2539 If the export did not fail previously but led to wrong output (PDF, say),
2540 it is in fact an improvement when the test now fails, label it as
2541 \begin_inset Quotes eld
2544 unreliable:wrong:output
2545 \begin_inset Quotes erd
2549 \begin_inset CommandInset ref
2551 reference "par:Unreliable-tests"
2558 \begin_layout Paragraph
2559 \begin_inset CommandInset label
2561 name "par:Inverted-tests"
2568 \begin_layout Standard
2569 Test cases whose name matches a pattern in the file
2570 \begin_inset Flex Code
2573 \begin_layout Plain Layout
2574 development/autotests/suspiciousTests
2584 They get also the test property
2585 \begin_inset Flex Code
2588 \begin_layout Plain Layout
2595 they are reported as failing if the export works without error
2596 \begin_inset Flex URL
2599 \begin_layout Plain Layout
2601 https://cmake.org/cmake/help/v3.0/command/set_tests_properties.html
2609 \begin_layout Standard
2610 Add failing cases to this file, if they cannot be solved
2611 \begin_inset Quotes eld
2615 \begin_inset Quotes erd
2618 but it is expected that the export will work in a foreseeable future, e.g.
2619 low priority issues like failures to export to a non-target format (for
2620 the manuals everything except pdf2).
2623 \begin_layout Standard
2624 The following sublabels are currently present in
2625 \begin_inset Flex Code
2628 \begin_layout Plain Layout
2637 \begin_layout Description
2638 todo test failures that require attention:
2642 \begin_layout Itemize
2643 minor issues to explore and properly sort later,
2646 \begin_layout Itemize
2650 \begin_layout Itemize
2651 LyX bugs to report at trac (move pattern to section "lyxbugs" once done).
2655 \begin_layout Description
2656 lyxbugs LyX bugs with a Trac number.
2659 \begin_layout Description
2660 ert Export failures due to "raw" LaTeX use in ERT or preamble code.
2664 \begin_layout Standard
2665 "Wontfix" if demonstrating correct use and OK in the default output format.
2669 \begin_layout Description
2670 texissues Export fails due to LaTeX limitations like non-ASCII characters
2671 in verbatim or listings, incompatible packages, ...
2675 \begin_layout Standard
2676 "Wontfix" if documents demonstrate correct use in the default output format:
2679 \begin_layout Itemize
2680 If the source can be made more robust without becoming "hackish", fix the
2684 \begin_layout Itemize
2685 if LyX could be enhanced to care for a permanent TeX limitation, file a
2686 ticket at trac and add a pattern under lyxbugs,
2689 \begin_layout Itemize
2690 otherwise, add a pattern here.
2694 \begin_layout Description
2695 attic Documents in the attic.
2696 (Kept for reference and format conversion test.)
2699 \begin_layout Subparagraph
2703 \begin_layout Standard
2704 Test cases whose name additionally matches a pattern in the file
2705 \begin_inset Flex Code
2708 \begin_layout Plain Layout
2709 development/autotests/suspendedTests
2727 This means they are not executed using
2728 \begin_inset Flex Code
2731 \begin_layout Plain Layout
2738 \begin_inset Flex Code
2741 \begin_layout Plain Layout
2748 However, they also get the test property
2749 \begin_inset Flex Code
2752 \begin_layout Plain Layout
2759 they are reported as failing if the export works without error.
2760 From time to time they still have to be checked using
2761 \begin_inset Flex Code
2764 \begin_layout Plain Layout
2773 \begin_layout Standard
2774 These tests are suspended, because the export fails for known reasons which
2775 cannot ATM be resolved.
2776 But it is expected the reason might disappear in the future.
2777 Be it new TL or better handling in \SpecialChar LyX
2781 \begin_layout Standard
2782 For ctest commands without the
2783 \begin_inset Flex Code
2786 \begin_layout Plain Layout
2792 parameter nothing changes.
2793 Suspended or not, tests will be executed depending only on the selecting
2794 regular expression given to the ctest command (see
2795 \begin_inset CommandInset ref
2797 reference "par:ctest-options"
2804 \begin_layout Paragraph
2805 \begin_inset CommandInset label
2807 name "par:Unreliable-tests"
2814 \begin_layout Standard
2815 Test cases whose name matches a pattern in the file
2816 \begin_inset Flex Code
2819 \begin_layout Plain Layout
2820 development/autotests/unreliableTests
2832 \begin_layout Standard
2833 These tests are not executed using
2834 \begin_inset Flex Code
2837 \begin_layout Plain Layout
2844 \begin_inset Flex Code
2847 \begin_layout Plain Layout
2857 \begin_layout Standard
2858 They pass or fail for various reasons not related to LyX (nonstandard, erratic)
2859 or pass but should rather fail (wrong output).
2861 \begin_inset Note Note
2864 \begin_layout Plain Layout
2865 *invalid* tests (wrong output) are not *unreliable*.
2866 # Use "unfit" or "unapplicable" as better label and name of pattern file?
2875 \begin_layout Description
2876 nonstandard Documents with additional requirements, e.g.
2877 a class or package file not in TeXLive.
2879 \begin_inset Note Note
2882 \begin_layout Plain Layout
2883 TODO: rename to "extra"?
2892 \begin_layout Standard
2893 These tests are labeled as
2899 \begin_layout Description
2900 erratic Tests depending on local configuration, OS, TeX distribution, package
2901 versions, or the phase of the moon.
2903 \begin_inset Note Note
2906 \begin_layout Plain Layout
2911 only for the phase-of-moon dependency?
2920 \begin_layout Standard
2921 These tests are labeled as
2927 \begin_layout Description
2929 \begin_inset space ~
2932 output Export does not fail but the resulting document has errors.
2936 \begin_layout Standard
2937 \paragraph_spacing single
2938 \begin_inset Note Note
2941 \begin_layout Plain Layout
2942 \paragraph_spacing single
2943 These tests are actually not
2951 (not measuring what they should measure).
2960 \begin_layout Paragraph
2961 \begin_inset CommandInset label
2963 name "par:Export-test-filtering"
2967 Export test filtering
2970 \begin_layout Standard
2971 The assignment of a label to a test is controlled by a set of files with
2972 regular expressions that are matched against the test names.
2975 \begin_layout Description
2976 ignoredTests (small file)
2977 \begin_inset Newline newline
2980 Tests selected here are withdrawn in the configuration step (cf.
2982 \begin_inset CommandInset ref
2984 reference "par:Configuring-ctests"
2992 \begin_layout Labeling
2993 \labelwidthstring 00.00.0000
2994 Input Test of any export combination
2997 \begin_layout Labeling
2998 \labelwidthstring 00.00.0000
2999 Output Stop if tests not selected here
3003 \begin_layout Description
3004 unreliableTests: Tests selected either pass or fail, but that is dependent
3005 on the system where the test is run.
3006 Selected tests gain the label 'unreliable'.
3010 \begin_layout Labeling
3011 \labelwidthstring 00.00.0000
3012 Input Each test which passed 'ignoredTests'
3015 \begin_layout Labeling
3016 \labelwidthstring 00.00.0000
3017 Output Stop if test selected, gain label 'unreliable'.
3021 \begin_layout Description
3023 \begin_inset space \space{}
3030 \begin_layout Labeling
3031 \labelwidthstring 00.00.0000
3032 Input Each test which passed 'unreliableTests'
3035 \begin_layout Labeling
3036 \labelwidthstring 00.00.0000
3037 Output Stop if not selected.
3040 \begin_layout Standard
3041 The following file is meant as subselections of 'suspiciousTests'.
3042 If neither subselection applies, test gains labels 'export' and 'inverted'
3045 \begin_layout Description
3046 suspendedTests Tests selected here gain the label 'suspended' but _not_
3047 'export' or 'inverted', although in ctest they remain inverted.
3048 ('ctest' knows only 'inverted' or not, labels are used only for test selection)
3052 \begin_layout Labeling
3053 \labelwidthstring 00.00.0000
3054 Input Each test selected by 'suspiciousTests'
3057 \begin_layout Labeling
3058 \labelwidthstring 00.00.0000
3059 Output Selected test gains label 'suspended'.
3065 \begin_layout Standard
3066 The following table may clarify label assignement
3069 \begin_layout Standard
3070 \begin_inset Tabular
3071 <lyxtabular version="3" rows="7" columns="12">
3072 <features tabularvalignment="middle">
3073 <column alignment="left" valignment="top" width="0pt">
3074 <column alignment="left" valignment="top" width="0pt">
3075 <column alignment="left" valignment="top" width="0pt">
3076 <column alignment="left" valignment="top" width="0pt">
3077 <column alignment="center" valignment="top">
3078 <column alignment="center" valignment="top">
3079 <column alignment="center" valignment="top">
3080 <column alignment="center" valignment="top">
3081 <column alignment="center" valignment="top">
3082 <column alignment="center" valignment="top">
3083 <column alignment="center" valignment="top">
3084 <column alignment="center" valignment="top">
3086 <cell multicolumn="1" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3089 \begin_layout Plain Layout
3095 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3098 \begin_layout Plain Layout
3104 <cell multicolumn="2" 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="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3125 \begin_layout Plain Layout
3126 Marked in ctest, Assigned label
3131 <cell multicolumn="2" alignment="center" valignment="top" usebox="none">
3134 \begin_layout Plain Layout
3140 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3143 \begin_layout Plain Layout
3149 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" 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" rightline="true" usebox="none">
3179 \begin_layout Plain Layout
3185 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
3188 \begin_layout Plain Layout
3196 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3199 \begin_layout Plain Layout
3205 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3208 \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 multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3235 \begin_layout Plain Layout
3241 <cell multicolumn="2" alignment="center" valignment="top" topline="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" rightline="true" usebox="none">
3289 \begin_layout Plain Layout
3295 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
3298 \begin_layout Plain Layout
3306 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3309 \begin_layout Plain Layout
3315 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3318 \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="center" valignment="top" topline="true" leftline="true" usebox="none">
3345 \begin_layout Plain Layout
3351 <cell alignment="center" valignment="top" topline="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" rightline="true" usebox="none">
3408 \begin_layout Plain Layout
3416 <cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3419 \begin_layout Plain Layout
3425 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3428 \begin_layout Plain Layout
3434 <cell 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="center" valignment="top" topline="true" leftline="true" usebox="none">
3455 \begin_layout Plain Layout
3461 <cell alignment="center" valignment="top" topline="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" rightline="true" usebox="none">
3518 \begin_layout Plain Layout
3526 <cell multirow="4" alignment="left" valignment="middle" topline="true" leftline="true" usebox="none">
3529 \begin_layout Plain Layout
3535 <cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3538 \begin_layout Plain Layout
3544 <cell multirow="3" alignment="left" valignment="middle" topline="true" bottomline="true" leftline="true" usebox="none">
3547 \begin_layout Plain Layout
3553 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3556 \begin_layout Plain Layout
3562 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3565 \begin_layout Plain Layout
3571 <cell alignment="center" valignment="top" topline="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" rightline="true" usebox="none">
3628 \begin_layout Plain Layout
3636 <cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3639 \begin_layout Plain Layout
3645 <cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3648 \begin_layout Plain Layout
3654 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3657 \begin_layout Plain Layout
3663 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3666 \begin_layout Plain Layout
3672 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3675 \begin_layout Plain Layout
3681 <cell alignment="center" valignment="top" topline="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" rightline="true" usebox="none">
3738 \begin_layout Plain Layout
3746 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3749 \begin_layout Plain Layout
3755 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3758 \begin_layout Plain Layout
3764 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3767 \begin_layout Plain Layout
3773 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3776 \begin_layout Plain Layout
3782 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3785 \begin_layout Plain Layout
3791 <cell alignment="center" valignment="top" topline="true" bottomline="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" rightline="true" usebox="none">
3848 \begin_layout Plain Layout
3862 \begin_layout Subsubsection
3866 \begin_layout Standard
3867 These tests check whether a .lyx file loads without any terminal messages.
3868 They correspond to the manual operations of simply opening a .lyx file on
3869 the terminal, exiting LyX once the file is loaded, and then checking whether
3870 there is any output from the terminal.
3871 These tests are useful for catching malformed .lyx files and parsing bugs.
3872 They can also be used to find a .lyx file in which an instance of something
3874 To do this, compile LyX with a local patch that outputs something to the
3875 terminal when an instance is found, and then run the check_load tests to
3876 see if any fail, which would mean that the situation occurs in the LyX
3877 documentation files corresponding to the failed tests.
3878 These tests are expectedly fragile: any LyX diagnostic message, which is
3879 not necessarily an error, would cause the tests to fail.
3880 Similarly, any message output by a library (e.g.
3881 Qt) would also cause failure.
3882 There are some messages that the check_load tests are instructed to ignore,
3883 which are stored in the file
3884 \begin_inset Flex Code
3887 \begin_layout Plain Layout
3888 development/autotests/filterCheckWarnings
3896 \begin_layout Standard
3897 Under cmake, the tests are labeled as 'load'.
3900 \begin_layout Subsubsection
3904 \begin_layout Standard
3905 Automated tests based on the "MonKey Testing" keytest program.
3906 They are documented in the README document in
3907 \begin_inset Flex Code
3910 \begin_layout Plain Layout
3911 development/autotests
3916 subfolder of the \SpecialChar LyX
3917 source code distribution.
3921 \begin_layout Subsubsection
3925 \begin_layout Standard
3926 These tests combine lyx2lyx tests with check_load tests.
3927 They fail if either fails.
3930 \begin_layout Subsubsection
3934 \begin_layout Standard
3935 The URL tests are enabled with the
3936 \begin_inset Flex Code
3939 \begin_layout Plain Layout
3940 -DLYX_ENABLE_URLTESTS=ON
3945 CMake flag and are useful for finding broken links in our documentation
3947 If a URL test fails, to see which link in particular was reported as broken,
3949 \begin_inset Flex Code
3952 \begin_layout Plain Layout
3959 These tests are extremely fragile (e.g.
3960 a test can depend on your Internet connection) and a failed URL test should
3961 not be taken too seriously.
3962 URL tests are labeled as
3967 \begin_layout Paragraph
3971 \begin_layout Standard
3972 cmake is required to run the \SpecialChar LyX
3973 tests, running them is not implemented for
3977 \begin_layout Standard
3978 The appropriate commands are:
3981 \begin_layout Itemize
3987 \begin_inset Newline newline
3990 runs all tests with label
3995 \begin_layout Itemize
3998 ctest -R 'check_.*urls'
4001 \begin_inset Newline newline
4004 runs the tests 'check_accessible_urls'
4007 \begin_layout Standard
4008 Associated test results can be examined in ctest-log directory in files
4009 of the form 'LastFailed.*URLS.log'
4012 \begin_layout Section
4013 Development policies
4016 \begin_layout Standard
4017 This chapter lists some guidelines that should be followed.
4018 This list is not complete, and many guidelines are in separate chapters,
4020 \begin_inset Quotes eld
4023 When is an update of the .lyx file format number needed?
4024 \begin_inset Quotes erd
4028 \begin_inset CommandInset ref
4030 reference "sec:When-is-an"
4037 \begin_layout Subsection
4038 When to set a fixed milestone?
4041 \begin_layout Standard
4042 Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following
4046 \begin_layout Enumerate
4047 Somebody is actively working on a fix.
4050 \begin_layout Enumerate
4051 The bug is so severe that it would block the release if it is not fixed.
4054 \begin_layout Standard
4055 If a bug is important, but nobody is working on it, and it is no showstopper,
4056 use a milestone like 2.1.x or 2.2.x.
4057 For all other bugs, do not set a milestone at all.
4060 \begin_layout Subsection
4061 Can we add rc entries in stable branch?
4064 \begin_layout Standard
4066 We are supposed to increase the prefs2prefs version number with such things.
4069 \begin_layout Section
4070 Documentation policies
4073 \begin_layout Standard
4074 The main documentation consists of these files:
4077 \begin_layout Description
4078 splash.lyx it is the first file you see after an installation.
4079 We assume that a new user sees this.
4080 It is therefore designed to be as simple as possible.
4081 Therefore please don't add any new formatting, only fix typos etc.
4082 Splash.lyx is up to date for \SpecialChar LyX
4083 2.1.x, currently maintained by Uwe Stöhr.
4086 \begin_layout Description
4087 Intro.lyx This is the manual new users will read to learn \SpecialChar LyX
4089 It therefore uses a limited set of formatting.
4090 For example a standard document class.
4091 Since new users will first learn about the formatting possibilities of
4093 please keep this file that simple.
4094 Intro.lyx is up to date for \SpecialChar LyX
4095 2.1.x, currently maintained by Uwe Stöhr.
4098 \begin_layout Description
4099 Tutorial.lyx our tutorial.
4100 It must be always up to date.
4101 Normally there is nothing to add since we don't want to overwhelm new users
4102 with too much details.
4103 The will learn these details while using \SpecialChar LyX
4104 and we have special manuals.
4105 Tutorial.lyx is up to date for \SpecialChar LyX
4106 2.1.x, currently maintained by Uwe Stöhr.
4109 \begin_layout Description
4110 UserGuide.lyx our main user guide.
4111 It covers a mixture of basic and detailed information.
4112 Some information is also in the Math and EmbeddedObjects manual so that
4113 the UserGuide refers to these files.
4114 UserGuide.lyx is up to date for \SpecialChar LyX
4115 2.1.x, currently maintained by Uwe Stöhr.
4118 \begin_layout Description
4119 EmbeddedObjects.lyx a special manual to explain things like tables floats
4122 EmbeddedObjects.lyx is up to date for \SpecialChar LyX
4123 2.1.x, currently maintained by Uwe
4127 \begin_layout Description
4128 Math.lyx a special manual to explain everything regarding math in all detail.
4129 Math.lyx is up to date for \SpecialChar LyX
4130 2.1.x, currently maintained by Uwe Stöhr.
4133 \begin_layout Description
4134 Additional.lyx this manual covers information that would be too much detail
4135 for the UserGuide or would make the UserGuide uncompilable or only compilable
4136 when installing a lot of special \SpecialChar LaTeX
4138 What should be in the UserGuide or better in Additional is a matter of
4140 it is up to you to decide that.
4141 Additional.lyx is not completely up to date for \SpecialChar LyX
4144 \begin_inset space ~
4147 8 is up to date and currently maintained by Uwe Stöhr.
4148 It certainly needs a rewrite and update.
4149 For example many info in chapter
4150 \begin_inset space ~
4153 2 and 3 are already covered by the UserGuide and/or the EmbeddedObjects
4157 \begin_layout Description
4158 Customization.lyx this manual covers information how to customize \SpecialChar LyX
4160 output formats, operating systems, languages etc.
4161 It is currently completely out of date and needs a major rewrite and update.
4162 If you do this please assure that your information are given for all OSes
4163 and \SpecialChar LaTeX
4164 distributions (meaning be as objective as possible).
4167 \begin_layout Standard
4169 \begin_inset space ~
4172 rules in editing the docs:
4175 \begin_layout Enumerate
4176 If you are not the maintainer of a doc file or a chapter/section, you MUST
4177 use change tracking so that the maintainer could review your changes
4180 \begin_layout Enumerate
4181 Respect the formatting of the document.
4182 The different files use different formatting styles.
4183 That is OK and has historic reasons nobody fully know ;-).
4184 But it is important to be consistent within one file.
4187 \begin_layout Enumerate
4188 All changes you make to a file in one language MUST also go the file in
4189 the other actively maintained languages.
4190 Normally the maintainer does this for you, if you are the maintainer, you
4191 must do this by copying or changing the changed or added text to the other
4192 files so that the translators sees the blue underlined text and know what
4193 they have to translate and what was changed.
4196 \begin_layout Enumerate
4197 You MUST assure that the document is compilable as
4198 \begin_inset Quotes eld
4202 \begin_inset Quotes erd