Commit Graph

93 Commits

Author SHA1 Message Date
Scott Kostyshak
5b2fb80491 Add description of lyx21 tests
These tests were added at e3cd6db4.
2015-12-26 23:51:13 -05:00
Kornel Benko
6b58b511cd Typo 2015-12-19 16:49:51 +01:00
Günter Milde
bdc50829cb minor autotest documentation update 2015-12-18 17:38:27 +01:00
Günter Milde
0529b40cc9 Set default output format for manuals to PDF (pdflatex).
Pdflatex is the recommended export tool for the manuals.
Pdflatex brings the best results for hyperlinking.
Some features (e.g. rotated text) are not available in DVI or PS (dvips).

This does not affect export from command line or autotests
(where this setting is ignored and the format must aways be given explicitely).
2015-12-10 10:40:50 +01:00
Günter Milde
d42bd06594 Structure export autotest documentation. 2015-12-09 09:54:25 +01:00
Richard Heck
07992c9955 Fix typo. 2015-12-08 10:41:22 -05:00
Scott Kostyshak
1405f9efb1 Explain why we do not update the local layout
We do not update the local layout of our .lyx files because users
would then not be able to export to older formats. For example, if a
2.2.0 user exported a template to 2.1.x format and tried to open the
file in LyX 2.1.x, there would be an error because the file would
contain a local layout whose format is too new. The root reason for
this is that we do not convert layouts to older layout formats.
2015-12-08 01:39:17 -05:00
Günter Milde
6df72ef648 ctest export test documentation update 2015-12-07 17:56:43 +01:00
Günter Milde
f35861bd75 ctest automatic tests: small correcions to pattern files and documenation. 2015-12-06 21:21:46 +01:00
Kornel Benko
d515544bb4 Development.lyx: Reflect recent label renaming of 'reverted' to 'inverted' 2015-12-04 21:56:31 +01:00
Kornel Benko
5696c38e93 Development.lyx: Spellchecker + special char corrections. 2015-12-02 13:55:38 +01:00
Kornel Benko
d879599cec Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result. 2015-12-02 11:02:17 +01:00
Günter Milde
6a498e5804 Restructure test documentation.
Use separate subsections for our 3 main test suites: 
unit tests, 
tex2lyx (functional) tests, and 
"autotests" (requiring cmake).
2015-12-02 08:54:24 +01:00
Kornel Benko
42536a5616 Add a table to clarify how main export test labels are assigned 2015-11-30 13:06:53 +01:00
Richard Heck
badaa2d1b2 Remove local layout from Additional.lyx and Development.lyx. It
was not actually  used in the latter. In the former, convert the
MenuItem insets to Noun.
2015-11-29 22:29:28 -05:00
Scott Kostyshak
299d7d70f0 Minor tweaks to Development.lyx
These small tweaks amend de1c8253.
2015-11-28 21:17:15 -05:00
Kornel Benko
de1c82531a Development.lyx: try to describe label assignment. 2015-11-29 02:37:11 +01:00
Scott Kostyshak
0ee4dff450 Document updating file format of LyX's files
The advantage of having the author of the file format change update
the files is that the author knows best what to expect in the diff
output.

This was discussed briefly here:
https://www.mail-archive.com/search?l=mid&q=n3bu5q%24reb%242%40ger.gmane.org
2015-11-28 18:12:26 -05:00
Günter Milde
960393b7a0 Small fixes to export test documentation. 2015-11-27 10:34:26 +01:00
Scott Kostyshak
2f4233721d Update docs to latest format for 2.2.0alpha2 2015-11-27 03:23:22 -05:00
Kornel Benko
1f9640e71f Describe some ctest extras. 2015-11-25 10:19:49 +01:00
Scott Kostyshak
f6bcf2a29e Document step to update LyX.py when update format 2015-11-23 22:16:00 -05:00
Georg Baum
385aed9721 Fix \origin lines
These were fixed manually. I tried to add an option to updatedocs.py to
open and save a file with LyX, but that did not work, since
lyx -x 'command-sequence buffer-write ; lyx-quit' does not write and does
not quit.
2015-11-11 22:25:18 +01:00
Uwe Stöhr
62edbec2aa Development.lyx: remove unused preamble code and modules 2015-11-10 00:39:54 +01:00
Kornel Benko
58050bc3ae Update Development.lyx to include 'suspended' cmake tests. 2015-11-04 13:06:14 +01:00
Uwe Stöhr
c0b815bf62 Development.lyx: describe how to update the tex2lyx references on Windows 2015-11-04 01:15:52 +01:00
Scott Kostyshak
13e1c13d2a Document various ways to run the tex2lyx tests
Each way might be preferred by a different developer and the more
ways that can be described of running the tests, the higher the
chance is that developers will find a way that works well for them.
2015-10-31 00:30:34 -04:00
Scott Kostyshak
1a4d5b3ce9 Document why tests are enabled for all formats
Explain why the export tests are enabled for formats that are not
expected to work well with certain document classes, modules, or
packages. The reason is that if a .lyx file goes from compiling
successfully for one format (even if that format is not officially
supported for the combination of features used), if that document
suddenly fails to compile, there is a significant chance that a bug
was introduced in LyX. In other words, there is a high signal/noise
ratio. If it is determined that a test is failing because an
expected incompatibility is exposed, then the test can be inverted.
2015-10-29 22:48:28 -04:00
Scott Kostyshak
231609743f More updates for the documentation on tests
- general cleanup
- add some more useful commands
- specify how to configure the URL tests

Thanks to Kornel for the helpful suggestions.
2015-10-29 22:11:11 -04:00
Georg Baum
a07cd69905 Document how to run tests on windows 2015-10-29 22:20:37 +01:00
Scott Kostyshak
74059f6b56 Document the export tests and other tests
The export tests, check_load tests, and URL tests are now documented
in the Development.lyx file. The export tests are described in
detail, such as how to run them and how to interpret the results.
2015-10-29 02:26:50 -04:00
Scott Kostyshak
9bb4787d56 Update format 2015-10-28 18:10:09 -04:00
Georg Baum
dcddfaa491 Add suggestion for test cases by Günter 2015-10-22 22:22:01 +02:00
Scott Kostyshak
7c0232e874 Document updating tex2lyx tests when using CMake
Since Kornel's commit at e2d41970, it is now possible to update the
tex2lyx tests with CMake. Note that this is a case where a make
target in the build directory can affect the source directory, which
might not be advisable.
2015-05-21 00:23:38 -04:00
Georg Baum
e56a24dfcc Add note about updating tex2lyx tests 2015-05-15 21:20:28 +02:00
Uwe Stöhr
6f04bfaf96 Development.lyx: add a documentation policy as requested by Scott 2015-02-17 00:12:02 +01:00
Scott Kostyshak
74b538f75d Add a "Development policies" section to dev manual
Writing these policies down makes it easier for newcommers to
understand guidelines and the intuition behind them.

The two policies this commit adds were responses by Georg and Richard
to two threads on the mailing list. The policies are titled
"When to set a fixed milestone" and
"Can we add rc entries in stable branch?".
2015-02-08 16:33:43 -05:00
Scott Kostyshak
460976eea8 Typo 2015-02-08 16:18:56 -05:00
Enrico Forestieri
3eefb8cfa6 Update documented command for running tex2lyx tests. 2014-05-12 23:54:50 +02:00
Georg Baum
9e5ecdcdce Update version 2014-05-12 21:53:27 +02:00
Uwe Stöhr
683a4d20bd Development.lyx: some format fixes
- fix line breaks and a some  microtypography tuning
2013-05-30 23:20:09 +02:00
Georg Baum
7bdc34a987 Implement forced local layouts
These should be used if any new style needs to be introduced in the stable
2.1 series: If the ForceLocal flag of the style is set, it will always be
written to the document header, so that even older 2.1 versions can read
and correctly output the document.
2013-05-15 07:19:49 +02:00
Georg Baum
1fde43b690 Add development manual.
This is rather incomplete, and will hopefully be extended in the future.
Currently, its main purpose is to document file format updates and tests.
2013-02-16 17:48:43 +01:00