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 pdf2
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 define 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 Standard
653 Note that we do not update the local layout of our
654 \begin_inset Flex Code
657 \begin_layout Plain Layout
663 files because users would then not be able to export to older formats.
664 For example, if a 2.2.0 user exported a template to 2.1.x format and tried
665 to open the file in LyX 2.1.x, there would be an error because the file would
666 contain a local layout whose format is too new.
667 The root reason for this is that we do not support converting layouts to
668 older layout formats, as we do for the
669 \begin_inset Flex Code
672 \begin_layout Plain Layout
681 \begin_layout Subsection
682 Updating the file format number of bind/ui files
685 \begin_layout Standard
687 \begin_inset CommandInset ref
689 reference "enu:updatefiles"
694 \begin_inset CommandInset ref
696 reference "subsec:update_lyx_files"
701 \begin_inset Flex Code
704 \begin_layout Plain Layout
710 command, use this command:
711 \begin_inset Flex Code
714 \begin_layout Plain Layout
715 bash development/tools/updatelfuns.sh
723 \begin_layout Subsection
724 Backporting new styles to the stable version
727 \begin_layout Standard
728 Starting with the stable \SpecialChar LyX
729 2.1 branch, there is a mechanism in place to backport
730 new styles to the stable version without the need to update the file format.
731 The basic idea is that the new style definition is automatically copied
732 to the document preamble, so that it can even be used by older minor revisions
733 that did not yet include the style.
734 To backport a new style to the stable version, the following steps are
738 \begin_layout Enumerate
740 \begin_inset Flex Code
743 \begin_layout Plain Layout
749 to the style definition in the development version.
752 \begin_layout Enumerate
753 Copy the style definition to the stable version, but use
754 \begin_inset Flex Code
757 \begin_layout Plain Layout
764 If needed adjust the format to the one used by the stable version (see
765 the customization manual for details of the layout file format).
768 \begin_layout Enumerate
769 For each update of the style in a later stable version, increase the argument
771 \begin_inset Flex Code
774 \begin_layout Plain Layout
780 by one (in the stable version, the development version should not be touched).
783 \begin_layout Standard
784 For details about the
785 \begin_inset Flex Code
788 \begin_layout Plain Layout
794 flag see the customization manual.
796 \begin_inset Flex Code
799 \begin_layout Plain Layout
805 support is needed for backported styles: Since the style of the development
806 version has an infinite version number, it will always be used.
807 Furthermore, since its version number is less than one, the style will
808 not be written anymore to the document header for files saved by the new
812 \begin_layout Standard
813 \begin_inset Newpage newpage
819 \begin_layout Section
823 \begin_layout Standard
824 Automated tests are an important tool to detect bugs and regressions in
825 software development.
826 Some projects like gcc even require each bug fix to be accompanied by a
827 test case for the automatic test suite, that would detect this bug.
828 Testing interactive features automatically is of course very hard, but
829 core functionality like document import and export can be tested quite
830 easily, and some tests of this kind exist.
833 \begin_layout Subsection
837 \begin_layout Standard
838 There are attempts to set up a suite of unit tests for LyX.
841 \begin_layout Standard
842 TODO: describe what is done and what is still to do.
845 \begin_layout Subsection
849 \begin_layout Standard
850 The tex2lyx tests are located in the
851 \begin_inset Flex Code
854 \begin_layout Plain Layout
860 subfolder of the \SpecialChar LyX
861 source code distribution.
862 The actual testing is performed by the simple python script
863 \begin_inset Flex Code
866 \begin_layout Plain Layout
867 src/tex2lyx/test/runtests.py
873 Each test consists of two files:
874 \begin_inset Flex Code
877 \begin_layout Plain Layout
883 contains the \SpecialChar LaTeX
884 code that should be tested.
886 \begin_inset Flex Code
889 \begin_layout Plain Layout
895 contains the expected output of tex2lyx.
896 When a test is run, the actual produced output is compared with the stored
898 The test passes if both are identical.
899 The test machinery is also able to generate a file
900 \begin_inset Flex Code
903 \begin_layout Plain Layout
909 by exporting the produced .lyx file with \SpecialChar LyX
911 This may be useful for roundtrip comparisons.
914 \begin_layout Subsubsection
918 \begin_layout Standard
919 The tex2lyx tests can be run in several ways.
921 \begin_inset Flex Code
924 \begin_layout Plain Layout
930 subfolder of the build directory, the commands
931 \begin_inset Flex Code
934 \begin_layout Plain Layout
940 (cmake, all platforms),
941 \begin_inset Flex Code
944 \begin_layout Plain Layout
950 (cmake, when using a make based build system and not MSVC) or
951 \begin_inset Flex Code
954 \begin_layout Plain Layout
960 (autotools) will run the tex2lyx tests.
961 Alternatively, in the root of the build directory, the command
962 \begin_inset Flex Code
965 \begin_layout Plain Layout
971 runs all tests whose names match the regex
972 \begin_inset Quotes eld
976 \begin_inset Quotes erd
980 Another way to run the tex2lyx tests in the root build directory is to
981 instead use the command
982 \begin_inset Flex Code
985 \begin_layout Plain Layout
986 ctest -L '(cmplyx|roundtrip)'
991 , which runs all tests categorized with the label
992 \begin_inset Quotes eld
996 \begin_inset Quotes erd
1000 \begin_inset Quotes eld
1004 \begin_inset Quotes erd
1008 If a test fails, the differences between the expected and actual results
1009 are output in unified diff format.
1012 \begin_layout Subsubsection
1013 Updating test references
1014 \begin_inset CommandInset label
1016 name "sec:Updating-test-references"
1023 \begin_layout Standard
1024 In some cases a changed tex2lyx output is not a test failure, but wanted,
1026 \begin_inset space \thinspace{}
1030 \begin_inset space \space{}
1033 if a tex2lyx bug was fixed, or a new feature was added.
1034 In these cases the stored references need to be updated.
1035 To do so if using autotools, call
1036 \begin_inset Flex Code
1039 \begin_layout Plain Layout
1046 \begin_inset Flex Code
1049 \begin_layout Plain Layout
1055 subdirectory of the build directory.
1056 If instead using CMake, call
1057 \begin_inset Flex Code
1060 \begin_layout Plain Layout
1061 make updatetex2lyxtests
1066 in the build directory or in the
1067 \begin_inset Flex Code
1070 \begin_layout Plain Layout
1076 subdirectory of the build directory.
1080 \begin_layout Plain Layout
1081 Note that this is a case where a make target in the build directory can
1082 affect the source directory, which might not be advisable.
1087 On Windows do the following:
1090 \begin_layout Itemize
1091 Assure that the path to the python.exe is in your system PATH variable.
1094 \begin_layout Itemize
1095 Double-click on the file
1096 \begin_inset Flex Code
1099 \begin_layout Plain Layout
1100 updatetex2lyxtests.vcxproj
1105 in the build directory or in the
1106 \begin_inset Flex Code
1109 \begin_layout Plain Layout
1115 subdirectory of your build directory.
1118 \begin_layout Itemize
1119 In the appearing MSVC program right-click on the project
1123 in the project explorer and chose
1130 \begin_layout Standard
1131 For convenience, these commands also produce re-exported roundtrip .lyx.tex
1133 Please examine the changed output carefully before committing the changed
1134 files to the repository: Since the test machinery does not do a roundtrip
1136 \begin_inset Formula $\Rightarrow$
1140 \begin_inset Formula $\Rightarrow$
1143 .tex, and does not compare the produced dvi or pdf output, it assumes that
1144 the stored .lyx reference produces correct output if processed by \SpecialChar LyX
1146 There is only one chance to detect wrong output: before committing a new
1148 Once it is committed, it is quite difficult to verify whether it is correct.
1151 \begin_layout Standard
1156 update the test references by opening them with \SpecialChar LyX
1157 or directly running lyx2lyx
1159 This would not work, since lyx2lyx and \SpecialChar LyX
1160 produce slightly different files
1161 regarding insignificant whitespace and line breaks.
1164 \begin_layout Subsubsection
1168 \begin_layout Standard
1169 In many cases tests for new features may be added to one of the existing
1170 test files, but sometimes this is not possible or not wanted.
1171 Then a new test file needs to be added:
1174 \begin_layout Enumerate
1176 \begin_inset Flex Code
1179 \begin_layout Plain Layout
1180 src/tex2lyx/test/<test name>.tex
1185 and run tex2lyx in roundtrip mode to produce the file
1186 \begin_inset Flex Code
1189 \begin_layout Plain Layout
1190 src/tex2lyx/test/<test name>.lyx.lyx
1196 This file will be the new reference.
1199 \begin_layout Enumerate
1200 Once you confirmed that the tex2lyx output is correct, add the new files
1201 to the corresponding lists in
1202 \begin_inset Flex Code
1205 \begin_layout Plain Layout
1206 src/tex2lyx/test/runtests.py
1212 \begin_inset Flex Code
1215 \begin_layout Plain Layout
1216 src/tex2lyx/Makefile.am
1222 \begin_inset Flex Code
1225 \begin_layout Plain Layout
1226 src/tex2lyx/test/CMakeLists.txt
1234 \begin_layout Enumerate
1235 Commit the changes to the repository, or send a patch to the development
1236 list and ask for committing if you do not have commit rights.
1239 \begin_layout Subsection
1240 ctest automatic tests (cmake only)
1243 \begin_layout Standard
1244 Some tests are located in the
1245 \begin_inset Flex Code
1248 \begin_layout Plain Layout
1249 development/autotests
1254 subfolder of the \SpecialChar LyX
1255 source code distribution.
1257 \begin_inset Flex Code
1260 \begin_layout Plain Layout
1266 is required to run the automatic \SpecialChar LyX
1267 tests, running them is not implemented
1272 \begin_layout Standard
1273 The \SpecialChar LyX
1274 tests can be run by the commands
1275 \begin_inset Flex Code
1278 \begin_layout Plain Layout
1285 \begin_inset Flex Code
1288 \begin_layout Plain Layout
1294 (when using a make based build system and not MSVC) in the
1295 \begin_inset Flex Code
1298 \begin_layout Plain Layout
1304 subfolder of the build directory.
1307 \begin_layout Subsubsection
1311 \begin_layout Standard
1312 The export tests are integration tests.
1313 They take longer to run and are more likely to break than the tex2lyx tests.
1314 Nevertheless, they have caught many regressions and without a better alternativ
1315 e it is important to keep them up-to-date and understand how they work.
1318 \begin_layout Standard
1320 \begin_inset Quotes eld
1324 \begin_inset Quotes erd
1327 documentation, template, and example files trying to export them to all
1328 supported output formats.
1331 \begin_layout Paragraph
1332 Expectations of LyX developers
1335 \begin_layout Standard
1336 Because the export tests are integration tests and take a long time to run,
1337 LyX developers are rarely expected to run all of the tests.
1338 Here are some good practices to follow by developers:
1341 \begin_layout Itemize
1342 When making a non-trivial change to a .layout file, run the export and layout
1343 tests corresponding with that .layout file.
1346 \begin_layout Itemize
1347 When making non-trivial changes to a .lyx file, run the export tests correspondin
1348 g to that .lyx file.
1351 \begin_layout Itemize
1352 When making non-trivial changes to LyX's \SpecialChar LaTeX
1354 touching the encoding code or package handling code that you expect will
1355 change the exported \SpecialChar LaTeX
1360 \begin_layout Standard
1361 \paragraph_spacing single
1362 Consider running all of the export tests before and after your change.
1363 If there are differences, please reconcile these (i.e.
1364 fix the bug or fix the tests)
1369 Ask for help if you're not sure what to.
1372 \begin_layout Standard
1373 If you do not want to run the tests,
1376 \begin_layout Itemize
1377 post the patch on the list and others will run the tests and eventually
1381 \begin_layout Itemize
1382 commit, but be prepared to fix eventually arising problems or to revert
1383 the commit if there is no easy fix.
1387 \begin_layout Itemize
1388 Understand how to interpret test failures.
1389 If your commit is found to have broken a test, you should be able to interpret
1390 the test results when made aware of them.
1392 \begin_inset CommandInset ref
1394 reference "subsec:Interpreting-export-tests"
1401 \begin_layout Paragraph
1402 Configuring the tests
1405 \begin_layout Standard
1406 To enable the export autotests, add the
1407 \begin_inset Flex Code
1410 \begin_layout Plain Layout
1411 -DLYX_ENABLE_EXPORT_TESTS=ON
1420 \begin_layout Standard
1421 \begin_inset Flex Code
1424 \begin_layout Plain Layout
1425 cmake -DLYX_ENABLE_EXPORT_TESTS=ON /path/to/source
1433 \begin_layout Standard
1435 This flag will increase the time for the cmake command by several seconds,
1436 mainly because of the process of inverting tests (see Section
1437 \begin_inset CommandInset ref
1439 reference "subsec:Interpreting-export-tests"
1446 \begin_layout Paragraph
1450 \begin_layout Standard
1451 To run all tests, in the build directory simply run the command
1452 \begin_inset Flex Code
1455 \begin_layout Plain Layout
1465 \begin_layout Standard
1466 To run only some of the tests, use command line options:
1469 \begin_layout Labeling
1470 \labelwidthstring -R
1471 \begin_inset Flex Code
1474 \begin_layout Plain Layout
1480 Run only the tests whose names match the given regular expression.
1483 \begin_layout Labeling
1484 \labelwidthstring -R
1485 \begin_inset Flex Code
1488 \begin_layout Plain Layout
1494 Run only the tests whose labels match the given regular expression.
1495 A test may have more that one label.
1500 \begin_layout Standard
1501 For example, to run only the export tests, you can use
1502 \begin_inset Flex Code
1505 \begin_layout Plain Layout
1516 \begin_layout Labeling
1517 \labelwidthstring -R
1518 \begin_inset Flex Code
1521 \begin_layout Plain Layout
1527 Exclude the tests whose names match the given regular expression.
1530 \begin_layout Labeling
1531 \labelwidthstring -R
1532 \begin_inset Flex Code
1535 \begin_layout Plain Layout
1541 Exclude the tests whose labels match the given regular expression.
1544 \begin_layout Standard
1545 The following options help to find good selection patterns:
1548 \begin_layout Labeling
1549 \labelwidthstring -R
1550 \begin_inset Flex Code
1553 \begin_layout Plain Layout
1559 List the tests that would be run but not actually run them.
1564 \begin_layout Standard
1565 Useful in conjunction with the -R, -L, -E and -LE options, e.g., if you want
1566 to know how many tests there are or whether your
1567 \begin_inset Flex Code
1570 \begin_layout Plain Layout
1576 regular expression did what you expected.
1580 \begin_layout Labeling
1581 \labelwidthstring -R
1582 \begin_inset Flex Code
1585 \begin_layout Plain Layout
1586 \SpecialChar nobreakdash
1587 \SpecialChar nobreakdash
1593 print the list of all labels associated with the test set.
1594 Can also be combined with -R, -L, -E, ...
1598 \begin_layout Standard
1599 Other relevant options are:
1602 \begin_layout Labeling
1603 \labelwidthstring -R
1604 \begin_inset Flex Code
1607 \begin_layout Plain Layout
1613 Run the tests in parallel using the given number of jobs.
1617 \begin_layout Standard
1618 We are still working on getting the tests to run in parallel.
1619 However, when running the tests in parallel, sometimes tests fail that
1620 pass when run sequentially.
1621 A reasonable approach is to first run the tests in parallel and then run
1622 the failed tests sequentially.
1626 \begin_layout Standard
1627 For example, to run 8 jobs at a time:
1630 \begin_layout Standard
1631 \begin_inset Flex Code
1634 \begin_layout Plain Layout
1643 \begin_layout Standard
1644 \begin_inset Flex Code
1647 \begin_layout Plain Layout
1648 ctest \SpecialChar nobreakdash
1649 \SpecialChar nobreakdash
1658 \begin_layout Standard
1660 Note that some tests cannot be run in parallel.
1661 These tests are marked in the code with the
1662 \begin_inset Flex Code
1665 \begin_layout Plain Layout
1676 \begin_layout Labeling
1677 \labelwidthstring -R
1678 \begin_inset Flex Code
1681 \begin_layout Plain Layout
1682 \SpecialChar nobreakdash
1683 \SpecialChar nobreakdash
1689 Set a global timeout on all tests that do not already have a timeout set
1694 \begin_layout Standard
1695 There have been bugs in LyX and in \SpecialChar LaTeX
1696 which cause compilation to hang, and
1697 without a timeout a test might never stop (in one case there was even a
1699 If a test times out, the
1700 \begin_inset Flex Code
1703 \begin_layout Plain Layout
1709 command exits with error, but you can distinguish between a timed out test
1710 and a failed test in the output reported at the end of the
1711 \begin_inset Flex Code
1714 \begin_layout Plain Layout
1724 \begin_layout Standard
1726 \begin_inset Flex Code
1729 \begin_layout Plain Layout
1735 ) the full list of command line options.
1738 \begin_layout Paragraph
1739 \begin_inset CommandInset label
1741 name "subsec:Interpreting-export-tests"
1745 Interpreting the export test results
1748 \begin_layout Standard
1749 A test can fail for several reasons, not all of them bad.
1752 \begin_layout Enumerate
1753 The .lyx file could have been added recently and some formats are not expected
1757 \begin_layout Enumerate
1758 A dependency is not met (e.g.
1759 the \SpecialChar LaTeX
1761 One hint that this is the case is that the corresponding
1762 \begin_inset Flex Code
1765 \begin_layout Plain Layout
1771 test will likely also fail.
1774 \begin_layout Enumerate
1775 An inverted test fails to fail (i.e.
1776 export that previously failed now works).
1779 \begin_layout Enumerate
1780 An external dependency was updated (e.g.
1785 \begin_layout Enumerate
1786 A recent code change introduced a bug.
1789 \begin_layout Enumerate
1790 \begin_inset CommandInset label
1796 A change in a document exposed a previously unknown bug or an incompatibility
1797 with an export format (e.g.
1798 Lua\SpecialChar LaTeX
1802 \begin_layout Standard
1803 Because the .lyx files are exported in several formats, it is not surprising
1804 that many of the exports fail.
1805 This expectation of failure is addressed by
1806 \begin_inset Quotes eld
1810 \begin_inset Quotes erd
1813 the tests, that is, by marking the test as
1814 \begin_inset Quotes eld
1818 \begin_inset Quotes erd
1821 if the export exits with error and as
1822 \begin_inset Quotes eld
1826 \begin_inset Quotes erd
1829 if the export succeeds
1834 It follows that these expected failures will not show up as failed tests
1835 in the test results and thus will not pollute the
1836 \begin_inset Quotes eld
1840 \begin_inset Quotes erd
1844 If the export actually succeeds, then the test will fail.
1845 The purpose of this failure is to get your attention—something has changed,
1846 possibly for the better.
1849 \begin_layout Standard
1850 We try to document why a test is inverted or ignored.
1851 See the comment (prefixed with
1852 \begin_inset Flex Code
1855 \begin_layout Plain Layout
1861 ) above the block in which the test is listed as inverted or ignored in
1863 \begin_inset Flex Code
1866 \begin_layout Plain Layout
1867 development/autotests/suspiciousTests
1873 \begin_inset Flex Code
1876 \begin_layout Plain Layout
1877 development/autotests/ignoredTests
1883 It is possible that an export goes from succeeding to failing just because
1884 the document was changed and the document was never expected to work with
1885 a certain export format in the first case.
1886 Once this is confirmed to be the situation, the test can be inverted.
1889 \begin_layout Standard
1890 A good question is why do we enable the tests for non-default formats? The
1891 answer is that if a non-default route is broken it is often because a bug
1892 was introduced in LyX and not because a document-specific change was made
1893 that is not supported by the route.
1894 In other words, there is a high signal/noise ratio in the export tests
1895 for some non-default formats.
1899 \begin_layout Standard
1900 What action should you take if a test fails? This depends:
1903 \begin_layout Standard
1904 Generally, if a change breaks compilation for the target format (for the
1905 manuals pdf2) without solving some important other issue, fix or revert
1906 the commit that led to failure.
1907 If a change breaks compilation for some non-target format (for the manuals
1908 everything except pdf2), invert the test.
1912 \begin_layout Standard
1913 A special case is given, if the export was succeeding before but showing
1914 garbled text in the PDF output.
1915 Try to establish, that when the compilation succeeded before the resulting
1917 Otherwise, it is in fact an improvement when a test fails.
1918 Now it might fail with a clear message of "language xyz not supported".
1919 It is always good to check manually why something fails and if it passes
1920 if the PDF output is good.
1923 \begin_layout Standard
1924 Sometimes a test is fixed as side-effect of some change.
1925 We should uninvert a test (remove it from the
1926 \begin_inset Flex Code
1929 \begin_layout Plain Layout
1935 file) in order to preserve the fix.
1938 \begin_layout Standard
1939 When a test or several tests fail, consider checking the files in the
1940 \begin_inset Flex Code
1943 \begin_layout Plain Layout
1949 subdirectory of your build directory.
1950 In this subdirectory are three files: the file
1951 \begin_inset Flex Code
1954 \begin_layout Plain Layout
1960 simply lists the tests that failed on your last
1961 \begin_inset Flex Code
1964 \begin_layout Plain Layout
1971 \begin_inset Flex Code
1974 \begin_layout Plain Layout
1980 file contains the output from the tests (and often has details explaining
1981 why a test failed); and the
1982 \begin_inset Flex Code
1985 \begin_layout Plain Layout
1991 file lists the times that it took to run the tests.
1994 \begin_layout Paragraph
1998 \begin_layout Standard
1999 These tests are expected to always fail.
2002 \begin_layout Description
2003 inverted These tests are expected to fail, but are subject to be examined.
2004 It is expected that they will pass in a foreseeable future.
2005 They are labeled 'inverted'.
2008 \begin_layout Description
2009 suspended Some inverted tests are labeled 'suspended'.
2010 This means, they are not executed using
2011 \begin_inset Flex Code
2014 \begin_layout Plain Layout
2021 \begin_inset Flex Code
2024 \begin_layout Plain Layout
2031 From time to time they still have to be checked using
2032 \begin_inset Flex Code
2035 \begin_layout Plain Layout
2045 \begin_layout Standard
2046 These tests are suspended, because they fail for known reasons which cannot
2048 But it is expected the reason might disappear in the future.
2049 Be it new TL or better handling in \SpecialChar LyX
2053 \begin_layout Standard
2054 For ctest commands without the
2055 \begin_inset Flex Code
2058 \begin_layout Plain Layout
2064 parameter nothing changes.
2065 Suspended or not, tests will be executed depending only on the regexes
2066 parameters given to the ctest command.
2070 \begin_layout Paragraph
2074 \begin_layout Standard
2075 These tests are not executed using
2076 \begin_inset Flex Code
2079 \begin_layout Plain Layout
2086 \begin_inset Flex Code
2089 \begin_layout Plain Layout
2099 \begin_layout Standard
2100 They pass or fail for various reasons not related to LyX (nonstandard, erratic)
2101 or pass but should rather fail (wrong output).
2104 \begin_layout Description
2105 nonstandard Documents with additional requirements, e.g.
2106 a class or package file not on CTAN.
2108 \begin_inset Note Note
2111 \begin_layout Plain Layout
2112 TODO: rename to "extra"?
2121 \begin_layout Standard
2122 These tests are labeled as
2128 \begin_layout Description
2129 erratic Tests depending on local configuration, OS, TeX distribution, package
2130 versions, or the phase of the moon.
2132 \begin_inset Note Note
2135 \begin_layout Plain Layout
2140 only for the phase-of-moon dependency.
2149 \begin_layout Standard
2150 These tests are labeled as
2156 \begin_layout Description
2158 \begin_inset space ~
2161 output Export does not fail but the resulting document has errors.
2165 \begin_layout Standard
2166 \paragraph_spacing single
2167 These tests are actually not
2175 (not measuring what they should measure).
2179 \begin_layout Paragraph
2180 Export test filtering
2183 \begin_layout Standard
2184 There are files which control the assignment of a label to a test.
2187 \begin_layout Description
2188 ignoredTests (small file)
2189 \begin_inset Newline newline
2192 Tests selected here are withdrawn
2196 \begin_layout Labeling
2197 \labelwidthstring 00.00.0000
2198 Input Test of any export combination
2201 \begin_layout Labeling
2202 \labelwidthstring 00.00.0000
2203 Output Stop if tests not selected here
2207 \begin_layout Description
2208 unreliableTests: Tests selected either pass or fail, but that is dependent
2209 on the system where the test is run.
2210 Selected tests gain the label 'unreliable'.
2214 \begin_layout Labeling
2215 \labelwidthstring 00.00.0000
2216 Input Each test which passed 'ignoredTests'
2219 \begin_layout Labeling
2220 \labelwidthstring 00.00.0000
2221 Output Stop if test selected, gain label 'unreliable'.
2225 \begin_layout Description
2227 \begin_inset space \space{}
2234 \begin_layout Labeling
2235 \labelwidthstring 00.00.0000
2236 Input Each test which passed 'unreliableTests'
2239 \begin_layout Labeling
2240 \labelwidthstring 00.00.0000
2241 Output Stop if not selected.
2244 \begin_layout Standard
2245 The following file is meant as subselections of 'suspiciousTests'.
2246 If neither subselection applies, test gains labels 'export' and 'inverted'
2249 \begin_layout Description
2250 suspendedTests Tests selected here gain the label 'suspended' but _not_
2251 'export' or 'inverted', although in ctest they remain inverted.
2252 ('ctest' knows only 'inverted' or not, labels are used only for test selection)
2256 \begin_layout Labeling
2257 \labelwidthstring 00.00.0000
2258 Input Each test selected by 'suspiciousTests'
2261 \begin_layout Labeling
2262 \labelwidthstring 00.00.0000
2263 Output Selected test gains label 'suspended'.
2269 \begin_layout Standard
2270 The following table may clarify label assignement
2273 \begin_layout Standard
2274 \begin_inset Tabular
2275 <lyxtabular version="3" rows="7" columns="12">
2276 <features tabularvalignment="middle">
2277 <column alignment="left" valignment="top" width="0pt">
2278 <column alignment="left" valignment="top" width="0pt">
2279 <column alignment="left" valignment="top" width="0pt">
2280 <column alignment="left" valignment="top" width="0pt">
2281 <column alignment="center" valignment="top">
2282 <column alignment="center" valignment="top">
2283 <column alignment="center" valignment="top">
2284 <column alignment="center" valignment="top">
2285 <column alignment="center" valignment="top">
2286 <column alignment="center" valignment="top">
2287 <column alignment="center" valignment="top">
2288 <column alignment="center" valignment="top">
2290 <cell multicolumn="1" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2293 \begin_layout Plain Layout
2299 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2302 \begin_layout Plain Layout
2308 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2311 \begin_layout Plain Layout
2317 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2320 \begin_layout Plain Layout
2326 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2329 \begin_layout Plain Layout
2330 Marked in ctest, Assigned label
2335 <cell multicolumn="2" alignment="center" valignment="top" usebox="none">
2338 \begin_layout Plain Layout
2344 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2347 \begin_layout Plain Layout
2353 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2356 \begin_layout Plain Layout
2362 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2365 \begin_layout Plain Layout
2371 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2374 \begin_layout Plain Layout
2380 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2383 \begin_layout Plain Layout
2389 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2392 \begin_layout Plain Layout
2400 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2403 \begin_layout Plain Layout
2409 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2412 \begin_layout Plain Layout
2418 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2421 \begin_layout Plain Layout
2427 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2430 \begin_layout Plain Layout
2436 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2439 \begin_layout Plain Layout
2445 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
2448 \begin_layout Plain Layout
2454 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2457 \begin_layout Plain Layout
2463 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
2466 \begin_layout Plain Layout
2472 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2475 \begin_layout Plain Layout
2481 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
2484 \begin_layout Plain Layout
2490 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2493 \begin_layout Plain Layout
2499 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2502 \begin_layout Plain Layout
2510 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2513 \begin_layout Plain Layout
2519 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2522 \begin_layout Plain Layout
2528 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2531 \begin_layout Plain Layout
2537 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2540 \begin_layout Plain Layout
2546 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2549 \begin_layout Plain Layout
2555 <cell alignment="center" valignment="top" topline="true" usebox="none">
2558 \begin_layout Plain Layout
2564 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2567 \begin_layout Plain Layout
2573 <cell alignment="center" valignment="top" topline="true" usebox="none">
2576 \begin_layout Plain Layout
2582 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2585 \begin_layout Plain Layout
2591 <cell alignment="center" valignment="top" topline="true" usebox="none">
2594 \begin_layout Plain Layout
2600 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2603 \begin_layout Plain Layout
2609 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2612 \begin_layout Plain Layout
2620 <cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2623 \begin_layout Plain Layout
2629 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2632 \begin_layout Plain Layout
2638 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2641 \begin_layout Plain Layout
2647 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2650 \begin_layout Plain Layout
2656 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2659 \begin_layout Plain Layout
2665 <cell alignment="center" valignment="top" topline="true" usebox="none">
2668 \begin_layout Plain Layout
2674 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2677 \begin_layout Plain Layout
2683 <cell alignment="center" valignment="top" topline="true" usebox="none">
2686 \begin_layout Plain Layout
2692 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2695 \begin_layout Plain Layout
2701 <cell alignment="center" valignment="top" topline="true" usebox="none">
2704 \begin_layout Plain Layout
2710 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2713 \begin_layout Plain Layout
2719 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2722 \begin_layout Plain Layout
2730 <cell multirow="4" alignment="left" valignment="middle" topline="true" leftline="true" usebox="none">
2733 \begin_layout Plain Layout
2739 <cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2742 \begin_layout Plain Layout
2748 <cell multirow="3" alignment="left" valignment="middle" topline="true" bottomline="true" leftline="true" usebox="none">
2751 \begin_layout Plain Layout
2757 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2760 \begin_layout Plain Layout
2766 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2769 \begin_layout Plain Layout
2775 <cell alignment="center" valignment="top" topline="true" usebox="none">
2778 \begin_layout Plain Layout
2784 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2787 \begin_layout Plain Layout
2793 <cell alignment="center" valignment="top" topline="true" usebox="none">
2796 \begin_layout Plain Layout
2802 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2805 \begin_layout Plain Layout
2811 <cell alignment="center" valignment="top" topline="true" usebox="none">
2814 \begin_layout Plain Layout
2820 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2823 \begin_layout Plain Layout
2829 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2832 \begin_layout Plain Layout
2840 <cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2843 \begin_layout Plain Layout
2849 <cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2852 \begin_layout Plain Layout
2858 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2861 \begin_layout Plain Layout
2867 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2870 \begin_layout Plain Layout
2876 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2879 \begin_layout Plain Layout
2885 <cell alignment="center" valignment="top" topline="true" usebox="none">
2888 \begin_layout Plain Layout
2894 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2897 \begin_layout Plain Layout
2903 <cell alignment="center" valignment="top" topline="true" usebox="none">
2906 \begin_layout Plain Layout
2912 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2915 \begin_layout Plain Layout
2921 <cell alignment="center" valignment="top" topline="true" usebox="none">
2924 \begin_layout Plain Layout
2930 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2933 \begin_layout Plain Layout
2939 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2942 \begin_layout Plain Layout
2950 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2953 \begin_layout Plain Layout
2959 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2962 \begin_layout Plain Layout
2968 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2971 \begin_layout Plain Layout
2977 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2980 \begin_layout Plain Layout
2986 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2989 \begin_layout Plain Layout
2995 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
2998 \begin_layout Plain Layout
3004 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3007 \begin_layout Plain Layout
3013 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
3016 \begin_layout Plain Layout
3022 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3025 \begin_layout Plain Layout
3031 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
3034 \begin_layout Plain Layout
3040 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3043 \begin_layout Plain Layout
3049 <cell alignment="center" valignment="top" topline="true" bottomline="true" rightline="true" usebox="none">
3052 \begin_layout Plain Layout
3066 \begin_layout Subsubsection
3070 \begin_layout Standard
3071 These tests check whether a .lyx file loads without any terminal messages.
3072 They correspond to the manual operations of simply opening a .lyx file on
3073 the terminal, exiting LyX once the file is loaded, and then checking whether
3074 there is any output from the terminal.
3075 These tests are useful for catching malformed .lyx files and parsing bugs.
3076 They can also be used to find a .lyx file in which an instance of something
3078 To do this, compile LyX with a local patch that outputs something to the
3079 terminal when an instance is found, and then run the check_load tests to
3080 see if any fail, which would mean that the situation occurs in the LyX
3081 documentation files corresponding to the failed tests.
3082 These tests are expectedly fragile: any LyX diagnostic message, which is
3083 not necessarily an error, would cause the tests to fail.
3084 Similarly, any message output by a library (e.g.
3085 Qt) would also cause failure.
3086 There are some messages that the check_load tests are instructed to ignore,
3087 which are stored in the file
3088 \begin_inset Flex Code
3091 \begin_layout Plain Layout
3092 development/autotests/filterCheckWarnings
3100 \begin_layout Standard
3101 Under cmake, the tests are labeled as 'load'.
3104 \begin_layout Subsubsection
3108 \begin_layout Standard
3109 These tests combine lyx2lyx tests with check_load tests.
3110 They fail if either fails.
3113 \begin_layout Subsubsection
3117 \begin_layout Standard
3118 The URL tests are enabled with the
3119 \begin_inset Flex Code
3122 \begin_layout Plain Layout
3123 -DLYX_ENABLE_URLTESTS=ON
3128 CMake flag and are useful for finding broken links in our documentation
3130 If a URL test fails, to see which link in particular was reported as broken,
3132 \begin_inset Flex Code
3135 \begin_layout Plain Layout
3142 These tests are extremely fragile (e.g.
3143 a test can depend on your Internet connection) and a failed URL test should
3144 not be taken too seriously.
3145 URL tests are labeled as
3150 \begin_layout Paragraph
3154 \begin_layout Standard
3155 cmake is required to run the \SpecialChar LyX
3156 tests, running them is not implemented for
3160 \begin_layout Standard
3161 The appropriate commands are:
3164 \begin_layout Itemize
3170 \begin_inset Newline newline
3173 runs all tests with label
3178 \begin_layout Itemize
3181 ctest -R 'check_.*urls'
3184 \begin_inset Newline newline
3187 runs the tests 'check_accessible_urls'
3190 \begin_layout Standard
3191 Associated test results can be examined in ctest-log directory in files
3192 of the form 'LastFailed.*URLS.log'
3195 \begin_layout Subsubsection
3199 \begin_layout Standard
3200 ctest label commands:
3203 \begin_layout Description
3204 \SpecialChar nobreakdash
3205 \SpecialChar nobreakdash
3206 print-labels shows all assigned labels
3209 \begin_layout Description
3210 \SpecialChar nobreakdash
3212 \begin_inset space ~
3215 labelname executes all tests to which this label is assigned to.
3216 A test may have more that one label.
3219 \begin_layout Description
3220 \SpecialChar nobreakdash
3222 \begin_inset space ~
3225 number executes tests in parallel using 'number' simultaneously processes.
3226 Some tests are marked as 'sequencial', for them this parameter has no effect.
3229 \begin_layout Section
3230 Development policies
3233 \begin_layout Standard
3234 This chapter lists some guidelines that should be followed.
3235 This list is not complete, and many guidelines are in separate chapters,
3237 \begin_inset Quotes eld
3240 When is an update of the .lyx file format number needed?
3241 \begin_inset Quotes erd
3245 \begin_inset CommandInset ref
3247 reference "sec:When-is-an"
3254 \begin_layout Subsection
3255 When to set a fixed milestone?
3258 \begin_layout Standard
3259 Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following
3263 \begin_layout Enumerate
3264 Somebody is actively working on a fix.
3267 \begin_layout Enumerate
3268 The bug is so severe that it would block the release if it is not fixed.
3271 \begin_layout Standard
3272 If a bug is important, but nobody is working on it, and it is no showstopper,
3273 use a milestone like 2.1.x or 2.2.x.
3274 For all other bugs, do not set a milestone at all.
3277 \begin_layout Subsection
3278 Can we add rc entries in stable branch?
3281 \begin_layout Standard
3283 We are supposed to increase the prefs2prefs version number with such things.
3286 \begin_layout Section
3287 Documentation policies
3290 \begin_layout Standard
3291 The main documentation consists of these files:
3294 \begin_layout Description
3295 splash.lyx it is the first file you see after an installation.
3296 We assume that a new user sees this.
3297 It is therefore designed to be as simple as possible.
3298 Therefore please don't add any new formatting, only fix typos etc.
3299 Splash.lyx is up to date for \SpecialChar LyX
3300 2.1.x, currently maintained by Uwe Stöhr.
3303 \begin_layout Description
3304 Intro.lyx This is the manual new users will read to learn \SpecialChar LyX
3306 It therefore uses a limited set of formatting.
3307 For example a standard document class.
3308 Since new users will first learn about the formatting possibilities of
3310 please keep this file that simple.
3311 Intro.lyx is up to date for \SpecialChar LyX
3312 2.1.x, currently maintained by Uwe Stöhr.
3315 \begin_layout Description
3316 Tutorial.lyx our tutorial.
3317 It must be always up to date.
3318 Normally there is nothing to add since we don't want to overwhelm new users
3319 with too much details.
3320 The will learn these details while using \SpecialChar LyX
3321 and we have special manuals.
3322 Tutorial.lyx is up to date for \SpecialChar LyX
3323 2.1.x, currently maintained by Uwe Stöhr.
3326 \begin_layout Description
3327 UserGuide.lyx our main user guide.
3328 It covers a mixture of basic and detailed information.
3329 Some information is also in the Math and EmbeddedObjects manual so that
3330 the UserGuide refers to these files.
3331 UserGuide.lyx is up to date for \SpecialChar LyX
3332 2.1.x, currently maintained by Uwe Stöhr.
3335 \begin_layout Description
3336 EmbeddedObjects.lyx a special manual to explain things like tables floats
3339 EmbeddedObjects.lyx is up to date for \SpecialChar LyX
3340 2.1.x, currently maintained by Uwe
3344 \begin_layout Description
3345 Math.lyx a special manual to explain everything regarding math in all detail.
3346 Math.lyx is up to date for \SpecialChar LyX
3347 2.1.x, currently maintained by Uwe Stöhr.
3350 \begin_layout Description
3351 Additional.lyx this manual covers information that would be too much detail
3352 for the UserGuide or would make the UserGuide uncompilable or only compilable
3353 when installing a lot of special \SpecialChar LaTeX
3355 What should be in the UserGuide or better in Additional is a matter of
3357 it is up to you to decide that.
3358 Additional.lyx is not completely up to date for \SpecialChar LyX
3361 \begin_inset space ~
3364 8 is up to date and currently maintained by Uwe Stöhr.
3365 It certainly needs a rewrite and update.
3366 For example many info in chapter
3367 \begin_inset space ~
3370 2 and 3 are already covered by the UserGuide and/or the EmbeddedObjects
3374 \begin_layout Description
3375 Customization.lyx this manual covers information how to customize \SpecialChar LyX
3377 output formats, operating systems, languages etc.
3378 It is currently completely out of date and needs a major rewrite and update.
3379 If you do this please assure that your information are given for all OSes
3380 and \SpecialChar LaTeX
3381 distributions (meaning be as objective as possible).
3384 \begin_layout Standard
3386 \begin_inset space ~
3389 rules in editing the docs:
3392 \begin_layout Enumerate
3393 If you are not the maintainer of a doc file or a chapter/section, you MUST
3394 use change tracking so that the maintainer could review your changes
3397 \begin_layout Enumerate
3398 Respect the formatting of the document.
3399 The different files use different formatting styles.
3400 That is OK and has historic reasons nobody fully know ;-).
3401 But it is important to be consistent within one file.
3404 \begin_layout Enumerate
3405 All changes you make to a file in one language MUST also go the file in
3406 the other actively maintained languages.
3407 Normally the maintainer does this for you, if you are the maintainer, you
3408 must do this by copying or changing the changed or added text to the other
3409 files so that the translators sees the blue underlined text and know what
3410 they have to translate and what was changed.
3413 \begin_layout Enumerate
3414 You MUST assure that the document is compilable as
3415 \begin_inset Quotes eld
3419 \begin_inset Quotes erd