anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2024-11-25 19:07:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
827450200f
lyx_mirror/lib/doc/Development.lyx

5050 lines
97 KiB
Plaintext
Raw Normal View History

Update format
2015-10-28 22:10:09 +00:00
#LyX 2.2 created this file. For more info see http://www.lyx.org/
Update docs to latest format.
2016-04-06 03:43:44 +00:00
\lyxformat 508
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 15:59:26 +00:00
\begin_document
\begin_header
Update docs
2016-01-12 21:30:37 +00:00
\save_transient_properties true
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-18 23:17:02 +00:00
\origin /systemlyxdir/doc/
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\textclass scrartcl
\options BCOR8mm,captions=tableheading
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 15:59:26 +00:00
\use_default_options false
\begin_modules
logicalmkup
\end_modules
\maintain_unincluded_children false
\language english
\language_package default
\inputencoding auto
\fontencoding global
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\font_roman "lmodern" "default"
\font_sans "lmss" "default"
\font_typewriter "lmtt" "default"
\font_math "auto" "auto"
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 15:59:26 +00:00
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\font_sf_scale 100 100
\font_tt_scale 100 100
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 15:59:26 +00:00
\graphics default
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 09:40:50 +00:00
\default_output_format pdf2
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
\output_sync 1
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 15:59:26 +00:00
\bibtex_command default
\index_command default
\paperfontsize 12
\spacing single
\use_hyperref true
\pdf_title "LyX's Development manual"
\pdf_author "LyX Team"
\pdf_subject "LyX's development documentation"
\pdf_keywords "LyX, Documentation, Development"
\pdf_bookmarks true
\pdf_bookmarksnumbered true
Development.lyx: some format fixes - fix line breaks and a some microtypography tuning
2013-05-30 21:20:09 +00:00
\pdf_bookmarksopen true
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 15:59:26 +00:00
\pdf_bookmarksopenlevel 1
\pdf_breaklinks false
\pdf_pdfborder false
\pdf_colorlinks true
\pdf_backref false
\pdf_pdfusetitle false
\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
\papersize a4paper
\use_geometry false
\use_package amsmath 1
\use_package amssymb 1
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 05:19:49 +00:00
\use_package cancel 0
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 15:59:26 +00:00
\use_package esint 0
\use_package mathdots 1
\use_package mathtools 0
\use_package mhchem 1
\use_package stackrel 0
\use_package stmaryrd 0
\use_package undertilde 0
\cite_engine basic
Development.lyx: some format fixes - fix line breaks and a some microtypography tuning
2013-05-30 21:20:09 +00:00
\cite_engine_type default
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 15:59:26 +00:00
\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
\justification true
\use_refstyle 0
\notefontcolor #0000ff
\index Index
\shortcut idx
\color #008000
\end_index
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\secnumdepth 4
\tocdepth 4
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 15:59:26 +00:00
\paragraph_separation indent
\paragraph_indentation default
\quotes_language english
\papercolumns 1
\papersides 2
\paperpagestyle headings
\tracking_changes false
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 20:23:13 +00:00
\output_changes false
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 15:59:26 +00:00
\html_math_output 0
\html_css_as_file 0
\html_be_strict true
\end_header
\begin_body
\begin_layout Title
Update format
2015-10-28 22:10:09 +00:00
Developing \SpecialChar LyX
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 15:59:26 +00:00
\end_layout
\begin_layout Subtitle
Update version
2014-05-12 19:53:27 +00:00
Version 2.2.x
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 15:59:26 +00:00
\end_layout
\begin_layout Author
Update format
2015-10-28 22:10:09 +00:00
by the \SpecialChar LyX
Team
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 15:59:26 +00:00
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
\noindent
Update format
2015-10-28 22:10:09 +00:00
If you have comments or error corrections, please send them to the \SpecialChar LyX
Documentatio
n mailing list,
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 15:59:26 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\noindent
<lyx-docs@lists.lyx.org>
\end_layout
\end_inset
.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\begin_inset CommandInset toc
LatexCommand tableofcontents
\end_inset
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Section
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 15:59:26 +00:00
Introduction
\end_layout
\begin_layout Standard
Update format
2015-10-28 22:10:09 +00:00
This manual documents some aspects of \SpecialChar LyX
development.
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 15:59:26 +00:00
It is currently rather incomplete, but will hopefully be extended in the
future.
Meanwhile, additional information can be found in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
development
\end_layout
\end_inset
Update format
2015-10-28 22:10:09 +00:00
subfolder of the \SpecialChar LyX
source code distribution.
This document is not translated, since the development language of \SpecialChar LyX
is
Development.lyx: Spellchecker + special char corrections.
2015-12-02 12:55:38 +00:00
English.
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
If you just want to use \SpecialChar LyX
, then you don't need to read this manual.
Update format
2015-10-28 22:10:09 +00:00
However, if you want to learn more about how \SpecialChar LyX
is developed, or even want
to participate in \SpecialChar LyX
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
development, you may find some interesting information
here.
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 15:59:26 +00:00
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Section
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 15:59:26 +00:00
File formats
\end_layout
\begin_layout Standard
Update format
2015-10-28 22:10:09 +00:00
\SpecialChar LyX
uses several custom file formats for configuration files and documents.
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 15:59:26 +00:00
This chapter contains some background concerning these file formats.
Several file formats are also described in detail in the regular user documenta
tion.
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Subsection
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 15:59:26 +00:00
File Format Numbers
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Subsection
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 15:59:26 +00:00
When is an update of the .lyx file format number needed?
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 21:29:20 +00:00
\begin_inset CommandInset label
LatexCommand label
name "sec:When-is-an"
\end_inset
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 15:59:26 +00:00
\end_layout
\begin_layout Standard
Typo
2015-02-08 21:18:29 +00:00
When you are working on a new feature you may ask yourself whether it needs
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 15:59:26 +00:00
an update of the .lyx file format number.
Whether an update is needed or not is not always obvious.
Development.lyx: Simplify the list of reasons for file format updates.
2016-04-04 08:25:43 +00:00
Rule of thumb:
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\end_layout
Development.lyx: Simplify the list of reasons for file format updates.
2016-04-04 08:25:43 +00:00
\begin_layout Quote
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
Whenever there is the danger that a previous version of LyX cannot open
a file using the new feature, a file format update is needed.
\end_layout
\begin_layout Standard
The file format change allows lyx2lyx rules to implement backwards compatibility.
Development.lyx: Simplify the list of reasons for file format updates.
2016-04-04 08:25:43 +00:00
Below you can find a list of reasons for file format updates with explanations:
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 15:59:26 +00:00
\end_layout
\begin_layout Description
New
\begin_inset space ~
\end_inset
document
\begin_inset space ~
\end_inset
setting Whenever you introduce a new setting that is stored in the document
header, a file format update is needed.
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\end_layout
\begin_layout Description
Removed
\begin_inset space ~
\end_inset
document
\begin_inset space ~
\end_inset
setting If a certain setting becomes obsolete and gets removed, a file format
update is needed.
\end_layout
\begin_layout Description
New
\begin_inset space ~
\end_inset
valid
\begin_inset space ~
\end_inset
value
\begin_inset space ~
\end_inset
for
\begin_inset space ~
\end_inset
an
\begin_inset space ~
\end_inset
existing
\begin_inset space ~
\end_inset
setting, e.
Development.lyx: some format fixes - fix line breaks and a some microtypography tuning
2013-05-30 21:20:09 +00:00
\begin_inset space \thinspace{}
\end_inset
g.
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\end_layout
\begin_deeper
\begin_layout Description
\paragraph_spacing single
Automatically
\begin_inset space ~
\end_inset
loaded
\begin_inset space ~
\end_inset
math
\begin_inset space ~
\end_inset
package The reason for this is that there is no true ERT inset for math
formulas: Each command is parsed, and if a user happens to define a local
command with the same name as a command that triggers an automatic load
of a package, they need to be able to switch off the automatic loading
of that package.
This switch is stored by the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
use_package
\end_layout
\end_inset
header setting.
\end_layout
\begin_layout Description
New
\begin_inset space ~
Development.lyx: some format fixes - fix line breaks and a some microtypography tuning
2013-05-30 21:20:09 +00:00
\end_inset
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
language that is stored in
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 15:59:26 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\backslash
language
\end_layout
\end_inset
.
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
Development.lyx: Simplify the list of reasons for file format updates.
2016-04-04 08:25:43 +00:00
\begin_inset Note Note
status collapsed
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\begin_layout Plain Layout
Development.lyx: Simplify the list of reasons for file format updates.
2016-04-04 08:25:43 +00:00
This requirement is under discussion.
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\end_layout
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 15:59:26 +00:00
\end_inset
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
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 15:59:26 +00:00
\end_layout
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\end_deeper
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 15:59:26 +00:00
\begin_layout Description
New
\begin_inset space ~
\end_inset
inset Of course a new inset requires a file format update.
\end_layout
\begin_layout Description
Development.lyx: Simplify the list of reasons for file format updates.
2016-04-04 08:25:43 +00:00
New
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 15:59:26 +00:00
\begin_inset space ~
\end_inset
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
style If a new style or inset layout is added to any layout file or module
shipped with \SpecialChar LyX
, then a new file format is needed in the master (development)
branch.
It is possible to backport new styles to the stable version without a file
format change.
See
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Backporting-new-styles"
\end_inset
for more information.
\end_layout
\begin_layout Description
Development.lyx: Simplify the list of reasons for file format updates.
2016-04-04 08:25:43 +00:00
Removed
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_inset space ~
\end_inset
style If a style or inset layout is removed in any layout file or module
shipped with \SpecialChar LyX
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
, a new file format is required.
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 15:59:26 +00:00
\end_layout
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\begin_layout Standard
However,
\series bold
new
\series default
layouts and modules do
\series bold
not
\series default
Development.lyx: Simplify the list of reasons for file format updates.
2016-04-04 08:25:43 +00:00
require a file format update (changed 03/16, see
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:New-layouts"
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 15:59:26 +00:00
\end_inset
Development.lyx: Simplify the list of reasons for file format updates.
2016-04-04 08:25:43 +00:00
).
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
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 15:59:26 +00:00
\end_layout
\begin_layout Standard
If you are still unsure, please ask on the development list.
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Subsection
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 23:11:09 +00:00
\begin_inset CommandInset label
LatexCommand label
name "subsec:update_lyx_files"
\end_inset
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
How to update the file format number of .lyx files
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 15:59:26 +00:00
\end_layout
\begin_layout Standard
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
Once you come to the conclusion that a file format update is needed, you
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 15:59:26 +00:00
should use the following procedure to perform the update:
\end_layout
\begin_layout Enumerate
Implement and test the new feature, including the reading and writing of
.lyx files.
Note that any file produced at this stage does not use a valid format,
Update format
2015-10-28 22:10:09 +00:00
so do not use this version of \SpecialChar LyX
for working on any important documents.
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 15:59:26 +00:00
\end_layout
\begin_layout Enumerate
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
\begin_inset CommandInset label
LatexCommand label
name "enu:Describe_format"
\end_inset
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 15:59:26 +00:00
Describe the new format in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
development/FORMAT
\end_layout
\end_inset
.
\end_layout
\begin_layout Enumerate
Update format
2015-10-28 22:10:09 +00:00
Update the \SpecialChar LyX
file format number in
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 15:59:26 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/version.h
\end_layout
\end_inset
.
\end_layout
Document step to update LyX.py when update format
2015-11-24 03:11:14 +00:00
\begin_layout Enumerate
Update the range of file formats in the array
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
format_relation
\end_layout
\end_inset
in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
lib/lyx2lyx/LyX.py
\end_layout
\end_inset
.
\end_layout
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 15:59:26 +00:00
\begin_layout Enumerate
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
\begin_inset CommandInset label
LatexCommand label
name "enu:Add-an-entry"
\end_inset
Development.lyx: some format fixes - fix line breaks and a some microtypography tuning
2013-05-30 21:20:09 +00:00
Add an entry to both format lists (for conversion and reversion) in
\begin_inset Newline newline
\end_inset
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 15:59:26 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
lib/lyx2lyx/lyx_2_3.py
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 15:59:26 +00:00
\end_layout
\end_inset
.
Development.lyx: some format fixes - fix line breaks and a some microtypography tuning
2013-05-30 21:20:09 +00:00
Add a conversion routine if needed (e.
\begin_inset space \thinspace{}
\end_inset
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
g., a new header setting always needs a conversion that adds the new setting,
but a new document language does not need one).
Add a reversion routine if needed.
\begin_inset Newline newline
Development.lyx: some format fixes - fix line breaks and a some microtypography tuning
2013-05-30 21:20:09 +00:00
\end_inset
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
While the conversion routine is required to produce a document that is equivalen
t to the old version, the requirements of the reversion are not that strict.
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 15:59:26 +00:00
If possible, try to produce a proper reversion, using ERT if needed, but
for some features this might be too complicated.
In this case, the minimum requirement of the reversion routine is that
Update format
2015-10-28 22:10:09 +00:00
it produces a valid document which can be read by an older \SpecialChar LyX
.
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 15:59:26 +00:00
If absolutely needed, even data loss is allowed for the reversion.
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
(In that case, you might want to add a LyX comment that indicates what
you have had to do, so the user is at least warned).
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 15:59:26 +00:00
\end_layout
\begin_layout Enumerate
Since tex2lyx has several implicit file format dependencies caused by sharing
Update format
2015-10-28 22:10:09 +00:00
code with \SpecialChar LyX
, updating the file format of .lyx files produced by tex2lyx at
the same time as updating the main .lyx file format is strongly recommended.
Therefore, a compiler warning will be issued if the \SpecialChar LyX
and tex2lyx .lyx file
format numbers differ.
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 15:59:26 +00:00
In many cases the tex2lyx update requires only the first and last item
of the list below:
\end_layout
\begin_deeper
\begin_layout Enumerate
Update the tex2lyx file format number in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/version.h
\end_layout
\end_inset
.
\end_layout
\begin_layout Enumerate
If the lyx2lyx conversion from the old to the new format is empty, or if
tex2lyx does not yet output the changed feature, you do not need any further
tex2lyx changes.
Otherwise, search for the changed feature in tex2lyx, and adjust the output
according to the lyx2lyx changes.
\end_layout
\begin_layout Enumerate
Update the tex2lyx test references as described in
\begin_inset CommandInset ref
LatexCommand formatted
reference "sec:Updating-test-references"
\end_inset
.
\end_layout
\end_deeper
\begin_layout Enumerate
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
If you did not implement full tex2lyx support for the new feature, add a
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 15:59:26 +00:00
line to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/tex2lyx/TODO.txt
\end_layout
\end_inset
describing the missing bits.
Note that it is perfectly fine if you do not add full tex2lyx support for
a new feature: The updating recommendation above is only issued for the
syntax of the produced .lyx file.
Update format
2015-10-28 22:10:09 +00:00
It is no problem if some features supported by \SpecialChar LyX
are still output as ERT
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
by tex2lyx.
The problems in the past that resulted in the update recommendation were
related to mixed version syntax, not ERT.
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 15:59:26 +00:00
\end_layout
Add suggestion for test cases by Günter
2015-10-22 20:21:25 +00:00
\begin_layout Enumerate
It would be nice if you could create a .lyx test file which contains instances
of all changed or added features.
Development.lyx: describe how to update the tex2lyx references on Windows
2015-11-04 00:15:52 +00:00
This could then be used to test lyx2lyx and tex2lyx.
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
Unfortunately, it has not yet been decided how to collect such examples,
Add suggestion for test cases by Günter
2015-10-22 20:21:25 +00:00
so please ask on the development list if you want to create one.
\end_layout
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 23:11:09 +00:00
\begin_layout Enumerate
\begin_inset CommandInset label
LatexCommand label
name "enu:updatefiles"
\end_inset
Update LyX's .lyx documentation files to the new format.
The developer who makes the change knows best what changes to expect when
inspecting the resulting diff.
Because of this, you might be able to catch a bug in the lyx2lyx code that
updates the format just by taking a quick scan through the large diff that
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
is the result.
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 23:11:09 +00:00
\begin_inset Note Note
status collapsed
\begin_layout Plain Layout
Another advantage is that if later we suspect a bug in lyx2lyx we can easily
see which layout update made an unexpected change by looking at the git
log of a .lyx file that suffers the problem.
\end_layout
\end_inset
To do this, first make sure that there are no changes to the git repository
that you will not want to commit (this is needed because it will be convenient
to commit with the command
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
git commit -a
\end_layout
\end_inset
).
Then run the following command in the root folder of the source:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
python development/tools/updatedocs.py
\end_layout
\end_inset
.
Document the automatic generation of LFUNs.lyx (51d4036d)
2016-01-27 17:39:56 +00:00
Look at the resulting changes using the command
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 23:11:09 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Document the automatic generation of LFUNs.lyx (51d4036d)
2016-01-27 17:39:56 +00:00
git diff
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 23:11:09 +00:00
\end_layout
\end_inset
Document the automatic generation of LFUNs.lyx (51d4036d)
2016-01-27 17:39:56 +00:00
.
If anything looks surprising, please investigate.
Keep in mind that the case of
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 23:11:09 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Document the automatic generation of LFUNs.lyx (51d4036d)
2016-01-27 17:39:56 +00:00
LFUNs.lyx
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 23:11:09 +00:00
\end_layout
\end_inset
Document the automatic generation of LFUNs.lyx (51d4036d)
2016-01-27 17:39:56 +00:00
is special, because it is first generated with
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 23:11:09 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Document the automatic generation of LFUNs.lyx (51d4036d)
2016-01-27 17:39:56 +00:00
gen_lfuns.py
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 23:11:09 +00:00
\end_layout
\end_inset
Document the automatic generation of LFUNs.lyx (51d4036d)
2016-01-27 17:39:56 +00:00
before being converted to the latest format.
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 23:11:09 +00:00
Finally, commit using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
git commit -a
\end_layout
\end_inset
.
\end_layout
\begin_layout Subsection
Updating the file format number of layout files
\end_layout
\begin_layout Standard
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
The procedure for updating the layout files is similar to that in step
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 23:11:09 +00:00
\begin_inset CommandInset ref
LatexCommand ref
reference "enu:updatefiles"
\end_inset
in section
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:update_lyx_files"
\end_inset
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
.
One need only run
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 23:11:09 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
python development/tools/updatelayouts.py
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 23:11:09 +00:00
\end_layout
\end_inset
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
instead of
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 23:11:09 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
updatedocs.py
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 23:11:09 +00:00
\end_layout
\end_inset
.
\end_layout
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 06:33:41 +00:00
\begin_layout Standard
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
Note that we do not automatically any local layout used in the
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 06:33:41 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.lyx
\end_layout
\end_inset
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
files shipped with \SpecialChar LyX
because users would then not be able to export to older
formats.
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 06:33:41 +00:00
For example, if a 2.2.0 user exported a template to 2.1.x format and tried
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
to open the file in \SpecialChar LyX
2.1.x, there would be an error because the file would
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 06:33:41 +00:00
contain a local layout whose format is too new.
Fix typo.
2015-12-08 15:41:22 +00:00
The root reason for this is that we do not support converting layouts to
older layout formats, as we do for the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.lyx
\end_layout
\end_inset
file format.
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 06:33:41 +00:00
\end_layout
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 23:11:09 +00:00
\begin_layout Subsection
Updating the file format number of bind/ui files
\end_layout
\begin_layout Standard
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
A change to the functionality of existing LFUNs can require a conversion
of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.bind
\end_layout
\end_inset
and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.ui
\end_layout
\end_inset
files, and therefore an increment of the LFUN format, as well as a conversion
of Info insets in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.lyx
\end_layout
\end_inset
files for manuals.
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
The latter cannot be done automatically and also requires an update of
the \SpecialChar LyX
file format.
(Think e.g.
\begin_inset space \space{}
\end_inset
of someone who might have made a set of \SpecialChar LyX
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
teaching manuals for use in their
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
own group.)
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
\begin_inset Foot
status open
\begin_layout Plain Layout
\begin_inset Flex URL
status open
\begin_layout Plain Layout
http://www.lyx.org/trac/ticket/9794
\end_layout
\end_inset
\end_layout
\end_inset
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\end_layout
\begin_layout Standard
To update the LFUN format:
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
\end_layout
\begin_layout Enumerate
Increment the LFUN file format number in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/LyXAction.h
\end_layout
\end_inset
.
\end_layout
\begin_layout Enumerate
Implement the LFUN conversion in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
lib/scripts/prefs2prefs_lfuns.py
\end_layout
\end_inset
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
.
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
\end_layout
\begin_layout Enumerate
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 23:11:09 +00:00
See step
\begin_inset CommandInset ref
LatexCommand ref
reference "enu:updatefiles"
\end_inset
in section
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:update_lyx_files"
\end_inset
but instead of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
updatedocs.py
\end_layout
\end_inset
command, use this command:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
bash development/tools/updatelfuns.sh
\end_layout
\end_inset
.
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_inset Note Note
status open
\begin_layout Plain Layout
This file should really be converted to python.
\end_layout
\end_inset
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 23:11:09 +00:00
\end_layout
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
\begin_layout Enumerate
Update Info insets in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.lyx
\end_layout
\end_inset
files.
To do so, increment the \SpecialChar LyX
format and proceed as in
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:update_lyx_files"
\end_inset
, steps
\begin_inset CommandInset ref
LatexCommand ref
reference "enu:Describe_format"
\end_inset
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
–
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
\begin_inset CommandInset ref
LatexCommand ref
reference "enu:updatefiles"
\end_inset
.
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
In the lyx2lyx implementation (step
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
\begin_inset CommandInset ref
LatexCommand ref
reference "enu:Add-an-entry"
\end_inset
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
), implement a conversion similar to the one in
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
prefs2prefs_lfuns.py
\end_layout
\end_inset
above, as well as a corresponding reversion; for this one can use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
convert_info_insets
\end_layout
\end_inset
from
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
lib/lyx2lyx/lyx2lyx_tools.py
\end_layout
\end_inset
.
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Subsection
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 05:19:49 +00:00
Backporting new styles to the stable version
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_inset CommandInset label
LatexCommand label
name "subsec:Backporting-new-styles"
\end_inset
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 05:19:49 +00:00
\end_layout
\begin_layout Standard
Update format
2015-10-28 22:10:09 +00:00
Starting with the stable \SpecialChar LyX
2.1 branch, there is a mechanism in place to backport
new styles to the stable version without the need to update the file format.
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 05:19:49 +00:00
The basic idea is that the new style definition is automatically copied
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
to the document preamble so that it can even be used by older minor versions
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 05:19:49 +00:00
that did not yet include the style.
To backport a new style to the stable version, the following steps are
needed:
\end_layout
\begin_layout Enumerate
Add the line
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ForceLocal -1
\end_layout
\end_inset
to the style definition in the development version.
\end_layout
\begin_layout Enumerate
Copy the style definition to the stable version, but use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ForceLocal 1
\end_layout
\end_inset
instead.
If needed adjust the format to the one used by the stable version (see
the customization manual for details of the layout file format).
\end_layout
\begin_layout Enumerate
For each update of the style in a later stable version, increase the argument
of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ForceLocal
\end_layout
\end_inset
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
by one.
(In the stable version, the development version should not be touched.)
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 05:19:49 +00:00
\end_layout
\begin_layout Standard
For details about the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ForceLocal
\end_layout
\end_inset
flag see the customization manual.
No
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
lyx2lyx
\end_layout
\end_inset
support is needed for backported styles: Since the style of the development
version has an infinite version number, it will always be used.
Furthermore, since its version number is less than one, the style will
not be written anymore to the document header for files saved by the new
version.
\end_layout
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_layout Section
New layouts and modules
\end_layout
\begin_layout Subsection
\begin_inset CommandInset label
LatexCommand label
name "subsec:New-layouts"
\end_inset
New layouts
\end_layout
\begin_layout Standard
Adding a new layout file to the \SpecialChar LyX
library makes it an
\begin_inset Quotes eld
\end_inset
officially supported
\begin_inset Quotes erd
\end_inset
layout.
You should therefore think carefully about whether you really want to do
this and discuss it on lyx-devel, since you will need to be prepared to
update and fix the layout if necessary.
If the layout is experimental or for a rarely used document class, then
it may be better to add it to the relevant portion of the \SpecialChar LyX
wiki, as a user
contribution.
See
\begin_inset CommandInset href
LatexCommand href
target "https://wiki.lyx.org/Layouts/Layouts"
\end_inset
.
\end_layout
\begin_layout Standard
In older versions of this document, it was stated that new layout files
require a file format change.
minor edit of development guide
2016-09-06 14:44:36 +00:00
After some discussion, it was decided that this is not needed.
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_inset Foot
status open
\begin_layout Plain Layout
See
\begin_inset CommandInset href
LatexCommand href
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
name "the thread “Proposal for a guide on updating layouts”"
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
target "http://permalink.gmane.org/gmane.editors.lyx.devel/161202"
\end_inset
.
\end_layout
\end_inset
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\end_layout
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\begin_layout Quote
For reference, here are the arguments on each side
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\end_layout
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\begin_deeper
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_layout Description
Pro
\begin_inset Quotes eld
\end_inset
New layout files are a file format change
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Itemize
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
All documents produced by 2.2.
\begin_inset Formula $x$
\end_inset
can always be edited and exported even if
\begin_inset Formula $x$
\end_inset
is different.
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
This is important for people using different machines, or exchanging work
with colleagues.
\end_layout
\begin_layout Description
Con
\begin_inset Quotes eld
\end_inset
New layout files are not a file format change
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Itemize
No new LaTeX classes can be supported in a stable version, and stable versions
have a typical lifetime of 2–3 years.
\end_layout
\begin_layout Itemize
We have the same situation already with custom layout files: If a document
using a custom layout file is moved between machines or people, then the
layout file needs to be exchanged as well.
If that is not done, then we have a fallback implemented so that such documents
can still be edited, but not exported, and the user gets a warning.
\end_layout
\begin_layout Itemize
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
The lyx2lyx script cannot do anything useful in such a case.
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\end_layout
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\end_deeper
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_layout Standard
If you have decided that you are going to add a new layout file to \SpecialChar LyX
itself,
then, you should do the following:
\end_layout
\begin_layout Enumerate
Put your new layout file in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
lib/layouts/
\end_layout
\end_inset
and add it to Git (
\begin_inset Flex Code
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
status collapsed
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_layout Plain Layout
git add lib/layouts/newlayout.layout
\end_layout
\end_inset
) so that it will be committed.
\end_layout
\begin_layout Enumerate
Add an entry in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
lib/Makefile.am
\end_layout
\end_inset
, so that the new layout actually gets installed.
\end_layout
\begin_layout Enumerate
Add an entry in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
lib/doc/LaTeXConfig.lyx
\end_layout
\end_inset
containing in particular a line like
\end_layout
\begin_deeper
\begin_layout Quote
Found: [InsetInfo]
\end_layout
\begin_layout Standard
where [InsetInfo] is obtained by entering in the minibuffer (Alt+X)
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
info-insert textclass <name>
\end_layout
\end_inset
.
This inset will automatically display a boxed
\begin_inset Quotes eld
\end_inset
yes
\begin_inset Quotes erd
\end_inset
or
\begin_inset Quotes eld
\end_inset
no
\begin_inset Quotes erd
\end_inset
depending on the availability of the package.
\end_layout
\end_deeper
\begin_layout Enumerate
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
A template or example is strongly encouraged (but not necessarily required).
It is also possible to provide both.
Add them to
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
lib/templates/
\end_layout
\end_inset
or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
lib/examples/
\end_layout
\end_inset
, respectively.
\end_layout
\begin_layout Enumerate
Reconfigure \SpecialChar LyX
.
\end_layout
\begin_layout Enumerate
Ensure the autotests for the new layout pass (see
\begin_inset CommandInset ref
LatexCommand ref
reference "par:when-to-run-an-export-test"
\end_inset
).
\end_layout
\begin_layout Subsection
New modules
\end_layout
\begin_layout Standard
Adding a new module is very similar to adding a new layout.
Therefore, the previous section applies to new modules as well, with two
exceptions:
\end_layout
\begin_layout Enumerate
You only need to add an entry to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
lib/doc/LaTeXConfig.lyx
\end_layout
\end_inset
if the module requires a LaTeX package.
In that case, the command for entering the InsetInfo is:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\paragraph_spacing single
info-insert package <name>
\end_layout
\end_inset
\end_layout
\begin_layout Enumerate
Modules do not need a template, only an example, which is strongly encouraged
but not necessarily required.
\end_layout
\begin_layout Subsection
Layouts for document classes with incompatible versions
\end_layout
minor edit of development guide
2016-09-06 14:44:36 +00:00
\begin_layout Standard
\begin_inset Note Greyedout
status open
\begin_layout Description
Note: This section is currently only a proposal under discussion.
Please correct/amend as suited.
Remove this note once a consensus is found.
\end_layout
\begin_layout Plain Layout
See the thread
\begin_inset Quotes eld
\end_inset
Proposal for a guide on updating layouts
\begin_inset Quotes erd
\end_inset
for details and background
\end_layout
\begin_layout Plain Layout
http://permalink.gmane.org/gmane.editors.lyx.devel/161126
\end_layout
\end_inset
\end_layout
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_layout Standard
Every now and then, there are changes to LaTeX document classes that break
backwards compatibility.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
Uwe has suggested we implement automatic detection of changes in class files.
This could be done by running a script every month that checks if a document
class was changed at CTAN and at the homepages of the scientific journals.
If it reports a change, we can check if our template and layout file are
still usable with the changed document class.
(This is different from the autotests insofar, as this would also catch
changes that do not result in compilation errors.)
\end_layout
\end_inset
Reasons can be a new name for the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
*.cls
\end_layout
\end_inset
file, removed \SpecialChar LaTeX
commands, or both.
How should this best be handled in \SpecialChar LyX
?
\end_layout
\begin_layout Standard
The idea is to support the new version with a new \SpecialChar LyX
layout so that:
\end_layout
\begin_layout Itemize
Existing documents can still be opened in \SpecialChar LyX
and will continue to work on
systems where the old version is still installed.
\end_layout
\begin_layout Itemize
With differently named
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
*.cls
\end_layout
\end_inset
files, \SpecialChar LyX
can check for the availability of the particular version and reflect
this in the GUI.
Different document class versions with the same file name are currently
(2.2.x) not detected by the configuration script.
This is planned for 2.3.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
https://www.mail-archive.com/lyx-devel@lists.lyx.org/msg192467.html
\end_layout
\begin_layout Plain Layout
However, what we really need is version detection for the configuration,
so that the user can be warned if the required class file has the wrong
version.
(If the class file keeps the name over the version change, only one of
the two layout files generates compilable documents.)
\end_layout
\begin_layout Plain Layout
This point was also made here: http://permalink.gmane.org/gmane.editors.lyx.devel/143
798
\end_layout
\end_inset
\end_layout
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\begin_layout Itemize
The new layout can be added both to the master and the stable branches,
in accord with the policy discussed in
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_inset CommandInset ref
LatexCommand formatted
reference "subsec:New-layouts"
\end_inset
.
No lyx2lyx conversion is then required when a new major version is released.
\end_layout
\begin_layout Standard
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
The user can move an existing document to the new version simply by selecting
a new document class.
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
This step is well supported by \SpecialChar LyX
, with established methods for handling
unsupported styles and other changes.
This way, no lyx2lyx code is required.
\end_layout
\begin_layout Standard
The steps to support a new version of an existing document class are thus:
\end_layout
\begin_layout Itemize
Create a new layout file including the upstream version in the name (avoid
special characters like spaces and dots), e.g.
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
acmsiggraph-v0-92.layout
\end_layout
\end_inset
.
\end_layout
\begin_layout Itemize
Include the name of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
*.cls
\end_layout
\end_inset
file as an optional argument in the
\begin_inset Flex Code
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
status collapsed
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_layout Plain Layout
\backslash
DeclareLaTeXClass
\end_layout
\end_inset
line and include the version number in the GUI name:
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\backslash
DeclareLaTeXClass[acmsiggraph]{ACM SIGGGRAPH (v.
\begin_inset space ~
\end_inset
0.92)}
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
Update the GUI name in the old layout file (whose name should not be changed),
e.g.:
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\backslash
DeclareLaTeXClass{ACM SIGGRAPH (<= v.
\begin_inset space ~
\end_inset
0.91, obsolete)}
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
To avoid duplicate definitions, the new layout can
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Input
\end_layout
\end_inset
the old layout file and add\SpecialChar breakableslash
remove\SpecialChar breakableslash
obsolete\SpecialChar breakableslash
modify settings and styles (similar
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
to the inclusion of
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_inset Flex Code
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
status collapsed
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_layout Plain Layout
*.inc
\end_layout
\end_inset
files).
\end_layout
\begin_deeper
\begin_layout Standard
It may be tempting to let the new layout be the
\begin_inset Quotes eld
\end_inset
master version
\begin_inset Quotes erd
\end_inset
and have the old layout import it.
However, this should not be done because any changes to the new layout
would need undo steps in the importing old layout.
\end_layout
\end_deeper
\begin_layout Itemize
If the new LaTeX document class obsoletes the old one, update the example
and template files to use the new layout.
Add a note about the changes (preferably with a pointer to the documentation
of the changes).
\end_layout
\begin_deeper
\begin_layout Standard
This way, new documents based on the template or example will use the up-to-date
document class version.
\end_layout
\end_deeper
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Standard
\begin_inset Newpage newpage
\end_inset
\end_layout
\begin_layout Section
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 15:59:26 +00:00
Tests
\end_layout
\begin_layout Standard
Automated tests are an important tool to detect bugs and regressions in
software development.
Some projects like gcc even require each bug fix to be accompanied by a
test case for the automatic test suite, that would detect this bug.
Testing interactive features automatically is of course very hard, but
core functionality like document import and export can be tested quite
easily, and some tests of this kind exist.
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Subsection
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
unit tests
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 15:59:26 +00:00
\end_layout
\begin_layout Standard
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
There are attempts to set up a suite of unit tests for LyX.
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 15:59:26 +00:00
\end_layout
\begin_layout Standard
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
TODO: describe what is done and what is still to do.
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 15:59:26 +00:00
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Subsection
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 15:59:26 +00:00
tex2lyx tests
\end_layout
\begin_layout Standard
The tex2lyx tests are located in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/tex2lyx/test
\end_layout
\end_inset
Update format
2015-10-28 22:10:09 +00:00
subfolder of the \SpecialChar LyX
source code distribution.
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 15:59:26 +00:00
The actual testing is performed by the simple python script
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/tex2lyx/test/runtests.py
\end_layout
\end_inset
.
Each test consists of two files:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<test name>.tex
\end_layout
\end_inset
Update format
2015-10-28 22:10:09 +00:00
contains the \SpecialChar LaTeX
code that should be tested.
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 15:59:26 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<test name>.lyx.lyx
\end_layout
\end_inset
contains the expected output of tex2lyx.
When a test is run, the actual produced output is compared with the stored
reference output.
The test passes if both are identical.
The test machinery is also able to generate a file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<test name>.lyx.tex
\end_layout
\end_inset
Update format
2015-10-28 22:10:09 +00:00
by exporting the produced .lyx file with \SpecialChar LyX
again.
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 15:59:26 +00:00
This may be useful for roundtrip comparisons.
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Subsubsection
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 15:59:26 +00:00
Running the tests
\end_layout
\begin_layout Standard
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 04:30:34 +00:00
The tex2lyx tests can be run in several ways.
When in the
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 15:59:26 +00:00
\begin_inset Flex Code
status collapsed
Document how to run tests on windows
2015-10-29 21:20:37 +00:00
\begin_layout Plain Layout
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 04:30:34 +00:00
src/tex2lyx
\end_layout
\end_inset
subfolder of the build directory, the commands
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest
Document how to run tests on windows
2015-10-29 21:20:37 +00:00
\end_layout
\end_inset
(cmake, all platforms),
\begin_inset Flex Code
status collapsed
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 15:59:26 +00:00
\begin_layout Plain Layout
make test
\end_layout
\end_inset
Document how to run tests on windows
2015-10-29 21:20:37 +00:00
(cmake, when using a make based build system and not MSVC) or
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 15:59:26 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Update documented command for running tex2lyx tests.
2014-05-12 21:54:50 +00:00
make alltests
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 15:59:26 +00:00
\end_layout
\end_inset
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 04:30:34 +00:00
(autotools) will run the tex2lyx tests.
Alternatively, in the root of the build directory, the command
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 15:59:26 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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 04:30:34 +00:00
ctest -R tex2lyx
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 15:59:26 +00:00
\end_layout
\end_inset
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 04:30:34 +00:00
runs all tests whose names match the regex
\begin_inset Quotes eld
\end_inset
tex2lyx
\begin_inset Quotes erd
\end_inset
.
Another way to run the tex2lyx tests in the root build directory is to
instead use the command
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest -L '(cmplyx|roundtrip)'
\end_layout
\end_inset
, which runs all tests categorized with the label
\begin_inset Quotes eld
\end_inset
roundtrip
\begin_inset Quotes erd
\end_inset
or
\begin_inset Quotes eld
\end_inset
cmplyx
\begin_inset Quotes erd
\end_inset
.
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 15:59:26 +00:00
If a test fails, the differences between the expected and actual results
are output in unified diff format.
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Subsubsection
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 15:59:26 +00:00
Updating test references
\begin_inset CommandInset label
LatexCommand label
name "sec:Updating-test-references"
\end_inset
\end_layout
\begin_layout Standard
In some cases a changed tex2lyx output is not a test failure, but wanted,
Development.lyx: some format fixes - fix line breaks and a some microtypography tuning
2013-05-30 21:20:09 +00:00
e.
\begin_inset space \thinspace{}
\end_inset
g.
\begin_inset space \space{}
\end_inset
if a tex2lyx bug was fixed, or a new feature was added.
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 15:59:26 +00:00
In these cases the stored references need to be updated.
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 04:18:45 +00:00
To do so if using autotools, call
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 15:59:26 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
make updatetests
\end_layout
\end_inset
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 04:18:45 +00:00
in the
\begin_inset Flex Code
status collapsed
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 15:59:26 +00:00
\begin_layout Plain Layout
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 04:18:45 +00:00
src/tex2lyx
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 15:59:26 +00:00
\end_layout
\end_inset
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 04:18:45 +00:00
subdirectory of the build directory.
If instead using CMake, call
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 15:59:26 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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 04:18:45 +00:00
make updatetex2lyxtests
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 15:59:26 +00:00
\end_layout
\end_inset
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 04:18:45 +00:00
in the build directory or in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/tex2lyx/test
\end_layout
\end_inset
Development.lyx: describe how to update the tex2lyx references on Windows
2015-11-04 00:15:52 +00:00
subdirectory of the build directory.
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 04:18:45 +00:00
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
Note that this is a case where a make target in the build directory can
affect the source directory, which might not be advisable.
\end_layout
\end_inset
Development.lyx: describe how to update the tex2lyx references on Windows
2015-11-04 00:15:52 +00:00
On Windows do the following:
\end_layout
\begin_layout Itemize
Assure that the path to the python.exe is in your system PATH variable.
\end_layout
\begin_layout Itemize
Double-click on the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
updatetex2lyxtests.vcxproj
\end_layout
\end_inset
in the build directory or in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/tex2lyx/test
\end_layout
\end_inset
subdirectory of your build directory.
\end_layout
\begin_layout Itemize
In the appearing MSVC program right-click on the project
\family sans
updatetex2lyxtests
\family default
in the project explorer and chose
\family sans
Create
\family default
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 04:18:45 +00:00
.
Development.lyx: describe how to update the tex2lyx references on Windows
2015-11-04 00:15:52 +00:00
\end_layout
\begin_layout Standard
For convenience, these commands also produce re-exported roundtrip .lyx.tex
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 15:59:26 +00:00
files.
Please examine the changed output carefully before committing the changed
files to the repository: Since the test machinery does not do a roundtrip
test .tex
\begin_inset Formula $\Rightarrow$
\end_inset
.lyx
\begin_inset Formula $\Rightarrow$
\end_inset
.tex, and does not compare the produced dvi or pdf output, it assumes that
Update format
2015-10-28 22:10:09 +00:00
the stored .lyx reference produces correct output if processed by \SpecialChar LyX
.
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 15:59:26 +00:00
There is only one chance to detect wrong output: before committing a new
reference.
Once it is committed, it is quite difficult to verify whether it is correct.
\end_layout
Add note about updating tex2lyx tests
2015-05-15 19:20:28 +00:00
\begin_layout Standard
Please
\emph on
do not
\emph default
Update format
2015-10-28 22:10:09 +00:00
update the test references by opening them with \SpecialChar LyX
or directly running lyx2lyx
on them.
This would not work, since lyx2lyx and \SpecialChar LyX
produce slightly different files
Add note about updating tex2lyx tests
2015-05-15 19:20:28 +00:00
regarding insignificant whitespace and line breaks.
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Subsubsection
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 15:59:26 +00:00
Adding a new test
\end_layout
\begin_layout Standard
In many cases tests for new features may be added to one of the existing
test files, but sometimes this is not possible or not wanted.
Then a new test file needs to be added:
\end_layout
\begin_layout Enumerate
Create the new file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/tex2lyx/test/<test name>.tex
\end_layout
\end_inset
and run tex2lyx in roundtrip mode to produce the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/tex2lyx/test/<test name>.lyx.lyx
\end_layout
\end_inset
.
This file will be the new reference.
\end_layout
\begin_layout Enumerate
Once you confirmed that the tex2lyx output is correct, add the new files
to the corresponding lists in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/tex2lyx/test/runtests.py
\end_layout
\end_inset
,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/tex2lyx/Makefile.am
\end_layout
\end_inset
and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/tex2lyx/test/CMakeLists.txt
\end_layout
\end_inset
.
\end_layout
\begin_layout Enumerate
Commit the changes to the repository, or send a patch to the development
list and ask for committing if you do not have commit rights.
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Subsection
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
ctest automatic tests
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\end_layout
\begin_layout Standard
Some tests are located in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
development/autotests/
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\end_layout
\end_inset
subfolder of the \SpecialChar LyX
source code distribution.
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\begin_inset Foot
status open
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_layout Plain Layout
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
The README document in this folder only describes the
\begin_inset Quotes eld
\end_inset
keytests
\begin_inset Quotes erd
\end_inset
subset of autotests!
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
These tests can be run by the commands
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest
\end_layout
\end_inset
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
in the
\emph on
build directory
\emph default
(all platforms) or (when using a make based build system and not MSVC)
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
make test
\end_layout
\end_inset
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
in the
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
autotests/
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\end_layout
\end_inset
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
subfolder of the
\emph on
build directory
\emph default
.
The test logs are written to the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Testing/Temporary/
\end_layout
\end_inset
subfolder of the
\emph on
\emph default
build directory.
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\end_layout
\begin_layout Subsubsection
Export tests
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 06:24:20 +00:00
\end_layout
\begin_layout Standard
The export tests are integration tests.
They take longer to run and are more likely to break than the tex2lyx tests.
Nevertheless, they have caught many regressions and without a better alternativ
e it is important to keep them up-to-date and understand how they work.
\end_layout
ctest export test documentation update
2015-12-07 16:56:43 +00:00
\begin_layout Standard
The export tests
\begin_inset Quotes eld
\end_inset
reuse
\begin_inset Quotes erd
\end_inset
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
documentation, template, and example documents.
In addition, there are a number of dedicated sample documents in the
Minor ctest documentation edits. Make sure not to confuse failing test and failing export for inverted tests.
2016-01-02 21:31:14 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
autotests/export/
\end_layout
\end_inset
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
subfolder of the \SpecialChar LyX
source code distribution.
All samples are (after copying and eventual processing by scripts) exported
to various output formats via the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
—export-to
\end_layout
\end_inset
command line option.
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
The tests checks for errors reported by LyX.
(However, error-free export is no guarantee for an error-free output document.)
ctest export test documentation update
2015-12-07 16:56:43 +00:00
\end_layout
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_layout Paragraph
Add material on updating layout files to the development docs. Joint work by Guenter Milde, Georg Baum, and Richard Heck.
2016-04-02 15:37:25 +00:00
\begin_inset CommandInset label
LatexCommand label
name "par:when-to-run-an-export-test"
\end_inset
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 06:24:20 +00:00
Expectations of LyX developers
\end_layout
\begin_layout Standard
Because the export tests are integration tests and take a long time to run,
LyX developers are rarely expected to run all of the tests.
Here are some good practices to follow by developers:
\end_layout
\begin_layout Itemize
When making a non-trivial change to a .layout file, run the export and layout
tests corresponding with that .layout file.
\end_layout
\begin_layout Itemize
When making non-trivial changes to a .lyx file, run the export tests correspondin
g to that .lyx file.
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
This rule is due to revision.
\end_layout
\begin_layout Plain Layout
There is an objection from the documentation maintainer that working on
the documentation must not be complicated by having to consider non-standard
exports.
\end_layout
\begin_layout Itemize
successful compiling/testing an edited documentation file with pdflatex
suffices to ensure it can be commited, not tests with other exports are
required.
\end_layout
\begin_layout Plain Layout
If sudden failures with other exports due to “half-tested” documentation
updates are a problem for the test maintainer, the test suite should use
copies that are
\end_layout
\begin_layout Itemize
copied to a cache dir (autotests/samples/doc/, say) but not changed,
\end_layout
\begin_layout Itemize
updated regularely (but on a time chosen by the test suite maintainer) from
the originals in lib/doc/
\end_layout
\begin_layout Plain Layout
This way,
\end_layout
\begin_layout Itemize
no test will fail due to ongoing work on documentation,
\end_layout
\begin_layout Itemize
the documentation is still tested in full (with some delay),
\end_layout
\begin_layout Itemize
failures with non-default export can be examined and handled accordingly
in one run with the cache update,
\end_layout
\begin_layout Itemize
“interesting failures” (like the nested-language+polyglossia problem in
es/Customization can be separated and moved into dedicated test samples.
\end_layout
\end_inset
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 06:24:20 +00:00
\end_layout
\begin_layout Itemize
Development.lyx: Spellchecker + special char corrections.
2015-12-02 12:55:38 +00:00
When making non-trivial changes to LyX's \SpecialChar LaTeX
export code (e.g.
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 06:24:20 +00:00
touching the encoding code or package handling code that you expect will
Development.lyx: Spellchecker + special char corrections.
2015-12-02 12:55:38 +00:00
change the exported \SpecialChar LaTeX
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
in some way):
\end_layout
\begin_deeper
\begin_layout Standard
\paragraph_spacing single
Consider running all of the export tests before and after your change.
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 06:24:20 +00:00
If there are differences, please reconcile these (i.e.
fix the bug or fix the tests)
\emph on
before
\emph default
committing.
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
Ask for help if you're not sure what to.
\end_layout
\begin_layout Standard
If you do not want to run the tests,
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 06:24:20 +00:00
\end_layout
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\begin_layout Itemize
post the patch on the list and others will run the tests and eventually
ask for fixes, or
\end_layout
\begin_layout Itemize
commit, but be prepared to fix eventually arising problems or to revert
the commit if there is no easy fix.
\end_layout
\end_deeper
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 06:24:20 +00:00
\begin_layout Itemize
Understand how to interpret test failures.
If your commit is found to have broken a test, you should be able to interpret
the test results when made aware of them.
See Section
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Interpreting-export-tests"
\end_inset
.
\end_layout
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\begin_layout Paragraph
\begin_inset CommandInset label
LatexCommand label
name "par:export-test-output-formats"
\end_inset
Output formats
\end_layout
\begin_layout Standard
The following output formats are currently tested for each sample document
(see
\begin_inset CommandInset ref
LatexCommand ref
reference "par:Export-test-filtering"
\end_inset
for exceptions):
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
LyX:
\end_layout
\begin_deeper
\begin_layout Labeling
\labelwidthstring 00.00.0000
lyx16 LyX 1.6 file format (lyx2lyx)
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
lyx21 LyX 2.1 file format (lyx2lyx)
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
xhtml LyXHTML (native LyX HTML export)
\end_layout
\end_deeper
\begin_layout Labeling
\labelwidthstring 00.00.0000
LyX
\begin_inset space ~
\end_inset
+
\begin_inset space ~
\end_inset
LaTeX:
\end_layout
\begin_deeper
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
dvi DVI (8-bit latex)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
dvi3_texF DVI (LuaTeX with 8-bit TeX fonts)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
dvi3_systemF DVI (LuaTeX with Unicode fonts)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
pdf2 PDF (pdflatex)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
pdf4_texF PDF (XeTeX with 8-bit TeX fonts)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
pdf4_systemF PDF (XeTeX with Unicode fonts)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
pdf5_texF PDF (LuaTeX with 8-bit TeX fonts)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
pdf5_systemF PDF (LuaTeX with Unicode fonts)
\end_layout
\end_deeper
\begin_layout Labeling
\labelwidthstring 00.00.0000
LyX
\begin_inset space ~
\end_inset
+
\begin_inset space ~
\end_inset
LaTeX
\begin_inset space ~
\end_inset
+
\begin_inset space ~
\end_inset
postprocessing:
\end_layout
\begin_deeper
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
pdf DVI -> PS (dvips) -> PDF (ps2pdf)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
pdf3 DVI -> PDF (dvipdfm)
\end_layout
\end_deeper
\begin_layout Labeling
\labelwidthstring 00.00.0000
not
\begin_inset space ~
\end_inset
tested: (or only if set as default output format in the document source)
\end_layout
\begin_deeper
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
latex LaTeX (plain)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
luatex LaTeX (LuaTeX)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
dviluatex LaTeX (dviluatex)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
pdflatex LaTeX (pdflatex)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
platex LaTeX (pLaTeX)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
xetex LaTeX (XeTeX)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
eps3 EPS (encapsulated Postscript) (cropped)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
ps DVI -> Postscript (dvips)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
odf
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
text (nor text2, ..., text4)
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
textparagraph
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
word
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
word2
\end_layout
\begin_layout Labeling
Modified labelwidthstring containing '_'. Otherwise the files is not compilable
2016-01-24 08:07:35 +00:00
\labelwidthstring pdf5msystemFM
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
wordhtml
\end_layout
\end_deeper
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_layout Paragraph
Minor ctest documentation edits. Make sure not to confuse failing test and failing export for inverted tests.
2016-01-02 21:31:14 +00:00
\begin_inset CommandInset label
LatexCommand label
name "par:Configuring-ctests"
\end_inset
Configuring the tests
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 06:24:20 +00:00
\end_layout
\begin_layout Standard
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
To enable the export autotests, add the
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 06:24:20 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DLYX_ENABLE_EXPORT_TESTS=ON
\end_layout
\end_inset
flag.
For example:
\end_layout
\begin_layout Standard
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
cmake -DLYX_ENABLE_EXPORT_TESTS=ON /path/to/source
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\noindent
This flag will increase the time for the cmake command by several seconds,
mainly because of the process of inverting tests (see Section
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Interpreting-export-tests"
\end_inset
).
\end_layout
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_layout Paragraph
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\begin_inset CommandInset label
LatexCommand label
name "par:ctest-options"
\end_inset
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 06:24:20 +00:00
Running the tests
\end_layout
\begin_layout Standard
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-30 02:11:11 +00:00
To run all tests, in the build directory simply run the command
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 06:24:20 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest
\end_layout
\end_inset
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
.
A full, up-to-date TeXLive installation is recommended to run the tests.
Otherwise, some tests will fail.
Tests with additional requirements are labeled
\begin_inset Quotes eld
\end_inset
unreliable:nonstandard
\begin_inset Quotes erd
\end_inset
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 06:24:20 +00:00
.
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\end_layout
\begin_layout Standard
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
To run only some of the tests, use command line options (see examples below):
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\end_layout
\begin_layout Labeling
\labelwidthstring -R
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 06:24:20 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
-R <pattern>
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 06:24:20 +00:00
\end_layout
\end_inset
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
Run only the tests whose names match the given regular expression.
\end_layout
\begin_layout Labeling
\labelwidthstring -R
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 06:24:20 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
-L <pattern>
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 06:24:20 +00:00
\end_layout
\end_inset
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
Run only the tests whose labels match the given regular expression.
minor autotest documentation update
2015-12-18 16:38:27 +00:00
A test may have more that one label.
\end_layout
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\begin_layout Labeling
\labelwidthstring -R
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-30 02:11:11 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
-E <pattern>
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-30 02:11:11 +00:00
\end_layout
\end_inset
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
Exclude the tests whose names match the given regular expression.
\end_layout
\begin_layout Labeling
\labelwidthstring -R
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 06:24:20 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
-LE <pattern>
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 06:24:20 +00:00
\end_layout
\end_inset
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
Exclude the tests whose labels match the given regular expression.
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
Cannot be combined with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-L
\end_layout
\end_inset
.
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\end_layout
\begin_layout Standard
The following options help to find good selection patterns:
\end_layout
\begin_layout Labeling
\labelwidthstring -R
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 06:24:20 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-N
\end_layout
\end_inset
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
List the tests that would be run but not actually run them.
\end_layout
\begin_deeper
\begin_layout Standard
Useful in conjunction with the -R, -L, -E and -LE options, e.g., if you want
to know how many tests there are or whether your
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 06:24:20 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
<pattern>
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 06:24:20 +00:00
\end_layout
\end_inset
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
regular expression did what you expected.
\end_layout
\end_deeper
\begin_layout Labeling
\labelwidthstring -R
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 06:24:20 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\SpecialChar nobreakdash
\SpecialChar nobreakdash
print-labels
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 06:24:20 +00:00
\end_layout
\end_inset
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
print the list of all labels associated with the test set.
Can also be combined with -R, -L, -E, ...
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 06:24:20 +00:00
\end_layout
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\begin_layout Standard
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
Other useful options are:
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\end_layout
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 06:24:20 +00:00
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\begin_layout Labeling
\labelwidthstring -R
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 06:24:20 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
-j <jobs>
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 06:24:20 +00:00
\end_layout
\end_inset
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
Run the tests in parallel using the given number of jobs.
\end_layout
\begin_deeper
\begin_layout Standard
We are still working on getting the tests to run in parallel.
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 06:24:20 +00:00
However, when running the tests in parallel, sometimes tests fail that
pass when run sequentially.
A reasonable approach is to first run the tests in parallel and then run
the failed tests sequentially.
minor autotest documentation update
2015-12-18 16:38:27 +00:00
\end_layout
\begin_layout Standard
For example, to run 8 jobs at a time:
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 06:24:20 +00:00
\end_layout
\begin_layout Standard
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest -j8
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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-30 02:11:11 +00:00
ctest \SpecialChar nobreakdash
\SpecialChar nobreakdash
rerun-failed
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 06:24:20 +00:00
\end_layout
\end_inset
\end_layout
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 20:06:23 +00:00
\begin_layout Standard
When specifying a subset of the tests (e.g.
using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\SpecialChar nobreakdash
R <pattern>
\end_layout
\end_inset
), the same subset must be specified when using the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\SpecialChar nobreakdash
\SpecialChar nobreakdash
rerun-failed
\end_layout
\end_inset
option because it is the test numbers that are used to index which tests
failed on the previous run.
\end_layout
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 06:24:20 +00:00
\begin_layout Standard
\noindent
Note that some tests cannot be run in parallel.
These tests are marked in the code with the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\noindent
RUN_SERIAL ON
\end_layout
\end_inset
CMake property.
\end_layout
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\end_deeper
\begin_layout Labeling
\labelwidthstring -R
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 06:24:20 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Update Development.lyx to include 'suspended' cmake tests.
2015-11-04 12:06:14 +00:00
\SpecialChar nobreakdash
\SpecialChar nobreakdash
timeout <seconds>
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 06:24:20 +00:00
\end_layout
\end_inset
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
Set a global timeout on all tests that do not already have a timeout set
on them.
\end_layout
\begin_deeper
\begin_layout Standard
There have been bugs in LyX and in \SpecialChar LaTeX
Development.lyx: Spellchecker + special char corrections.
2015-12-02 12:55:38 +00:00
which cause compilation to hang, and
without a timeout a test might never stop (in one case there was even a
memory leak).
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 06:24:20 +00:00
If a test times out, the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest
\end_layout
\end_inset
command exits with error, but you can distinguish between a timed out test
and a failed test in the output reported at the end of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest
\end_layout
\end_inset
command.
\end_layout
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\end_deeper
Small fixes to export test documentation.
2015-11-27 09:33:12 +00:00
\begin_layout Standard
See the manual (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
man ctest
\end_layout
\end_inset
) the full list of command line options.
\end_layout
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\begin_layout Paragraph
Examples
\end_layout
\begin_layout Itemize
run only the export tests:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest -L export
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
run inverted tests:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest -L "inverted|suspended"
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
list all export tests which match any of the labelling patterns:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest -N -R "
\backslash
..*_export/"
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
exclude rarely used output formats and post-processing tests
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest -L export -E "_(texF|dvi3|pdf3?)"
\end_layout
\end_inset
\end_layout
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_layout Paragraph
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 06:24:20 +00:00
\begin_inset CommandInset label
LatexCommand label
name "subsec:Interpreting-export-tests"
\end_inset
Interpreting the export test results
\end_layout
\begin_layout Standard
A test can fail for several reasons, not all of them bad.
\end_layout
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-30 02:48:28 +00:00
\begin_layout Enumerate
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
A new or edited sample document may be incompatible with some output formats.
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 06:24:20 +00:00
\end_layout
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-30 02:48:28 +00:00
\begin_layout Enumerate
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 06:24:20 +00:00
A dependency is not met (e.g.
Development.lyx: Spellchecker + special char corrections.
2015-12-02 12:55:38 +00:00
the \SpecialChar LaTeX
class file).
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 06:24:20 +00:00
One hint that this is the case is that the corresponding
\begin_inset Flex Code
ctest automatic tests: small correcions to pattern files and documenation.
2015-12-06 20:21:46 +00:00
status collapsed
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 06:24:20 +00:00
\begin_layout Plain Layout
check_load
\end_layout
\end_inset
test will likely also fail.
\end_layout
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-30 02:48:28 +00:00
\begin_layout Enumerate
Small fixes to export test documentation.
2015-11-27 09:33:12 +00:00
An inverted test fails to fail (i.e.
export that previously failed now works).
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 06:24:20 +00:00
\end_layout
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-30 02:48:28 +00:00
\begin_layout Enumerate
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 06:24:20 +00:00
An external dependency was updated (e.g.
Development.lyx: Spellchecker + special char corrections.
2015-12-02 12:55:38 +00:00
\SpecialChar TeX
Live).
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 06:24:20 +00:00
\end_layout
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-30 02:48:28 +00:00
\begin_layout Enumerate
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 06:24:20 +00:00
A recent code change introduced a bug.
\end_layout
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-30 02:48:28 +00:00
\begin_layout Enumerate
\begin_inset CommandInset label
LatexCommand label
name "enu:exposed"
\end_inset
Small fixes to export test documentation.
2015-11-27 09:33:12 +00:00
A change in a document exposed a previously unknown bug or an incompatibility
with an export format (e.g.
Development.lyx: Spellchecker + special char corrections.
2015-12-02 12:55:38 +00:00
Lua\SpecialChar LaTeX
).
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-30 02:48:28 +00:00
\end_layout
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 06:24:20 +00:00
\begin_layout Standard
Because the .lyx files are exported in several formats, it is not surprising
that many of the exports fail.
This expectation of failure is addressed by
\begin_inset Quotes eld
\end_inset
inverting
\begin_inset Quotes erd
\end_inset
the tests, that is, by marking the test as
\begin_inset Quotes eld
\end_inset
passing
\begin_inset Quotes erd
\end_inset
if the export exits with error and as
\begin_inset Quotes eld
\end_inset
failing
\begin_inset Quotes erd
\end_inset
if the export succeeds
\emph on
.
\emph default
It follows that these expected failures will not show up as failed tests
in the test results and thus will not pollute the
\begin_inset Quotes eld
\end_inset
good
\begin_inset Quotes erd
\end_inset
tests.
If the export actually succeeds, then the test will fail.
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-30 02:48:28 +00:00
The purpose of this failure is to get your attention—something has changed,
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 06:24:20 +00:00
possibly for the better.
\end_layout
\begin_layout Standard
We try to document why a test is inverted or ignored.
See the comment (prefixed with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
#
\end_layout
\end_inset
) above the block in which the test is listed as inverted or ignored in
the files
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Development.lyx: Reflect recent label renaming of 'reverted' to 'inverted'
2015-12-04 20:56:31 +00:00
development/autotests/suspiciousTests
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 06:24:20 +00:00
\end_layout
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\end_inset
,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
development/autotests/unreliableTests
\end_layout
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 06:24:20 +00:00
\end_inset
and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
development/autotests/ignoredTests
\end_layout
\end_inset
.
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
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-30 02:48:28 +00:00
\end_layout
\begin_layout Standard
A good question is why do we enable the tests for non-default formats? The
answer is that if a non-default route is broken it is often because a bug
was introduced in LyX and not because a document-specific change was made
that is not supported by the route.
In other words, there is a high signal/noise ratio in the export tests
Small fixes to export test documentation.
2015-11-27 09:33:12 +00:00
for some non-default formats.
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-30 02:48:28 +00:00
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 06:24:20 +00:00
\end_layout
\begin_layout Standard
When a test or several tests fail, consider checking the files in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Testing/Temporary/
\end_layout
\end_inset
subdirectory of your build directory.
In this subdirectory are three files: the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
LastTestsFailed.log
\end_layout
\end_inset
simply lists the tests that failed on your last
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest
\end_layout
\end_inset
command; the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
LastTest.log
\end_layout
\end_inset
file contains the output from the tests (and often has details explaining
why a test failed); and the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
CTestCostData.txt
\end_layout
\end_inset
file lists the times that it took to run the tests.
\end_layout
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_layout Paragraph
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
What action should you take if a test fails?
\end_layout
\begin_layout Standard
\paragraph_spacing single
It is always good to check manually why something fails and if it passes
if the PDF output is good.
\end_layout
\begin_layout Itemize
Generally, if a change breaks compilation for the target format (for the
manuals pdf2) without solving some important other issue,
\emph on
fix or revert the commit
\emph default
that led to failure.
\end_layout
\begin_layout Itemize
If it is not possible to (immediately) fix the failure but there are reasons
not to revert the commit (e.g.
it fixes another more important issue),
\emph on
invert
\emph default
the failing test case (see
\begin_inset CommandInset ref
LatexCommand ref
reference "par:Inverted-tests"
\end_inset
).
\end_layout
\begin_layout Itemize
If an
\emph on
inverted
\emph default
test case fails because the export now works,
\emph on
uninvert
\emph default
the test by removing the labeling pattern from
\begin_inset Quotes eld
\end_inset
suspiciousTests
\begin_inset Quotes erd
\end_inset
) (see
\begin_inset CommandInset ref
LatexCommand ref
reference "par:Inverted-tests"
\end_inset
).
\end_layout
\begin_layout Itemize
If the export did not fail previously but led to wrong output (PDF, say),
it is in fact an improvement when the test now fails, label it as
\begin_inset Quotes eld
\end_inset
minor edit of development guide
2016-09-06 14:44:36 +00:00
unreliable:wrong_output
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\begin_inset Quotes erd
\end_inset
(
\begin_inset CommandInset ref
LatexCommand ref
reference "par:Unreliable-tests"
\end_inset
).
\end_layout
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
\begin_layout Itemize
In case of tests failing due to missing requirements (when only a subset
of TeXLive is installed or a test labeled
\begin_inset Quotes eld
\end_inset
unreliable:nonstandard
\begin_inset Quotes erd
\end_inset
fails), ignore the failure, ask for someone else to run the test, or install
the missing ressources and try again.
\end_layout
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\begin_layout Paragraph
\begin_inset CommandInset label
LatexCommand label
name "par:Inverted-tests"
\end_inset
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
Inverted tests
Update Development.lyx to include 'suspended' cmake tests.
2015-11-04 12:06:14 +00:00
\end_layout
\begin_layout Standard
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
Test cases whose name matches a pattern in the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
development/autotests/suspiciousTests
\end_layout
\end_inset
get the label
Minor ctest documentation edits. Make sure not to confuse failing test and failing export for inverted tests.
2016-01-02 21:31:14 +00:00
\emph on
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
inverted
Minor ctest documentation edits. Make sure not to confuse failing test and failing export for inverted tests.
2016-01-02 21:31:14 +00:00
\emph default
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
.
They get also the test property
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
WILL_FAIL
\end_layout
\end_inset
, i.e.
they are reported as failing if the export works without error
\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
https://cmake.org/cmake/help/v3.0/command/set_tests_properties.html
\end_layout
\end_inset
.
\end_layout
\begin_layout Standard
Add failing cases to this file, if they cannot be solved
\begin_inset Quotes eld
\end_inset
immediately
\begin_inset Quotes erd
\end_inset
but it is expected that the export will work in a foreseeable future, e.g.
low priority issues like failures to export to a non-target format (for
the manuals everything except pdf2).
\end_layout
\begin_layout Standard
The following sublabels are currently present in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
suspiciousTests
\end_layout
\end_inset
:
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\end_layout
\begin_layout Description
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
todo test failures that require attention:
\end_layout
\begin_deeper
\begin_layout Itemize
minor issues to explore and properly sort later,
\end_layout
\begin_layout Itemize
easyfix issues,
\end_layout
\begin_layout Itemize
LyX bugs to report at trac (move pattern to section "lyxbugs" once done).
\end_layout
\end_deeper
\begin_layout Description
lyxbugs LyX bugs with a Trac number.
\end_layout
\begin_layout Description
ert Export failures due to "raw" LaTeX use in ERT or preamble code.
\end_layout
\begin_deeper
\begin_layout Standard
"Wontfix" if demonstrating correct use and OK in the default output format.
\end_layout
\end_deeper
\begin_layout Description
texissues Export fails due to LaTeX limitations like non-ASCII characters
in verbatim or listings, incompatible packages, ...
\end_layout
\begin_deeper
\begin_layout Standard
"Wontfix" if documents demonstrate correct use in the default output format:
\end_layout
\begin_layout Itemize
If the source can be made more robust without becoming "hackish", fix the
source,
\end_layout
\begin_layout Itemize
if LyX could be enhanced to care for a permanent TeX limitation, file a
ticket at trac and add a pattern under lyxbugs,
\end_layout
\begin_layout Itemize
otherwise, add a pattern here.
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\end_layout
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\end_deeper
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\begin_layout Description
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
attic Documents in the attic.
(Kept for reference and format conversion test.)
\end_layout
\begin_layout Subparagraph
suspended
\end_layout
\begin_layout Standard
Test cases whose name additionally matches a pattern in the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
development/autotests/suspendedTests
\end_layout
\end_inset
get the label
\emph on
suspended
\emph default
(instead of
\emph on
export
\emph default
and
\emph on
inverted
\emph default
).
This means they are not executed using
Update Development.lyx to include 'suspended' cmake tests.
2015-11-04 12:06:14 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest -L export
\end_layout
\end_inset
or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Development.lyx: Reflect recent label renaming of 'reverted' to 'inverted'
2015-12-04 20:56:31 +00:00
ctest -L inverted
Update Development.lyx to include 'suspended' cmake tests.
2015-11-04 12:06:14 +00:00
\end_layout
\end_inset
.
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
However, they also get the test property
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
WILL_FAIL
\end_layout
\end_inset
, i.e.
they are reported as failing if the export works without error.
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
From time to time they still have to be checked using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest -L suspended
Update Development.lyx to include 'suspended' cmake tests.
2015-11-04 12:06:14 +00:00
\end_layout
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\end_inset
.
\end_layout
Update Development.lyx to include 'suspended' cmake tests.
2015-11-04 12:06:14 +00:00
\begin_layout Standard
Minor ctest documentation edits. Make sure not to confuse failing test and failing export for inverted tests.
2016-01-02 21:31:14 +00:00
These tests are suspended, because the export fails for known reasons which
cannot ATM be resolved.
Update Development.lyx to include 'suspended' cmake tests.
2015-11-04 12:06:14 +00:00
But it is expected the reason might disappear in the future.
Be it new TL or better handling in \SpecialChar LyX
.
\end_layout
\begin_layout Standard
For ctest commands without the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-L
\end_layout
\end_inset
parameter nothing changes.
Typo
2016-01-18 09:59:35 +00:00
Suspended or not, tests will be executed depending only on the selecting
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
regular expression given to the ctest command (see
\begin_inset CommandInset ref
LatexCommand ref
reference "par:ctest-options"
\end_inset
).
Update Development.lyx to include 'suspended' cmake tests.
2015-11-04 12:06:14 +00:00
\end_layout
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_layout Paragraph
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\begin_inset CommandInset label
LatexCommand label
name "par:Unreliable-tests"
\end_inset
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
Unreliable tests
\end_layout
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\begin_layout Standard
Test cases whose name matches a pattern in the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
development/autotests/unreliableTests
\end_layout
\end_inset
get the label
\emph on
unreliable
\emph default
.
\end_layout
minor autotest documentation update
2015-12-18 16:38:27 +00:00
\begin_layout Standard
These tests are not executed using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest -L export
\end_layout
\end_inset
or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest -L inverted
\end_layout
\end_inset
.
\end_layout
\begin_layout Standard
They pass or fail for various reasons not related to LyX (nonstandard, erratic)
or pass but should rather fail (wrong output).
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\begin_inset Note Note
status collapsed
\begin_layout Plain Layout
*invalid* tests (wrong output) are not *unreliable*.
# Use "unfit" or "unapplicable" as better label and name of pattern file?
\end_layout
\end_inset
minor autotest documentation update
2015-12-18 16:38:27 +00:00
\end_layout
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\begin_layout Description
minor autotest documentation update
2015-12-18 16:38:27 +00:00
nonstandard Documents with additional requirements, e.g.
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
a class or package file not in TeXLive.
minor autotest documentation update
2015-12-18 16:38:27 +00:00
\begin_inset Note Note
status open
\begin_layout Plain Layout
TODO: rename to "extra"?
\end_layout
\end_inset
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\end_layout
\begin_deeper
\begin_layout Standard
These tests are labeled as
\family typewriter
'nonstandard'.
\end_layout
\end_deeper
\begin_layout Description
minor autotest documentation update
2015-12-18 16:38:27 +00:00
erratic Tests depending on local configuration, OS, TeX distribution, package
versions, or the phase of the moon.
\begin_inset Note Note
status open
\begin_layout Plain Layout
TODO: use
\emph on
erratic
\emph default
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
only for the phase-of-moon dependency?
minor autotest documentation update
2015-12-18 16:38:27 +00:00
\end_layout
Small fixes to export test documentation.
2015-11-27 09:33:12 +00:00
\end_inset
minor autotest documentation update
2015-12-18 16:38:27 +00:00
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\end_layout
\begin_deeper
\begin_layout Standard
These tests are labeled as
\family typewriter
'erratic'.
\end_layout
minor autotest documentation update
2015-12-18 16:38:27 +00:00
\end_deeper
\begin_layout Description
wrong
\begin_inset space ~
\end_inset
output Export does not fail but the resulting document has errors.
\end_layout
\begin_deeper
\begin_layout Standard
\paragraph_spacing single
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\begin_inset Note Note
status open
\begin_layout Plain Layout
\paragraph_spacing single
minor autotest documentation update
2015-12-18 16:38:27 +00:00
These tests are actually not
\emph on
unreliable
\emph default
but
\emph on
invalid
\emph default
(not measuring what they should measure).
\end_layout
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\end_inset
\end_layout
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\end_deeper
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_layout Paragraph
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\begin_inset CommandInset label
LatexCommand label
name "par:Export-test-filtering"
\end_inset
Development.lyx: try to describe label assignment.
2015-11-29 01:37:11 +00:00
Export test filtering
\end_layout
\begin_layout Standard
Minor ctest documentation edits. Make sure not to confuse failing test and failing export for inverted tests.
2016-01-02 21:31:14 +00:00
The assignment of a label to a test is controlled by a set of files with
regular expressions that are matched against the test names.
Development.lyx: try to describe label assignment.
2015-11-29 01:37:11 +00:00
\end_layout
\begin_layout Description
ctest automatic tests: small correcions to pattern files and documenation.
2015-12-06 20:21:46 +00:00
ignoredTests (small file)
Development.lyx: try to describe label assignment.
2015-11-29 01:37:11 +00:00
\begin_inset Newline newline
\end_inset
Minor ctest documentation edits. Make sure not to confuse failing test and failing export for inverted tests.
2016-01-02 21:31:14 +00:00
Tests selected here are withdrawn in the configuration step (cf.
\begin_inset CommandInset ref
LatexCommand ref
reference "par:Configuring-ctests"
\end_inset
).
Development.lyx: try to describe label assignment.
2015-11-29 01:37:11 +00:00
\end_layout
\begin_deeper
\begin_layout Labeling
\labelwidthstring 00.00.0000
Input Test of any export combination
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
Output Stop if tests not selected here
\end_layout
\end_deeper
\begin_layout Description
Minor tweaks to Development.lyx These small tweaks amend de1c8253.
2015-11-29 02:17:15 +00:00
unreliableTests: Tests selected either pass or fail, but that is dependent
on the system where the test is run.
Development.lyx: try to describe label assignment.
2015-11-29 01:37:11 +00:00
Selected tests gain the label 'unreliable'.
\end_layout
\begin_deeper
\begin_layout Labeling
\labelwidthstring 00.00.0000
Input Each test which passed 'ignoredTests'
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
Output Stop if test selected, gain label 'unreliable'.
\end_layout
\end_deeper
\begin_layout Description
suspiciousTests
\begin_inset space \space{}
\end_inset
\end_layout
\begin_deeper
\begin_layout Labeling
\labelwidthstring 00.00.0000
Input Each test which passed 'unreliableTests'
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
Output Stop if not selected.
\end_layout
\begin_layout Standard
The following file is meant as subselections of 'suspiciousTests'.
Development.lyx: Reflect recent label renaming of 'reverted' to 'inverted'
2015-12-04 20:56:31 +00:00
If neither subselection applies, test gains labels 'export' and 'inverted'
Development.lyx: try to describe label assignment.
2015-11-29 01:37:11 +00:00
\end_layout
\begin_layout Description
suspendedTests Tests selected here gain the label 'suspended' but _not_
Development.lyx: Reflect recent label renaming of 'reverted' to 'inverted'
2015-12-04 20:56:31 +00:00
'export' or 'inverted', although in ctest they remain inverted.
('ctest' knows only 'inverted' or not, labels are used only for test selection)
Development.lyx: try to describe label assignment.
2015-11-29 01:37:11 +00:00
\end_layout
\begin_deeper
\begin_layout Labeling
\labelwidthstring 00.00.0000
Input Each test selected by 'suspiciousTests'
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
Output Selected test gains label 'suspended'.
\end_layout
\end_deeper
\end_deeper
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_layout Standard
The following table may clarify label assignement
\end_layout
\begin_layout Standard
\begin_inset Tabular
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
<lyxtabular version="3" rows="7" columns="12">
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
<features tabularvalignment="middle">
<column alignment="left" valignment="top" width="0pt">
<column alignment="left" valignment="top" width="0pt">
<column alignment="left" valignment="top" width="0pt">
<column alignment="left" valignment="top" width="0pt">
<column alignment="center" valignment="top">
<column alignment="center" valignment="top">
<column alignment="center" valignment="top">
<column alignment="center" valignment="top">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
<column alignment="center" valignment="top">
<column alignment="center" valignment="top">
<column alignment="center" valignment="top">
<column alignment="center" valignment="top">
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
<row>
<cell multicolumn="1" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
Test found in file:
\end_layout
\end_inset
</cell>
<cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
Marked in ctest, Assigned label
\end_layout
\end_inset
</cell>
<cell multicolumn="2" alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\end_layout
\end_inset
</cell>
<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\end_inset
</cell>
<cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\end_inset
</cell>
</row>
<row>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
Ignored
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
Unreliable
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
Suspicious
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
Suspended
\end_layout
\end_inset
</cell>
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_inset Text
\begin_layout Plain Layout
export
\end_layout
\end_inset
</cell>
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
<cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_inset Text
\begin_layout Plain Layout
unreliable
\end_layout
\end_inset
</cell>
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
<cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_inset Text
\begin_layout Plain Layout
Development.lyx: Reflect recent label renaming of 'reverted' to 'inverted'
2015-12-04 20:56:31 +00:00
inverted
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\end_layout
\end_inset
</cell>
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
<cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_inset Text
\begin_layout Plain Layout
suspended
\end_layout
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\end_inset
</cell>
<cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\end_inset
</cell>
</row>
<row>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
Yes
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
</row>
<row>
<cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
No
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
Yes
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_layout Plain Layout
+
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
<cell alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
</row>
<row>
<cell multirow="4" alignment="left" valignment="middle" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
No
\end_layout
\end_inset
</cell>
<cell multirow="3" alignment="left" valignment="middle" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
Yes
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
Yes
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
+
\end_layout
\end_inset
</cell>
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
<cell alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_inset Text
\begin_layout Plain Layout
+
\end_layout
\end_inset
</cell>
</row>
<row>
<cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
No
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_layout Plain Layout
+
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
+
\end_layout
\end_inset
</cell>
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
<cell alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
+
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
</row>
<row>
<cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
No
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
\begin_inset Text
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_layout Plain Layout
+
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
<cell alignment="center" valignment="top" topline="true" bottomline="true" rightline="true" usebox="none">
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
</row>
</lyxtabular>
\end_inset
\end_layout
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_layout Subsubsection
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 06:24:20 +00:00
check_load tests
\end_layout
\begin_layout Standard
These tests check whether a .lyx file loads without any terminal messages.
They correspond to the manual operations of simply opening a .lyx file on
the terminal, exiting LyX once the file is loaded, and then checking whether
there is any output from the terminal.
These tests are useful for catching malformed .lyx files and parsing bugs.
They can also be used to find a .lyx file in which an instance of something
happens.
To do this, compile LyX with a local patch that outputs something to the
terminal when an instance is found, and then run the check_load tests to
see if any fail, which would mean that the situation occurs in the LyX
documentation files corresponding to the failed tests.
These tests are expectedly fragile: any LyX diagnostic message, which is
not necessarily an error, would cause the tests to fail.
Similarly, any message output by a library (e.g.
Qt) would also cause failure.
There are some messages that the check_load tests are instructed to ignore,
which are stored in the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
development/autotests/filterCheckWarnings
\end_layout
\end_inset
.
\end_layout
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\begin_layout Standard
Under cmake, the tests are labeled as 'load'.
\end_layout
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\begin_layout Subsubsection
Keytests
\end_layout
\begin_layout Standard
Add CMake flag for keytests and disable by default The keytests were previously enabled by default if the necessary dependencies were found. They require a GUI and mouse so can sometimes be annoying. Further, they are not currently reliable. They are thus now disabled by default.
2016-07-13 08:51:58 +00:00
Automated tests based on the "MonKey Testing" keytest program are enabled
if the necessary dependencies are found and if the CMake flag
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DLYX_ENABLE_KEYTESTS=ON
\end_layout
\end_inset
is used.
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
They are documented in the README document in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
development/autotests
\end_layout
\end_inset
subfolder of the \SpecialChar LyX
source code distribution.
\end_layout
Add description of lyx21 tests These tests were added at e3cd6db4.
2015-12-27 04:51:13 +00:00
\begin_layout Subsubsection
lyx21 tests
\end_layout
\begin_layout Standard
These tests combine lyx2lyx tests with check_load tests.
They fail if either fails.
\end_layout
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_layout Subsubsection
URL tests
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 06:24:20 +00:00
\end_layout
\begin_layout Standard
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-30 02:11:11 +00:00
The URL tests are enabled with the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DLYX_ENABLE_URLTESTS=ON
\end_layout
\end_inset
CMake flag and are useful for finding broken links in our documentation
files.
If a URL test fails, to see which link in particular was reported as broken,
see the output in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
LastTest.log
\end_layout
\end_inset
.
These tests are extremely fragile (e.g.
a test can depend on your Internet connection) and a failed URL test should
not be taken too seriously.
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
URL tests are labeled as
\family typewriter
'url'.
\end_layout
Restructure test documentation. Use separate subsections for our 3 main test suites: unit tests, tex2lyx (functional) tests, and "autotests" (requiring cmake).
2015-12-02 07:54:24 +00:00
\begin_layout Paragraph
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
Running URL tests
\end_layout
\begin_layout Standard
cmake is required to run the \SpecialChar LyX
tests, running them is not implemented for
autotools.
\end_layout
\begin_layout Standard
The appropriate commands are:
\end_layout
\begin_layout Itemize
\family typewriter
ctest -L url
\family default
\begin_inset Newline newline
\end_inset
Typo
2015-12-18 17:55:05 +00:00
runs all tests with label
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\family typewriter
'url'
\end_layout
\begin_layout Itemize
\family typewriter
ctest -R 'check_.*urls'
\family default
\begin_inset Newline newline
\end_inset
Typo
2015-12-18 17:55:05 +00:00
runs the tests 'check_accessible_urls'
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\end_layout
\begin_layout Standard
Associated test results can be examined in ctest-log directory in files
of the form 'LastFailed.*URLS.log'
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Section
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 21:29:20 +00:00
Development policies
\end_layout
\begin_layout Standard
This chapter lists some guidelines that should be followed.
This list is not complete, and many guidelines are in separate chapters,
such as
\begin_inset Quotes eld
\end_inset
When is an update of the .lyx file format number needed?
\begin_inset Quotes erd
\end_inset
in Section
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:When-is-an"
\end_inset
.
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Subsection
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 21:29:20 +00:00
When to set a fixed milestone?
\end_layout
\begin_layout Standard
Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following
holds:
\end_layout
\begin_layout Enumerate
Somebody is actively working on a fix.
\end_layout
\begin_layout Enumerate
The bug is so severe that it would block the release if it is not fixed.
\end_layout
\begin_layout Standard
If a bug is important, but nobody is working on it, and it is no showstopper,
use a milestone like 2.1.x or 2.2.x.
For all other bugs, do not set a milestone at all.
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Subsection
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 21:29:20 +00:00
Can we add rc entries in stable branch?
\end_layout
\begin_layout Standard
No.
We are supposed to increase the prefs2prefs version number with such things.
\end_layout
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\begin_layout Section
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
Documentation policies
\end_layout
\begin_layout Standard
The main documentation consists of these files:
\end_layout
\begin_layout Description
splash.lyx it is the first file you see after an installation.
We assume that a new user sees this.
It is therefore designed to be as simple as possible.
Therefore please don't add any new formatting, only fix typos etc.
Update format
2015-10-28 22:10:09 +00:00
Splash.lyx is up to date for \SpecialChar LyX
2.1.x, currently maintained by Uwe Stöhr.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
\end_layout
\begin_layout Description
Update format
2015-10-28 22:10:09 +00:00
Intro.lyx This is the manual new users will read to learn \SpecialChar LyX
.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
It therefore uses a limited set of formatting.
For example a standard document class.
Since new users will first learn about the formatting possibilities of
Update format
2015-10-28 22:10:09 +00:00
\SpecialChar LyX
please keep this file that simple.
Intro.lyx is up to date for \SpecialChar LyX
2.1.x, currently maintained by Uwe Stöhr.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
\end_layout
\begin_layout Description
Tutorial.lyx our tutorial.
It must be always up to date.
Normally there is nothing to add since we don't want to overwhelm new users
with too much details.
Update format
2015-10-28 22:10:09 +00:00
The will learn these details while using \SpecialChar LyX
and we have special manuals.
Tutorial.lyx is up to date for \SpecialChar LyX
2.1.x, currently maintained by Uwe Stöhr.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
\end_layout
\begin_layout Description
UserGuide.lyx our main user guide.
It covers a mixture of basic and detailed information.
Some information is also in the Math and EmbeddedObjects manual so that
the UserGuide refers to these files.
Update format
2015-10-28 22:10:09 +00:00
UserGuide.lyx is up to date for \SpecialChar LyX
2.1.x, currently maintained by Uwe Stöhr.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
\end_layout
\begin_layout Description
EmbeddedObjects.lyx a special manual to explain things like tables floats
boxes etc.
in all detail.
Update format
2015-10-28 22:10:09 +00:00
EmbeddedObjects.lyx is up to date for \SpecialChar LyX
2.1.x, currently maintained by Uwe
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
Stöhr.
\end_layout
\begin_layout Description
Math.lyx a special manual to explain everything regarding math in all detail.
Update format
2015-10-28 22:10:09 +00:00
Math.lyx is up to date for \SpecialChar LyX
2.1.x, currently maintained by Uwe Stöhr.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
\end_layout
\begin_layout Description
Additional.lyx this manual covers information that would be too much detail
for the UserGuide or would make the UserGuide uncompilable or only compilable
Update format
2015-10-28 22:10:09 +00:00
when installing a lot of special \SpecialChar LaTeX
-packages.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
What should be in the UserGuide or better in Additional is a matter of
taste.
it is up to you to decide that.
Update format
2015-10-28 22:10:09 +00:00
Additional.lyx is not completely up to date for \SpecialChar LyX
2.1.x.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
Only chapter
\begin_inset space ~
\end_inset
8 is up to date and currently maintained by Uwe Stöhr.
It certainly needs a rewrite and update.
For example many info in chapter
\begin_inset space ~
\end_inset
2 and 3 are already covered by the UserGuide and/or the EmbeddedObjects
manual.
\end_layout
\begin_layout Description
Update format
2015-10-28 22:10:09 +00:00
Customization.lyx this manual covers information how to customize \SpecialChar LyX
for certain
output formats, operating systems, languages etc.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
It is currently completely out of date and needs a major rewrite and update.
If you do this please assure that your information are given for all OSes
Update format
2015-10-28 22:10:09 +00:00
and \SpecialChar LaTeX
distributions (meaning be as objective as possible).
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
\end_layout
\begin_layout Standard
There are only 4
\begin_inset space ~
\end_inset
rules in editing the docs:
\end_layout
\begin_layout Enumerate
If you are not the maintainer of a doc file or a chapter/section, you MUST
use change tracking so that the maintainer could review your changes
\end_layout
\begin_layout Enumerate
Respect the formatting of the document.
The different files use different formatting styles.
minor edit of development guide
2016-09-06 14:44:36 +00:00
That is OK and has historic reasons nobody fully knows ;-).
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
But it is important to be consistent within one file.
\end_layout
\begin_layout Enumerate
All changes you make to a file in one language MUST also go the file in
the other actively maintained languages.
Normally the maintainer does this for you, if you are the maintainer, you
must do this by copying or changing the changed or added text to the other
files so that the translators sees the blue underlined text and know what
they have to translate and what was changed.
\end_layout
\begin_layout Enumerate
You MUST assure that the document is compilable as
\begin_inset Quotes eld
\end_inset
PDF (pdflatex)
\begin_inset Quotes erd
\end_inset
after your changes.
\end_layout
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 15:59:26 +00:00
\end_body
\end_document
Reference in New Issue Copy Permalink