1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
7 \options BCOR8mm,captions=tableheading
8 \use_default_options false
12 \maintain_unincluded_children false
14 \language_package default
17 \font_roman "lmodern" "default"
18 \font_sans "lmss" "default"
19 \font_typewriter "lmtt" "default"
20 \font_math "auto" "auto"
21 \font_default_family default
22 \use_non_tex_fonts false
25 \font_sf_scale 100 100
26 \font_tt_scale 100 100
28 \default_output_format default
30 \bibtex_command default
31 \index_command default
35 \pdf_title "LyX's Development manual"
36 \pdf_author "LyX Team"
37 \pdf_subject "LyX's development documentation"
38 \pdf_keywords "LyX, Documentation, Development"
40 \pdf_bookmarksnumbered true
41 \pdf_bookmarksopen true
42 \pdf_bookmarksopenlevel 1
47 \pdf_pdfusetitle false
48 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
51 \use_package amsmath 1
52 \use_package amssymb 1
55 \use_package mathdots 1
56 \use_package mathtools 0
58 \use_package stackrel 0
59 \use_package stmaryrd 0
60 \use_package undertilde 0
62 \cite_engine_type default
66 \paperorientation portrait
70 \notefontcolor #0000ff
77 \paragraph_separation indent
78 \paragraph_indentation default
79 \quotes_language english
82 \paperpagestyle headings
83 \tracking_changes false
93 Developing \SpecialChar LyX
97 \begin_layout Subtitle
102 by the \SpecialChar LyX
107 \begin_layout Plain Layout
109 If you have comments or error corrections, please send them to the \SpecialChar LyX
112 \begin_inset Flex Code
115 \begin_layout Plain Layout
117 <lyx-docs@lists.lyx.org>
130 \begin_layout Standard
131 \begin_inset CommandInset toc
132 LatexCommand tableofcontents
139 \begin_layout Section
143 \begin_layout Standard
144 This manual documents some aspects of \SpecialChar LyX
146 It is currently rather incomplete, but will hopefully be extended in the
148 Meanwhile, additional information can be found in the
149 \begin_inset Flex Code
152 \begin_layout Plain Layout
158 subfolder of the \SpecialChar LyX
159 source code distribution.
160 This document is not translated, since the development language of \SpecialChar LyX
163 If you want to use \SpecialChar LyX
164 you don't need to read this manual.
165 However, if you want to learn more about how \SpecialChar LyX
166 is developed, or even want
167 to participate in \SpecialChar LyX
168 development, you may find some interesting information.
171 \begin_layout Section
175 \begin_layout Standard
177 uses several custom file formats for configuration files and documents.
178 This chapter contains some background concerning these file formats.
179 Several file formats are also described in detail in the regular user documenta
183 \begin_layout Subsection
187 \begin_layout Subsection
188 When is an update of the .lyx file format number needed?
189 \begin_inset CommandInset label
191 name "sec:When-is-an"
198 \begin_layout Standard
199 When you are working on a new feature you may ask yourself whether it needs
200 an update of the .lyx file format number.
201 Whether an update is needed or not is not always obvious.
202 Below you can find a list of reasons for file format updates with explanations:
205 \begin_layout Description
214 setting Whenever you introduce a new setting that is stored in the document
215 header, a file format update is needed.
216 This is also true if you add a new valid value to an existing setting,
218 \begin_inset space \thinspace{}
222 \begin_inset space \space{}
225 a new language that is stored in
226 \begin_inset Flex Code
229 \begin_layout Plain Layout
240 \begin_layout Description
249 setting If a certain setting becomes obsolete and gets removed, a file format
253 \begin_layout Description
258 inset Of course a new inset requires a file format update.
261 \begin_layout Description
266 style in any layout file or module shipped with \SpecialChar LyX
267 , or new shipped layout
269 These requirements are currently under discussion and might change in the
273 \begin_layout Description
286 package Any new math package that is automatically loaded needs a file format
288 The reason for this is that there is no true ERT inset for math formulas:
289 Each command is parsed, and if a user happens to 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 support converting layouts to older
668 layout formats, as we do for the .lyx file format.
671 \begin_layout Subsection
672 Updating the file format number of bind/ui files
675 \begin_layout Standard
677 \begin_inset CommandInset ref
679 reference "enu:updatefiles"
684 \begin_inset CommandInset ref
686 reference "subsec:update_lyx_files"
691 \begin_inset Flex Code
694 \begin_layout Plain Layout
700 command, use this command:
701 \begin_inset Flex Code
704 \begin_layout Plain Layout
705 bash development/tools/updatelfuns.sh
713 \begin_layout Subsection
714 Backporting new styles to the stable version
717 \begin_layout Standard
718 Starting with the stable \SpecialChar LyX
719 2.1 branch, there is a mechanism in place to backport
720 new styles to the stable version without the need to update the file format.
721 The basic idea is that the new style definition is automatically copied
722 to the document preamble, so that it can even be used by older minor revisions
723 that did not yet include the style.
724 To backport a new style to the stable version, the following steps are
728 \begin_layout Enumerate
730 \begin_inset Flex Code
733 \begin_layout Plain Layout
739 to the style definition in the development version.
742 \begin_layout Enumerate
743 Copy the style definition to the stable version, but use
744 \begin_inset Flex Code
747 \begin_layout Plain Layout
754 If needed adjust the format to the one used by the stable version (see
755 the customization manual for details of the layout file format).
758 \begin_layout Enumerate
759 For each update of the style in a later stable version, increase the argument
761 \begin_inset Flex Code
764 \begin_layout Plain Layout
770 by one (in the stable version, the development version should not be touched).
773 \begin_layout Standard
774 For details about the
775 \begin_inset Flex Code
778 \begin_layout Plain Layout
784 flag see the customization manual.
786 \begin_inset Flex Code
789 \begin_layout Plain Layout
795 support is needed for backported styles: Since the style of the development
796 version has an infinite version number, it will always be used.
797 Furthermore, since its version number is less than one, the style will
798 not be written anymore to the document header for files saved by the new
802 \begin_layout Standard
803 \begin_inset Newpage newpage
809 \begin_layout Section
813 \begin_layout Standard
814 Automated tests are an important tool to detect bugs and regressions in
815 software development.
816 Some projects like gcc even require each bug fix to be accompanied by a
817 test case for the automatic test suite, that would detect this bug.
818 Testing interactive features automatically is of course very hard, but
819 core functionality like document import and export can be tested quite
820 easily, and some tests of this kind exist.
823 \begin_layout Subsection
827 \begin_layout Standard
828 There are attempts to set up a suite of unit tests for LyX.
831 \begin_layout Standard
832 TODO: describe what is done and what is still to do.
835 \begin_layout Subsection
839 \begin_layout Standard
840 The tex2lyx tests are located in the
841 \begin_inset Flex Code
844 \begin_layout Plain Layout
850 subfolder of the \SpecialChar LyX
851 source code distribution.
852 The actual testing is performed by the simple python script
853 \begin_inset Flex Code
856 \begin_layout Plain Layout
857 src/tex2lyx/test/runtests.py
863 Each test consists of two files:
864 \begin_inset Flex Code
867 \begin_layout Plain Layout
873 contains the \SpecialChar LaTeX
874 code that should be tested.
876 \begin_inset Flex Code
879 \begin_layout Plain Layout
885 contains the expected output of tex2lyx.
886 When a test is run, the actual produced output is compared with the stored
888 The test passes if both are identical.
889 The test machinery is also able to generate a file
890 \begin_inset Flex Code
893 \begin_layout Plain Layout
899 by exporting the produced .lyx file with \SpecialChar LyX
901 This may be useful for roundtrip comparisons.
904 \begin_layout Subsubsection
908 \begin_layout Standard
909 The tex2lyx tests can be run in several ways.
911 \begin_inset Flex Code
914 \begin_layout Plain Layout
920 subfolder of the build directory, the commands
921 \begin_inset Flex Code
924 \begin_layout Plain Layout
930 (cmake, all platforms),
931 \begin_inset Flex Code
934 \begin_layout Plain Layout
940 (cmake, when using a make based build system and not MSVC) or
941 \begin_inset Flex Code
944 \begin_layout Plain Layout
950 (autotools) will run the tex2lyx tests.
951 Alternatively, in the root of the build directory, the command
952 \begin_inset Flex Code
955 \begin_layout Plain Layout
961 runs all tests whose names match the regex
962 \begin_inset Quotes eld
966 \begin_inset Quotes erd
970 Another way to run the tex2lyx tests in the root build directory is to
971 instead use the command
972 \begin_inset Flex Code
975 \begin_layout Plain Layout
976 ctest -L '(cmplyx|roundtrip)'
981 , which runs all tests categorized with the label
982 \begin_inset Quotes eld
986 \begin_inset Quotes erd
990 \begin_inset Quotes eld
994 \begin_inset Quotes erd
998 If a test fails, the differences between the expected and actual results
999 are output in unified diff format.
1002 \begin_layout Subsubsection
1003 Updating test references
1004 \begin_inset CommandInset label
1006 name "sec:Updating-test-references"
1013 \begin_layout Standard
1014 In some cases a changed tex2lyx output is not a test failure, but wanted,
1016 \begin_inset space \thinspace{}
1020 \begin_inset space \space{}
1023 if a tex2lyx bug was fixed, or a new feature was added.
1024 In these cases the stored references need to be updated.
1025 To do so if using autotools, call
1026 \begin_inset Flex Code
1029 \begin_layout Plain Layout
1036 \begin_inset Flex Code
1039 \begin_layout Plain Layout
1045 subdirectory of the build directory.
1046 If instead using CMake, call
1047 \begin_inset Flex Code
1050 \begin_layout Plain Layout
1051 make updatetex2lyxtests
1056 in the build directory or in the
1057 \begin_inset Flex Code
1060 \begin_layout Plain Layout
1066 subdirectory of the build directory.
1070 \begin_layout Plain Layout
1071 Note that this is a case where a make target in the build directory can
1072 affect the source directory, which might not be advisable.
1077 On Windows do the following:
1080 \begin_layout Itemize
1081 Assure that the path to the python.exe is in your system PATH variable.
1084 \begin_layout Itemize
1085 Double-click on the file
1086 \begin_inset Flex Code
1089 \begin_layout Plain Layout
1090 updatetex2lyxtests.vcxproj
1095 in the build directory or in the
1096 \begin_inset Flex Code
1099 \begin_layout Plain Layout
1105 subdirectory of your build directory.
1108 \begin_layout Itemize
1109 In the appearing MSVC program right-click on the project
1113 in the project explorer and chose
1120 \begin_layout Standard
1121 For convenience, these commands also produce re-exported roundtrip .lyx.tex
1123 Please examine the changed output carefully before committing the changed
1124 files to the repository: Since the test machinery does not do a roundtrip
1126 \begin_inset Formula $\Rightarrow$
1130 \begin_inset Formula $\Rightarrow$
1133 .tex, and does not compare the produced dvi or pdf output, it assumes that
1134 the stored .lyx reference produces correct output if processed by \SpecialChar LyX
1136 There is only one chance to detect wrong output: before committing a new
1138 Once it is committed, it is quite difficult to verify whether it is correct.
1141 \begin_layout Standard
1146 update the test references by opening them with \SpecialChar LyX
1147 or directly running lyx2lyx
1149 This would not work, since lyx2lyx and \SpecialChar LyX
1150 produce slightly different files
1151 regarding insignificant whitespace and line breaks.
1154 \begin_layout Subsubsection
1158 \begin_layout Standard
1159 In many cases tests for new features may be added to one of the existing
1160 test files, but sometimes this is not possible or not wanted.
1161 Then a new test file needs to be added:
1164 \begin_layout Enumerate
1166 \begin_inset Flex Code
1169 \begin_layout Plain Layout
1170 src/tex2lyx/test/<test name>.tex
1175 and run tex2lyx in roundtrip mode to produce the file
1176 \begin_inset Flex Code
1179 \begin_layout Plain Layout
1180 src/tex2lyx/test/<test name>.lyx.lyx
1186 This file will be the new reference.
1189 \begin_layout Enumerate
1190 Once you confirmed that the tex2lyx output is correct, add the new files
1191 to the corresponding lists in
1192 \begin_inset Flex Code
1195 \begin_layout Plain Layout
1196 src/tex2lyx/test/runtests.py
1202 \begin_inset Flex Code
1205 \begin_layout Plain Layout
1206 src/tex2lyx/Makefile.am
1212 \begin_inset Flex Code
1215 \begin_layout Plain Layout
1216 src/tex2lyx/test/CMakeLists.txt
1224 \begin_layout Enumerate
1225 Commit the changes to the repository, or send a patch to the development
1226 list and ask for committing if you do not have commit rights.
1229 \begin_layout Subsection
1230 ctest automatic tests (cmake only)
1233 \begin_layout Standard
1234 Some tests are located in the
1235 \begin_inset Flex Code
1238 \begin_layout Plain Layout
1239 development/autotests
1244 subfolder of the \SpecialChar LyX
1245 source code distribution.
1247 \begin_inset Flex Code
1250 \begin_layout Plain Layout
1256 is required to run the automatic \SpecialChar LyX
1257 tests, running them is not implemented
1262 \begin_layout Standard
1263 The \SpecialChar LyX
1264 tests can be run by the commands
1265 \begin_inset Flex Code
1268 \begin_layout Plain Layout
1275 \begin_inset Flex Code
1278 \begin_layout Plain Layout
1284 (when using a make based build system and not MSVC) in the
1285 \begin_inset Flex Code
1288 \begin_layout Plain Layout
1294 subfolder of the build directory.
1297 \begin_layout Subsubsection
1301 \begin_layout Standard
1302 The export tests are integration tests.
1303 They take longer to run and are more likely to break than the tex2lyx tests.
1304 Nevertheless, they have caught many regressions and without a better alternativ
1305 e it is important to keep them up-to-date and understand how they work.
1308 \begin_layout Standard
1310 \begin_inset Quotes eld
1314 \begin_inset Quotes erd
1317 the documentation, template, and example files trying to export them to
1318 all supported output formats.
1321 \begin_layout Paragraph
1322 Expectations of LyX developers
1325 \begin_layout Standard
1326 Because the export tests are integration tests and take a long time to run,
1327 LyX developers are rarely expected to run all of the tests.
1328 Here are some good practices to follow by developers:
1331 \begin_layout Itemize
1332 When making a non-trivial change to a .layout file, run the export and layout
1333 tests corresponding with that .layout file.
1336 \begin_layout Itemize
1337 When making non-trivial changes to a .lyx file, run the export tests correspondin
1338 g to that .lyx file.
1341 \begin_layout Itemize
1342 When making non-trivial changes to LyX's \SpecialChar LaTeX
1344 touching the encoding code or package handling code that you expect will
1345 change the exported \SpecialChar LaTeX
1346 in some way), consider running all of the export tests
1347 before and after your change.
1348 If there are differences, please reconcile these (i.e.
1349 fix the bug or fix the tests)
1354 Ask for help if you're not sure what to do or if you do not want to run
1355 the tests, post the patch on the list and others will run the tests.
1358 \begin_layout Itemize
1359 Understand how to interpret test failures.
1360 If your commit is found to have broken a test, you should be able to interpret
1361 the test results when made aware of them.
1363 \begin_inset CommandInset ref
1365 reference "subsec:Interpreting-export-tests"
1372 \begin_layout Paragraph
1373 Configuring the tests
1376 \begin_layout Standard
1377 To enable these tests, add the
1378 \begin_inset Flex Code
1381 \begin_layout Plain Layout
1382 -DLYX_ENABLE_EXPORT_TESTS=ON
1391 \begin_layout Standard
1392 \begin_inset Flex Code
1395 \begin_layout Plain Layout
1396 cmake -DLYX_ENABLE_EXPORT_TESTS=ON /path/to/source
1404 \begin_layout Standard
1406 This flag will increase the time for the cmake command by several seconds,
1407 mainly because of the process of inverting tests (see Section
1408 \begin_inset CommandInset ref
1410 reference "subsec:Interpreting-export-tests"
1417 \begin_layout Paragraph
1421 \begin_layout Standard
1422 To run all tests, in the build directory simply run the command
1423 \begin_inset Flex Code
1426 \begin_layout Plain Layout
1433 To run only some of the tests, use the command
1434 \begin_inset Flex Code
1437 \begin_layout Plain Layout
1444 \begin_inset Flex Code
1447 \begin_layout Plain Layout
1453 is a regular expression that matches test names.
1454 To run only the export tests, you can use
1455 \begin_inset Flex Code
1458 \begin_layout Plain Layout
1465 For the list of test categories available in addition to
1466 \begin_inset Quotes eld
1470 \begin_inset Quotes erd
1474 \begin_inset Flex Code
1477 \begin_layout Plain Layout
1478 ctest \SpecialChar nobreakdash
1479 \SpecialChar nobreakdash
1486 It is often useful to list the tests without running them (e.g.
1487 if you want to know how many tests there are or whether your
1488 \begin_inset Flex Code
1491 \begin_layout Plain Layout
1497 regular expression did what you expected).
1498 This can be done with the
1499 \begin_inset Flex Code
1502 \begin_layout Plain Layout
1509 \begin_inset Flex Code
1512 \begin_layout Plain Layout
1513 \SpecialChar nobreakdash
1514 \SpecialChar nobreakdash
1521 We are still working on getting the tests to run in parallel which is supported
1523 \begin_inset Flex Code
1526 \begin_layout Plain Layout
1533 \begin_inset Flex Code
1536 \begin_layout Plain Layout
1543 \begin_inset Flex Code
1546 \begin_layout Plain Layout
1547 \SpecialChar nobreakdash
1548 \SpecialChar nobreakdash
1555 However, when running the tests in parallel, sometimes tests fail that
1556 pass when run sequentially.
1557 A reasonable approach is to first run the tests in parallel and then run
1558 the failed tests sequentially.
1559 For example, to run 8 jobs at a time:
1562 \begin_layout Standard
1563 \begin_inset Flex Code
1566 \begin_layout Plain Layout
1575 \begin_layout Standard
1576 \begin_inset Flex Code
1579 \begin_layout Plain Layout
1580 ctest \SpecialChar nobreakdash
1581 \SpecialChar nobreakdash
1590 \begin_layout Standard
1592 Note that some tests cannot be run in parallel.
1593 These tests are marked in the code with the
1594 \begin_inset Flex Code
1597 \begin_layout Plain Layout
1607 \begin_layout Standard
1608 In some situations the option
1609 \begin_inset Flex Code
1612 \begin_layout Plain Layout
1613 \SpecialChar nobreakdash
1614 \SpecialChar nobreakdash
1621 There have been bugs in LyX and in \SpecialChar LaTeX
1622 which cause compilation to hang, and
1623 without a timeout a test might never stop (in one case there was even a
1625 If a test times out, the
1626 \begin_inset Flex Code
1629 \begin_layout Plain Layout
1635 command exits with error, but you can distinguish between a timed out test
1636 and a failed test in the output reported at the end of the
1637 \begin_inset Flex Code
1640 \begin_layout Plain Layout
1649 \begin_layout Standard
1651 \begin_inset Flex Code
1654 \begin_layout Plain Layout
1660 ) the full list of command line options.
1663 \begin_layout Paragraph
1664 \begin_inset CommandInset label
1666 name "subsec:Interpreting-export-tests"
1670 Interpreting the export test results
1673 \begin_layout Standard
1674 A test can fail for several reasons, not all of them bad.
1677 \begin_layout Enumerate
1678 The .lyx file could have been added recently and some formats are not expected
1682 \begin_layout Enumerate
1683 A dependency is not met (e.g.
1684 the \SpecialChar LaTeX
1686 One hint that this is the case is that the corresponding
1687 \begin_inset Flex Code
1690 \begin_layout Plain Layout
1696 test will likely also fail.
1699 \begin_layout Enumerate
1700 An inverted test fails to fail (i.e.
1701 export that previously failed now works).
1704 \begin_layout Enumerate
1705 An external dependency was updated (e.g.
1710 \begin_layout Enumerate
1711 A recent code change introduced a bug.
1714 \begin_layout Enumerate
1715 \begin_inset CommandInset label
1721 A change in a document exposed a previously unknown bug or an incompatibility
1722 with an export format (e.g.
1723 Lua\SpecialChar LaTeX
1727 \begin_layout Standard
1728 Because the .lyx files are exported in several formats, it is not surprising
1729 that many of the exports fail.
1730 This expectation of failure is addressed by
1731 \begin_inset Quotes eld
1735 \begin_inset Quotes erd
1738 the tests, that is, by marking the test as
1739 \begin_inset Quotes eld
1743 \begin_inset Quotes erd
1746 if the export exits with error and as
1747 \begin_inset Quotes eld
1751 \begin_inset Quotes erd
1754 if the export succeeds
1759 It follows that these expected failures will not show up as failed tests
1760 in the test results and thus will not pollute the
1761 \begin_inset Quotes eld
1765 \begin_inset Quotes erd
1769 If the export actually succeeds, then the test will fail.
1770 The purpose of this failure is to get your attention—something has changed,
1771 possibly for the better.
1774 \begin_layout Standard
1775 We try to document why a test is inverted or ignored.
1776 See the comment (prefixed with
1777 \begin_inset Flex Code
1780 \begin_layout Plain Layout
1786 ) above the block in which the test is listed as inverted or ignored in
1788 \begin_inset Flex Code
1791 \begin_layout Plain Layout
1792 development/autotests/suspiciousTests
1798 \begin_inset Flex Code
1801 \begin_layout Plain Layout
1802 development/autotests/ignoredTests
1808 It is possible that an export goes from succeeding to failing just because
1809 the document was changed and the document was never expected to work with
1810 a certain export format in the first case.
1811 Once this is confirmed to be the situation, the test can be inverted.
1814 \begin_layout Standard
1815 A good question is why do we enable the tests for non-default formats? The
1816 answer is that if a non-default route is broken it is often because a bug
1817 was introduced in LyX and not because a document-specific change was made
1818 that is not supported by the route.
1819 In other words, there is a high signal/noise ratio in the export tests
1820 for some non-default formats.
1824 \begin_layout Standard
1825 What action should you take if a test fails? This depends:
1828 \begin_layout Standard
1829 Generally, if a change breaks compilation for the target format (for the
1830 manuals pdf2) without solving some important other issue, fix or revert
1831 the commit that led to failure.
1832 If a change breaks compilation for some non-target format (for the manuals
1833 everything except pdf2), invert the test.
1837 \begin_layout Standard
1838 A special case is given, if the export was succeeding before but showing
1839 garbled text in the PDF output.
1840 Try to establish, that when the compilation succeeded before the resulting
1842 Otherwise, it is in fact an improvement when a test fails.
1843 Now it might fail with a clear message of "language xyz not supported".
1844 It is always good to check manually why something fails and if it passes
1845 if the PDF output is good.
1848 \begin_layout Standard
1849 Sometimes a test is fixed as side-effect of some change.
1850 We should uninvert a test (remove it from the
1851 \begin_inset Flex Code
1854 \begin_layout Plain Layout
1860 file) in order to preserve the fix.
1863 \begin_layout Standard
1864 When a test or several tests fail, consider checking the files in the
1865 \begin_inset Flex Code
1868 \begin_layout Plain Layout
1874 subdirectory of your build directory.
1875 In this subdirectory are three files: the file
1876 \begin_inset Flex Code
1879 \begin_layout Plain Layout
1885 simply lists the tests that failed on your last
1886 \begin_inset Flex Code
1889 \begin_layout Plain Layout
1896 \begin_inset Flex Code
1899 \begin_layout Plain Layout
1905 file contains the output from the tests (and often has details explaining
1906 why a test failed); and the
1907 \begin_inset Flex Code
1910 \begin_layout Plain Layout
1916 file lists the times that it took to run the tests.
1919 \begin_layout Paragraph
1923 \begin_layout Standard
1924 These tests are expected to always fail.
1927 \begin_layout Description
1928 inverted These tests are expected to fail, but are subject to be examined.
1929 It is expected that they will pass in a foreseeable future.
1930 They are labeled 'inverted'.
1933 \begin_layout Description
1934 suspended Some inverted tests are labeled 'suspended'.
1935 This means, they are not executed using
1936 \begin_inset Flex Code
1939 \begin_layout Plain Layout
1946 \begin_inset Flex Code
1949 \begin_layout Plain Layout
1956 From time to time they still have to be checked using
1957 \begin_inset Flex Code
1960 \begin_layout Plain Layout
1970 \begin_layout Standard
1971 These tests are suspended, because they fail for known reasons which cannot
1973 But it is expected the reason might disappear in the future.
1974 Be it new TL or better handling in \SpecialChar LyX
1978 \begin_layout Standard
1979 For ctest commands without the
1980 \begin_inset Flex Code
1983 \begin_layout Plain Layout
1989 parameter nothing changes.
1990 Suspended or not, tests will be executed depending only on the regexes
1991 parameters given to the ctest command.
1995 \begin_layout Paragraph
1999 \begin_layout Description
2000 nonstandard Requires non-standard ressources (\SpecialChar LaTeX
2001 packages and document classes,
2002 fonts, ...) that are not a requirement for running this test suite.
2006 \begin_layout Standard
2007 These tests are labeled as
2013 \begin_layout Description
2015 \begin_inset Quotes eld
2019 \begin_inset Quotes erd
2022 result, depending on local configuration, OS, \SpecialChar TeX
2023 distribution, package versions,
2024 or the phase of the moon.
2028 \begin_layout Standard
2029 These tests are labeled as
2035 \begin_layout Paragraph
2036 Export test filtering
2039 \begin_layout Standard
2040 There are files which control the assignment of a label to a test.
2043 \begin_layout Description
2044 ignoredTests (small file)
2045 \begin_inset Newline newline
2048 Tests selected here are withdrawn
2052 \begin_layout Labeling
2053 \labelwidthstring 00.00.0000
2054 Input Test of any export combination
2057 \begin_layout Labeling
2058 \labelwidthstring 00.00.0000
2059 Output Stop if tests not selected here
2063 \begin_layout Description
2064 unreliableTests: Tests selected either pass or fail, but that is dependent
2065 on the system where the test is run.
2066 Selected tests gain the label 'unreliable'.
2070 \begin_layout Labeling
2071 \labelwidthstring 00.00.0000
2072 Input Each test which passed 'ignoredTests'
2075 \begin_layout Labeling
2076 \labelwidthstring 00.00.0000
2077 Output Stop if test selected, gain label 'unreliable'.
2081 \begin_layout Description
2083 \begin_inset space \space{}
2090 \begin_layout Labeling
2091 \labelwidthstring 00.00.0000
2092 Input Each test which passed 'unreliableTests'
2095 \begin_layout Labeling
2096 \labelwidthstring 00.00.0000
2097 Output Stop if not selected.
2100 \begin_layout Standard
2101 The following file is meant as subselections of 'suspiciousTests'.
2102 If neither subselection applies, test gains labels 'export' and 'inverted'
2105 \begin_layout Description
2106 suspendedTests Tests selected here gain the label 'suspended' but _not_
2107 'export' or 'inverted', although in ctest they remain inverted.
2108 ('ctest' knows only 'inverted' or not, labels are used only for test selection)
2112 \begin_layout Labeling
2113 \labelwidthstring 00.00.0000
2114 Input Each test selected by 'suspiciousTests'
2117 \begin_layout Labeling
2118 \labelwidthstring 00.00.0000
2119 Output Selected test gains label 'suspended'.
2125 \begin_layout Standard
2126 The following table may clarify label assignement
2129 \begin_layout Standard
2130 \begin_inset Tabular
2131 <lyxtabular version="3" rows="7" columns="12">
2132 <features tabularvalignment="middle">
2133 <column alignment="left" valignment="top" width="0pt">
2134 <column alignment="left" valignment="top" width="0pt">
2135 <column alignment="left" valignment="top" width="0pt">
2136 <column alignment="left" valignment="top" width="0pt">
2137 <column alignment="center" valignment="top">
2138 <column alignment="center" valignment="top">
2139 <column alignment="center" valignment="top">
2140 <column alignment="center" valignment="top">
2141 <column alignment="center" valignment="top">
2142 <column alignment="center" valignment="top">
2143 <column alignment="center" valignment="top">
2144 <column alignment="center" valignment="top">
2146 <cell multicolumn="1" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2149 \begin_layout Plain Layout
2155 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2158 \begin_layout Plain Layout
2164 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2167 \begin_layout Plain Layout
2173 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2176 \begin_layout Plain Layout
2182 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2185 \begin_layout Plain Layout
2186 Marked in ctest, Assigned label
2191 <cell multicolumn="2" alignment="center" valignment="top" usebox="none">
2194 \begin_layout Plain Layout
2200 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2203 \begin_layout Plain Layout
2209 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2212 \begin_layout Plain Layout
2218 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2221 \begin_layout Plain Layout
2227 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2230 \begin_layout Plain Layout
2236 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2239 \begin_layout Plain Layout
2245 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2248 \begin_layout Plain Layout
2256 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2259 \begin_layout Plain Layout
2265 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2268 \begin_layout Plain Layout
2274 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2277 \begin_layout Plain Layout
2283 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2286 \begin_layout Plain Layout
2292 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2295 \begin_layout Plain Layout
2301 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
2304 \begin_layout Plain Layout
2310 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2313 \begin_layout Plain Layout
2319 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
2322 \begin_layout Plain Layout
2328 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2331 \begin_layout Plain Layout
2337 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
2340 \begin_layout Plain Layout
2346 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2349 \begin_layout Plain Layout
2355 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2358 \begin_layout Plain Layout
2366 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2369 \begin_layout Plain Layout
2375 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2378 \begin_layout Plain Layout
2384 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2387 \begin_layout Plain Layout
2393 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2396 \begin_layout Plain Layout
2402 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2405 \begin_layout Plain Layout
2411 <cell alignment="center" valignment="top" topline="true" usebox="none">
2414 \begin_layout Plain Layout
2420 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2423 \begin_layout Plain Layout
2429 <cell alignment="center" valignment="top" topline="true" usebox="none">
2432 \begin_layout Plain Layout
2438 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2441 \begin_layout Plain Layout
2447 <cell alignment="center" valignment="top" topline="true" usebox="none">
2450 \begin_layout Plain Layout
2456 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2459 \begin_layout Plain Layout
2465 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2468 \begin_layout Plain Layout
2476 <cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2479 \begin_layout Plain Layout
2485 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2488 \begin_layout Plain Layout
2494 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2497 \begin_layout Plain Layout
2503 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2506 \begin_layout Plain Layout
2512 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2515 \begin_layout Plain Layout
2521 <cell alignment="center" valignment="top" topline="true" usebox="none">
2524 \begin_layout Plain Layout
2530 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2533 \begin_layout Plain Layout
2539 <cell alignment="center" valignment="top" topline="true" usebox="none">
2542 \begin_layout Plain Layout
2548 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2551 \begin_layout Plain Layout
2557 <cell alignment="center" valignment="top" topline="true" usebox="none">
2560 \begin_layout Plain Layout
2566 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2569 \begin_layout Plain Layout
2575 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2578 \begin_layout Plain Layout
2586 <cell multirow="4" alignment="left" valignment="middle" topline="true" leftline="true" usebox="none">
2589 \begin_layout Plain Layout
2595 <cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2598 \begin_layout Plain Layout
2604 <cell multirow="3" alignment="left" valignment="middle" topline="true" bottomline="true" leftline="true" usebox="none">
2607 \begin_layout Plain Layout
2613 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2616 \begin_layout Plain Layout
2622 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2625 \begin_layout Plain Layout
2631 <cell alignment="center" valignment="top" topline="true" usebox="none">
2634 \begin_layout Plain Layout
2640 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2643 \begin_layout Plain Layout
2649 <cell alignment="center" valignment="top" topline="true" usebox="none">
2652 \begin_layout Plain Layout
2658 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2661 \begin_layout Plain Layout
2667 <cell alignment="center" valignment="top" topline="true" usebox="none">
2670 \begin_layout Plain Layout
2676 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2679 \begin_layout Plain Layout
2685 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2688 \begin_layout Plain Layout
2696 <cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2699 \begin_layout Plain Layout
2705 <cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2708 \begin_layout Plain Layout
2714 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2717 \begin_layout Plain Layout
2723 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2726 \begin_layout Plain Layout
2732 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2735 \begin_layout Plain Layout
2741 <cell alignment="center" valignment="top" topline="true" usebox="none">
2744 \begin_layout Plain Layout
2750 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2753 \begin_layout Plain Layout
2759 <cell alignment="center" valignment="top" topline="true" usebox="none">
2762 \begin_layout Plain Layout
2768 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2771 \begin_layout Plain Layout
2777 <cell alignment="center" valignment="top" topline="true" usebox="none">
2780 \begin_layout Plain Layout
2786 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2789 \begin_layout Plain Layout
2795 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2798 \begin_layout Plain Layout
2806 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2809 \begin_layout Plain Layout
2815 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2818 \begin_layout Plain Layout
2824 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2827 \begin_layout Plain Layout
2833 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2836 \begin_layout Plain Layout
2842 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2845 \begin_layout Plain Layout
2851 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
2854 \begin_layout Plain Layout
2860 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2863 \begin_layout Plain Layout
2869 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
2872 \begin_layout Plain Layout
2878 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2881 \begin_layout Plain Layout
2887 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
2890 \begin_layout Plain Layout
2896 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2899 \begin_layout Plain Layout
2905 <cell alignment="center" valignment="top" topline="true" bottomline="true" rightline="true" usebox="none">
2908 \begin_layout Plain Layout
2922 \begin_layout Subsubsection
2926 \begin_layout Standard
2927 These tests check whether a .lyx file loads without any terminal messages.
2928 They correspond to the manual operations of simply opening a .lyx file on
2929 the terminal, exiting LyX once the file is loaded, and then checking whether
2930 there is any output from the terminal.
2931 These tests are useful for catching malformed .lyx files and parsing bugs.
2932 They can also be used to find a .lyx file in which an instance of something
2934 To do this, compile LyX with a local patch that outputs something to the
2935 terminal when an instance is found, and then run the check_load tests to
2936 see if any fail, which would mean that the situation occurs in the LyX
2937 documentation files corresponding to the failed tests.
2938 These tests are expectedly fragile: any LyX diagnostic message, which is
2939 not necessarily an error, would cause the tests to fail.
2940 Similarly, any message output by a library (e.g.
2941 Qt) would also cause failure.
2942 There are some messages that the check_load tests are instructed to ignore,
2943 which are stored in the file
2944 \begin_inset Flex Code
2947 \begin_layout Plain Layout
2948 development/autotests/filterCheckWarnings
2956 \begin_layout Standard
2957 Under cmake, the tests are labeled as 'load'.
2960 \begin_layout Subsubsection
2964 \begin_layout Standard
2965 The URL tests are enabled with the
2966 \begin_inset Flex Code
2969 \begin_layout Plain Layout
2970 -DLYX_ENABLE_URLTESTS=ON
2975 CMake flag and are useful for finding broken links in our documentation
2977 If a URL test fails, to see which link in particular was reported as broken,
2979 \begin_inset Flex Code
2982 \begin_layout Plain Layout
2989 These tests are extremely fragile (e.g.
2990 a test can depend on your Internet connection) and a failed URL test should
2991 not be taken too seriously.
2992 URL tests are labeled as
2997 \begin_layout Paragraph
3001 \begin_layout Standard
3002 cmake is required to run the \SpecialChar LyX
3003 tests, running them is not implemented for
3007 \begin_layout Standard
3008 The appropriate commands are:
3011 \begin_layout Itemize
3017 \begin_inset Newline newline
3020 runns all tests with label
3025 \begin_layout Itemize
3028 ctest -R 'check_.*urls'
3031 \begin_inset Newline newline
3034 runns the tests 'check_accessible_urls'
3037 \begin_layout Standard
3038 Associated test results can be examined in ctest-log directory in files
3039 of the form 'LastFailed.*URLS.log'
3042 \begin_layout Subsubsection
3046 \begin_layout Standard
3047 ctest label commands:
3050 \begin_layout Description
3051 \SpecialChar nobreakdash
3052 \SpecialChar nobreakdash
3053 print-labels shows all assigned labels
3056 \begin_layout Description
3057 \SpecialChar nobreakdash
3059 \begin_inset space ~
3062 labelname executes all tests to which this label is assigned to.
3063 A test may have more that one label.
3066 \begin_layout Description
3067 \SpecialChar nobreakdash
3069 \begin_inset space ~
3072 number executes tests in parallel using 'number' simultaneously processes.
3073 Some tests are marked as 'sequencial', for them this parameter has no effect.
3076 \begin_layout Section
3077 Development policies
3080 \begin_layout Standard
3081 This chapter lists some guidelines that should be followed.
3082 This list is not complete, and many guidelines are in separate chapters,
3084 \begin_inset Quotes eld
3087 When is an update of the .lyx file format number needed?
3088 \begin_inset Quotes erd
3092 \begin_inset CommandInset ref
3094 reference "sec:When-is-an"
3101 \begin_layout Subsection
3102 When to set a fixed milestone?
3105 \begin_layout Standard
3106 Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following
3110 \begin_layout Enumerate
3111 Somebody is actively working on a fix.
3114 \begin_layout Enumerate
3115 The bug is so severe that it would block the release if it is not fixed.
3118 \begin_layout Standard
3119 If a bug is important, but nobody is working on it, and it is no showstopper,
3120 use a milestone like 2.1.x or 2.2.x.
3121 For all other bugs, do not set a milestone at all.
3124 \begin_layout Subsection
3125 Can we add rc entries in stable branch?
3128 \begin_layout Standard
3130 We are supposed to increase the prefs2prefs version number with such things.
3133 \begin_layout Section
3134 Documentation policies
3137 \begin_layout Standard
3138 The main documentation consists of these files:
3141 \begin_layout Description
3142 splash.lyx it is the first file you see after an installation.
3143 We assume that a new user sees this.
3144 It is therefore designed to be as simple as possible.
3145 Therefore please don't add any new formatting, only fix typos etc.
3146 Splash.lyx is up to date for \SpecialChar LyX
3147 2.1.x, currently maintained by Uwe Stöhr.
3150 \begin_layout Description
3151 Intro.lyx This is the manual new users will read to learn \SpecialChar LyX
3153 It therefore uses a limited set of formatting.
3154 For example a standard document class.
3155 Since new users will first learn about the formatting possibilities of
3157 please keep this file that simple.
3158 Intro.lyx is up to date for \SpecialChar LyX
3159 2.1.x, currently maintained by Uwe Stöhr.
3162 \begin_layout Description
3163 Tutorial.lyx our tutorial.
3164 It must be always up to date.
3165 Normally there is nothing to add since we don't want to overwhelm new users
3166 with too much details.
3167 The will learn these details while using \SpecialChar LyX
3168 and we have special manuals.
3169 Tutorial.lyx is up to date for \SpecialChar LyX
3170 2.1.x, currently maintained by Uwe Stöhr.
3173 \begin_layout Description
3174 UserGuide.lyx our main user guide.
3175 It covers a mixture of basic and detailed information.
3176 Some information is also in the Math and EmbeddedObjects manual so that
3177 the UserGuide refers to these files.
3178 UserGuide.lyx is up to date for \SpecialChar LyX
3179 2.1.x, currently maintained by Uwe Stöhr.
3182 \begin_layout Description
3183 EmbeddedObjects.lyx a special manual to explain things like tables floats
3186 EmbeddedObjects.lyx is up to date for \SpecialChar LyX
3187 2.1.x, currently maintained by Uwe
3191 \begin_layout Description
3192 Math.lyx a special manual to explain everything regarding math in all detail.
3193 Math.lyx is up to date for \SpecialChar LyX
3194 2.1.x, currently maintained by Uwe Stöhr.
3197 \begin_layout Description
3198 Additional.lyx this manual covers information that would be too much detail
3199 for the UserGuide or would make the UserGuide uncompilable or only compilable
3200 when installing a lot of special \SpecialChar LaTeX
3202 What should be in the UserGuide or better in Additional is a matter of
3204 it is up to you to decide that.
3205 Additional.lyx is not completely up to date for \SpecialChar LyX
3208 \begin_inset space ~
3211 8 is up to date and currently maintained by Uwe Stöhr.
3212 It certainly needs a rewrite and update.
3213 For example many info in chapter
3214 \begin_inset space ~
3217 2 and 3 are already covered by the UserGuide and/or the EmbeddedObjects
3221 \begin_layout Description
3222 Customization.lyx this manual covers information how to customize \SpecialChar LyX
3224 output formats, operating systems, languages etc.
3225 It is currently completely out of date and needs a major rewrite and update.
3226 If you do this please assure that your information are given for all OSes
3227 and \SpecialChar LaTeX
3228 distributions (meaning be as objective as possible).
3231 \begin_layout Standard
3233 \begin_inset space ~
3236 rules in editing the docs:
3239 \begin_layout Enumerate
3240 If you are not the maintainer of a doc file or a chapter/section, you MUST
3241 use change tracking so that the maintainer could review your changes
3244 \begin_layout Enumerate
3245 Respect the formatting of the document.
3246 The different files use different formatting styles.
3247 That is OK and has historic reasons nobody fully know ;-).
3248 But it is important to be consistent within one file.
3251 \begin_layout Enumerate
3252 All changes you make to a file in one language MUST also go the file in
3253 the other actively maintained languages.
3254 Normally the maintainer does this for you, if you are the maintainer, you
3255 must do this by copying or changing the changed or added text to the other
3256 files so that the translators sees the blue underlined text and know what
3257 they have to translate and what was changed.
3260 \begin_layout Enumerate
3261 You MUST assure that the document is compilable as
3262 \begin_inset Quotes eld
3266 \begin_inset Quotes erd