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 Subsection
653 Updating the file format number of bind/ui files
656 \begin_layout Standard
658 \begin_inset CommandInset ref
660 reference "enu:updatefiles"
665 \begin_inset CommandInset ref
667 reference "subsec:update_lyx_files"
672 \begin_inset Flex Code
675 \begin_layout Plain Layout
681 command, use this command:
682 \begin_inset Flex Code
685 \begin_layout Plain Layout
686 bash development/tools/updatelfuns.sh
694 \begin_layout Subsection
695 Backporting new styles to the stable version
698 \begin_layout Standard
699 Starting with the stable \SpecialChar LyX
700 2.1 branch, there is a mechanism in place to backport
701 new styles to the stable version without the need to update the file format.
702 The basic idea is that the new style definition is automatically copied
703 to the document preamble, so that it can even be used by older minor revisions
704 that did not yet include the style.
705 To backport a new style to the stable version, the following steps are
709 \begin_layout Enumerate
711 \begin_inset Flex Code
714 \begin_layout Plain Layout
720 to the style definition in the development version.
723 \begin_layout Enumerate
724 Copy the style definition to the stable version, but use
725 \begin_inset Flex Code
728 \begin_layout Plain Layout
735 If needed adjust the format to the one used by the stable version (see
736 the customization manual for details of the layout file format).
739 \begin_layout Enumerate
740 For each update of the style in a later stable version, increase the argument
742 \begin_inset Flex Code
745 \begin_layout Plain Layout
751 by one (in the stable version, the development version should not be touched).
754 \begin_layout Standard
755 For details about the
756 \begin_inset Flex Code
759 \begin_layout Plain Layout
765 flag see the customization manual.
767 \begin_inset Flex Code
770 \begin_layout Plain Layout
776 support is needed for backported styles: Since the style of the development
777 version has an infinite version number, it will always be used.
778 Furthermore, since its version number is less than one, the style will
779 not be written anymore to the document header for files saved by the new
783 \begin_layout Standard
784 \begin_inset Newpage newpage
790 \begin_layout Section
794 \begin_layout Standard
795 Automated tests are an important tool to detect bugs and regressions in
796 software development.
797 Some projects like gcc even require each bug fix to be accompanied by a
798 test case for the automatic test suite, that would detect this bug.
799 Testing interactive features automatically is of course very hard, but
800 core functionality like document import and export can be tested quite
801 easily, and some tests of this kind exist.
804 \begin_layout Subsection
808 \begin_layout Standard
809 There are attempts to set up a suite of unit tests for LyX.
812 \begin_layout Standard
813 TODO: describe what is done and what is still to do.
816 \begin_layout Subsection
820 \begin_layout Standard
821 The tex2lyx tests are located in the
822 \begin_inset Flex Code
825 \begin_layout Plain Layout
831 subfolder of the \SpecialChar LyX
832 source code distribution.
833 The actual testing is performed by the simple python script
834 \begin_inset Flex Code
837 \begin_layout Plain Layout
838 src/tex2lyx/test/runtests.py
844 Each test consists of two files:
845 \begin_inset Flex Code
848 \begin_layout Plain Layout
854 contains the \SpecialChar LaTeX
855 code that should be tested.
857 \begin_inset Flex Code
860 \begin_layout Plain Layout
866 contains the expected output of tex2lyx.
867 When a test is run, the actual produced output is compared with the stored
869 The test passes if both are identical.
870 The test machinery is also able to generate a file
871 \begin_inset Flex Code
874 \begin_layout Plain Layout
880 by exporting the produced .lyx file with \SpecialChar LyX
882 This may be useful for roundtrip comparisons.
885 \begin_layout Subsubsection
889 \begin_layout Standard
890 The tex2lyx tests can be run in several ways.
892 \begin_inset Flex Code
895 \begin_layout Plain Layout
901 subfolder of the build directory, the commands
902 \begin_inset Flex Code
905 \begin_layout Plain Layout
911 (cmake, all platforms),
912 \begin_inset Flex Code
915 \begin_layout Plain Layout
921 (cmake, when using a make based build system and not MSVC) or
922 \begin_inset Flex Code
925 \begin_layout Plain Layout
931 (autotools) will run the tex2lyx tests.
932 Alternatively, in the root of the build directory, the command
933 \begin_inset Flex Code
936 \begin_layout Plain Layout
942 runs all tests whose names match the regex
943 \begin_inset Quotes eld
947 \begin_inset Quotes erd
951 Another way to run the tex2lyx tests in the root build directory is to
952 instead use the command
953 \begin_inset Flex Code
956 \begin_layout Plain Layout
957 ctest -L '(cmplyx|roundtrip)'
962 , which runs all tests categorized with the label
963 \begin_inset Quotes eld
967 \begin_inset Quotes erd
971 \begin_inset Quotes eld
975 \begin_inset Quotes erd
979 If a test fails, the differences between the expected and actual results
980 are output in unified diff format.
983 \begin_layout Subsubsection
984 Updating test references
985 \begin_inset CommandInset label
987 name "sec:Updating-test-references"
994 \begin_layout Standard
995 In some cases a changed tex2lyx output is not a test failure, but wanted,
997 \begin_inset space \thinspace{}
1001 \begin_inset space \space{}
1004 if a tex2lyx bug was fixed, or a new feature was added.
1005 In these cases the stored references need to be updated.
1006 To do so if using autotools, call
1007 \begin_inset Flex Code
1010 \begin_layout Plain Layout
1017 \begin_inset Flex Code
1020 \begin_layout Plain Layout
1026 subdirectory of the build directory.
1027 If instead using CMake, call
1028 \begin_inset Flex Code
1031 \begin_layout Plain Layout
1032 make updatetex2lyxtests
1037 in the build directory or in the
1038 \begin_inset Flex Code
1041 \begin_layout Plain Layout
1047 subdirectory of the build directory.
1051 \begin_layout Plain Layout
1052 Note that this is a case where a make target in the build directory can
1053 affect the source directory, which might not be advisable.
1058 On Windows do the following:
1061 \begin_layout Itemize
1062 Assure that the path to the python.exe is in your system PATH variable.
1065 \begin_layout Itemize
1066 Double-click on the file
1067 \begin_inset Flex Code
1070 \begin_layout Plain Layout
1071 updatetex2lyxtests.vcxproj
1076 in the build directory or in the
1077 \begin_inset Flex Code
1080 \begin_layout Plain Layout
1086 subdirectory of your build directory.
1089 \begin_layout Itemize
1090 In the appearing MSVC program right-click on the project
1094 in the project explorer and chose
1101 \begin_layout Standard
1102 For convenience, these commands also produce re-exported roundtrip .lyx.tex
1104 Please examine the changed output carefully before committing the changed
1105 files to the repository: Since the test machinery does not do a roundtrip
1107 \begin_inset Formula $\Rightarrow$
1111 \begin_inset Formula $\Rightarrow$
1114 .tex, and does not compare the produced dvi or pdf output, it assumes that
1115 the stored .lyx reference produces correct output if processed by \SpecialChar LyX
1117 There is only one chance to detect wrong output: before committing a new
1119 Once it is committed, it is quite difficult to verify whether it is correct.
1122 \begin_layout Standard
1127 update the test references by opening them with \SpecialChar LyX
1128 or directly running lyx2lyx
1130 This would not work, since lyx2lyx and \SpecialChar LyX
1131 produce slightly different files
1132 regarding insignificant whitespace and line breaks.
1135 \begin_layout Subsubsection
1139 \begin_layout Standard
1140 In many cases tests for new features may be added to one of the existing
1141 test files, but sometimes this is not possible or not wanted.
1142 Then a new test file needs to be added:
1145 \begin_layout Enumerate
1147 \begin_inset Flex Code
1150 \begin_layout Plain Layout
1151 src/tex2lyx/test/<test name>.tex
1156 and run tex2lyx in roundtrip mode to produce the file
1157 \begin_inset Flex Code
1160 \begin_layout Plain Layout
1161 src/tex2lyx/test/<test name>.lyx.lyx
1167 This file will be the new reference.
1170 \begin_layout Enumerate
1171 Once you confirmed that the tex2lyx output is correct, add the new files
1172 to the corresponding lists in
1173 \begin_inset Flex Code
1176 \begin_layout Plain Layout
1177 src/tex2lyx/test/runtests.py
1183 \begin_inset Flex Code
1186 \begin_layout Plain Layout
1187 src/tex2lyx/Makefile.am
1193 \begin_inset Flex Code
1196 \begin_layout Plain Layout
1197 src/tex2lyx/test/CMakeLists.txt
1205 \begin_layout Enumerate
1206 Commit the changes to the repository, or send a patch to the development
1207 list and ask for committing if you do not have commit rights.
1210 \begin_layout Subsection
1211 automatic LyX tests (cmake only)
1214 \begin_layout Standard
1215 Some tests are located in the
1216 \begin_inset Flex Code
1219 \begin_layout Plain Layout
1220 development/autotests
1225 subfolder of the \SpecialChar LyX
1226 source code distribution.
1228 \begin_inset Flex Code
1231 \begin_layout Plain Layout
1237 is required to run the automatic \SpecialChar LyX
1238 tests, running them is not implemented
1243 \begin_layout Standard
1244 The \SpecialChar LyX
1245 tests can be run by the commands
1246 \begin_inset Flex Code
1249 \begin_layout Plain Layout
1256 \begin_inset Flex Code
1259 \begin_layout Plain Layout
1265 (when using a make based build system and not MSVC) in the
1266 \begin_inset Flex Code
1269 \begin_layout Plain Layout
1275 subfolder of the build directory.
1278 \begin_layout Subsubsection
1282 \begin_layout Standard
1283 The export tests are integration tests.
1284 They take longer to run and are more likely to break than the tex2lyx tests.
1285 Nevertheless, they have caught many regressions and without a better alternativ
1286 e it is important to keep them up-to-date and understand how they work.
1289 \begin_layout Standard
1290 The export tests require the
1291 \begin_inset Flex Code
1294 \begin_layout Plain Layout
1300 command that comes with the
1301 \begin_inset Flex Code
1304 \begin_layout Plain Layout
1313 \begin_layout Paragraph
1314 Expectations of LyX developers
1317 \begin_layout Standard
1318 Because the export tests are integration tests and take a long time to run,
1319 LyX developers are rarely expected to run all of the tests.
1320 Here are some good practices to follow by developers:
1323 \begin_layout Itemize
1324 When making a non-trivial change to a .layout file, run the export and layout
1325 tests corresponding with that .layout file.
1328 \begin_layout Itemize
1329 When making non-trivial changes to a .lyx file, run the export tests correspondin
1330 g to that .lyx file.
1333 \begin_layout Itemize
1334 When making non-trivial changes to LyX's \SpecialChar LaTeX
1336 touching the encoding code or package handling code that you expect will
1337 change the exported \SpecialChar LaTeX
1338 in some way), consider running all of the export tests
1339 before and after your change.
1340 If there are differences, please reconcile these (i.e.
1341 fix the bug or fix the tests)
1346 Ask for help if you're not sure what to do or if you do not want to run
1347 the tests, post the patch on the list and others will run the tests.
1350 \begin_layout Itemize
1351 Understand how to interpret test failures.
1352 If your commit is found to have broken a test, you should be able to interpret
1353 the test results when made aware of them.
1355 \begin_inset CommandInset ref
1357 reference "subsec:Interpreting-export-tests"
1364 \begin_layout Paragraph
1365 Configuring the tests
1368 \begin_layout Standard
1369 To enable these tests, add the
1370 \begin_inset Flex Code
1373 \begin_layout Plain Layout
1374 -DLYX_ENABLE_EXPORT_TESTS=ON
1383 \begin_layout Standard
1384 \begin_inset Flex Code
1387 \begin_layout Plain Layout
1388 cmake -DLYX_ENABLE_EXPORT_TESTS=ON /path/to/source
1396 \begin_layout Standard
1398 This flag will increase the time for the cmake command by several seconds,
1399 mainly because of the process of inverting tests (see Section
1400 \begin_inset CommandInset ref
1402 reference "subsec:Interpreting-export-tests"
1409 \begin_layout Paragraph
1413 \begin_layout Standard
1414 To run all tests, in the build directory simply run the command
1415 \begin_inset Flex Code
1418 \begin_layout Plain Layout
1425 To run only some of the tests, use the command
1426 \begin_inset Flex Code
1429 \begin_layout Plain Layout
1436 \begin_inset Flex Code
1439 \begin_layout Plain Layout
1445 is a regular expression that matches test names.
1446 To run only the export tests, you can use
1447 \begin_inset Flex Code
1450 \begin_layout Plain Layout
1457 For the list of test categories available in addition to
1458 \begin_inset Quotes eld
1462 \begin_inset Quotes erd
1466 \begin_inset Flex Code
1469 \begin_layout Plain Layout
1470 ctest \SpecialChar nobreakdash
1471 \SpecialChar nobreakdash
1478 It is often useful to list the tests without running them (e.g.
1479 if you want to know how many tests there are or whether your
1480 \begin_inset Flex Code
1483 \begin_layout Plain Layout
1489 regular expression did what you expected).
1490 This can be done with the
1491 \begin_inset Flex Code
1494 \begin_layout Plain Layout
1501 \begin_inset Flex Code
1504 \begin_layout Plain Layout
1505 \SpecialChar nobreakdash
1506 \SpecialChar nobreakdash
1513 We are still working on getting the tests to run in parallel which is supported
1515 \begin_inset Flex Code
1518 \begin_layout Plain Layout
1525 \begin_inset Flex Code
1528 \begin_layout Plain Layout
1535 \begin_inset Flex Code
1538 \begin_layout Plain Layout
1539 \SpecialChar nobreakdash
1540 \SpecialChar nobreakdash
1547 However, when running the tests in parallel, sometimes tests fail that
1548 pass when run sequentially.
1549 A reasonable approach is to first run the tests in parallel and then run
1550 the failed tests sequentially.
1551 For example, to run 8 jobs at a time:
1554 \begin_layout Standard
1555 \begin_inset Flex Code
1558 \begin_layout Plain Layout
1567 \begin_layout Standard
1568 \begin_inset Flex Code
1571 \begin_layout Plain Layout
1572 ctest \SpecialChar nobreakdash
1573 \SpecialChar nobreakdash
1582 \begin_layout Standard
1584 Note that some tests cannot be run in parallel.
1585 These tests are marked in the code with the
1586 \begin_inset Flex Code
1589 \begin_layout Plain Layout
1599 \begin_layout Standard
1600 In some situations the option
1601 \begin_inset Flex Code
1604 \begin_layout Plain Layout
1605 \SpecialChar nobreakdash
1606 \SpecialChar nobreakdash
1613 There have been bugs in LyX and in \SpecialChar LaTeX
1614 which cause compilation to hang, and
1615 without a timeout a test might never stop (in one case there was even a
1617 If a test times out, the
1618 \begin_inset Flex Code
1621 \begin_layout Plain Layout
1627 command exits with error, but you can distinguish between a timed out test
1628 and a failed test in the output reported at the end of the
1629 \begin_inset Flex Code
1632 \begin_layout Plain Layout
1641 \begin_layout Standard
1643 \begin_inset Flex Code
1646 \begin_layout Plain Layout
1652 ) the full list of command line options.
1655 \begin_layout Paragraph
1656 \begin_inset CommandInset label
1658 name "subsec:Interpreting-export-tests"
1662 Interpreting the export test results
1665 \begin_layout Standard
1666 A test can fail for several reasons, not all of them bad.
1669 \begin_layout Enumerate
1670 The .lyx file could have been added recently and some formats are not expected
1674 \begin_layout Enumerate
1675 A dependency is not met (e.g.
1676 the \SpecialChar LaTeX
1678 One hint that this is the case is that the corresponding
1679 \begin_inset Flex Code
1682 \begin_layout Plain Layout
1688 test will likely also fail.
1691 \begin_layout Enumerate
1692 An inverted test fails to fail (i.e.
1693 export that previously failed now works).
1696 \begin_layout Enumerate
1697 An external dependency was updated (e.g.
1702 \begin_layout Enumerate
1703 A recent code change introduced a bug.
1706 \begin_layout Enumerate
1707 \begin_inset CommandInset label
1713 A change in a document exposed a previously unknown bug or an incompatibility
1714 with an export format (e.g.
1715 Lua\SpecialChar LaTeX
1719 \begin_layout Standard
1720 Because the .lyx files are exported in several formats, it is not surprising
1721 that many of the exports fail.
1722 This expectation of failure is addressed by
1723 \begin_inset Quotes eld
1727 \begin_inset Quotes erd
1730 the tests, that is, by marking the test as
1731 \begin_inset Quotes eld
1735 \begin_inset Quotes erd
1738 if the export exits with error and as
1739 \begin_inset Quotes eld
1743 \begin_inset Quotes erd
1746 if the export succeeds
1751 It follows that these expected failures will not show up as failed tests
1752 in the test results and thus will not pollute the
1753 \begin_inset Quotes eld
1757 \begin_inset Quotes erd
1761 If the export actually succeeds, then the test will fail.
1762 The purpose of this failure is to get your attention—something has changed,
1763 possibly for the better.
1766 \begin_layout Standard
1767 We try to document why a test is inverted or ignored.
1768 See the comment (prefixed with
1769 \begin_inset Flex Code
1772 \begin_layout Plain Layout
1778 ) above the block in which the test is listed as inverted or ignored in
1780 \begin_inset Flex Code
1783 \begin_layout Plain Layout
1784 development/autotests/suspiciousTests
1790 \begin_inset Flex Code
1793 \begin_layout Plain Layout
1794 development/autotests/ignoredTests
1800 It is possible that an export goes from succeeding to failing just because
1801 the document was changed and the document was never expected to work with
1802 a certain export format in the first case.
1803 Once this is confirmed to be the situation, the test can be inverted.
1806 \begin_layout Standard
1807 A good question is why do we enable the tests for non-default formats? The
1808 answer is that if a non-default route is broken it is often because a bug
1809 was introduced in LyX and not because a document-specific change was made
1810 that is not supported by the route.
1811 In other words, there is a high signal/noise ratio in the export tests
1812 for some non-default formats.
1816 \begin_layout Standard
1817 What action should you take if a test fails? First, check manually that
1818 when the compilation succeeded before the resulting PDF was good.
1819 In fact, sometimes it is an improvement when a test fails.
1820 If you check manually, it might be the case that the export was succeeding
1821 before but showing garbled text in a PDF output.
1822 Now it might fail with a clear message of "language xyz not supported".
1823 It is always good to check manually why something fails and if it passes
1824 if the PDF output is good.
1827 \begin_layout Standard
1828 Sometimes a test is fixed as side-effect of some change.
1829 We should uninvert a test (remove it from the
1830 \begin_inset Flex Code
1833 \begin_layout Plain Layout
1839 file) in order to preserve the fix.
1842 \begin_layout Standard
1843 When a test or several tests fail, consider checking the files in the
1844 \begin_inset Flex Code
1847 \begin_layout Plain Layout
1853 subdirectory of your build directory.
1854 In this subdirectory are three files: the file
1855 \begin_inset Flex Code
1858 \begin_layout Plain Layout
1864 simply lists the tests that failed on your last
1865 \begin_inset Flex Code
1868 \begin_layout Plain Layout
1875 \begin_inset Flex Code
1878 \begin_layout Plain Layout
1884 file contains the output from the tests (and often has details explaining
1885 why a test failed); and the
1886 \begin_inset Flex Code
1889 \begin_layout Plain Layout
1895 file lists the times that it took to run the tests.
1898 \begin_layout Paragraph
1902 \begin_layout Standard
1903 These tests are expected to always fail.
1906 \begin_layout Description
1907 inverted These tests are expected to fail, but are subject to be examined.
1908 It is expected that they will pass in a foreseeable future.
1909 They are labeled 'inverted'.
1912 \begin_layout Description
1913 suspended Some inverted tests are labeled 'suspended'.
1914 This means, they are not executed using
1915 \begin_inset Flex Code
1918 \begin_layout Plain Layout
1925 \begin_inset Flex Code
1928 \begin_layout Plain Layout
1935 From time to time they still have to be checked using
1936 \begin_inset Flex Code
1939 \begin_layout Plain Layout
1949 \begin_layout Standard
1950 These tests are suspended, because they fail for known reasons which cannot
1952 But it is expected the reason might disappear in the future.
1953 Be it new TL or better handling in \SpecialChar LyX
1957 \begin_layout Standard
1958 For ctest commands without the
1959 \begin_inset Flex Code
1962 \begin_layout Plain Layout
1968 parameter nothing changes.
1969 Suspended or not, tests will be executed depending only on the regexes
1970 parameters given to the ctest command.
1974 \begin_layout Paragraph
1978 \begin_layout Description
1979 nonstandard Requires non-standard ressources (\SpecialChar LaTeX
1980 packages and document classes,
1981 fonts, ...) that are not a requirement for running this test suite.
1985 \begin_layout Standard
1986 These tests are labeled as
1992 \begin_layout Description
1994 \begin_inset Quotes eld
1998 \begin_inset Quotes erd
2001 result, depending on local configuration, OS, \SpecialChar TeX
2002 distribution, package versions,
2003 or the phase of the moon.
2007 \begin_layout Standard
2008 These tests are labeled as
2014 \begin_layout Paragraph
2015 Export test filtering
2018 \begin_layout Standard
2019 There are files which control the assignment of a label to a test.
2022 \begin_layout Description
2023 ignoredTests (smal file)
2024 \begin_inset Newline newline
2027 Tests selected here are withdrawn
2031 \begin_layout Labeling
2032 \labelwidthstring 00.00.0000
2033 Input Test of any export combination
2036 \begin_layout Labeling
2037 \labelwidthstring 00.00.0000
2038 Output Stop if tests not selected here
2042 \begin_layout Description
2043 unreliableTests: Tests selected either pass or fail, but that is dependent
2044 on the system where the test is run.
2045 Selected tests gain the label 'unreliable'.
2049 \begin_layout Labeling
2050 \labelwidthstring 00.00.0000
2051 Input Each test which passed 'ignoredTests'
2054 \begin_layout Labeling
2055 \labelwidthstring 00.00.0000
2056 Output Stop if test selected, gain label 'unreliable'.
2060 \begin_layout Description
2062 \begin_inset space \space{}
2069 \begin_layout Labeling
2070 \labelwidthstring 00.00.0000
2071 Input Each test which passed 'unreliableTests'
2074 \begin_layout Labeling
2075 \labelwidthstring 00.00.0000
2076 Output Stop if not selected.
2079 \begin_layout Standard
2080 The following file is meant as subselections of 'suspiciousTests'.
2081 If neither subselection applies, test gains labels 'export' and 'inverted'
2084 \begin_layout Description
2085 suspendedTests Tests selected here gain the label 'suspended' but _not_
2086 'export' or 'inverted', although in ctest they remain inverted.
2087 ('ctest' knows only 'inverted' or not, labels are used only for test selection)
2091 \begin_layout Labeling
2092 \labelwidthstring 00.00.0000
2093 Input Each test selected by 'suspiciousTests'
2096 \begin_layout Labeling
2097 \labelwidthstring 00.00.0000
2098 Output Selected test gains label 'suspended'.
2104 \begin_layout Standard
2105 The following table may clarify label assignement
2108 \begin_layout Standard
2109 \begin_inset Tabular
2110 <lyxtabular version="3" rows="7" columns="12">
2111 <features tabularvalignment="middle">
2112 <column alignment="left" valignment="top" width="0pt">
2113 <column alignment="left" valignment="top" width="0pt">
2114 <column alignment="left" valignment="top" width="0pt">
2115 <column alignment="left" valignment="top" width="0pt">
2116 <column alignment="center" valignment="top">
2117 <column alignment="center" valignment="top">
2118 <column alignment="center" valignment="top">
2119 <column alignment="center" valignment="top">
2120 <column alignment="center" valignment="top">
2121 <column alignment="center" valignment="top">
2122 <column alignment="center" valignment="top">
2123 <column alignment="center" valignment="top">
2125 <cell multicolumn="1" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2128 \begin_layout Plain Layout
2134 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2137 \begin_layout Plain Layout
2143 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2146 \begin_layout Plain Layout
2152 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2155 \begin_layout Plain Layout
2161 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2164 \begin_layout Plain Layout
2165 Marked in ctest, Assigned label
2170 <cell multicolumn="2" alignment="center" valignment="top" usebox="none">
2173 \begin_layout Plain Layout
2179 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2182 \begin_layout Plain Layout
2188 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2191 \begin_layout Plain Layout
2197 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2200 \begin_layout Plain Layout
2206 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2209 \begin_layout Plain Layout
2215 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2218 \begin_layout Plain Layout
2224 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2227 \begin_layout Plain Layout
2235 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2238 \begin_layout Plain Layout
2244 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2247 \begin_layout Plain Layout
2253 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2256 \begin_layout Plain Layout
2262 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2265 \begin_layout Plain Layout
2271 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2274 \begin_layout Plain Layout
2280 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
2283 \begin_layout Plain Layout
2289 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2292 \begin_layout Plain Layout
2298 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
2301 \begin_layout Plain Layout
2307 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2310 \begin_layout Plain Layout
2316 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
2319 \begin_layout Plain Layout
2325 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2328 \begin_layout Plain Layout
2334 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2337 \begin_layout Plain Layout
2345 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2348 \begin_layout Plain Layout
2354 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2357 \begin_layout Plain Layout
2363 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2366 \begin_layout Plain Layout
2372 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2375 \begin_layout Plain Layout
2381 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2384 \begin_layout Plain Layout
2390 <cell alignment="center" valignment="top" topline="true" usebox="none">
2393 \begin_layout Plain Layout
2399 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2402 \begin_layout Plain Layout
2408 <cell alignment="center" valignment="top" topline="true" usebox="none">
2411 \begin_layout Plain Layout
2417 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2420 \begin_layout Plain Layout
2426 <cell alignment="center" valignment="top" topline="true" usebox="none">
2429 \begin_layout Plain Layout
2435 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2438 \begin_layout Plain Layout
2444 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2447 \begin_layout Plain Layout
2455 <cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2458 \begin_layout Plain Layout
2464 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2467 \begin_layout Plain Layout
2473 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2476 \begin_layout Plain Layout
2482 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2485 \begin_layout Plain Layout
2491 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2494 \begin_layout Plain Layout
2500 <cell alignment="center" valignment="top" topline="true" usebox="none">
2503 \begin_layout Plain Layout
2509 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2512 \begin_layout Plain Layout
2518 <cell alignment="center" valignment="top" topline="true" usebox="none">
2521 \begin_layout Plain Layout
2527 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2530 \begin_layout Plain Layout
2536 <cell alignment="center" valignment="top" topline="true" usebox="none">
2539 \begin_layout Plain Layout
2545 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2548 \begin_layout Plain Layout
2554 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2557 \begin_layout Plain Layout
2565 <cell multirow="4" alignment="left" valignment="middle" topline="true" leftline="true" usebox="none">
2568 \begin_layout Plain Layout
2574 <cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2577 \begin_layout Plain Layout
2583 <cell multirow="3" alignment="left" valignment="middle" topline="true" bottomline="true" leftline="true" usebox="none">
2586 \begin_layout Plain Layout
2592 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2595 \begin_layout Plain Layout
2601 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2604 \begin_layout Plain Layout
2610 <cell alignment="center" valignment="top" topline="true" usebox="none">
2613 \begin_layout Plain Layout
2619 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2622 \begin_layout Plain Layout
2628 <cell alignment="center" valignment="top" topline="true" usebox="none">
2631 \begin_layout Plain Layout
2637 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2640 \begin_layout Plain Layout
2646 <cell alignment="center" valignment="top" topline="true" usebox="none">
2649 \begin_layout Plain Layout
2655 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2658 \begin_layout Plain Layout
2664 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2667 \begin_layout Plain Layout
2675 <cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2678 \begin_layout Plain Layout
2684 <cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2687 \begin_layout Plain Layout
2693 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2696 \begin_layout Plain Layout
2702 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2705 \begin_layout Plain Layout
2711 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2714 \begin_layout Plain Layout
2720 <cell alignment="center" valignment="top" topline="true" usebox="none">
2723 \begin_layout Plain Layout
2729 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2732 \begin_layout Plain Layout
2738 <cell alignment="center" valignment="top" topline="true" usebox="none">
2741 \begin_layout Plain Layout
2747 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2750 \begin_layout Plain Layout
2756 <cell alignment="center" valignment="top" topline="true" usebox="none">
2759 \begin_layout Plain Layout
2765 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2768 \begin_layout Plain Layout
2774 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2777 \begin_layout Plain Layout
2785 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2788 \begin_layout Plain Layout
2794 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2797 \begin_layout Plain Layout
2803 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2806 \begin_layout Plain Layout
2812 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2815 \begin_layout Plain Layout
2821 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2824 \begin_layout Plain Layout
2830 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
2833 \begin_layout Plain Layout
2839 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2842 \begin_layout Plain Layout
2848 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
2851 \begin_layout Plain Layout
2857 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2860 \begin_layout Plain Layout
2866 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
2869 \begin_layout Plain Layout
2875 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2878 \begin_layout Plain Layout
2884 <cell alignment="center" valignment="top" topline="true" bottomline="true" rightline="true" usebox="none">
2887 \begin_layout Plain Layout
2901 \begin_layout Subsubsection
2905 \begin_layout Standard
2906 These tests check whether a .lyx file loads without any terminal messages.
2907 They correspond to the manual operations of simply opening a .lyx file on
2908 the terminal, exiting LyX once the file is loaded, and then checking whether
2909 there is any output from the terminal.
2910 These tests are useful for catching malformed .lyx files and parsing bugs.
2911 They can also be used to find a .lyx file in which an instance of something
2913 To do this, compile LyX with a local patch that outputs something to the
2914 terminal when an instance is found, and then run the check_load tests to
2915 see if any fail, which would mean that the situation occurs in the LyX
2916 documentation files corresponding to the failed tests.
2917 These tests are expectedly fragile: any LyX diagnostic message, which is
2918 not necessarily an error, would cause the tests to fail.
2919 Similarly, any message output by a library (e.g.
2920 Qt) would also cause failure.
2921 There are some messages that the check_load tests are instructed to ignore,
2922 which are stored in the file
2923 \begin_inset Flex Code
2926 \begin_layout Plain Layout
2927 development/autotests/filterCheckWarnings
2935 \begin_layout Standard
2936 Under cmake, the tests are labeled as 'load'.
2939 \begin_layout Subsubsection
2943 \begin_layout Standard
2944 The URL tests are enabled with the
2945 \begin_inset Flex Code
2948 \begin_layout Plain Layout
2949 -DLYX_ENABLE_URLTESTS=ON
2954 CMake flag and are useful for finding broken links in our documentation
2956 If a URL test fails, to see which link in particular was reported as broken,
2958 \begin_inset Flex Code
2961 \begin_layout Plain Layout
2968 These tests are extremely fragile (e.g.
2969 a test can depend on your Internet connection) and a failed URL test should
2970 not be taken too seriously.
2971 URL tests are labeled as
2976 \begin_layout Paragraph
2980 \begin_layout Standard
2981 cmake is required to run the \SpecialChar LyX
2982 tests, running them is not implemented for
2986 \begin_layout Standard
2987 The appropriate commands are:
2990 \begin_layout Itemize
2996 \begin_inset Newline newline
2999 runns all tests with label
3004 \begin_layout Itemize
3007 ctest -R 'check_.*urls'
3010 \begin_inset Newline newline
3013 runns the tests 'check_accessible_urls'
3016 \begin_layout Standard
3017 Associated test results can be examined in ctest-log directory in files
3018 of the form 'LastFailed.*URLS.log'
3021 \begin_layout Subsubsection
3025 \begin_layout Standard
3026 ctest label commands:
3029 \begin_layout Description
3030 \SpecialChar nobreakdash
3031 \SpecialChar nobreakdash
3032 print-labels shows all assigned labels
3035 \begin_layout Description
3036 \SpecialChar nobreakdash
3038 \begin_inset space ~
3041 labelname executes all tests to which this label is assigned to.
3042 A test may have more that one label.
3045 \begin_layout Description
3046 \SpecialChar nobreakdash
3048 \begin_inset space ~
3051 number executes tests in parallel using 'number' simultaneously processes.
3052 Some tests are marked as 'sequencial', for them this parameter has no effect.
3055 \begin_layout Section
3056 Development policies
3059 \begin_layout Standard
3060 This chapter lists some guidelines that should be followed.
3061 This list is not complete, and many guidelines are in separate chapters,
3063 \begin_inset Quotes eld
3066 When is an update of the .lyx file format number needed?
3067 \begin_inset Quotes erd
3071 \begin_inset CommandInset ref
3073 reference "sec:When-is-an"
3080 \begin_layout Subsection
3081 When to set a fixed milestone?
3084 \begin_layout Standard
3085 Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following
3089 \begin_layout Enumerate
3090 Somebody is actively working on a fix.
3093 \begin_layout Enumerate
3094 The bug is so severe that it would block the release if it is not fixed.
3097 \begin_layout Standard
3098 If a bug is important, but nobody is working on it, and it is no showstopper,
3099 use a milestone like 2.1.x or 2.2.x.
3100 For all other bugs, do not set a milestone at all.
3103 \begin_layout Subsection
3104 Can we add rc entries in stable branch?
3107 \begin_layout Standard
3109 We are supposed to increase the prefs2prefs version number with such things.
3112 \begin_layout Section
3113 Documentation policies
3116 \begin_layout Standard
3117 The main documentation consists of these files:
3120 \begin_layout Description
3121 splash.lyx it is the first file you see after an installation.
3122 We assume that a new user sees this.
3123 It is therefore designed to be as simple as possible.
3124 Therefore please don't add any new formatting, only fix typos etc.
3125 Splash.lyx is up to date for \SpecialChar LyX
3126 2.1.x, currently maintained by Uwe Stöhr.
3129 \begin_layout Description
3130 Intro.lyx This is the manual new users will read to learn \SpecialChar LyX
3132 It therefore uses a limited set of formatting.
3133 For example a standard document class.
3134 Since new users will first learn about the formatting possibilities of
3136 please keep this file that simple.
3137 Intro.lyx is up to date for \SpecialChar LyX
3138 2.1.x, currently maintained by Uwe Stöhr.
3141 \begin_layout Description
3142 Tutorial.lyx our tutorial.
3143 It must be always up to date.
3144 Normally there is nothing to add since we don't want to overwhelm new users
3145 with too much details.
3146 The will learn these details while using \SpecialChar LyX
3147 and we have special manuals.
3148 Tutorial.lyx is up to date for \SpecialChar LyX
3149 2.1.x, currently maintained by Uwe Stöhr.
3152 \begin_layout Description
3153 UserGuide.lyx our main user guide.
3154 It covers a mixture of basic and detailed information.
3155 Some information is also in the Math and EmbeddedObjects manual so that
3156 the UserGuide refers to these files.
3157 UserGuide.lyx is up to date for \SpecialChar LyX
3158 2.1.x, currently maintained by Uwe Stöhr.
3161 \begin_layout Description
3162 EmbeddedObjects.lyx a special manual to explain things like tables floats
3165 EmbeddedObjects.lyx is up to date for \SpecialChar LyX
3166 2.1.x, currently maintained by Uwe
3170 \begin_layout Description
3171 Math.lyx a special manual to explain everything regarding math in all detail.
3172 Math.lyx is up to date for \SpecialChar LyX
3173 2.1.x, currently maintained by Uwe Stöhr.
3176 \begin_layout Description
3177 Additional.lyx this manual covers information that would be too much detail
3178 for the UserGuide or would make the UserGuide uncompilable or only compilable
3179 when installing a lot of special \SpecialChar LaTeX
3181 What should be in the UserGuide or better in Additional is a matter of
3183 it is up to you to decide that.
3184 Additional.lyx is not completely up to date for \SpecialChar LyX
3187 \begin_inset space ~
3190 8 is up to date and currently maintained by Uwe Stöhr.
3191 It certainly needs a rewrite and update.
3192 For example many info in chapter
3193 \begin_inset space ~
3196 2 and 3 are already covered by the UserGuide and/or the EmbeddedObjects
3200 \begin_layout Description
3201 Customization.lyx this manual covers information how to customize \SpecialChar LyX
3203 output formats, operating systems, languages etc.
3204 It is currently completely out of date and needs a major rewrite and update.
3205 If you do this please assure that your information are given for all OSes
3206 and \SpecialChar LaTeX
3207 distributions (meaning be as objective as possible).
3210 \begin_layout Standard
3212 \begin_inset space ~
3215 rules in editing the docs:
3218 \begin_layout Enumerate
3219 If you are not the maintainer of a doc file or a chapter/section, you MUST
3220 use change tracking so that the maintainer could review your changes
3223 \begin_layout Enumerate
3224 Respect the formatting of the document.
3225 The different files use different formatting styles.
3226 That is OK and has historic reasons nobody fully know ;-).
3227 But it is important to be consistent within one file.
3230 \begin_layout Enumerate
3231 All changes you make to a file in one language MUST also go the file in
3232 the other actively maintained languages.
3233 Normally the maintainer does this for you, if you are the maintainer, you
3234 must do this by copying or changing the changed or added text to the other
3235 files so that the translators sees the blue underlined text and know what
3236 they have to translate and what was changed.
3239 \begin_layout Enumerate
3240 You MUST assure that the document is compilable as
3241 \begin_inset Quotes eld
3245 \begin_inset Quotes erd