1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
7 \options BCOR8mm,captions=tableheading
8 \use_default_options false
12 \maintain_unincluded_children false
14 \language_package default
17 \font_roman "lmodern" "default"
18 \font_sans "lmss" "default"
19 \font_typewriter "lmtt" "default"
20 \font_math "auto" "auto"
21 \font_default_family default
22 \use_non_tex_fonts false
25 \font_sf_scale 100 100
26 \font_tt_scale 100 100
28 \default_output_format default
30 \bibtex_command default
31 \index_command default
35 \pdf_title "LyX's Development manual"
36 \pdf_author "LyX Team"
37 \pdf_subject "LyX's development documentation"
38 \pdf_keywords "LyX, Documentation, Development"
40 \pdf_bookmarksnumbered true
41 \pdf_bookmarksopen true
42 \pdf_bookmarksopenlevel 1
47 \pdf_pdfusetitle false
48 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
51 \use_package amsmath 1
52 \use_package amssymb 1
55 \use_package mathdots 1
56 \use_package mathtools 0
58 \use_package stackrel 0
59 \use_package stmaryrd 0
60 \use_package undertilde 0
62 \cite_engine_type default
66 \paperorientation portrait
70 \notefontcolor #0000ff
77 \paragraph_separation indent
78 \paragraph_indentation default
79 \quotes_language english
82 \paperpagestyle headings
83 \tracking_changes false
93 Developing \SpecialChar LyX
97 \begin_layout Subtitle
102 by the \SpecialChar LyX
107 \begin_layout Plain Layout
109 If you have comments or error corrections, please send them to the \SpecialChar LyX
112 \begin_inset Flex Code
115 \begin_layout Plain Layout
117 <lyx-docs@lists.lyx.org>
130 \begin_layout Standard
131 \begin_inset CommandInset toc
132 LatexCommand tableofcontents
139 \begin_layout Section
143 \begin_layout Standard
144 This manual documents some aspects of \SpecialChar LyX
146 It is currently rather incomplete, but will hopefully be extended in the
148 Meanwhile, additional information can be found in the
149 \begin_inset Flex Code
152 \begin_layout Plain Layout
158 subfolder of the \SpecialChar LyX
159 source code distribution.
160 This document is not translated, since the development language of \SpecialChar LyX
163 If you want to use \SpecialChar LyX
164 you don't need to read this manual.
165 However, if you want to learn more about how \SpecialChar LyX
166 is developed, or even want
167 to participate in \SpecialChar LyX
168 development, you may find some interesting information.
171 \begin_layout Section
175 \begin_layout Standard
177 uses several custom file formats for configuration files and documents.
178 This chapter contains some background concerning these file formats.
179 Several file formats are also described in detail in the regular user documenta
183 \begin_layout Subsection
187 \begin_layout Subsection
188 When is an update of the .lyx file format number needed?
189 \begin_inset CommandInset label
191 name "sec:When-is-an"
198 \begin_layout Standard
199 When you are working on a new feature you may ask yourself whether it needs
200 an update of the .lyx file format number.
201 Whether an update is needed or not is not always obvious.
202 Below you can find a list of reasons for file format updates with explanations:
205 \begin_layout Description
214 setting Whenever you introduce a new setting that is stored in the document
215 header, a file format update is needed.
216 This is also true if you add a new valid value to an existing setting,
218 \begin_inset space \thinspace{}
222 \begin_inset space \space{}
225 a new language that is stored in
226 \begin_inset Flex Code
229 \begin_layout Plain Layout
240 \begin_layout Description
249 setting If a certain setting becomes obsolete and gets removed, a file format
253 \begin_layout Description
258 inset Of course a new inset requires a file format update.
261 \begin_layout Description
266 style in any layout file or module shipped with \SpecialChar LyX
267 , or new shipped layout
269 These requirements are currently under discussion and might change in the
273 \begin_layout Description
286 package Any new math package that is automatically loaded needs a file format
288 The reason for this is that there is no true ERT inset for math formulas:
289 Each command is parsed, and if a user happens to defne a local command
290 with the same name as a command that triggers an automatic load of a package,
291 he needs to be able to switch off the automatic loading of that package.
292 This switch is stored by the
293 \begin_inset Flex Code
296 \begin_layout Plain Layout
305 \begin_layout Standard
306 If you are still unsure, please ask on the development list.
309 \begin_layout Subsection
310 How to update the file format number of .lyx files
311 \begin_inset CommandInset label
313 name "subsec:update_lyx_files"
320 \begin_layout Standard
321 Once you came to the conclusion that a file format update is needed you
322 should use the following procedure to perform the update:
325 \begin_layout Enumerate
326 Implement and test the new feature, including the reading and writing of
328 Note that any file produced at this stage does not use a valid format,
329 so do not use this version of \SpecialChar LyX
330 for working on any important documents.
333 \begin_layout Enumerate
334 Describe the new format in
335 \begin_inset Flex Code
338 \begin_layout Plain Layout
347 \begin_layout Enumerate
348 Update the \SpecialChar LyX
349 file format number in
350 \begin_inset Flex Code
353 \begin_layout Plain Layout
362 \begin_layout Enumerate
363 Update the range of file formats in the array
364 \begin_inset Flex Code
367 \begin_layout Plain Layout
374 \begin_inset Flex Code
377 \begin_layout Plain Layout
386 \begin_layout Enumerate
387 Add an entry to both format lists (for conversion and reversion) in
388 \begin_inset Newline newline
392 \begin_inset Flex Code
395 \begin_layout Plain Layout
396 lib/lyx2lyx/lyx_2_2.py
402 Add a conversion routine if needed (e.
403 \begin_inset space \thinspace{}
407 \begin_inset space \space{}
410 a new header setting always needs a conversion that adds the new setting,
411 a new document language does not need one).
412 Add a reversion routine if needed.
413 While the conversion routine is required to produce a document that is
414 equivalent to the old version, the requirements of the reversion are not
416 If possible, try to produce a proper reversion, using ERT if needed, but
417 for some features this might be too complicated.
418 In this case, the minimum requirement of the reversion routine is that
419 it produces a valid document which can be read by an older \SpecialChar LyX
421 If absolutely needed, even data loss is allowed for the reversion.
424 \begin_layout Enumerate
425 Since tex2lyx has several implicit file format dependencies caused by sharing
426 code with \SpecialChar LyX
427 , updating the file format of .lyx files produced by tex2lyx at
428 the same time as updating the main .lyx file format is strongly recommended.
429 Therefore, a compiler warning will be issued if the \SpecialChar LyX
430 and tex2lyx .lyx file
431 format numbers differ.
432 In many cases the tex2lyx update requires only the first and last item
434 \begin_inset Separator parbreak
441 \begin_layout Enumerate
442 Update the tex2lyx file format number in
443 \begin_inset Flex Code
446 \begin_layout Plain Layout
455 \begin_layout Enumerate
456 If the lyx2lyx conversion from the old to the new format is empty, or if
457 tex2lyx does not yet output the changed feature, you do not need any further
459 Otherwise, search for the changed feature in tex2lyx, and adjust the output
460 according to the lyx2lyx changes.
463 \begin_layout Enumerate
464 Update the tex2lyx test references as described in
465 \begin_inset CommandInset ref
466 LatexCommand formatted
467 reference "sec:Updating-test-references"
475 \begin_layout Enumerate
476 If you did not implement full tex2lyx support of the new feature, add a
478 \begin_inset Flex Code
481 \begin_layout Plain Layout
487 describing the missing bits.
488 Note that it is perfectly fine if you do not add full tex2lyx support for
489 a new feature: The updating recommendation above is only issued for the
490 syntax of the produced .lyx file.
491 It is no problem if some features supported by \SpecialChar LyX
492 are still output as ERT
493 by tex2lyx, since the problems in the past that resulted in the update
494 recommendation were related to mixed version syntax, not ERT.
497 \begin_layout Enumerate
498 It would be nice if you could create a .lyx test file which contains instances
499 of all changed or added features.
500 This could then be used to test lyx2lyx and tex2lyx.
501 Unfortunately it has not yet been decided how to collect such examples,
502 so please ask on the development list if you want to create one.
505 \begin_layout Enumerate
506 \begin_inset CommandInset label
508 name "enu:updatefiles"
512 Update LyX's .lyx documentation files to the new format.
513 The developer who makes the change knows best what changes to expect when
514 inspecting the resulting diff.
515 Because of this, you might be able to catch a bug in the lyx2lyx code that
516 updates the format just by taking a quick scan through the large diff that
518 \begin_inset Note Note
521 \begin_layout Plain Layout
522 Another advantage is that if later we suspect a bug in lyx2lyx we can easily
523 see which layout update made an unexpected change by looking at the git
524 log of a .lyx file that suffers the problem.
530 To do this, first make sure that there are no changes to the git repository
531 that you will not want to commit (this is needed because it will be convenient
532 to commit with the command
533 \begin_inset Flex Code
536 \begin_layout Plain Layout
543 Then run the following command in the root folder of the source:
544 \begin_inset Flex Code
547 \begin_layout Plain Layout
548 python development/tools/updatedocs.py
554 Then, revert the change to
555 \begin_inset Flex Code
558 \begin_layout Plain Layout
564 because that file is meant to be generated separately:
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
569 git checkout lib/doc/LFUNs.lyx
575 \begin_inset Note Note
578 \begin_layout Plain Layout
579 TODO: this step should be done within updatedocs.py
585 Look at the resulting changes using the command
586 \begin_inset Flex Code
589 \begin_layout Plain Layout
596 If anything looks surprising, please investigate.
597 Finally, commit using
598 \begin_inset Flex Code
601 \begin_layout Plain Layout
610 \begin_layout Subsection
611 Updating the file format number of layout files
614 \begin_layout Standard
616 \begin_inset CommandInset ref
618 reference "enu:updatefiles"
623 \begin_inset CommandInset ref
625 reference "subsec:update_lyx_files"
630 \begin_inset Flex Code
633 \begin_layout Plain Layout
639 command, use this command:
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
644 python development/tools/updatelayouts.py
652 \begin_layout Subsection
653 Updating the file format number of bind/ui files
656 \begin_layout Standard
658 \begin_inset CommandInset ref
660 reference "enu:updatefiles"
665 \begin_inset CommandInset ref
667 reference "subsec:update_lyx_files"
672 \begin_inset Flex Code
675 \begin_layout Plain Layout
681 command, use this command:
682 \begin_inset Flex Code
685 \begin_layout Plain Layout
686 bash development/tools/updatelfuns.sh
694 \begin_layout Subsection
695 Backporting new styles to the stable version
698 \begin_layout Standard
699 Starting with the stable \SpecialChar LyX
700 2.1 branch, there is a mechanism in place to backport
701 new styles to the stable version without the need to update the file format.
702 The basic idea is that the new style definition is automatically copied
703 to the document preamble, so that it can even be used by older minor revisions
704 that did not yet include the style.
705 To backport a new style to the stable version, the following steps are
709 \begin_layout Enumerate
711 \begin_inset Flex Code
714 \begin_layout Plain Layout
720 to the style definition in the development version.
723 \begin_layout Enumerate
724 Copy the style definition to the stable version, but use
725 \begin_inset Flex Code
728 \begin_layout Plain Layout
735 If needed adjust the format to the one used by the stable version (see
736 the customization manual for details of the layout file format).
739 \begin_layout Enumerate
740 For each update of the style in a later stable version, increase the argument
742 \begin_inset Flex Code
745 \begin_layout Plain Layout
751 by one (in the stable version, the development version should not be touched).
754 \begin_layout Standard
755 For details about the
756 \begin_inset Flex Code
759 \begin_layout Plain Layout
765 flag see the customization manual.
767 \begin_inset Flex Code
770 \begin_layout Plain Layout
776 support is needed for backported styles: Since the style of the development
777 version has an infinite version number, it will always be used.
778 Furthermore, since its version number is less than one, the style will
779 not be written anymore to the document header for files saved by the new
783 \begin_layout Standard
784 \begin_inset Newpage newpage
790 \begin_layout Section
794 \begin_layout Standard
795 Automated tests are an important tool to detect bugs and regressions in
796 software development.
797 Some projects like gcc even require each bug fix to be accompanied by a
798 test case for the automatic test suite, that would detect this bug.
799 Testing interactive features automatically is of course very hard, but
800 core functionality like document import and export can be tested quite
801 easily, and some tests of this kind exist.
804 \begin_layout Subsection
809 \begin_layout Standard
810 Some tests are located in the
811 \begin_inset Flex Code
814 \begin_layout Plain Layout
815 development/autotests
820 subfolder of the \SpecialChar LyX
821 source code distribution.
824 \begin_layout Subsubsection
828 \begin_layout Standard
829 cmake is required to run the \SpecialChar LyX
830 tests, running them is not implemented for
833 tests can be run by the commands
834 \begin_inset Flex Code
837 \begin_layout Plain Layout
844 \begin_inset Flex Code
847 \begin_layout Plain Layout
853 (when using a make based build system and not MSVC) in the
854 \begin_inset Flex Code
857 \begin_layout Plain Layout
863 subfolder of the build directory.
866 \begin_layout Subsection
870 \begin_layout Standard
871 The tex2lyx tests are located in the
872 \begin_inset Flex Code
875 \begin_layout Plain Layout
881 subfolder of the \SpecialChar LyX
882 source code distribution.
883 The actual testing is performed by the simple python script
884 \begin_inset Flex Code
887 \begin_layout Plain Layout
888 src/tex2lyx/test/runtests.py
894 Each test consists of two files:
895 \begin_inset Flex Code
898 \begin_layout Plain Layout
904 contains the \SpecialChar LaTeX
905 code that should be tested.
907 \begin_inset Flex Code
910 \begin_layout Plain Layout
916 contains the expected output of tex2lyx.
917 When a test is run, the actual produced output is compared with the stored
919 The test passes if both are identical.
920 The test machinery is also able to generate a file
921 \begin_inset Flex Code
924 \begin_layout Plain Layout
930 by exporting the produced .lyx file with \SpecialChar LyX
932 This may be useful for roundtrip comparisons.
935 \begin_layout Subsubsection
939 \begin_layout Standard
940 The tex2lyx tests can be run in several ways.
942 \begin_inset Flex Code
945 \begin_layout Plain Layout
951 subfolder of the build directory, the commands
952 \begin_inset Flex Code
955 \begin_layout Plain Layout
961 (cmake, all platforms),
962 \begin_inset Flex Code
965 \begin_layout Plain Layout
971 (cmake, when using a make based build system and not MSVC) or
972 \begin_inset Flex Code
975 \begin_layout Plain Layout
981 (autotools) will run the tex2lyx tests.
982 Alternatively, in the root of the build directory, the command
983 \begin_inset Flex Code
986 \begin_layout Plain Layout
992 runs all tests whose names match the regex
993 \begin_inset Quotes eld
997 \begin_inset Quotes erd
1001 Another way to run the tex2lyx tests in the root build directory is to
1002 instead use the command
1003 \begin_inset Flex Code
1006 \begin_layout Plain Layout
1007 ctest -L '(cmplyx|roundtrip)'
1012 , which runs all tests categorized with the label
1013 \begin_inset Quotes eld
1017 \begin_inset Quotes erd
1021 \begin_inset Quotes eld
1025 \begin_inset Quotes erd
1029 If a test fails, the differences between the expected and actual results
1030 are output in unified diff format.
1033 \begin_layout Subsubsection
1034 Updating test references
1035 \begin_inset CommandInset label
1037 name "sec:Updating-test-references"
1044 \begin_layout Standard
1045 In some cases a changed tex2lyx output is not a test failure, but wanted,
1047 \begin_inset space \thinspace{}
1051 \begin_inset space \space{}
1054 if a tex2lyx bug was fixed, or a new feature was added.
1055 In these cases the stored references need to be updated.
1056 To do so if using autotools, call
1057 \begin_inset Flex Code
1060 \begin_layout Plain Layout
1067 \begin_inset Flex Code
1070 \begin_layout Plain Layout
1076 subdirectory of the build directory.
1077 If instead using CMake, call
1078 \begin_inset Flex Code
1081 \begin_layout Plain Layout
1082 make updatetex2lyxtests
1087 in the build directory or in the
1088 \begin_inset Flex Code
1091 \begin_layout Plain Layout
1097 subdirectory of the build directory.
1101 \begin_layout Plain Layout
1102 Note that this is a case where a make target in the build directory can
1103 affect the source directory, which might not be advisable.
1108 On Windows do the following:
1111 \begin_layout Itemize
1112 Assure that the path to the python.exe is in your system PATH variable.
1115 \begin_layout Itemize
1116 Double-click on the file
1117 \begin_inset Flex Code
1120 \begin_layout Plain Layout
1121 updatetex2lyxtests.vcxproj
1126 in the build directory or in the
1127 \begin_inset Flex Code
1130 \begin_layout Plain Layout
1136 subdirectory of your build directory.
1139 \begin_layout Itemize
1140 In the appearing MSVC program right-click on the project
1144 in the project explorer and chose
1151 \begin_layout Standard
1152 For convenience, these commands also produce re-exported roundtrip .lyx.tex
1154 Please examine the changed output carefully before committing the changed
1155 files to the repository: Since the test machinery does not do a roundtrip
1157 \begin_inset Formula $\Rightarrow$
1161 \begin_inset Formula $\Rightarrow$
1164 .tex, and does not compare the produced dvi or pdf output, it assumes that
1165 the stored .lyx reference produces correct output if processed by \SpecialChar LyX
1167 There is only one chance to detect wrong output: before committing a new
1169 Once it is committed, it is quite difficult to verify whether it is correct.
1172 \begin_layout Standard
1177 update the test references by opening them with \SpecialChar LyX
1178 or directly running lyx2lyx
1180 This would not work, since lyx2lyx and \SpecialChar LyX
1181 produce slightly different files
1182 regarding insignificant whitespace and line breaks.
1185 \begin_layout Subsubsection
1189 \begin_layout Standard
1190 In many cases tests for new features may be added to one of the existing
1191 test files, but sometimes this is not possible or not wanted.
1192 Then a new test file needs to be added:
1195 \begin_layout Enumerate
1197 \begin_inset Flex Code
1200 \begin_layout Plain Layout
1201 src/tex2lyx/test/<test name>.tex
1206 and run tex2lyx in roundtrip mode to produce the file
1207 \begin_inset Flex Code
1210 \begin_layout Plain Layout
1211 src/tex2lyx/test/<test name>.lyx.lyx
1217 This file will be the new reference.
1220 \begin_layout Enumerate
1221 Once you confirmed that the tex2lyx output is correct, add the new files
1222 to the corresponding lists in
1223 \begin_inset Flex Code
1226 \begin_layout Plain Layout
1227 src/tex2lyx/test/runtests.py
1233 \begin_inset Flex Code
1236 \begin_layout Plain Layout
1237 src/tex2lyx/Makefile.am
1243 \begin_inset Flex Code
1246 \begin_layout Plain Layout
1247 src/tex2lyx/test/CMakeLists.txt
1255 \begin_layout Enumerate
1256 Commit the changes to the repository, or send a patch to the development
1257 list and ask for committing if you do not have commit rights.
1260 \begin_layout Subsection
1261 Export tests (cmake only)
1264 \begin_layout Standard
1265 The export tests are integration tests.
1266 They take longer to run and are more likely to break than the tex2lyx tests.
1267 Nevertheless, they have caught many regressions and without a better alternativ
1268 e it is important to keep them up-to-date and understand how they work.
1271 \begin_layout Standard
1272 The export tests require the
1273 \begin_inset Flex Code
1276 \begin_layout Plain Layout
1282 command that comes with the
1283 \begin_inset Flex Code
1286 \begin_layout Plain Layout
1295 \begin_layout Subsubsection
1296 Expectations of LyX developers
1299 \begin_layout Standard
1300 Because the export tests are integration tests and take a long time to run,
1301 LyX developers are rarely expected to run all of the tests.
1302 Here are some good practices to follow by developers:
1305 \begin_layout Itemize
1306 When making a non-trivial change to a .layout file, run the export and layout
1307 tests corresponding with that .layout file.
1310 \begin_layout Itemize
1311 When making non-trivial changes to a .lyx file, run the export tests correspondin
1312 g to that .lyx file.
1315 \begin_layout Itemize
1316 When making non-trivial changes to LyX's LaTeX export code (e.g.
1317 touching the encoding code or package handling code that you expect will
1318 change the exported LaTeX in some way), consider running all of the export
1319 tests before and after your change.
1320 If there are differences, please reconcile these (i.e.
1321 fix the bug or fix the tests)
1326 Ask for help if you're not sure what to do or if you do not want to run
1327 the tests, post the patch on the list and others will run the tests.
1330 \begin_layout Itemize
1331 Understand how to interpret test failures.
1332 If your commit is found to have broken a test, you should be able to interpret
1333 the test results when made aware of them.
1335 \begin_inset CommandInset ref
1337 reference "subsec:Interpreting-export-tests"
1344 \begin_layout Subsubsection
1345 Configuring the tests
1348 \begin_layout Standard
1349 To enable these tests, add the
1350 \begin_inset Flex Code
1353 \begin_layout Plain Layout
1354 -DLYX_ENABLE_EXPORT_TESTS=ON
1363 \begin_layout Standard
1364 \begin_inset Flex Code
1367 \begin_layout Plain Layout
1368 cmake -DLYX_ENABLE_EXPORT_TESTS=ON /path/to/source
1376 \begin_layout Standard
1378 This flag will increase the time for the cmake command by several seconds,
1379 mainly because of the process of inverting tests (see Section
1380 \begin_inset CommandInset ref
1382 reference "subsec:Interpreting-export-tests"
1389 \begin_layout Subsubsection
1393 \begin_layout Standard
1394 To run all tests, in the build directory simply run the command
1395 \begin_inset Flex Code
1398 \begin_layout Plain Layout
1405 To run only some of the tests, use the command
1406 \begin_inset Flex Code
1409 \begin_layout Plain Layout
1416 \begin_inset Flex Code
1419 \begin_layout Plain Layout
1425 is a regular expression that matches test names.
1426 To run only the export tests, you can use
1427 \begin_inset Flex Code
1430 \begin_layout Plain Layout
1437 For the list of test categories available in addition to
1438 \begin_inset Quotes eld
1442 \begin_inset Quotes erd
1446 \begin_inset Flex Code
1449 \begin_layout Plain Layout
1450 ctest \SpecialChar nobreakdash
1451 \SpecialChar nobreakdash
1458 It is often useful to list the tests without running them (e.g.
1459 if you want to know how many tests there are or whether your
1460 \begin_inset Flex Code
1463 \begin_layout Plain Layout
1469 regular expression did what you expected).
1470 This can be done with the
1471 \begin_inset Flex Code
1474 \begin_layout Plain Layout
1481 \begin_inset Flex Code
1484 \begin_layout Plain Layout
1485 \SpecialChar nobreakdash
1486 \SpecialChar nobreakdash
1493 We are still working on getting the tests to run in parallel which is supported
1495 \begin_inset Flex Code
1498 \begin_layout Plain Layout
1505 \begin_inset Flex Code
1508 \begin_layout Plain Layout
1515 \begin_inset Flex Code
1518 \begin_layout Plain Layout
1519 \SpecialChar nobreakdash
1520 \SpecialChar nobreakdash
1527 However, when running the tests in parallel, sometimes tests fail that
1528 pass when run sequentially.
1529 A reasonable approach is to first run the tests in parallel and then run
1530 the failed tests sequentially.
1531 For example, to run 8 jobs at a time:
1534 \begin_layout Standard
1535 \begin_inset Flex Code
1538 \begin_layout Plain Layout
1547 \begin_layout Standard
1548 \begin_inset Flex Code
1551 \begin_layout Plain Layout
1552 ctest \SpecialChar nobreakdash
1553 \SpecialChar nobreakdash
1562 \begin_layout Standard
1564 Note that some tests cannot be run in parallel.
1565 These tests are marked in the code with the
1566 \begin_inset Flex Code
1569 \begin_layout Plain Layout
1579 \begin_layout Standard
1580 In some situations the option
1581 \begin_inset Flex Code
1584 \begin_layout Plain Layout
1585 \SpecialChar nobreakdash
1586 \SpecialChar nobreakdash
1593 There have been bugs in LyX and in LaTeX which cause compilation to hang,
1594 and without a timeout a test might never stop (in one case there was even
1596 If a test times out, the
1597 \begin_inset Flex Code
1600 \begin_layout Plain Layout
1606 command exits with error, but you can distinguish between a timed out test
1607 and a failed test in the output reported at the end of the
1608 \begin_inset Flex Code
1611 \begin_layout Plain Layout
1620 \begin_layout Standard
1622 \begin_inset Flex Code
1625 \begin_layout Plain Layout
1631 ) the full list of command line options.
1634 \begin_layout Subsubsection
1635 \begin_inset CommandInset label
1637 name "subsec:Interpreting-export-tests"
1641 Interpreting the export test results
1644 \begin_layout Standard
1645 A test can fail for several reasons, not all of them bad.
1648 \begin_layout Enumerate
1649 The .lyx file could have been added recently and some formats are not expected
1653 \begin_layout Enumerate
1654 A dependency is not met (e.g.
1655 the LaTeX class file).
1656 One hint that this is the case is that the corresponding
1657 \begin_inset Flex Code
1660 \begin_layout Plain Layout
1666 test will likely also fail.
1669 \begin_layout Enumerate
1670 An inverted test fails to fail (i.e.
1671 export that previously failed now works).
1674 \begin_layout Enumerate
1675 An external dependency was updated (e.g.
1679 \begin_layout Enumerate
1680 A recent code change introduced a bug.
1683 \begin_layout Enumerate
1684 \begin_inset CommandInset label
1690 A change in a document exposed a previously unknown bug or an incompatibility
1691 with an export format (e.g.
1695 \begin_layout Standard
1696 Because the .lyx files are exported in several formats, it is not surprising
1697 that many of the exports fail.
1698 This expectation of failure is addressed by
1699 \begin_inset Quotes eld
1703 \begin_inset Quotes erd
1706 the tests, that is, by marking the test as
1707 \begin_inset Quotes eld
1711 \begin_inset Quotes erd
1714 if the export exits with error and as
1715 \begin_inset Quotes eld
1719 \begin_inset Quotes erd
1722 if the export succeeds
1727 It follows that these expected failures will not show up as failed tests
1728 in the test results and thus will not pollute the
1729 \begin_inset Quotes eld
1733 \begin_inset Quotes erd
1737 If the export actually succeeds, then the test will fail.
1738 The purpose of this failure is to get your attention—something has changed,
1739 possibly for the better.
1742 \begin_layout Standard
1743 We try to document why a test is inverted or ignored.
1744 See the comment (prefixed with
1745 \begin_inset Flex Code
1748 \begin_layout Plain Layout
1754 ) above the block in which the test is listed as inverted or ignored in
1756 \begin_inset Flex Code
1759 \begin_layout Plain Layout
1760 development/autotests/revertedTests
1766 \begin_inset Flex Code
1769 \begin_layout Plain Layout
1770 development/autotests/ignoredTests
1776 It is possible that an export goes from succeeding to failing just because
1777 the document was changed and the document was never expected to work with
1778 a certain export format in the first case.
1779 Once this is confirmed to be the situation, the test can be inverted.
1782 \begin_layout Standard
1783 A good question is why do we enable the tests for non-default formats? The
1784 answer is that if a non-default route is broken it is often because a bug
1785 was introduced in LyX and not because a document-specific change was made
1786 that is not supported by the route.
1787 In other words, there is a high signal/noise ratio in the export tests
1788 for some non-default formats.
1792 \begin_layout Standard
1793 What action should you take if a test fails? First, check manually that
1794 when the compilation succeeded before the resulting PDF was good.
1795 In fact, sometimes it is an improvement when a test fails.
1796 If you check manually, it might be the case that the export was succeeding
1797 before but showing garbled text in a PDF output.
1798 Now it might fail with a clear message of "language xyz not supported".
1799 It is always good to check manually why something fails and if it passes
1800 if the PDF output is good.
1803 \begin_layout Standard
1804 Sometimes a test is fixed as side-effect of some change.
1805 We should uninvert a test (remove it from the
1806 \begin_inset Flex Code
1809 \begin_layout Plain Layout
1815 file) in order to preserve the fix.
1818 \begin_layout Standard
1819 When a test or several tests fail, consider checking the files in the
1820 \begin_inset Flex Code
1823 \begin_layout Plain Layout
1829 subdirectory of your build directory.
1830 In this subdirectory are three files: the file
1831 \begin_inset Flex Code
1834 \begin_layout Plain Layout
1840 simply lists the tests that failed on your last
1841 \begin_inset Flex Code
1844 \begin_layout Plain Layout
1851 \begin_inset Flex Code
1854 \begin_layout Plain Layout
1860 file contains the output from the tests (and often has details explaining
1861 why a test failed); and the
1862 \begin_inset Flex Code
1865 \begin_layout Plain Layout
1871 file lists the times that it took to run the tests.
1874 \begin_layout Subsubsection
1878 \begin_layout Standard
1879 These tests are expected to always fail.
1882 \begin_layout Description
1883 reverted These tests are expected to fail, but are subject to be examined.
1884 It is expected that they will pass in a foreseeable future.
1885 They are labeled 'reverted'.
1888 \begin_layout Description
1889 suspended Some inverted tests are labeled 'suspended'.
1890 This means, they are not executed using
1891 \begin_inset Flex Code
1894 \begin_layout Plain Layout
1901 \begin_inset Flex Code
1904 \begin_layout Plain Layout
1911 From time to time they still have to be checked using
1912 \begin_inset Flex Code
1915 \begin_layout Plain Layout
1925 \begin_layout Standard
1926 These tests are suspended, because they fail for known reasons which cannot
1928 But it is expected the reason might disappear in the future.
1929 Be it new TL or better handling in \SpecialChar LyX
1933 \begin_layout Standard
1934 For ctest commands without the
1935 \begin_inset Flex Code
1938 \begin_layout Plain Layout
1944 parameter nothing changes.
1945 Suspended or not, tests will be executed depending only on the regexes
1946 parameters given to the ctest command.
1950 \begin_layout Subsubsection
1954 \begin_layout Description
1955 nonstandard Requires non-standard ressources (LaTeX packages and document
1956 classes, fonts, ...) that are not a requirement for running this test suite.
1960 \begin_layout Standard
1961 These tests are labeled as
1967 \begin_layout Description
1969 \begin_inset Quotes eld
1973 \begin_inset Quotes erd
1976 result, depending on local configuration, OS, TeX distribution, package
1977 versions, or the phase of the moon.
1981 \begin_layout Standard
1982 These tests are labeled as
1988 \begin_layout Subsection
1989 Export test filtering
1992 \begin_layout Standard
1993 There are files which control the assignment of a label to a test.
1996 \begin_layout Description
1997 ignoredTests (smal file)
1998 \begin_inset Newline newline
2001 Tests selected here are withdrawn
2005 \begin_layout Labeling
2006 \labelwidthstring 00.00.0000
2007 Input Test of any export combination
2010 \begin_layout Labeling
2011 \labelwidthstring 00.00.0000
2012 Output Stop if tests not selected here
2016 \begin_layout Description
2017 unreliableTests: Tests selected either pass or fail, but that is dependent
2018 on the system where the test is run.
2019 Selected tests gain the label 'unreliable'.
2023 \begin_layout Labeling
2024 \labelwidthstring 00.00.0000
2025 Input Each test which passed 'ignoredTests'
2028 \begin_layout Labeling
2029 \labelwidthstring 00.00.0000
2030 Output Stop if test selected, gain label 'unreliable'.
2034 \begin_layout Description
2036 \begin_inset space \space{}
2043 \begin_layout Labeling
2044 \labelwidthstring 00.00.0000
2045 Input Each test which passed 'unreliableTests'
2048 \begin_layout Labeling
2049 \labelwidthstring 00.00.0000
2050 Output Stop if not selected.
2053 \begin_layout Standard
2054 The following file is meant as subselections of 'suspiciousTests'.
2055 If neither subselection applies, test gains labels 'export' and 'reverted'
2058 \begin_layout Description
2059 suspendedTests Tests selected here gain the label 'suspended' but _not_
2060 'export' or 'reverted'.
2064 \begin_layout Labeling
2065 \labelwidthstring 00.00.0000
2066 Input Each test selected by 'suspiciousTests'
2069 \begin_layout Labeling
2070 \labelwidthstring 00.00.0000
2071 Output Selected test gains label 'suspended'.
2077 \begin_layout Subsection
2081 \begin_layout Standard
2082 These tests check whether a .lyx file loads without any terminal messages.
2083 They correspond to the manual operations of simply opening a .lyx file on
2084 the terminal, exiting LyX once the file is loaded, and then checking whether
2085 there is any output from the terminal.
2086 These tests are useful for catching malformed .lyx files and parsing bugs.
2087 They can also be used to find a .lyx file in which an instance of something
2089 To do this, compile LyX with a local patch that outputs something to the
2090 terminal when an instance is found, and then run the check_load tests to
2091 see if any fail, which would mean that the situation occurs in the LyX
2092 documentation files corresponding to the failed tests.
2093 These tests are expectedly fragile: any LyX diagnostic message, which is
2094 not necessarily an error, would cause the tests to fail.
2095 Similarly, any message output by a library (e.g.
2096 Qt) would also cause failure.
2097 There are some messages that the check_load tests are instructed to ignore,
2098 which are stored in the file
2099 \begin_inset Flex Code
2102 \begin_layout Plain Layout
2103 development/autotests/filterCheckWarnings
2111 \begin_layout Standard
2112 Under cmake, the tests are labeled as 'load'.
2115 \begin_layout Subsection
2116 URL tests (cmake only)
2119 \begin_layout Standard
2120 The URL tests are enabled with the
2121 \begin_inset Flex Code
2124 \begin_layout Plain Layout
2125 -DLYX_ENABLE_URLTESTS=ON
2130 CMake flag and are useful for finding broken links in our documentation
2132 If a URL test fails, to see which link in particular was reported as broken,
2134 \begin_inset Flex Code
2137 \begin_layout Plain Layout
2144 These tests are extremely fragile (e.g.
2145 a test can depend on your Internet connection) and a failed URL test should
2146 not be taken too seriously.
2147 URL tests are labeled as
2152 \begin_layout Subsubsection
2156 \begin_layout Standard
2157 cmake is required to run the \SpecialChar LyX
2158 tests, running them is not implemented for
2162 \begin_layout Standard
2163 The appropriate commands are:
2166 \begin_layout Itemize
2172 \begin_inset Newline newline
2175 runns all tests with label
2180 \begin_layout Itemize
2183 ctest -R 'check_.*urls'
2186 \begin_inset Newline newline
2189 runns the tests 'check_accessible_urls'
2192 \begin_layout Standard
2193 Associated test results can be examined in ctest-log directory in files
2194 of the form 'LastFailed.*URLS.log'
2197 \begin_layout Subsection
2198 Test labels (cmake only)
2201 \begin_layout Standard
2202 ctest label commands:
2205 \begin_layout Description
2206 \SpecialChar nobreakdash
2207 \SpecialChar nobreakdash
2208 print-labels shows all assigned labels
2211 \begin_layout Description
2212 \SpecialChar nobreakdash
2214 \begin_inset space ~
2217 labelname executes all tests to which this label is asigned to.
2218 A test may have more that one label.
2221 \begin_layout Description
2222 \SpecialChar nobreakdash
2224 \begin_inset space ~
2227 number executes tests in parallel using 'number' simultaneously processes.
2228 Some tests are marked as 'sequencial', for them this parameter has no effect.
2231 \begin_layout Section
2232 Development policies
2235 \begin_layout Standard
2236 This chapter lists some guidelines that should be followed.
2237 This list is not complete, and many guidelines are in separate chapters,
2239 \begin_inset Quotes eld
2242 When is an update of the .lyx file format number needed?
2243 \begin_inset Quotes erd
2247 \begin_inset CommandInset ref
2249 reference "sec:When-is-an"
2256 \begin_layout Subsection
2257 When to set a fixed milestone?
2260 \begin_layout Standard
2261 Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following
2265 \begin_layout Enumerate
2266 Somebody is actively working on a fix.
2269 \begin_layout Enumerate
2270 The bug is so severe that it would block the release if it is not fixed.
2273 \begin_layout Standard
2274 If a bug is important, but nobody is working on it, and it is no showstopper,
2275 use a milestone like 2.1.x or 2.2.x.
2276 For all other bugs, do not set a milestone at all.
2279 \begin_layout Subsection
2280 Can we add rc entries in stable branch?
2283 \begin_layout Standard
2285 We are supposed to increase the prefs2prefs version number with such things.
2288 \begin_layout Section
2289 Documentation policies
2292 \begin_layout Standard
2293 The main documentation consists of these files:
2296 \begin_layout Description
2297 splash.lyx it is the first file you see after an installation.
2298 We assume that a new user sees this.
2299 It is therefore designed to be as simple as possible.
2300 Therefore please don't add any new formatting, only fix typos etc.
2301 Splash.lyx is up to date for \SpecialChar LyX
2302 2.1.x, currently maintained by Uwe Stöhr.
2305 \begin_layout Description
2306 Intro.lyx This is the manual new users will read to learn \SpecialChar LyX
2308 It therefore uses a limited set of formatting.
2309 For example a standard document class.
2310 Since new users will first learn about the formatting possibilities of
2312 please keep this file that simple.
2313 Intro.lyx is up to date for \SpecialChar LyX
2314 2.1.x, currently maintained by Uwe Stöhr.
2317 \begin_layout Description
2318 Tutorial.lyx our tutorial.
2319 It must be always up to date.
2320 Normally there is nothing to add since we don't want to overwhelm new users
2321 with too much details.
2322 The will learn these details while using \SpecialChar LyX
2323 and we have special manuals.
2324 Tutorial.lyx is up to date for \SpecialChar LyX
2325 2.1.x, currently maintained by Uwe Stöhr.
2328 \begin_layout Description
2329 UserGuide.lyx our main user guide.
2330 It covers a mixture of basic and detailed information.
2331 Some information is also in the Math and EmbeddedObjects manual so that
2332 the UserGuide refers to these files.
2333 UserGuide.lyx is up to date for \SpecialChar LyX
2334 2.1.x, currently maintained by Uwe Stöhr.
2337 \begin_layout Description
2338 EmbeddedObjects.lyx a special manual to explain things like tables floats
2341 EmbeddedObjects.lyx is up to date for \SpecialChar LyX
2342 2.1.x, currently maintained by Uwe
2346 \begin_layout Description
2347 Math.lyx a special manual to explain everything regarding math in all detail.
2348 Math.lyx is up to date for \SpecialChar LyX
2349 2.1.x, currently maintained by Uwe Stöhr.
2352 \begin_layout Description
2353 Additional.lyx this manual covers information that would be too much detail
2354 for the UserGuide or would make the UserGuide uncompilable or only compilable
2355 when installing a lot of special \SpecialChar LaTeX
2357 What should be in the UserGuide or better in Additional is a matter of
2359 it is up to you to decide that.
2360 Additional.lyx is not completely up to date for \SpecialChar LyX
2363 \begin_inset space ~
2366 8 is up to date and currently maintained by Uwe Stöhr.
2367 It certainly needs a rewrite and update.
2368 For example many info in chapter
2369 \begin_inset space ~
2372 2 and 3 are already covered by the UserGuide and/or the EmbeddedObjects
2376 \begin_layout Description
2377 Customization.lyx this manual covers information how to customize \SpecialChar LyX
2379 output formats, operating systems, languages etc.
2380 It is currently completely out of date and needs a major rewrite and update.
2381 If you do this please assure that your information are given for all OSes
2382 and \SpecialChar LaTeX
2383 distributions (meaning be as objective as possible).
2386 \begin_layout Standard
2388 \begin_inset space ~
2391 rules in editing the docs:
2394 \begin_layout Enumerate
2395 If you are not the maintainer of a doc file or a chapter/section, you MUST
2396 use change tracking so that the maintainer could review your changes
2399 \begin_layout Enumerate
2400 Respect the formatting of the document.
2401 The different files use different formatting styles.
2402 That is OK and has historic reasons nobody fully know ;-).
2403 But it is important to be consistent within one file.
2406 \begin_layout Enumerate
2407 All changes you make to a file in one language MUST also go the file in
2408 the other actively maintained languages.
2409 Normally the maintainer does this for you, if you are the maintainer, you
2410 must do this by copying or changing the changed or added text to the other
2411 files so that the translators sees the blue underlined text and know what
2412 they have to translate and what was changed.
2415 \begin_layout Enumerate
2416 You MUST assure that the document is compilable as
2417 \begin_inset Quotes eld
2421 \begin_inset Quotes erd