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
15 InsetLayout CharStyle:MenuItem
24 \newcommand*{\menuitem}[1]{{\sffamily #1}}
29 \language_package default
32 \font_roman "lmodern" "default"
33 \font_sans "lmss" "default"
34 \font_typewriter "lmtt" "default"
35 \font_math "auto" "auto"
36 \font_default_family default
37 \use_non_tex_fonts false
40 \font_sf_scale 100 100
41 \font_tt_scale 100 100
43 \default_output_format default
45 \bibtex_command default
46 \index_command default
50 \pdf_title "LyX's Development manual"
51 \pdf_author "LyX Team"
52 \pdf_subject "LyX's development documentation"
53 \pdf_keywords "LyX, Documentation, Development"
55 \pdf_bookmarksnumbered true
56 \pdf_bookmarksopen true
57 \pdf_bookmarksopenlevel 1
62 \pdf_pdfusetitle false
63 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
66 \use_package amsmath 1
67 \use_package amssymb 1
70 \use_package mathdots 1
71 \use_package mathtools 0
73 \use_package stackrel 0
74 \use_package stmaryrd 0
75 \use_package undertilde 0
77 \cite_engine_type default
81 \paperorientation portrait
85 \notefontcolor #0000ff
92 \paragraph_separation indent
93 \paragraph_indentation default
94 \quotes_language english
97 \paperpagestyle headings
98 \tracking_changes false
108 Developing \SpecialChar LyX
112 \begin_layout Subtitle
117 by the \SpecialChar LyX
122 \begin_layout Plain Layout
124 If you have comments or error corrections, please send them to the \SpecialChar LyX
127 \begin_inset Flex Code
130 \begin_layout Plain Layout
132 <lyx-docs@lists.lyx.org>
145 \begin_layout Standard
146 \begin_inset CommandInset toc
147 LatexCommand tableofcontents
154 \begin_layout Section
158 \begin_layout Standard
159 This manual documents some aspects of \SpecialChar LyX
161 It is currently rather incomplete, but will hopefully be extended in the
163 Meanwhile, additional information can be found in the
164 \begin_inset Flex Code
167 \begin_layout Plain Layout
173 subfolder of the \SpecialChar LyX
174 source code distribution.
175 This document is not translated, since the development language of \SpecialChar LyX
178 If you want to use \SpecialChar LyX
179 you don't need to read this manual.
180 However, if you want to learn more about how \SpecialChar LyX
181 is developed, or even want
182 to participate in \SpecialChar LyX
183 development, you may find some interesting information.
186 \begin_layout Section
190 \begin_layout Standard
192 uses several custom file formats for configuration files and documents.
193 This chapter contains some background concerning these file formats.
194 Several file formats are also described in detail in the regular user documenta
198 \begin_layout Subsection
202 \begin_layout Subsection
203 When is an update of the .lyx file format number needed?
204 \begin_inset CommandInset label
206 name "sec:When-is-an"
213 \begin_layout Standard
214 When you are working on a new feature you may ask yourself whether it needs
215 an update of the .lyx file format number.
216 Whether an update is needed or not is not always obvious.
217 Below you can find a list of reasons for file format updates with explanations:
220 \begin_layout Description
229 setting Whenever you introduce a new setting that is stored in the document
230 header, a file format update is needed.
231 This is also true if you add a new valid value to an existing setting,
233 \begin_inset space \thinspace{}
237 \begin_inset space \space{}
240 a new language that is stored in
241 \begin_inset Flex Code
244 \begin_layout Plain Layout
255 \begin_layout Description
264 setting If a certain setting becomes obsolete and gets removed, a file format
268 \begin_layout Description
273 inset Of course a new inset requires a file format update.
276 \begin_layout Description
281 style in any layout file or module shipped with \SpecialChar LyX
282 , or new shipped layout
284 These requirements are currently under discussion and might change in the
288 \begin_layout Description
301 package Any new math package that is automatically loaded needs a file format
303 The reason for this is that there is no true ERT inset for math formulas:
304 Each command is parsed, and if a user happens to defne a local command
305 with the same name as a command that triggers an automatic load of a package,
306 he needs to be able to switch off the automatic loading of that package.
307 This switch is stored by the
308 \begin_inset Flex Code
311 \begin_layout Plain Layout
320 \begin_layout Standard
321 If you are still unsure, please ask on the development list.
324 \begin_layout Subsection
325 How to update the file format number of .lyx files
328 \begin_layout Standard
329 Once you came to the conclusion that a file format update is needed you
330 should use the following procedure to perform the update:
333 \begin_layout Enumerate
334 Implement and test the new feature, including the reading and writing of
336 Note that any file produced at this stage does not use a valid format,
337 so do not use this version of \SpecialChar LyX
338 for working on any important documents.
341 \begin_layout Enumerate
342 Describe the new format in
343 \begin_inset Flex Code
346 \begin_layout Plain Layout
355 \begin_layout Enumerate
356 Update the \SpecialChar LyX
357 file format number in
358 \begin_inset Flex Code
361 \begin_layout Plain Layout
370 \begin_layout Enumerate
371 Add an entry to both format lists (for conversion and reversion) in
372 \begin_inset Newline newline
376 \begin_inset Flex Code
379 \begin_layout Plain Layout
380 lib/lyx2lyx/lyx_2_2.py
386 Add a conversion routine if needed (e.
387 \begin_inset space \thinspace{}
391 \begin_inset space \space{}
394 a new header setting always needs a conversion that adds the new setting,
395 a new document language does not need one).
396 Add a reversion routine if needed.
397 While the conversion routine is required to produce a document that is
398 equivalent to the old version, the requirements of the reversion are not
400 If possible, try to produce a proper reversion, using ERT if needed, but
401 for some features this might be too complicated.
402 In this case, the minimum requirement of the reversion routine is that
403 it produces a valid document which can be read by an older \SpecialChar LyX
405 If absolutely needed, even data loss is allowed for the reversion.
408 \begin_layout Enumerate
409 Since tex2lyx has several implicit file format dependencies caused by sharing
410 code with \SpecialChar LyX
411 , updating the file format of .lyx files produced by tex2lyx at
412 the same time as updating the main .lyx file format is strongly recommended.
413 Therefore, a compiler warning will be issued if the \SpecialChar LyX
414 and tex2lyx .lyx file
415 format numbers differ.
416 In many cases the tex2lyx update requires only the first and last item
418 \begin_inset Separator parbreak
425 \begin_layout Enumerate
426 Update the tex2lyx file format number in
427 \begin_inset Flex Code
430 \begin_layout Plain Layout
439 \begin_layout Enumerate
440 If the lyx2lyx conversion from the old to the new format is empty, or if
441 tex2lyx does not yet output the changed feature, you do not need any further
443 Otherwise, search for the changed feature in tex2lyx, and adjust the output
444 according to the lyx2lyx changes.
447 \begin_layout Enumerate
448 Update the tex2lyx test references as described in
449 \begin_inset CommandInset ref
450 LatexCommand formatted
451 reference "sec:Updating-test-references"
459 \begin_layout Enumerate
460 If you did not implement full tex2lyx support of the new feature, add a
462 \begin_inset Flex Code
465 \begin_layout Plain Layout
471 describing the missing bits.
472 Note that it is perfectly fine if you do not add full tex2lyx support for
473 a new feature: The updating recommendation above is only issued for the
474 syntax of the produced .lyx file.
475 It is no problem if some features supported by \SpecialChar LyX
476 are still output as ERT
477 by tex2lyx, since the problems in the past that resulted in the update
478 recommendation were related to mixed version syntax, not ERT.
481 \begin_layout Enumerate
482 It would be nice if you could create a .lyx test file which contains instances
483 of all changed or added features.
484 This could then be used to test lyx2lyx and tex2lyx.
485 Unfortunately it has not yet been decided how to collect such examples,
486 so please ask on the development list if you want to create one.
489 \begin_layout Subsection
490 Backporting new styles to the stable version
493 \begin_layout Standard
494 Starting with the stable \SpecialChar LyX
495 2.1 branch, there is a mechanism in place to backport
496 new styles to the stable version without the need to update the file format.
497 The basic idea is that the new style definition is automatically copied
498 to the document preamble, so that it can even be used by older minor revisions
499 that did not yet include the style.
500 To backport a new style to the stable version, the following steps are
504 \begin_layout Enumerate
506 \begin_inset Flex Code
509 \begin_layout Plain Layout
515 to the style definition in the development version.
518 \begin_layout Enumerate
519 Copy the style definition to the stable version, but use
520 \begin_inset Flex Code
523 \begin_layout Plain Layout
530 If needed adjust the format to the one used by the stable version (see
531 the customization manual for details of the layout file format).
534 \begin_layout Enumerate
535 For each update of the style in a later stable version, increase the argument
537 \begin_inset Flex Code
540 \begin_layout Plain Layout
546 by one (in the stable version, the development version should not be touched).
549 \begin_layout Standard
550 For details about the
551 \begin_inset Flex Code
554 \begin_layout Plain Layout
560 flag see the customization manual.
562 \begin_inset Flex Code
565 \begin_layout Plain Layout
571 support is needed for backported styles: Since the style of the development
572 version has an infinite version number, it will always be used.
573 Furthermore, since its version number is less than one, the style will
574 not be written anymore to the document header for files saved by the new
578 \begin_layout Standard
579 \begin_inset Newpage newpage
585 \begin_layout Section
589 \begin_layout Standard
590 Automated tests are an important tool to detect bugs and regressions in
591 software development.
592 Some projects like gcc even require each bug fix to be accompanied by a
593 test case for the automatic test suite, that would detect this bug.
594 Testing interactive features automatically is of course very hard, but
595 core functionality like document import and export can be tested quite
596 easily, and some tests of this kind exist.
599 \begin_layout Subsection
604 \begin_layout Standard
605 Some tests are located in the
606 \begin_inset Flex Code
609 \begin_layout Plain Layout
610 development/autotests
615 subfolder of the \SpecialChar LyX
616 source code distribution.
619 \begin_layout Subsubsection
623 \begin_layout Standard
624 cmake is required to run the \SpecialChar LyX
625 tests, running them is not implemented for
628 tests can be run by the commands
629 \begin_inset Flex Code
632 \begin_layout Plain Layout
639 \begin_inset Flex Code
642 \begin_layout Plain Layout
648 (when using a make based build system and not MSVC) in the
649 \begin_inset Flex Code
652 \begin_layout Plain Layout
658 subfolder of the build directory.
661 \begin_layout Subsection
665 \begin_layout Standard
666 The tex2lyx tests are located in the
667 \begin_inset Flex Code
670 \begin_layout Plain Layout
676 subfolder of the \SpecialChar LyX
677 source code distribution.
678 The actual testing is performed by the simple python script
679 \begin_inset Flex Code
682 \begin_layout Plain Layout
683 src/tex2lyx/test/runtests.py
689 Each test consists of two files:
690 \begin_inset Flex Code
693 \begin_layout Plain Layout
699 contains the \SpecialChar LaTeX
700 code that should be tested.
702 \begin_inset Flex Code
705 \begin_layout Plain Layout
711 contains the expected output of tex2lyx.
712 When a test is run, the actual produced output is compared with the stored
714 The test passes if both are identical.
715 The test machinery is also able to generate a file
716 \begin_inset Flex Code
719 \begin_layout Plain Layout
725 by exporting the produced .lyx file with \SpecialChar LyX
727 This may be useful for roundtrip comparisons.
730 \begin_layout Subsubsection
734 \begin_layout Standard
735 The tex2lyx tests can be run in several ways.
737 \begin_inset Flex Code
740 \begin_layout Plain Layout
746 subfolder of the build directory, the commands
747 \begin_inset Flex Code
750 \begin_layout Plain Layout
756 (cmake, all platforms),
757 \begin_inset Flex Code
760 \begin_layout Plain Layout
766 (cmake, when using a make based build system and not MSVC) or
767 \begin_inset Flex Code
770 \begin_layout Plain Layout
776 (autotools) will run the tex2lyx tests.
777 Alternatively, in the root of the build directory, the command
778 \begin_inset Flex Code
781 \begin_layout Plain Layout
787 runs all tests whose names match the regex
788 \begin_inset Quotes eld
792 \begin_inset Quotes erd
796 Another way to run the tex2lyx tests in the root build directory is to
797 instead use the command
798 \begin_inset Flex Code
801 \begin_layout Plain Layout
802 ctest -L '(cmplyx|roundtrip)'
807 , which runs all tests categorized with the label
808 \begin_inset Quotes eld
812 \begin_inset Quotes erd
816 \begin_inset Quotes eld
820 \begin_inset Quotes erd
824 If a test fails, the differences between the expected and actual results
825 are output in unified diff format.
828 \begin_layout Subsubsection
829 Updating test references
830 \begin_inset CommandInset label
832 name "sec:Updating-test-references"
839 \begin_layout Standard
840 In some cases a changed tex2lyx output is not a test failure, but wanted,
842 \begin_inset space \thinspace{}
846 \begin_inset space \space{}
849 if a tex2lyx bug was fixed, or a new feature was added.
850 In these cases the stored references need to be updated.
851 To do so if using autotools, call
852 \begin_inset Flex Code
855 \begin_layout Plain Layout
862 \begin_inset Flex Code
865 \begin_layout Plain Layout
871 subdirectory of the build directory.
872 If instead using CMake, call
873 \begin_inset Flex Code
876 \begin_layout Plain Layout
877 make updatetex2lyxtests
882 in the build directory or in the
883 \begin_inset Flex Code
886 \begin_layout Plain Layout
892 subdirectory of the build directory.
896 \begin_layout Plain Layout
897 Note that this is a case where a make target in the build directory can
898 affect the source directory, which might not be advisable.
903 On Windows do the following:
906 \begin_layout Itemize
907 Assure that the path to the python.exe is in your system PATH variable.
910 \begin_layout Itemize
911 Double-click on the file
912 \begin_inset Flex Code
915 \begin_layout Plain Layout
916 updatetex2lyxtests.vcxproj
921 in the build directory or in the
922 \begin_inset Flex Code
925 \begin_layout Plain Layout
931 subdirectory of your build directory.
934 \begin_layout Itemize
935 In the appearing MSVC program right-click on the project
939 in the project explorer and chose
946 \begin_layout Standard
947 For convenience, these commands also produce re-exported roundtrip .lyx.tex
949 Please examine the changed output carefully before committing the changed
950 files to the repository: Since the test machinery does not do a roundtrip
952 \begin_inset Formula $\Rightarrow$
956 \begin_inset Formula $\Rightarrow$
959 .tex, and does not compare the produced dvi or pdf output, it assumes that
960 the stored .lyx reference produces correct output if processed by \SpecialChar LyX
962 There is only one chance to detect wrong output: before committing a new
964 Once it is committed, it is quite difficult to verify whether it is correct.
967 \begin_layout Standard
972 update the test references by opening them with \SpecialChar LyX
973 or directly running lyx2lyx
975 This would not work, since lyx2lyx and \SpecialChar LyX
976 produce slightly different files
977 regarding insignificant whitespace and line breaks.
980 \begin_layout Subsubsection
984 \begin_layout Standard
985 In many cases tests for new features may be added to one of the existing
986 test files, but sometimes this is not possible or not wanted.
987 Then a new test file needs to be added:
990 \begin_layout Enumerate
992 \begin_inset Flex Code
995 \begin_layout Plain Layout
996 src/tex2lyx/test/<test name>.tex
1001 and run tex2lyx in roundtrip mode to produce the file
1002 \begin_inset Flex Code
1005 \begin_layout Plain Layout
1006 src/tex2lyx/test/<test name>.lyx.lyx
1012 This file will be the new reference.
1015 \begin_layout Enumerate
1016 Once you confirmed that the tex2lyx output is correct, add the new files
1017 to the corresponding lists in
1018 \begin_inset Flex Code
1021 \begin_layout Plain Layout
1022 src/tex2lyx/test/runtests.py
1028 \begin_inset Flex Code
1031 \begin_layout Plain Layout
1032 src/tex2lyx/Makefile.am
1038 \begin_inset Flex Code
1041 \begin_layout Plain Layout
1042 src/tex2lyx/test/CMakeLists.txt
1050 \begin_layout Enumerate
1051 Commit the changes to the repository, or send a patch to the development
1052 list and ask for committing if you do not have commit rights.
1055 \begin_layout Subsection
1059 \begin_layout Standard
1060 The export tests are integration tests.
1061 They take longer to run and are more likely to break than the tex2lyx tests.
1062 Nevertheless, they have caught many regressions and without a better alternativ
1063 e it is important to keep them up-to-date and understand how they work.
1066 \begin_layout Subsubsection
1067 Expectations of LyX developers
1070 \begin_layout Standard
1071 Because the export tests are integration tests and take a long time to run,
1072 LyX developers are rarely expected to run all of the tests.
1073 Here are some good practices to follow by developers:
1076 \begin_layout Itemize
1077 When making a non-trivial change to a .layout file, run the export and layout
1078 tests corresponding with that .layout file.
1081 \begin_layout Itemize
1082 When making non-trivial changes to a .lyx file, run the export tests correspondin
1083 g to that .lyx file.
1086 \begin_layout Itemize
1087 When making non-trivial changes to LyX's LaTeX export code (e.g.
1088 touching the encoding code or package handling code that you expect will
1089 change the exported LaTeX in some way), consider running all of the export
1090 tests before and after your change.
1091 If there are differences, please reconcile these (i.e.
1092 fix the bug or fix the tests)
1097 Ask for help if you're not sure what to do or if you do not want to run
1098 the tests, post the patch on the list and others will run the tests.
1101 \begin_layout Itemize
1102 Understand how to interpret test failures.
1103 If your commit is found to have broken a test, you should be able to interpret
1104 the test results when made aware of them.
1106 \begin_inset CommandInset ref
1108 reference "subsec:Interpreting-export-tests"
1115 \begin_layout Subsubsection
1116 Configuring the tests
1119 \begin_layout Standard
1120 To enable these tests when using CMake, add the
1121 \begin_inset Flex Code
1124 \begin_layout Plain Layout
1125 -DLYX_ENABLE_EXPORT_TESTS=ON
1134 \begin_layout Standard
1135 \begin_inset Flex Code
1138 \begin_layout Plain Layout
1139 cmake -DLYX_ENABLE_EXPORT_TESTS=ON /path/to/source
1147 \begin_layout Standard
1149 This flag will increase the time for the cmake command by several seconds,
1150 mainly because of the process of inverting tests (see Section
1151 \begin_inset CommandInset ref
1153 reference "subsec:Interpreting-export-tests"
1160 \begin_layout Subsubsection
1164 \begin_layout Standard
1165 To run all tests, in the build directory simply run the command
1166 \begin_inset Flex Code
1169 \begin_layout Plain Layout
1176 To run only some of the tests, use the command
1177 \begin_inset Flex Code
1180 \begin_layout Plain Layout
1187 \begin_inset Flex Code
1190 \begin_layout Plain Layout
1196 is a regular expression that matches test names.
1197 To run only the export tests, you can use
1198 \begin_inset Flex Code
1201 \begin_layout Plain Layout
1208 For the list of test categories available in addition to
1209 \begin_inset Quotes eld
1213 \begin_inset Quotes erd
1217 \begin_inset Flex Code
1220 \begin_layout Plain Layout
1221 ctest \SpecialChar nobreakdash
1222 \SpecialChar nobreakdash
1229 It is often useful to list the tests without running them (e.g.
1230 if you want to know how many tests there are or whether your
1231 \begin_inset Flex Code
1234 \begin_layout Plain Layout
1240 regular expression did what you expected).
1241 This can be done with the
1242 \begin_inset Flex Code
1245 \begin_layout Plain Layout
1252 \begin_inset Flex Code
1255 \begin_layout Plain Layout
1256 \SpecialChar nobreakdash
1257 \SpecialChar nobreakdash
1264 We are still working on getting the tests to run in parallel which is supported
1266 \begin_inset Flex Code
1269 \begin_layout Plain Layout
1276 \begin_inset Flex Code
1279 \begin_layout Plain Layout
1286 \begin_inset Flex Code
1289 \begin_layout Plain Layout
1290 \SpecialChar nobreakdash
1291 \SpecialChar nobreakdash
1298 However, when running the tests in parallel, sometimes tests fail that
1299 pass when run sequentially.
1300 A reasonable approach is to first run the tests in parallel and then run
1301 the failed tests sequentially.
1302 For example, to run 8 jobs at a time:
1305 \begin_layout Standard
1306 \begin_inset Flex Code
1309 \begin_layout Plain Layout
1318 \begin_layout Standard
1319 \begin_inset Flex Code
1322 \begin_layout Plain Layout
1323 ctest \SpecialChar nobreakdash
1324 \SpecialChar nobreakdash
1333 \begin_layout Standard
1335 Note that some tests cannot be run in parallel.
1336 These tests are marked in the code with the
1337 \begin_inset Flex Code
1340 \begin_layout Plain Layout
1350 \begin_layout Standard
1351 In some situations the option
1352 \begin_inset Flex Code
1355 \begin_layout Plain Layout
1356 \SpecialChar nobreakdash
1357 \SpecialChar nobreakdash
1364 There have been bugs in LyX and in LaTeX which cause compilation to hang,
1365 and without a timeout a test might never stop (in one case there was even
1367 If a test times out, the
1368 \begin_inset Flex Code
1371 \begin_layout Plain Layout
1377 command exits with error, but you can distinguish between a timed out test
1378 and a failed test in the output reported at the end of the
1379 \begin_inset Flex Code
1382 \begin_layout Plain Layout
1391 \begin_layout Subsubsection
1392 \begin_inset CommandInset label
1394 name "subsec:Interpreting-export-tests"
1398 Interpreting the export test results
1401 \begin_layout Standard
1402 A test can fail for several reasons, not all of them bad.
1405 \begin_layout Enumerate
1406 The .lyx file could have been added recently and some formats are not expected
1410 \begin_layout Enumerate
1411 A dependency is not met (e.g.
1412 the LaTeX class file).
1413 One hint that this is the case is that the corresponding
1414 \begin_inset Flex Code
1417 \begin_layout Plain Layout
1423 test will likely also fail.
1426 \begin_layout Enumerate
1427 An export that previously failed to compile now compiles.
1430 \begin_layout Enumerate
1431 An external dependency was updated (e.g.
1435 \begin_layout Enumerate
1436 A recent code change introduced a bug.
1439 \begin_layout Enumerate
1440 \begin_inset CommandInset label
1446 A change in a document exposed the incompatibility of that class with an
1451 \begin_layout Standard
1452 Because the .lyx files are exported in several formats, it is not surprising
1453 that many of the exports fail.
1454 This expectation of failure is addressed by
1455 \begin_inset Quotes eld
1459 \begin_inset Quotes erd
1462 the tests, that is, by marking the test as
1463 \begin_inset Quotes eld
1467 \begin_inset Quotes erd
1470 if the export exits with error and as
1471 \begin_inset Quotes eld
1475 \begin_inset Quotes erd
1478 if the export succeeds
1483 It follows that these expected failures will not show up as failed tests
1484 in the test results and thus will not pollute the
1485 \begin_inset Quotes eld
1489 \begin_inset Quotes erd
1493 If the export actually succeeds, then the test will fail.
1494 The purpose of this failure is to get your attention—something has changed,
1495 possibly for the better.
1498 \begin_layout Standard
1499 We try to document why a test is inverted or ignored.
1500 See the comment (prefixed with
1501 \begin_inset Flex Code
1504 \begin_layout Plain Layout
1510 ) above the block in which the test is listed as inverted or ignored in
1512 \begin_inset Flex Code
1515 \begin_layout Plain Layout
1516 development/autotests/revertedTests
1522 \begin_inset Flex Code
1525 \begin_layout Plain Layout
1526 development/autotests/ignoredTests
1532 It is possible that an export goes from succeeding to failing just because
1533 the document was changed and the document was never expected to work with
1534 a certain export format in the first case.
1535 Once this is confirmed to be the situation, the test can be inverted.
1538 \begin_layout Standard
1539 A good question is why do we enable the tests for non-default formats? The
1540 answer is that if a non-default route is broken it is often because a bug
1541 was introduced in LyX and not because a document-specific change was made
1542 that is not supported by the route.
1543 In other words, there is a high signal/noise ratio in the export tests
1544 for the non-default formats.
1548 \begin_layout Standard
1549 What action should you take if a test fails? First, check manually that
1550 when the compilation succeeded before the resulting PDF was good.
1551 In fact, sometimes it is an improvement when a test fails.
1552 If you check manually, it might be the case that the export was succeeding
1553 before but showing garbled text in a PDF output.
1554 Now it might fail with a clear message of "language xyz not supported".
1555 It is always good to check manually why something fails and if it passes
1556 if the PDF output is good.
1559 \begin_layout Standard
1560 Sometimes a test is fixed by accident.
1561 We should uninvert a test (remove it from the
1562 \begin_inset Flex Code
1565 \begin_layout Plain Layout
1571 file) in order to preserve the fix.
1574 \begin_layout Standard
1575 When a test or several tests fail, consider checking the files in the
1576 \begin_inset Flex Code
1579 \begin_layout Plain Layout
1585 subdirectory of your build directory.
1586 In this subdirectory are three files: the file
1587 \begin_inset Flex Code
1590 \begin_layout Plain Layout
1596 simply lists the tests that failed on your last
1597 \begin_inset Flex Code
1600 \begin_layout Plain Layout
1607 \begin_inset Flex Code
1610 \begin_layout Plain Layout
1616 file contains the output from the tests (and often has details explaining
1617 why a test failed); and the
1618 \begin_inset Flex Code
1621 \begin_layout Plain Layout
1627 file lists the times that it took to run the tests.
1630 \begin_layout Subsubsection
1634 \begin_layout Standard
1635 Some inverted tests are 'suspended'.
1636 This means, they are not executed using
1637 \begin_inset Flex Code
1640 \begin_layout Plain Layout
1647 \begin_inset Flex Code
1650 \begin_layout Plain Layout
1657 From time to time they still have to be checked.
1660 \begin_layout Standard
1661 These tests are suspended, because they fail for known reasons which cannot
1663 But it is expected the reason might disappear in the future.
1664 Be it new TL or better handling in \SpecialChar LyX
1668 \begin_layout Standard
1669 For ctest commands without the
1670 \begin_inset Flex Code
1673 \begin_layout Plain Layout
1679 parameter nothing changes.
1680 Suspended or not, tests will be executed depending only on the regexes
1681 parameters given to the ctest command.
1684 \begin_layout Subsection
1688 \begin_layout Standard
1689 These tests check whether a .lyx file loads without any terminal messages.
1690 They correspond to the manual operations of simply opening a .lyx file on
1691 the terminal, exiting LyX once the file is loaded, and then checking whether
1692 there is any output from the terminal.
1693 These tests are useful for catching malformed .lyx files and parsing bugs.
1694 They can also be used to find a .lyx file in which an instance of something
1696 To do this, compile LyX with a local patch that outputs something to the
1697 terminal when an instance is found, and then run the check_load tests to
1698 see if any fail, which would mean that the situation occurs in the LyX
1699 documentation files corresponding to the failed tests.
1700 These tests are expectedly fragile: any LyX diagnostic message, which is
1701 not necessarily an error, would cause the tests to fail.
1702 Similarly, any message output by a library (e.g.
1703 Qt) would also cause failure.
1704 There are some messages that the check_load tests are instructed to ignore,
1705 which are stored in the file
1706 \begin_inset Flex Code
1709 \begin_layout Plain Layout
1710 development/autotests/filterCheckWarnings
1718 \begin_layout Subsection
1722 \begin_layout Standard
1723 The URL tests are enabled with the
1724 \begin_inset Flex Code
1727 \begin_layout Plain Layout
1728 -DLYX_ENABLE_URLTESTS=ON
1733 CMake flag and are useful for finding broken links in our documentation
1735 If a URL test fails, to see which link in particular was reported as broken,
1737 \begin_inset Flex Code
1740 \begin_layout Plain Layout
1747 These tests are extremely fragile (e.g.
1748 a test can depend on your Internet connection) and a failed URL test should
1749 not be taken too seriously.
1752 \begin_layout Section
1753 Development policies
1756 \begin_layout Standard
1757 This chapter lists some guidelines that should be followed.
1758 This list is not complete, and many guidelines are in separate chapters,
1760 \begin_inset Quotes eld
1763 When is an update of the .lyx file format number needed?
1764 \begin_inset Quotes erd
1768 \begin_inset CommandInset ref
1770 reference "sec:When-is-an"
1777 \begin_layout Subsection
1778 When to set a fixed milestone?
1781 \begin_layout Standard
1782 Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following
1786 \begin_layout Enumerate
1787 Somebody is actively working on a fix.
1790 \begin_layout Enumerate
1791 The bug is so severe that it would block the release if it is not fixed.
1794 \begin_layout Standard
1795 If a bug is important, but nobody is working on it, and it is no showstopper,
1796 use a milestone like 2.1.x or 2.2.x.
1797 For all other bugs, do not set a milestone at all.
1800 \begin_layout Subsection
1801 Can we add rc entries in stable branch?
1804 \begin_layout Standard
1806 We are supposed to increase the prefs2prefs version number with such things.
1809 \begin_layout Section
1810 Documentation policies
1813 \begin_layout Standard
1814 The main documentation consists of these files:
1817 \begin_layout Description
1818 splash.lyx it is the first file you see after an installation.
1819 We assume that a new user sees this.
1820 It is therefore designed to be as simple as possible.
1821 Therefore please don't add any new formatting, only fix typos etc.
1822 Splash.lyx is up to date for \SpecialChar LyX
1823 2.1.x, currently maintained by Uwe Stöhr.
1826 \begin_layout Description
1827 Intro.lyx This is the manual new users will read to learn \SpecialChar LyX
1829 It therefore uses a limited set of formatting.
1830 For example a standard document class.
1831 Since new users will first learn about the formatting possibilities of
1833 please keep this file that simple.
1834 Intro.lyx is up to date for \SpecialChar LyX
1835 2.1.x, currently maintained by Uwe Stöhr.
1838 \begin_layout Description
1839 Tutorial.lyx our tutorial.
1840 It must be always up to date.
1841 Normally there is nothing to add since we don't want to overwhelm new users
1842 with too much details.
1843 The will learn these details while using \SpecialChar LyX
1844 and we have special manuals.
1845 Tutorial.lyx is up to date for \SpecialChar LyX
1846 2.1.x, currently maintained by Uwe Stöhr.
1849 \begin_layout Description
1850 UserGuide.lyx our main user guide.
1851 It covers a mixture of basic and detailed information.
1852 Some information is also in the Math and EmbeddedObjects manual so that
1853 the UserGuide refers to these files.
1854 UserGuide.lyx is up to date for \SpecialChar LyX
1855 2.1.x, currently maintained by Uwe Stöhr.
1858 \begin_layout Description
1859 EmbeddedObjects.lyx a special manual to explain things like tables floats
1862 EmbeddedObjects.lyx is up to date for \SpecialChar LyX
1863 2.1.x, currently maintained by Uwe
1867 \begin_layout Description
1868 Math.lyx a special manual to explain everything regarding math in all detail.
1869 Math.lyx is up to date for \SpecialChar LyX
1870 2.1.x, currently maintained by Uwe Stöhr.
1873 \begin_layout Description
1874 Additional.lyx this manual covers information that would be too much detail
1875 for the UserGuide or would make the UserGuide uncompilable or only compilable
1876 when installing a lot of special \SpecialChar LaTeX
1878 What should be in the UserGuide or better in Additional is a matter of
1880 it is up to you to decide that.
1881 Additional.lyx is not completely up to date for \SpecialChar LyX
1884 \begin_inset space ~
1887 8 is up to date and currently maintained by Uwe Stöhr.
1888 It certainly needs a rewrite and update.
1889 For example many info in chapter
1890 \begin_inset space ~
1893 2 and 3 are already covered by the UserGuide and/or the EmbeddedObjects
1897 \begin_layout Description
1898 Customization.lyx this manual covers information how to customize \SpecialChar LyX
1900 output formats, operating systems, languages etc.
1901 It is currently completely out of date and needs a major rewrite and update.
1902 If you do this please assure that your information are given for all OSes
1903 and \SpecialChar LaTeX
1904 distributions (meaning be as objective as possible).
1907 \begin_layout Standard
1909 \begin_inset space ~
1912 rules in editing the docs:
1915 \begin_layout Enumerate
1916 If you are not the maintainer of a doc file or a chapter/section, you MUST
1917 use change tracking so that the maintainer could review your changes
1920 \begin_layout Enumerate
1921 Respect the formatting of the document.
1922 The different files use different formatting styles.
1923 That is OK and has historic reasons nobody fully know ;-).
1924 But it is important to be consistent within one file.
1927 \begin_layout Enumerate
1928 All changes you make to a file in one language MUST also go the file in
1929 the other actively maintained languages.
1930 Normally the maintainer does this for you, if you are the maintainer, you
1931 must do this by copying or changing the changed or added text to the other
1932 files so that the translators sees the blue underlined text and know what
1933 they have to translate and what was changed.
1936 \begin_layout Enumerate
1937 You MUST assure that the document is compilable as
1938 \begin_inset Quotes eld
1942 \begin_inset Quotes erd