Commit Graph

58 Commits

Author SHA1 Message Date
Scott Kostyshak
ce071eec92 Update docs to 2.2.0beta1 format 2016-02-09 21:38:47 -05:00
Günter Milde
fa75f57603 ctest export tests: document requirements.
Add suggestion for policy for "reuse" of documentation files.
2016-02-01 23:56:37 +01:00
Scott Kostyshak
d5694318ef Document need to use same subset if --rerun-failed
When running the tests with ctest, --rerun-failed can be used to run
the tests that failed on the previous run. However, the same subset
must be specified because it is the test numbers that are used to
index which tests failed on the previous run. For example, it would
be incorrect to do the following:

  ctest -R export
  ctest --rerun-failed

The following is correct:

  ctest -R export
  ctest -R export --rerun-failed
2016-01-31 15:22:10 -05:00
Guillaume Munch
627bb7bd07 Document the automatic generation of LFUNs.lyx (51d4036d) 2016-01-27 18:39:56 +01:00
Guillaume Munch
e5e8b55abb Development.lyx: intructions for LFUN format increment
Document the new policy
2016-01-27 18:35:38 +01:00
Guillaume Munch
360742c515 New LFUN tabular-feature: update docs
Simply run updatedocs.py
2016-01-27 18:35:10 +01:00
Uwe Stöhr
c1e0b24304 acmsiggraph.layout: update layout for ACM siggraph 0.92
fileformat change: update fileformat for all files
2016-01-27 01:58:13 +01:00
Kornel Benko
230c9275d1 Modified labelwidthstring containing '_'.
Otherwise the files is not compilable
2016-01-24 09:07:35 +01:00
Günter Milde
7ecdcef236 Update/enhance/edit autotest documentation. 2016-01-22 22:42:40 +01:00
Uwe Stöhr
a03ca62042 Development.lyx: restore \origin tag
Kornel, it seems that something is incorrect in your system because every change you make to the docs files removes the \origin tag
2016-01-19 00:17:02 +01:00
Kornel Benko
10ec8ed91d Typo 2016-01-18 10:59:35 +01:00
Günter Milde
3ec76c472e ctest autotest documentation update 2016-01-18 10:25:23 +01:00
Georg Baum
867ecaad4f Update docs for \output_changes move
Since \output_changes is written again at the original position, we need to
fix those files that have been updated using the intermediate version.
The update was done by running development/tools/updatedocs.py <lyxexe> where
<lyxexe> was the path to an up to date LyX binary. All files that did contain
additional changes were reverted:

lib/doc/LFUNs.lyx
lib/doc/UserGuide.lyx
lib/doc/Shortcuts.lyx
lib/examples/de/beamer.lyx

The \SpecialChar changes are fine, these files have never been saved by LyX
after the update to 483.
2016-01-15 21:23:13 +01:00
Guillaume Munch
4a1e158c95 Update docs 2016-01-12 21:30:37 +00:00
Günter Milde
88b3fa3225 Minor ctest documentation edits.
Make sure not to confuse failing test and failing export for inverted tests.
2016-01-05 17:07:14 +01:00
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