anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2024-12-15 01:41:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
d44b5671ea
lyx_mirror/lib/doc/Development.lyx

7867 lines
142 KiB
Plaintext
Raw Normal View History

Rename legacy input encoding settings. Format incremented to 573
2019-04-16 18:17:32 +00:00
#LyX 2.4 created this file. For more info see https://www.lyx.org/
Update docs
2024-01-11 16:06:40 +00:00
\lyxformat 620
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
remove buildlyxdir again per request
2019-03-25 15:32:27 +00:00
\origin /systemlyxdir/doc/
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\textclass scrbook
Development.lyx: remove unused preamble code and modules
2015-11-09 23:39:54 +00:00
\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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\maintain_unincluded_children no
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
\language english
\language_package default
Use utf8 as inputenc for documentation, examples, and templates.
2019-05-08 17:59:57 +00:00
\inputencoding utf8
Rename legacy input encoding settings. Format incremented to 573
2019-04-16 18:17:32 +00:00
\fontencoding auto
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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\font_roman_osf false
\font_sans_osf false
\font_typewriter_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
Development.lyx, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
\use_microtype false
Update docs to 2.3.0alpha1 format
2017-04-24 04:03:19 +00:00
\use_dash_ligatures 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
\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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\float_placement class
\float_alignment class
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
\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"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\papersize a4
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_geometry false
\use_package amsmath 1
\use_package amssymb 1
Turn 'Do not load' math option to 'Automatic' (ticket 10661)
2017-10-19 12:47:51 +00:00
\use_package cancel 1
\use_package esint 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
\use_package mathdots 1
Turn 'Do not load' math option to 'Automatic' (ticket 10661)
2017-10-19 12:47:51 +00:00
\use_package mathtools 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
\use_package mhchem 1
Turn 'Do not load' math option to 'Automatic' (ticket 10661)
2017-10-19 12:47:51 +00:00
\use_package stackrel 1
\use_package stmaryrd 1
\use_package undertilde 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
\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
doc files: save them with LyX 2.3 - part 1
2017-11-19 00:55:05 +00:00
\use_minted 0
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\use_lineno 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
\notefontcolor #0000ff
\index Index
\shortcut idx
\color #008000
\end_index
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\secnumdepth 4
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\tocdepth 2
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
Update docs to 2.3.0alpha1 format
2017-04-24 04:03:19 +00:00
\is_math_indent 0
Update docs to 2.3.0beta1 format
2017-08-14 06:31:24 +00:00
\math_numbering_side default
Fix typo in Development.lyx
2017-01-09 18:48:32 +00:00
\quotes_style english
\dynamic_quotes 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
\papercolumns 1
\papersides 2
\paperpagestyle headings
Rename legacy input encoding settings. Format incremented to 573
2019-04-16 18:17:32 +00:00
\tablestyle 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
\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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\change_bars false
\postpone_fragile_content 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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\docbook_table_output 0
Remove empty section, re-organize.
2021-03-23 14:53:54 +00:00
\docbook_mathml_prefix 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
\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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
Version 2.4.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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If you have comments on or error corrections to this documentation,
please send them to the \SpecialChar LyX
Documentation mailing list:
Update Development.lyx
2020-11-11 22:20:46 +00:00
\begin_inset CommandInset href
LatexCommand href
target "lyx-docs@lists.lyx.org"
type "mailto:"
literal "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
\end_inset
Update Development.lyx
2020-11-11 22:20:46 +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
\end_inset
\end_layout
\begin_layout Standard
\begin_inset CommandInset toc
LatexCommand tableofcontents
\end_inset
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Chapter
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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
It is currently rather incomplete,
but will hopefully be extended in the future.
Meanwhile,
additional information can be found 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
\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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
This document is not translated,
since the development language of \SpecialChar LyX
is 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
,
then you don't need to read this manual.
However,
if you want to learn more about how \SpecialChar LyX
is developed,
or even want to participate in \SpecialChar LyX
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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Chapter
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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Several file formats are also described in detail in the regular user documentation.
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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +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
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
When you are working on a new feature you may ask yourself whether it needs an update of the .lyx file format number.
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
Whether an update is needed or not is not always obvious.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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.
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
setting If a certain setting becomes obsolete and gets removed,
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
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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.
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
See
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Backporting-new-styles"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
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_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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
style If a style or inset layout is removed in any layout file or module shipped with \SpecialChar LyX
,
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
However,
Review material on updating layout files to the development docs.
2016-04-03 12:38:09 +00:00
\series bold
new
\series default
layouts and modules do
\series bold
not
\series default
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "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
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If you are still unsure,
please ask on the development 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
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Section
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Once you come to the conclusion that a file format update is needed,
you should use the following procedure to perform the update:
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Implement and test the new feature,
including the reading and writing 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
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
\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
Rename legacy input encoding settings. Format incremented to 573
2019-04-16 18:17:32 +00:00
lib/lyx2lyx/lyx_2_4.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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
g.,
a new header setting always needs a conversion that adds the new setting,
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
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
While the conversion routine is required to produce a document that is equivalent to the old version,
the requirements of the reversion are not that strict.
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 it produces a valid document which can be read by an older \SpecialChar LyX
Update format
2015-10-28 22:10:09 +00:00
.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If absolutely needed,
even data loss is allowed for the reversion.
(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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Since tex2lyx has several implicit file format dependencies caused by sharing 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.
In many cases the tex2lyx update requires only the first and last item of the list below:
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_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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
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
Update the tex2lyx test references as described in
\begin_inset CommandInset ref
LatexCommand formatted
reference "sec:Updating-test-references"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "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
\end_inset
.
\end_layout
\end_deeper
\begin_layout Enumerate
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If you did not implement full tex2lyx support for the new feature,
add a line to
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/tex2lyx/TODO.txt
\end_layout
\end_inset
describing the missing bits.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
are still output as ERT 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
Rename legacy input encoding settings. Format incremented to 573
2019-04-16 18:17:32 +00:00
Test samples are collected under the corresponding subdirectories of
\family typewriter
/autotests
\family default
.
Add suggestion for test cases by Günter
2015-10-22 20:21:25 +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 Enumerate
\begin_inset CommandInset label
LatexCommand label
name "enu:updatefiles"
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Test your lyx2lyx code by updating 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 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
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
git commit -a
\end_layout
\end_inset
).
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Then run the following command in the root folder of the source:
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
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
.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If anything looks surprising,
please investigate.
Document the automatic generation of LFUNs.lyx (51d4036d)
2016-01-27 17:39:56 +00:00
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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.
Development.lyx: Updates - the range of file format does no longer need to be updated - mention rule 6 of the documentation policies
2016-10-16 12:52:46 +00:00
\begin_inset Newline newline
\end_inset
\begin_inset Note Greyedout
status open
\begin_layout Plain Layout
\series bold
Note:
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Development.lyx: Updates - the range of file format does no longer need to be updated - mention rule 6 of the documentation policies
2016-10-16 12:52:46 +00:00
\series default
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Only commit file format changes in the doc files if these files are using the new feature of the new file format.
Development.lyx: Updates - the range of file format does no longer need to be updated - mention rule 6 of the documentation policies
2016-10-16 12:52:46 +00:00
The reason is rule
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "enu:The-fileformat-of"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
Development.lyx: Updates - the range of file format does no longer need to be updated - mention rule 6 of the documentation policies
2016-10-16 12:52:46 +00:00
\end_inset
of the documentation policies described in sec.
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Documentation-policies"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
Development.lyx: Updates - the range of file format does no longer need to be updated - mention rule 6 of the documentation policies
2016-10-16 12:52:46 +00:00
\end_inset
.
\end_layout
\end_inset
\end_layout
\begin_layout Enumerate
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Finally,
commit using
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
git commit -a
\end_layout
\end_inset
.
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Section
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
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"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
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_inset
in section
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:update_lyx_files"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
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_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
Fix typo in Development.lyx
2017-01-09 18:48:32 +00:00
Note that we do not automatically update 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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 \SpecialChar 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 support converting layouts to older layout formats,
as we do for the
Fix typo.
2015-12-08 15:41:22 +00:00
\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
Remove empty section, re-organize.
2021-03-23 14:53:54 +00:00
\begin_layout Section
Backporting new styles to the stable version
\begin_inset CommandInset label
LatexCommand label
name "subsec:Backporting-new-styles"
\end_inset
\end_layout
\begin_layout Standard
Starting with the stable \SpecialChar LyX
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
The basic idea is that the new style definition is automatically copied to the document preamble so that it can even be used by older minor versions that did not yet include the style.
To backport a new style to the stable version,
the following steps are needed:
Remove empty section, re-organize.
2021-03-23 14:53:54 +00:00
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Copy the style definition to the stable version,
but use
Remove empty section, re-organize.
2021-03-23 14:53:54 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ForceLocal 1
\end_layout
\end_inset
instead.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If needed adjust the format to the one used by the stable version (see the customization manual for details of the layout file format).
Remove empty section, re-organize.
2021-03-23 14:53:54 +00:00
\end_layout
\begin_layout Enumerate
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
For each update of the style in a later stable version,
increase the argument of
Remove empty section, re-organize.
2021-03-23 14:53:54 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ForceLocal
\end_layout
\end_inset
by one.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
(In the stable version,
the development version should not be touched.)
Remove empty section, re-organize.
2021-03-23 14:53:54 +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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
Remove empty section, re-organize.
2021-03-23 14:53:54 +00:00
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Section
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
Updating the file format number of bind/ui files
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
A change to the functionality of existing LFUNs can require a conversion of
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
.bind
\end_layout
\end_inset
and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.ui
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
files,
and therefore an increment of the LFUN format,
as well as a conversion of Info insets 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
.lyx
\end_layout
\end_inset
files for manuals.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
The latter cannot be done automatically and also requires an update of the \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
file format.
(Think e.g.
\begin_inset space \space{}
\end_inset
of someone who might have made a set of \SpecialChar LyX
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
teaching manuals for use in their 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
doc, templates and example files: use https for links to lyx.org
2017-12-15 01:53:06 +00:00
https://www.lyx.org/trac/ticket/9794
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
\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"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
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_inset
in section
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:update_lyx_files"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
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_inset
but instead of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
updatedocs.py
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
command,
use this 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
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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
To do so,
increment the \SpecialChar LyX
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
format and proceed as in
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:update_lyx_files"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
,
steps
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:Describe_format"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +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
–
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"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +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
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"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
Development.lyx: intructions for LFUN format increment Document the new policy
2016-01-08 08:01:38 +00:00
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
above,
as well as a corresponding reversion;
for this one can use
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
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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Chapter
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
New layouts and modules
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Section
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: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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
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
See
\begin_inset CommandInset href
LatexCommand href
target "https://wiki.lyx.org/Layouts/Layouts"
Update docs to 2.3.0alpha1 format
2017-04-24 04:03:19 +00:00
literal "false"
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_inset
.
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
In older versions of this document,
it was stated that new layout files require a file format change.
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”"
Amend(4) 9cfa55d2 The gmane entry http://permalink.gmane.org/gmane.editors.lyx.devel/161202 is not accessible.
2024-10-08 16:35:34 +00:00
target "https://www.mail-archive.com/lyx-devel@lists.lyx.org/msg193244.html"
Update docs to 2.3.0alpha1 format
2017-04-24 04:03:19 +00:00
literal "false"
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_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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
This is important for people using different machines,
or exchanging work with colleagues.
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 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
No new LaTeX classes can be supported in a stable version,
and stable versions have a typical lifetime of 2–3 years.
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 Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
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 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,
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
then,
you should do the following:
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 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
,
so that the new layout actually gets installed.
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 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Found:
[InsetInfo]
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
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
,
respectively.
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 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"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
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_inset
).
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Section
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
New modules
\end_layout
\begin_layout Standard
Adding a new module is very similar to adding a new layout.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Therefore,
the previous section applies to new modules as well,
with two exceptions:
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 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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
In that case,
the command for entering the InsetInfo is:
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
info-insert package <name>
\end_layout
\end_inset
\end_layout
\begin_layout Enumerate
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Modules do not need a template,
only an example,
which is strongly encouraged but not necessarily required.
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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Section
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
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Note:
This section is currently only a proposal under discussion.
minor edit of development guide
2016-09-06 14:44:36 +00:00
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Every now and then,
there are changes to LaTeX document classes that break backwards compatibility.
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 collapsed
\begin_layout Plain Layout
Uwe has suggested we implement automatic detection of changes in class files.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.)
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
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
file,
removed \SpecialChar LaTeX
commands,
or both.
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 should this best be handled in \SpecialChar LyX
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
?
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
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
and will continue to work on systems where the old version is still installed.
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 Itemize
With differently named
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
*.cls
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
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 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.)
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 Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
This point was also made here:
http://permalink.gmane.org/gmane.editors.lyx.devel/143798
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
\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"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
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_inset
.
No lyx2lyx conversion is then required when a new major version is released.
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
,
with established methods for handling unsupported styles and other changes.
This way,
no lyx2lyx code is required.
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
The steps to support a new version of an existing document class are thus:
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Create a new layout file including the upstream version in the name (avoid special characters like spaces and dots),
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 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
0.91,
obsolete)}
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
\end_inset
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
To avoid duplicate definitions,
the new layout can
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
Input
\end_layout
\end_inset
the old layout file and add\SpecialChar breakableslash
remove\SpecialChar breakableslash
obsolete\SpecialChar breakableslash
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
modify settings and styles (similar 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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
However,
this should not be done because any changes to the new layout would need undo steps in the importing old 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
\end_layout
\end_deeper
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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).
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_deeper
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
This way,
new documents based on the template or example will use the up-to-date document class 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
\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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Chapter
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Section
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +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
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
.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Each test consists of two 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
\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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
When a test is run,
the actual produced output is compared with the stored reference output.
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 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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +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
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
subfolder of the build directory,
the commands
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
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
(cmake,
all platforms),
Document how to run tests on windows
2015-10-29 21:20:37 +00:00
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Another way to run the tex2lyx tests in the root build directory is to instead use the command
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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest -L '(cmplyx|roundtrip)'
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
,
which runs all tests categorized with the label
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
\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
.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If a test fails,
the differences between the expected and actual results are output in unified diff format.
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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +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
Updating test references
\begin_inset CommandInset label
LatexCommand label
name "sec:Updating-test-references"
\end_inset
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Note that this is a case where a make target in the build directory can affect the source directory,
which might not be advisable.
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
\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
Development.lyx: a MSCV specific update
2016-10-16 13:30:51 +00:00
In the appearing MSVC program assure that you build the
\emph on
Development.lyx: update info how to update the tex2lyx test files
2016-10-27 22:46:59 +00:00
Release
Development.lyx: a MSCV specific update
2016-10-16 13:30:51 +00:00
\emph default
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
version,
then right-click on the project
Development.lyx: describe how to update the tex2lyx references on Windows
2015-11-04 00:15:52 +00:00
\family sans
updatetex2lyxtests
\family default
Development.lyx: update info how to update the tex2lyx test files
2016-10-27 22:46:59 +00:00
in the project explorer and choose then
Development.lyx: describe how to update the tex2lyx references on Windows
2015-11-04 00:15:52 +00:00
\family sans
Development.lyx: update info how to update the tex2lyx test files
2016-10-27 22:46:59 +00:00
Project
\begin_inset space ~
\end_inset
Only\SpecialChar menuseparator
Rebuild
\begin_inset space ~
\end_inset
only
Development.lyx: describe how to update the tex2lyx references on Windows
2015-11-04 00:15:52 +00:00
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
For convenience,
these commands also produce re-exported roundtrip .lyx.tex 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
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 Formula $\Rightarrow$
\end_inset
.lyx
\begin_inset Formula $\Rightarrow$
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
.tex,
and does not compare the produced dvi or pdf output,
it assumes that the stored .lyx reference produces correct output if processed by \SpecialChar LyX
Update format
2015-10-28 22:10:09 +00:00
.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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.
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 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
or directly running lyx2lyx on them.
This would not work,
since lyx2lyx and \SpecialChar LyX
produce slightly different files regarding insignificant whitespace and line breaks.
Add note about updating tex2lyx tests
2015-05-15 19:20:28 +00:00
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +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
Adding a new test
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
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
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Once you confirmed that the tex2lyx output is correct,
add the new files to the corresponding lists 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/tex2lyx/test/runtests.py
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Section
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
(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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +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
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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Nevertheless,
they have caught many regressions and without a better alternative it is important to keep them up-to-date and understand how they work.
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
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 format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
All samples are (after copying and eventual processing by scripts) exported to various output formats via the
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
—
export-to
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
(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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Subsubsection
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
When making a non-trivial change to a .layout file,
run the export and layout tests corresponding with that .layout 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
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
When making non-trivial changes to a .lyx file,
run the export tests corresponding 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
There is an objection from the documentation maintainer that working on the documentation must not be complicated by having to consider non-standard exports.
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
successful compiling/testing an edited documentation file with pdflatex suffices to ensure it can be commited,
not tests with other exports are required.
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
\end_layout
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
copied to a cache dir (autotests/samples/doc/,
say) but not changed,
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
updated regularely (but on a time chosen by the test suite maintainer) from the originals in lib/doc/
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
\end_layout
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
This way,
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
failures with non-default export can be examined and handled accordingly in one run with the cache update,
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
“interesting failures” (like the nested-language+polyglossia problem in es/Customization can be separated and moved into dedicated test samples.
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
\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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
touching the encoding code or package handling code that you expect will 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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If there are differences,
please reconcile these (i.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
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
post the patch on the list and others will run the tests and eventually ask for fixes,
or
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
commit,
but be prepared to fix eventually arising problems or to revert the commit if there is no easy fix.
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If your commit is found to have broken a test,
you should be able to interpret the test results when made aware of them.
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
See Section
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Interpreting-export-tests"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
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
.
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Subsubsection
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\begin_inset CommandInset label
LatexCommand label
name "par:export-test-output-formats"
\end_inset
Output formats
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
The following output formats are currently tested for each sample document (see
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\begin_inset CommandInset ref
LatexCommand ref
reference "par:Export-test-filtering"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
tested:
(or only if set as default output format in the document source)
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\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 format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
text (nor text2,
...,
text4)
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Subsubsection
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
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
).
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Subsubsection
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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
.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
A full,
up-to-date TeXLive installation is recommended to run the tests.
Otherwise,
some tests will fail.
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
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 format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Can also be combined with -R,
-L,
-E,
...
Structure export autotest documentation.
2015-12-09 08:54:25 +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
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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
),
the same subset must be specified when using the
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_inset Flex Code
status collapsed
\begin_layout Plain Layout
\SpecialChar nobreakdash
\SpecialChar nobreakdash
rerun-failed
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
option because it is the test numbers that are used to index which tests failed on the previous run.
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
\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
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Set a global timeout on all tests that do not already have a timeout set on them.
Structure export autotest documentation.
2015-12-09 08:54:25 +00:00
\end_layout
\begin_deeper
\begin_layout Standard
There have been bugs in LyX and in \SpecialChar LaTeX
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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).
If a test times out,
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
ctest
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
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
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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Subsubsection
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
Examples
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
run only the export tests:
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest -L export
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
run inverted tests:
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctest -L "inverted|suspended"
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
list all export tests which match any of the labelling patterns:
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +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
\begin_inset CommandInset label
LatexCommand label
name "subsec:Interpreting-export-tests"
\end_inset
Interpreting the export test results
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
A test can fail for several reasons,
not all of them bad.
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
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Because the .lyx files are exported in several formats,
it is not surprising that many of the exports fail.
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
This expectation of failure is addressed by
\begin_inset Quotes eld
\end_inset
inverting
\begin_inset Quotes erd
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
the tests,
that is,
by marking the test as
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 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
It follows that these expected failures will not show up as failed tests in the test results and thus will not pollute 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 Quotes eld
\end_inset
good
\begin_inset Quotes erd
\end_inset
tests.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If the export actually succeeds,
then the test will fail.
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
) above the block in which the test is listed as inverted or ignored in the files
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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
development/autotests/invertedTests
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
,
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
When a test or several tests fail,
consider checking the files in 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
Testing/Temporary/
\end_layout
\end_inset
subdirectory of your build directory.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
In this subdirectory are three files:
the 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
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
command;
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
LastTest.log
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
file contains the output from the tests (and often has details explaining why a test failed);
and 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
CTestCostData.txt
\end_layout
\end_inset
file lists the times that it took to run the tests.
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Subsubsection
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
It is always good to check manually why something fails and if it passes if the PDF output is good.
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Generally,
if a change breaks compilation for the target format (for the manuals pdf2) without solving some important other issue,
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\emph on
fix or revert the commit
\emph default
that led to failure.
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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),
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\emph on
invert
\emph default
the failing test case (see
\begin_inset CommandInset ref
LatexCommand ref
reference "par:Inverted-tests"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\end_inset
).
\end_layout
\begin_layout Itemize
If an
\emph on
inverted
\emph default
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
test case fails because the export now works,
first confirm that the output of the corresponding export looks good (e.g.,
not garbled text).
Then,
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\emph on
uninvert
\emph default
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
the test by removing the pattern from the
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\begin_inset Quotes eld
\end_inset
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
invertedTests
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\begin_inset Quotes erd
\end_inset
Development.lyx: remove an unmatched parenthesis
2019-01-14 17:36:25 +00:00
file (see
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\begin_inset CommandInset ref
LatexCommand ref
reference "par:Inverted-tests"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\end_inset
).
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If the export did not fail previously but led to wrong output (PDF,
say),
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
ctests: require up-to-date TeX Live for reliable The unreliable sublabel varying_versions is now defined to be about versions other than TeX Live, because we require a full and up-to-date TeX Live installation for reliable tests. For discussion, see: https://www.mail-archive.com/search?l=mid&q=o1ovd9%24479%241%40blaine.gmane.org
2016-12-03 05:35:48 +00:00
Non-failing test with wrong output should be labeled as
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\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"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\end_inset
).
\end_layout
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\end_inset
it is in fact an improvement when the test now fails.
\emph on
Invert
\emph default
the failing test case (see
\begin_inset CommandInset ref
LatexCommand ref
reference "par:Inverted-tests"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
In case of tests failing due to missing requirements (tests labeled
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
\begin_inset Quotes eld
\end_inset
unreliable:nonstandard
\begin_inset Quotes erd
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
or testing on a system with only a subset of TeXLive installed),
ignore the failure,
ask for someone else to run the test,
or install the missing resources and try again.
Cmake export tests: Introduce 'LYX_DEBUG_LATEX' environment variable. Setting this variable to '1' will include also latex messages in ctest log file LastTest.log.
2016-10-12 12:35:23 +00:00
\end_layout
\begin_layout Itemize
Check the log file Testing/Temporary/LastTest.log.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
In case of latex-errors rerun the failing test with environment variable 'LYX_DEBUG_LATEX' set to '1'.
This will include latex messages in LastTest.log,
so it should be easier to interpret the fail-reason.
ctest export tests: document requirements. Add suggestion for policy for "reuse" of documentation files.
2016-02-01 22:56:37 +00:00
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Subsubsection
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
development/autotests/invertedTests
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
,
i.e.
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Add failing cases to this file,
if they cannot be solved
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\begin_inset Quotes eld
\end_inset
immediately
\begin_inset Quotes erd
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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).
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\end_layout
\begin_layout Standard
The following sublabels are currently present in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
invertedTests
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
minor issues to explore and properly sort later,
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
texissues Export fails due to LaTeX limitations like non-ASCII characters in verbatim or listings,
incompatible packages,
...
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\end_layout
\begin_deeper
\begin_layout Standard
"Wontfix" if documents demonstrate correct use in the default output format:
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If the source can be made more robust without becoming "hackish",
fix the source,
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
if LyX could be enhanced to care for a permanent TeX limitation,
file a ticket at trac and add a pattern under lyxbugs,
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
attic Documents in the attic (kept for reference and format conversion test).
Usually
\begin_inset Quotes eld
\end_inset
Wontfix
\begin_inset Quotes erd
\end_inset
.
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Paragraph
Update Development.lyx
2021-01-10 11:27:40 +00:00
Suspended tests
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\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
.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
However,
they also get the test property
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
WILL_FAIL
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
,
i.e.
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Suspended or not,
tests will be executed depending only on the selecting regular expression given to the ctest command (see
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\begin_inset CommandInset ref
LatexCommand ref
reference "par:ctest-options"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
ctest autotest documentation update
2016-01-18 09:25:23 +00:00
\end_inset
).
Update Development.lyx to include 'suspended' cmake tests.
2015-11-04 12:06:14 +00:00
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Subsubsection
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\begin_layout Standard
The following sublabels are currently present in
\begin_inset Flex Code
status collapsed
minor autotest documentation update
2015-12-18 16:38:27 +00:00
\begin_layout Plain Layout
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
unreliableTests
minor autotest documentation update
2015-12-18 16:38:27 +00:00
\end_layout
\end_inset
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
:
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\end_layout
\begin_layout Description
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nonstandard Documents with additional requirements,
e.g.
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
TODO:
rename to
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\begin_inset Quotes eld
\end_inset
extra
\begin_inset Quotes erd
\end_inset
or
\begin_inset Quotes eld
\end_inset
exotic
\begin_inset Quotes erd
\end_inset
?
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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\begin_layout Description
erratic Tests depending on local configuration or the phase of the moon.
\end_layout
\begin_layout Description
ctests: require up-to-date TeX Live for reliable The unreliable sublabel varying_versions is now defined to be about versions other than TeX Live, because we require a full and up-to-date TeX Live installation for reliable tests. For discussion, see: https://www.mail-archive.com/search?l=mid&q=o1ovd9%24479%241%40blaine.gmane.org
2016-12-03 05:35:48 +00:00
varying_versions Tests depending on e.g.
OS or version of a non-TeX-Live dependency.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Note that a full,
up-to-date TeX Live installation is required so this sublabel is about versions of other dependencies.
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\end_layout
minor autotest documentation update
2015-12-18 16:38:27 +00:00
\begin_layout Description
wrong
\begin_inset space ~
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
output Export does not fail but the resulting document has (undetected) errors.
minor autotest documentation update
2015-12-18 16:38:27 +00:00
\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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
These tests are in a strict sense not unreliable but
minor autotest documentation update
2015-12-18 16:38:27 +00:00
\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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Subsubsection
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +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"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
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
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
unreliableTests:
Tests selected pass or fail 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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Output Gain label 'unreliable',
proceed with checking for 'inverted'.
Development.lyx: try to describe label assignment.
2015-11-29 01:37:11 +00:00
\end_layout
\end_deeper
\begin_layout Description
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
invertedTests
Development.lyx: try to describe label assignment.
2015-11-29 01:37:11 +00:00
\begin_inset space \space{}
\end_inset
\end_layout
\begin_deeper
\begin_layout Labeling
\labelwidthstring 00.00.0000
Development.lyx, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
Input Each test which passed 'ignoredTests'
Development.lyx: try to describe label assignment.
2015-11-29 01:37:11 +00:00
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Output Stop if not selected,
gain test-property 'WILL_FAIL' (i.e.
tests are reported as failing if the export works without error.) If no subselection applies,
gain labels 'export' and 'inverted'.
Development.lyx: try to describe label assignment.
2015-11-29 01:37:11 +00:00
\end_layout
\begin_layout Standard
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
The following filter perfoms a subselection of 'invertedTests':
Development.lyx: try to describe label assignment.
2015-11-29 01:37:11 +00:00
\end_layout
\begin_layout Description
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
suspendedTests Tests selected here gain the label 'suspended' but _not_ '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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
Input Each test selected by 'invertedTests'
Development.lyx: try to describe label assignment.
2015-11-29 01:37:11 +00:00
\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
Development.lyx, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
\begin_inset space \hspace{}
\length -3cm
\end_inset
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\begin_inset Tabular
Development.lyx, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
<lyxtabular version="3" rows="6" columns="8">
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
<features tabularvalignment="middle">
Development.lyx, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
<column alignment="left" valignment="top" width="2cm">
<column alignment="left" valignment="top" width="2.5cm">
<column alignment="left" valignment="top" width="2cm">
<column alignment="center" valignment="top" width="2.5cm">
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
<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">
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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
Test matching pattern in file:
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="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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03: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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
Assigned label
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\end_layout
\end_inset
</cell>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell 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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
test property
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
</row>
<row>
<cell alignment="left" valignment="top" topline="true" bottomline="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, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
ignored\SpecialChar softhyphen
Tests
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="left" valignment="top" topline="true" bottomline="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, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
unreliable\SpecialChar softhyphen
Tests
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\begin_inset Text
\begin_layout Plain Layout
Development.lyx, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
inverted\SpecialChar softhyphen
Tests
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\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>
Development.lyx, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
<cell alignment="center" valignment="top" topline="true" bottomline="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, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
suspended\SpecialChar softhyphen
Tests
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell 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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
export
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
suspended
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
</row>
<row>
<cell alignment="left" valignment="top" topline="true" bottomline="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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
Yes
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\begin_inset Text
\begin_layout Plain Layout
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
-
\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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="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
\end_layout
\end_inset
</cell>
Development.lyx, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
<cell alignment="center" valignment="top" topline="true" bottomline="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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
-
\end_layout
\end_inset
</cell>
<cell 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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
-
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="true" rightline="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">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
No
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, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
<cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\begin_inset Text
\begin_layout Plain Layout
Development.lyx, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
If Yes,
\begin_inset Newline newline
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\end_inset
Development.lyx, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
add label
\begin_inset Newline newline
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\end_inset
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
Development.lyx, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
'unreliable'
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\end_layout
\end_inset
</cell>
<cell multirow="3" alignment="left" valignment="middle" 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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\begin_layout Plain Layout
Yes
\end_layout
\end_inset
</cell>
Development.lyx, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\begin_inset Text
\begin_layout Plain Layout
Yes
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\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>
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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
+
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
WILL_FAIL
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>
</row>
<row>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell multirow="4" alignment="left" 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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell multirow="4" alignment="left" 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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
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, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
<cell alignment="center" valignment="top" topline="true" bottomline="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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
No
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 alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\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
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" rightline="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
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\end_inset
</cell>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
WILL_FAIL
\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>
Development.lyx, updated handling of unreliable tests.
2016-11-30 10:47:39 +00:00
<cell alignment="center" valignment="top" topline="true" bottomline="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
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="true" bottomline="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
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="true" bottomline="true" rightline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\begin_inset Text
\begin_layout Plain Layout
-
\end_layout
\end_inset
</cell>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03: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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
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>
</row>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
</lyxtabular>
\end_inset
\end_layout
\begin_layout Standard
\begin_inset Note Note
status open
\begin_layout Plain Layout
Without the
\begin_inset Quotes eld
\end_inset
suspendedTests
\begin_inset Quotes erd
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
filter,
this would be far less complicated:
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\end_layout
\begin_layout Plain Layout
\begin_inset Tabular
<lyxtabular version="3" rows="6" columns="7">
<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="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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell multicolumn="1" alignment="left" 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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
Test matching pattern in file:
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell multicolumn="2" alignment="left" 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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell multicolumn="2" alignment="left" 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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03: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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
Label
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell multicolumn="2" 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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\begin_inset Text
\begin_layout Plain Layout
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell 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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
test property
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
</row>
<row>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\begin_inset Text
\begin_layout Plain Layout
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
ignoredTests
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="left" valignment="top" topline="true" bottomline="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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
unreliableTests
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\begin_inset Text
\begin_layout Plain Layout
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
invertedTests
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
export
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\end_layout
\end_inset
</cell>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
unreliable
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell 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
\end_layout
\end_inset
</cell>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
</row>
<row>
<cell alignment="left" valignment="top" topline="true" bottomline="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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
Yes
\end_layout
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="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 alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
-
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 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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03: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
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\end_layout
\end_inset
</cell>
</row>
<row>
<cell multirow="3" alignment="left" valignment="middle" 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">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
-
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 alignment="center" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
+
\end_layout
\end_inset
</cell>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
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>
</row>
<row>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell multirow="4" alignment="left" valignment="middle" 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
\end_layout
\end_inset
</cell>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell multirow="3" alignment="left" valignment="middle" topline="true" bottomline="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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
No
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="true" bottomline="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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
Yes
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell 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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
+
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="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
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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
<cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03: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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
WILL_FAIL
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
</row>
<row>
<cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\begin_inset Text
\begin_layout Plain Layout
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\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
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
+
Development.lyx: Clarify a bit the difference between assigned label and reversion of ctest result.
2015-12-02 10:02:17 +00:00
\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>
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03: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>
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
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
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>
</row>
</lyxtabular>
\end_inset
ctests: rename pattern file "suspiciousTests" to "invertedTests".
2016-09-16 10:03:17 +00:00
\end_layout
\end_inset
Add a table to clarify how main export test labels are assigned
2015-11-30 12:06:53 +00:00
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Subsection
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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
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
These tests are useful for catching malformed .lyx files and parsing bugs.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
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
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Under cmake,
the tests are labeled as 'load'.
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Subsection
Update/enhance/edit autotest documentation.
2016-01-22 21:42:14 +00:00
Keytests
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Automated tests based on the "MonKey Testing" keytest program are enabled if the necessary dependencies are found and if the CMake flag
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
\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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Subsection
Add description of lyx21 tests These tests were added at e3cd6db4.
2015-12-27 04:51:13 +00:00
lyx21 tests
\end_layout
\begin_layout Standard
These tests combine lyx2lyx tests with check_load tests.
They fail if either fails.
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +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
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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,
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
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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Subsubsection
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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
tests,
running them is not implemented for autotools.
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Associated test results can be examined in ctest-log directory in files of the form 'LastFailed.*URLS.log'
Describe some ctest extras.
2015-11-25 09:18:41 +00:00
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Chapter
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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
This list is not complete,
and many guidelines are in separate chapters,
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
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"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
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
\end_inset
.
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +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
When to set a fixed milestone?
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following holds:
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
\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
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If a bug is important,
but nobody is working on it,
and it is no showstopper,
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
use a milestone like 2.1.x or 2.2.x.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
For all other bugs,
do not set a milestone at all.
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
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +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
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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Chapter
Development.lyx: Updates - the range of file format does no longer need to be updated - mention rule 6 of the documentation policies
2016-10-16 12:52:46 +00:00
\begin_inset CommandInset label
LatexCommand label
name "sec:Documentation-policies"
\end_inset
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
Documentation policies
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Section
Development.lyx: update documentation rules
2016-09-16 21:25:04 +00:00
Rules
\end_layout
\begin_layout Standard
There are 6
\begin_inset space ~
\end_inset
rules in editing the docs:
\end_layout
\begin_layout Enumerate
\begin_inset CommandInset label
LatexCommand label
name "enu:If-you-are"
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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
Development.lyx: update documentation rules
2016-09-16 21:25:04 +00:00
\end_layout
\begin_layout Enumerate
Respect the formatting of the document.
The different files use different formatting styles.
That is OK and has historic reasons nobody fully knows ;-).
But it is important to be consistent within one file.
\end_layout
\begin_layout Enumerate
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
Development.lyx: update documentation rules
2016-09-16 21:25:04 +00:00
\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
Development.lyx: small change from Scott
2016-10-10 00:45:05 +00:00
or the document's default output format after your changes.
Development.lyx: update documentation rules
2016-09-16 21:25:04 +00:00
\end_layout
\begin_layout Enumerate
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
All fixes (typos,
compilation fixes,
updates info etc.) go at first into the current Git branch because the user should benefit from all fixes with every minor release.
Development.lyx: update documentation rules
2016-09-16 21:25:04 +00:00
Feel free to commit directly to branch as long as you follow rule
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "enu:If-you-are"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
Development.lyx: update documentation rules
2016-09-16 21:25:04 +00:00
\end_inset
.
You can immediately commit to master as well.
\end_layout
\begin_layout Enumerate
Development.lyx: Updates - the range of file format does no longer need to be updated - mention rule 6 of the documentation policies
2016-10-16 12:52:46 +00:00
\begin_inset CommandInset label
LatexCommand label
name "enu:The-fileformat-of"
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
The fileformat of a file must not be changed unless you document a new feature in LyX that requires a new fileformat.
The reason for this rule is to keep it easy for the doc maintainers to port/backport changes to from master/branch.
Development.lyx: update documentation rules
2016-09-16 21:25:04 +00:00
\end_layout
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
\begin_layout Standard
The main documentation consists of these files:
\end_layout
\begin_layout Description
Update Development.lyx
2021-01-10 11:27:40 +00:00
Welcome.lyx It is the first file you see after an installation.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
We assume that a new user sees this.
It is therefore designed to be as simple as possible.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Therefore please don't add any new formatting,
only fix typos etc.
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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Since new users will first learn about the formatting possibilities of \SpecialChar LyX
Update format
2015-10-28 22:10:09 +00:00
please keep this file that simple.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
\end_layout
\begin_layout Description
Update Development.lyx
2021-01-10 11:27:40 +00:00
Tutorial.lyx Our tutorial.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
It must be always up to date.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Normally there is nothing to add since we don't want to overwhelm new users with too much details.
Update Development.lyx
2021-01-10 11:27:40 +00:00
They will learn these details while using \SpecialChar LyX
Update format
2015-10-28 22:10:09 +00:00
and we have special manuals.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
\end_layout
\begin_layout Description
Update Development.lyx
2021-01-10 11:27:40 +00:00
UserGuide.lyx Our main user guide.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
It covers a mixture of basic and detailed information.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Some information is also in the Math and EmbeddedObjects manual so that the UserGuide refers to these files.
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 of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
EmbeddedObjects.lyx A special manual to explain things like tables floats boxes etc.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
in all detail.
\end_layout
\begin_layout Description
Update Development.lyx
2021-01-10 11:27:40 +00:00
Math.lyx A special manual to explain everything regarding math in all detail.
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 of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Additional.lyx This manual covers information that would be too much detail for the UserGuide or would make the UserGuide uncompilable or only compilable when installing a lot of special \SpecialChar LaTeX
Update Development.lyx
2021-01-10 11:27:40 +00:00
packages.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
What should be in the UserGuide or better in Additional is a matter of taste.
Update Development.lyx
2021-01-10 11:27:40 +00:00
It is up to you to decide that.
Additional.lyx is not completely up to date (only chapter
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
\begin_inset space ~
\end_inset
Update Development.lyx
2021-01-10 11:27:40 +00:00
8 is up to date).
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
It certainly needs a rewrite and update.
For example many info in chapter
\begin_inset space ~
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
2 and 3 are already covered by the UserGuide and/or the EmbeddedObjects manual.
Development.lyx: add a documentation policy as requested by Scott
2015-02-16 23:12:02 +00:00
\end_layout
\begin_layout Description
Update Development.lyx
2021-01-10 11:27:40 +00:00
Customization.lyx This manual covers information how to customize \SpecialChar LyX
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
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.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If you do this please assure that your information are given for all OSes and \SpecialChar LaTeX
Update format
2015-10-28 22:10:09 +00:00
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
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Chapter
Coding rules
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
The aim of this chapter is to serve as a guide for the developers,
to aid us to get clean and uniform code.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
It is incomplete.
We really like to have new developers joining the \SpecialChar LyX
Project.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
However,
we have had problems in the past with developers leaving the project and their contributed code in a far from perfect state.
Most of this happened before we really became aware of these issues,
but still,
we don't want it to happen again.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
So we have put together some guidelines and rules for the developers.
\end_layout
\begin_layout Section
General
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
These guidelines should save us a lot of work while cleaning up the code and help us to have quality code.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\SpecialChar LyX
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
has been haunted by problems coming from unfinished projects by people who have left the team.
Those problems will hopefully disappear if the code is easy to hand over to somebody else.
In general,
if you want to contribute to the main source,
we expect at least that you:
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
The most important rule first:
KISS (Keep It Simple Stupid),
always use a simple implementation in favor of a more complicated one.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
This eases maintenance a lot.
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Write good C++ code:
readable,
well commented,
and taking advantage of the OO model.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
Follow the formatting guidelines.
See sec.
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Formatting"
plural "false"
caps "false"
noprefix "false"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_inset
.
\end_layout
Bump minimal GCC version to 4.9
2020-11-16 17:35:54 +00:00
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
As of LyX 2.4.0,
you can use features of C++11.
Accordingly you have to use C++11 standard conforming compiler,
e.
Bump minimal GCC version to 4.9
2020-11-16 17:35:54 +00:00
\begin_inset space \thinspace{}
\end_inset
g.
not too dated version of GCC or Clang.
\end_layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_layout Itemize
Update Development.lyx
2020-11-11 22:20:46 +00:00
Adapt the code to the structures already existing in \SpecialChar LyX
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
,
or in the case that you have better ideas,
discuss them on the developer's list before writing the code.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Update Development.lyx
2020-11-11 22:20:46 +00:00
Take advantage of the C++ standard library.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
Especially don't use custom containers when a standard container is usable;
learn to use the algorithms and functors in the standard library.
\end_layout
\begin_layout Itemize
Update Development.lyx
2020-11-11 22:20:46 +00:00
Be aware of exceptions and write exception safe code.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
See sec.
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Exceptions"
plural "false"
caps "false"
noprefix "false"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_inset
.
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Document all variables,
methods,
functions,
classes etc.
We are using the source documentation program doxygen,
a program that handles javadoc syntax,
to document sources.
You can download doxygen from:
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_inset Flex URL
status open
\begin_layout Plain Layout
Approved replace 'http:' urls with 'https:' urls There are still urls without access to their https counterpart left though.
2024-10-17 11:51:53 +00:00
https://www.stack.nl/~dimitri/doxygen/
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
Update Development.lyx
2020-11-11 22:20:46 +00:00
We have certain code constructs that we try to follow.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
See sec.
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Code-constructs"
plural "false"
caps "false"
noprefix "false"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_inset
.
\end_layout
\begin_layout Section
Submitting code
\end_layout
\begin_layout Standard
It is implicitly understood that all patches contributed to The \SpecialChar LyX
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Project is under the Gnu General Public License,
version 2 or later.
If you have a problem with that,
don't contribute code.
Also please don't just pop up out of the blue with a huge patch (or small) that changes something substantial in \SpecialChar LyX
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Always discuss your ideas with the developers on the developer's mailing list.
When you create the patch,
please use
Update Development.lyx
2020-11-11 22:20:46 +00:00
\begin_inset Quotes eld
\end_inset
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\family typewriter
diff -up
\family default
Update Development.lyx
2020-11-11 22:20:46 +00:00
\begin_inset Quotes erd
\end_inset
since we find that a lot easier to read than the other diff formats.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Also please do not send patches that implements or fixes several different things;
several patches is a much better option.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
We also require you to provide a commit message entry with every patch,
this describes in detail what the patch is doing.
\end_layout
\begin_layout Section
Code constructs
\begin_inset CommandInset label
LatexCommand label
name "sec:Code-constructs"
\end_inset
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
We have several guidelines on code constructs,
some of these exist to make the code faster,
others to make the code clearer.
Yet others exist to allow us to take advantage of the strong type checking in C++.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Declaration of variables should wait as long as possible.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
The rule is:
Update Development.lyx
2020-11-11 22:20:46 +00:00
\begin_inset Quotes eld
\end_inset
Don't declare it until you need it.
\begin_inset Quotes erd
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
In C++ there are a lot of user defined types,
and these can very often be expensive to initialize.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
This rule connects to the next rule too.
\end_layout
\begin_layout Itemize
Update Development.lyx
2020-11-11 22:20:46 +00:00
Declare the variable as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
const
\end_layout
\end_inset
if you don't need to change it.
This applies to POD types like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
int
\end_layout
\end_inset
as well as classes.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Make the scope of a variable as small as possible.
\end_layout
\begin_layout Itemize
Make good use of namespaces.
Update Development.lyx
2020-11-11 22:20:46 +00:00
Prefer anonymous namespaces to declaring
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
static
\end_layout
\end_inset
for file scope.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Prefer preincrement to postincrement whenever possible.
\end_layout
\begin_layout Itemize
Preincrement has potential of being faster than postincrement.
Just think about the obvious implementations of pre/post-increment.
This rule applies to decrement too.
\end_layout
\begin_layout Itemize
Use:
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
++T;
\end_layout
\begin_layout Plain Layout
--U;
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Do not use:
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
T++;
// not used in LyX
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
U--;
// not used in LyX
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\end_deeper
\begin_layout Itemize
Try to minimize evaluation of the same code over and over.
This is aimed especially at loops.
\begin_inset Newline newline
\end_inset
Use:
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Container::iterator end = large.end();
\end_layout
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
for (Container::iterator it = large.begin();
it != end;
++it) {
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
...;
\end_layout
\begin_layout Plain Layout
}
\end_layout
\end_inset
Update Development.lyx
2020-11-11 22:20:46 +00:00
\end_layout
\begin_layout Standard
Or better (C++11):
\end_layout
\begin_layout Standard
\begin_inset listings
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
inline false
status open
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
for (auto const & it :
large) {
Update Development.lyx
2020-11-11 22:20:46 +00:00
\end_layout
\begin_layout Plain Layout
...;
\end_layout
\begin_layout Plain Layout
}
\end_layout
\end_inset
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Standard
Do not use:
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
for (Container::iterator it = large.begin();
it != large.end();
++it) {
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
...;
\end_layout
\begin_layout Plain Layout
}
\end_layout
\end_inset
\end_layout
\end_deeper
\begin_layout Itemize
For functions and methods that return a non-POD type
\begin_inset Foot
status open
\begin_layout Plain Layout
Plain Ol' Data type
\end_layout
\end_inset
Update Development.lyx
2020-11-11 22:20:46 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
T
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
,
return
Update Development.lyx
2020-11-11 22:20:46 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
T const
\end_layout
\end_inset
instead.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
This gives better type checking,
and will give a compiler warning when temporaries are used wrongly.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Standard
Use:
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update Development.lyx
2020-11-11 22:20:46 +00:00
T const add(...);
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Do not use:
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update Development.lyx
2020-11-11 22:20:46 +00:00
T add(...);
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\end_deeper
\begin_layout Itemize
Avoid using the default cases in switch statements unless you have too.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Use the correct type for the switch expression and let the compiler ensure that all cases are exhausted.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
enum Foo {
\end_layout
\begin_layout Plain Layout
FOO_BAR1,
\end_layout
\begin_layout Plain Layout
FOO_BAR2
\end_layout
\begin_layout Plain Layout
};
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
Foo f = ...;
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
switch (f) {
\end_layout
\begin_layout Plain Layout
Update Development.lyx
2021-01-10 11:27:40 +00:00
case FOO_BAR1:
\end_layout
\begin_layout Plain Layout
...;
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
break;
\end_layout
\begin_layout Plain Layout
Update Development.lyx
2021-01-10 11:27:40 +00:00
case FOO_BAR2:
\end_layout
\begin_layout Plain Layout
...;
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
break;
\end_layout
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
default:
// not needed and would shadow a wrong use of Foo
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
Update Development.lyx
2021-01-10 11:27:40 +00:00
...;
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
break;
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
}
\end_layout
\end_inset
Update coding rules
2021-02-15 14:55:33 +00:00
\end_layout
\begin_layout Itemize
Use default initialization such as
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
int i = 0;
\end_layout
\begin_layout Plain Layout
Class * ptr = nullptr;
\end_layout
\end_inset
rather than brace initialization:
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
int i {};
\end_layout
\begin_layout Plain Layout
Class * ptr {};
\end_layout
\end_inset
for PODs.
Use brace initialization only for more complex data structures.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Section
Exceptions
\begin_inset CommandInset label
LatexCommand label
name "sec:Exceptions"
\end_inset
\end_layout
\begin_layout Standard
Be aware of the presence of exceptions.
One important thing to realize is that you often do not have to use throw,
try or catch to be exception safe.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Let's look at the different types of exceptions safety (these are taken from Herb Sutter's book
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_inset CommandInset citation
LatexCommand cite
key "sutter"
literal "false"
\end_inset
):
\end_layout
\begin_layout Enumerate
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Basic guarantee:
Even in the presence of exceptions thrown by T or other exceptions,
Stack objects don't leak resources.
Note that this also implies that the container will be destructible and usable even if an exception is thrown while performing some container operation.
However,
if an exception is thrown,
the container will be in a consistent,
but not necessarily predictable,
state.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
Containers that support the basic guarantee can work safely in some settings.
\end_layout
\begin_layout Enumerate
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Strong guarantee:
If an operation terminates because of an exception,
program state will remain unchanged.
This always implies commit-or-rollback semantics,
including that no references or iterators into the container be invalidated if an operation fails.
For example,
if a Stack client calls Top and then attempts a Push that fails because of an exception,
then the state of the Stack object must be unchanged and the reference returned from the prior call to Top must still be valid.
For more information on these guarantees,
see Dave Abrahams's documentation of the SGI exception-safe standard library adaption at:
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_inset Flex URL
status open
\begin_layout Plain Layout
http://www.stlport.org/doc/exception_safety.html
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Probably the most interesting point here is that when you implement the basic guarantee,
the strong guarantee often comes for free.
For example,
in our Stack implementation,
almost everything we did was needed to satisfy just the basic guarantee – and what's presented above very nearly satisfies the strong guarantee,
with little or no extra work.
Not half bad,
considering all the trouble we went to.
In addition to these two guarantees,
there is one more guarantee that certain functions must provide in order to make overall exception safety possible:
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Enumerate
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
No throw guarantee:
The function will not emit an exception under any circumstances.
Overall exception safety isn't possible unless certain functions are guaranteed not to throw.
In particular,
we've seen that this is true for destructors;
later in this miniseries,
we'll see that it's also needed in certain helper functions,
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
such as
\family typewriter
Swap()
\family default
.
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
For all cases where we might be able to write exception safe functions without using try,
throw or catch we should do so.
In particular we should look over all destructors to ensure that they are as exception safe as possible.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Section
Formatting
\begin_inset CommandInset label
LatexCommand label
name "sec:Formatting"
\end_inset
\end_layout
\begin_layout Itemize
Only one declaration on each line.
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Standard
Use:
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
int a;
\end_layout
\begin_layout Plain Layout
int b;
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Do not use:
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
int a,
b;
// not used in LyX
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Standard
This is especially important when initialization is done at the same time:
\end_layout
\begin_layout Standard
Use:
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
string a = "Lars";
\end_layout
\begin_layout Plain Layout
string b = "Gullik";
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Do not use:
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
string a = "Lars",
b = "Gullik";
// not used in LyX
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Update Development.lyx
2020-11-11 22:20:46 +00:00
[Note that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
string a = "Lars"
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
is formally calling a copy constructor on a temporary constructed from a string literal and therefore has the potential of being more expensive then direct construction by
Update Development.lyx
2020-11-11 22:20:46 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
string a("Lars")
\end_layout
\end_inset
.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
However the compiler is allowed to elide the copy (even if it had side effects),
and modern compilers typically do so.
Given these equal costs,
\SpecialChar LyX
code favours the '=' idiom as it is in line with the traditional C-style initialization,
Update Development.lyx
2020-11-11 22:20:46 +00:00
\emph on
and
\emph default
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
cannot be mistaken as function declaration,
Update Development.lyx
2020-11-11 22:20:46 +00:00
\emph on
and
\emph default
reduces the level of nested parentheses in more initializations.]
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_deeper
\begin_layout Itemize
Pointers and references:
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Standard
Use:
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
char * p = "flop";
\end_layout
\begin_layout Plain Layout
char & c = *p;
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Do not use:
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
char *p = "flop";
// not used in LyX
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
char &c = *p;
// not used in LyX
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Some time ago we had a huge discussion on this subject and after convincing argumentation from Asger this is what we decided.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
Also note that we will have:
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
char const * p;
\end_layout
\end_inset
\end_layout
\begin_layout Standard
and not
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
const char * p;
// not used in LyX
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\end_deeper
\begin_layout Itemize
Operator names and parentheses
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
operator==(type)
\end_layout
\end_inset
\end_layout
\begin_layout Standard
and not
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
operator == (type) // not used in LyX
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
The == is part of the function name,
separating it makes the declaration look like an expression.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_deeper
\begin_layout Itemize
Function names and parentheses
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
void mangle()
\end_layout
\end_inset
\end_layout
\begin_layout Standard
and not
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
void mangle () // not used in LyX
\end_layout
\end_inset
\end_layout
\end_deeper
\begin_layout Itemize
Enumerators
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
enum Foo {
\end_layout
\begin_layout Plain Layout
FOO_ONE = 1,
\end_layout
\begin_layout Plain Layout
FOO_TWO = 2,
\end_layout
\begin_layout Plain Layout
FOO_THREE = 3
\end_layout
\begin_layout Plain Layout
};
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Update Development.lyx
2021-01-10 11:27:40 +00:00
or (C++11)
\end_layout
\begin_layout Standard
\begin_inset listings
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
inline false
status open
\begin_layout Plain Layout
enum class Foo {
\end_layout
\begin_layout Plain Layout
One = 1,
\end_layout
\begin_layout Plain Layout
Two = 2,
\end_layout
\begin_layout Plain Layout
Three = 3
\end_layout
\begin_layout Plain Layout
};
\end_layout
\end_inset
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
and not
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
enum { one = 1,
two = 2,
three 3 };
// not used in LyX
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Standard
and not
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
enum {
\end_layout
\begin_layout Plain Layout
One = 1,
\end_layout
\begin_layout Plain Layout
Two = 2,
\end_layout
\begin_layout Plain Layout
Three = 3
\end_layout
\begin_layout Plain Layout
};
\end_layout
\end_inset
\end_layout
\end_deeper
\begin_layout Itemize
Null pointers
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Standard
Update Development.lyx
2020-11-11 22:20:46 +00:00
Use nullptr (C++11):
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update Development.lyx
2020-11-11 22:20:46 +00:00
void * p = nullptr;
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Standard
and not
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
void * p = NULL;
// not used in LyX
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Standard
and not
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
void * p = '
\backslash
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
0';
// not used in LyX
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Standard
and not
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
void * p = 42 - 7 * 6;
// not used in LyX
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Note:
As an exception,
imported third party code as well as code interfacing the
Update Development.lyx
2020-11-11 22:20:46 +00:00
\begin_inset Quotes eld
\end_inset
native
\begin_inset Quotes erd
\end_inset
APIs (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
src/support/os_*
\end_layout
\end_inset
) can use NULL.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_deeper
\begin_layout Itemize
Naming rules for classes
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Itemize
Use descriptive but simple and short names.
Do not abbreviate.
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Class names are usually capitalized,
and function names lowercased.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Enums are named like Classes,
values are usually in lower-case.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Update Development.lyx
2020-11-11 22:20:46 +00:00
Public API functions are camel-case (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
void setAFlagToAValue(bool)
Update Development.lyx
2020-11-11 22:20:46 +00:00
\end_layout
\end_inset
).
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Update Development.lyx
2020-11-11 22:20:46 +00:00
Member variables are underscored (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
enable_this_feature_flag_
Update Development.lyx
2020-11-11 22:20:46 +00:00
\end_layout
\end_inset
) with a final
\begin_inset Quotes eld
\end_inset
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
_
Update Development.lyx
2020-11-11 22:20:46 +00:00
\begin_inset Quotes erd
\end_inset
.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Update Development.lyx
2020-11-11 22:20:46 +00:00
Private/protected functions are also camel-case.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
New types are capitalized,
so this goes for typedefs,
classes,
structs and enums.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_deeper
\begin_layout Itemize
Formatting
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Adapt the formatting of your code to the one used in the other parts of \SpecialChar LyX
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
In case there is different formatting for the same construct,
use the one used more often.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_deeper
\begin_layout Itemize
Use existing structures
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Itemize
\begin_inset CommandInset label
LatexCommand label
name "Use-string-wherever"
\end_inset
Update Development.lyx
2020-11-11 22:20:46 +00:00
Use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
string
\end_layout
\end_inset
wherever possible.
Unicode strings should prefer using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
docstring
\end_layout
\end_inset
instead of UTF-8 encoded
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
std::string
\end_layout
\end_inset
.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Update Development.lyx
2020-11-11 22:20:46 +00:00
Check out the filename and path tools in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
filetools.h
\end_layout
\end_inset
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Update Development.lyx
2020-11-11 22:20:46 +00:00
Check out the string tools in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
lstring.h
\end_layout
\end_inset
.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Use the \SpecialChar LyX
Err class to report errors and messages using the lyxerr instantiation.
[add description of other existing structures]
\end_layout
\end_deeper
\begin_layout Itemize
Declarations
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Use this order for the access sections of your class:
public,
protected,
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
private.
The public section is interesting for every user of the class.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
The private section is only of interest for the implementors of the class (you).
[Obviously not true since this is for developers,
and we do not want one developer only to be able to read and understand the implementation of class internals.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
Lgb]
\end_layout
\begin_layout Itemize
Avoid declaring global objects in the declaration file of the class.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If the same variable is used for all objects,
use a static member.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Avoid global or static variables.
\end_layout
\end_deeper
\begin_layout Itemize
File headers
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
If you create a new file,
the top of the file should look something like this :
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
/**
\end_layout
\begin_layout Plain Layout
*
\backslash
file NewFile.cpp
\end_layout
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
* This file is part of LyX,
the document processor.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
* Licence details can be found in the file COPYING.
\end_layout
\begin_layout Plain Layout
*
\end_layout
\begin_layout Plain Layout
*
\backslash
author Kaiser Sose
\end_layout
\begin_layout Plain Layout
*
\end_layout
\begin_layout Plain Layout
Update Development.lyx
2020-11-11 22:20:46 +00:00
* Full author contact details are available
\end_layout
\begin_layout Plain Layout
* in file CREDITS.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
*/
\end_layout
\end_inset
\end_layout
\end_deeper
\begin_layout Itemize
Documentation
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Itemize
The documentation is generated from the header files.
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
You document for the other developers,
not for yourself.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
You should document what the function does,
not the implementation.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Itemize
in the .cpp files you document the implementation.
\end_layout
\end_deeper
\begin_layout Itemize
Update Development.lyx
2020-11-11 22:20:46 +00:00
Single line description (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
///
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
),
multiple lines description (
Update Development.lyx
2020-11-11 22:20:46 +00:00
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
/** ...
*/
\end_layout
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
),
see the doxygen webpage referenced above.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_deeper
\begin_layout Section
Update Development.lyx
2020-11-11 22:20:46 +00:00
Naming rules for \SpecialChar LyX
User Functions (LFUNs)
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Standard
Here is the set of rules to apply when a new command name is introduced:
\end_layout
\begin_layout Enumerate
Use the object.event order.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
That is,
use `word-forward' instead of `forward-word'.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Enumerate
Don't introduce an alias for an already named object.
Same for events.
\end_layout
\begin_layout Enumerate
Forward movement or focus is called `forward' (not `right').
\end_layout
\begin_layout Enumerate
Backward movement or focus is called `backward' (not `left').
\end_layout
\begin_layout Enumerate
Upward movement of focus is called `up'.
\end_layout
\begin_layout Enumerate
Downward movement is called `down'.
\end_layout
\begin_layout Enumerate
The begin of an object is called `begin' (not `start').
\end_layout
\begin_layout Enumerate
The end of an object is called `end'.
\end_layout
\begin_layout Section
How to create class interfaces
\end_layout
\begin_layout Standard
(a.k.a How Non-Member Functions Improve Encapsulation)
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
I recently read an article by Scott Meyers,
where he makes a strong case on how non-member functions makes classes more encapsulated,
not less.
Just skipping to the core of this provides us with the following algorithm for deciding what kind of function to add to a class interface:
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
We need to add a function f to the class C's API.
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
if (f needs to be virtual)
\end_layout
\begin_layout Plain Layout
make f a member function of C;
\end_layout
\begin_layout Plain Layout
else if (f is operator>> or operator<<) {
\end_layout
\begin_layout Plain Layout
make f a non-member function;
\end_layout
\begin_layout Plain Layout
if (f needs access to non-public members of C)
\end_layout
\begin_layout Plain Layout
make f a friend of C;
\end_layout
\begin_layout Plain Layout
} else if (f needs type conversions on its left-most argument) {
\end_layout
\begin_layout Plain Layout
make f a non-member function;
\end_layout
\begin_layout Plain Layout
if (f needs access to non-public members of C)
\end_layout
\begin_layout Plain Layout
make f a friend of C;
\end_layout
\begin_layout Plain Layout
} else if (f can be implemented via C's public interface)
\end_layout
\begin_layout Plain Layout
make f a non-member function;
\end_layout
\begin_layout Plain Layout
else
\end_layout
\begin_layout Plain Layout
make f a member function of C;
\end_layout
\end_inset
\end_layout
\end_deeper
\begin_layout Chapter
Coding recommendations
\end_layout
\begin_layout Standard
These are some rules for effective C++ programming.
These are taken from Scott Meyers
\begin_inset CommandInset citation
LatexCommand cite
key "journal"
literal "true"
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
,
and are presented in their short form.
These are not all the rules Meyers presents,
only the most important of them.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\SpecialChar LyX
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
does not yet follow these rules,
but they should be the goal.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
use
\family typewriter
const
\family default
and
\family typewriter
inline
\family default
instead of
\family typewriter
#define
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
use the same form in corresponding calls to new and delete,
i.e.
Update Development.lyx
2020-11-11 22:20:46 +00:00
write
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
delete[] obj;
\end_layout
\end_inset
if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
new obj[n];
\end_layout
\end_inset
was used to create the object and write
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
delete obj;
\end_layout
\end_inset
if you wrote
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
new obj;
\end_layout
\end_inset
Notice strings should be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
std::string
\end_layout
\end_inset
's instead of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
char *
\end_layout
\end_inset
's.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
(this contradicts to
\begin_inset CommandInset ref
LatexCommand ref
reference "Use-string-wherever"
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
nolink "false"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_inset
)
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
define a default constructor,
copy constructor and an assignment operator for all classes with dynamically allocated memory that are not made noncopyable
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
do not define default constructor,
copy constructor and an assignment operator if the compiler generated one would do the same
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
make destructors virtual in base classes and only there
\end_layout
\begin_layout Itemize
assign to all data members in operator=()
\end_layout
\begin_layout Itemize
strive for class interfaces that are complete and minimal
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
differentiate among member functions,
global functions and friend functions
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
avoid data members in the public interface
\end_layout
\begin_layout Itemize
use const whenever possible
\end_layout
\begin_layout Itemize
pass and return objects by reference instead of by value
\end_layout
\begin_layout Itemize
choose carefully between function overloading and parameter defaulting
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
never return a reference to a local object or a dereferenced pointer initialized by new within the function
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
use enums for integral constants
\end_layout
\begin_layout Itemize
minimize compilation dependencies between files
\end_layout
\begin_layout Itemize
pay attention to compiler warnings
\end_layout
\begin_layout Itemize
differentiate between inheritance of interface and inheritance of implementation
\end_layout
\begin_layout Itemize
differentiate between inheritance and templates
\end_layout
\begin_layout Itemize
ensure that global objects are initialized before they are used
\end_layout
\begin_layout Itemize
Update Development.lyx
2020-11-11 22:20:46 +00:00
avoid conditions to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
if
\end_layout
\end_inset
and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
while
\end_layout
\end_inset
that span more than a line
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Chapter
\start_of_appendix
Notes
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
And one of mine:
(Lgb)
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
when switching on enums,
refrain from using "default:" if possible
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_deeper
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
And one of mine:
(Andre')
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
try to implement your class in a way that the automatically generated copy constructor and copy assignment work out-of-the box
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
I don't have problems with using boost in the implementation _if and only if_ it provides actual benefits over less intrusive alternatives.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
I do have a problem with needlessly sprinkling 'boost::' over interfaces,
especially if it does not add any value.
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Given that there seems to be an unconditional "typedef unsigned int quint32;" in qglobal.h I don't think there's any platform supported by current \SpecialChar LyX
that could not use 'unsigned int' (and an static assert in some implementation file for the unlikely case some ILP64 zombie raises its ugly head again.
And if that happens,
using <cstdint> would still be a better choice...)
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
The idea is to create something that's not compilable as soon as the condition is violated.
There are lots of possibilities to achieve this,
some examples follow:
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Standard
In C++11 there's a "built-in":
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
static_assert(sizeof(int) == 4,
"Funny platform")
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
until then on namespace scope:
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update Development.lyx
2020-11-11 22:20:46 +00:00
#include <boost/static_assert.hpp>
\end_layout
\begin_layout Plain Layout
BOOST_STATIC_ASSERT(sizeof(int) == 4)
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Standard
or without boost:
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
Update Development.lyx
2020-11-11 22:20:46 +00:00
template<bool Condition>
\end_layout
\begin_layout Plain Layout
struct static_assert_helper;
\end_layout
\begin_layout Plain Layout
template <>
\end_layout
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
struct static_assert_helper<true> {};
Update Development.lyx
2020-11-11 22:20:46 +00:00
\end_layout
\begin_layout Plain Layout
enum {
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
Update Development.lyx
2020-11-11 22:20:46 +00:00
dummy = sizeof(static_assert_helper<sizeof(int) == 4>)
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
Update Development.lyx
2020-11-11 22:20:46 +00:00
};
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
or somewhat brutish without templates,
in any function:
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Standard
\begin_inset listings
Update Development.lyx
2020-11-11 22:20:46 +00:00
lstparams "basicstyle={\ttfamily},showstringspaces=false,tabsize=4"
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
inline false
status open
\begin_layout Plain Layout
const int d = sizeof(int) - 4;
\end_layout
\begin_layout Plain Layout
Update Development.lyx
2020-11-11 22:20:46 +00:00
switch (0) {
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
case 0:
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
case !(d*d):
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
break;
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Plain Layout
}
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Update Development.lyx
2020-11-11 22:20:46 +00:00
Any of them in a .cpp file will break compilation as soon as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
sizeof(int)
\end_layout
\end_inset
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
is not equal 4.
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Personally I prefer something like the third version (or the first,
if using C++11 is allowed).
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_deeper
\end_deeper
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
And one of mine:
(vfr)
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Itemize
On dynamics_casts
\begin_inset Flex URL
status open
\begin_layout Plain Layout
Amend(2) 9cfa55d2
2024-10-08 13:37:15 +00:00
https://www.lyx.org/trac/changeset/573500dd04f154f27318ac5ec469a337f97fe9f0/lyxgit
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\end_inset
:
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Standard
A dynamic_cast is necessary when:
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
the object to be casted is from an external library because we can't add Qxxx::asXxxx() to Qt e.g.:
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Itemize
QAbstractListModel to GuiIdListModel,
\end_layout
\begin_layout Itemize
QValidator to PathValidator,
\end_layout
\begin_layout Itemize
QWidget to TabWorkArea,
\end_layout
\begin_layout Itemize
QWidget to GuiWorkArea;
\end_layout
\end_deeper
\begin_layout Itemize
the object is to be casted from an interface to the implementing class,
because the Interface does not know by whom it is implemented:
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Itemize
ProgressInterface to GuiProgress,
\end_layout
\begin_layout Itemize
Application to GuiApplication.
\end_layout
\end_deeper
\begin_layout Standard
A dynamic_cast can be replaced by:
\end_layout
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
already existing as***Inset() functions,
e.g.:
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Itemize
asHullInset(),
\end_layout
\begin_layout Itemize
asInsetMath()->asMacro(),
\end_layout
\begin_layout Itemize
asInsetText();
\end_layout
\end_deeper
\begin_layout Itemize
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
A static_cast when we are sure this can't go wrong,
e.g.:
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\begin_inset Separator latexpar
\end_inset
\end_layout
\begin_deeper
\begin_layout Itemize
we are sure that CellData::inset->clone() is an InsetTableCell,
\end_layout
\begin_layout Itemize
in cases where we explicitly check it->lyxCode().
\end_layout
\end_deeper
\end_deeper
\end_deeper
\begin_layout Bibliography
\begin_inset CommandInset bibitem
LatexCommand bibitem
key "meyers"
literal "true"
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Meyers,
Scott.
Effective C++:
50 Specific Ways to Improve Your Programs and Design.
Addison-Wesley,
1992.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Bibliography
\begin_inset CommandInset bibitem
LatexCommand bibitem
key "sutter"
literal "true"
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Sutter,
Herb.
Exceptional C++:
47 engineering puzzles,
programming problems,
and solutions.
Update Development.lyx
2020-11-11 22:20:46 +00:00
ISBN 0-201-61562-2.
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +00:00
\end_layout
\begin_layout Bibliography
\begin_inset CommandInset bibitem
LatexCommand bibitem
key "journal"
literal "true"
\end_inset
Update format of docs using LyX binary Especially after the change to use semantic linefeeds (7b23c76b), the diffs are large and it's hard to figure out what diff is the result of the linefeed change and which diff is the result of an edit. By updating the docs, it will make the edits easier to understand from the diff. This commit used the LyX binary to write the new .lyx files since lyx2lyx does not apply semantic linefeeds. I used the following command: ./development/tools/updatedocs.py [path to 'lyx' binary] A few documents were not updated (e.g., the command sequence used failed because a dialog about a missing dependency was shown). I did not update Additional.lyx for any language since it is undergoing changes. I also didn't change anything in doc/fr since JP is working on some of those. I also didn't change doc/ru since it appears Yuriy already updated those.
2022-12-11 16:12:05 +00:00
Meyers,
Scott.
C/C++ User's Journal (Vol.18,
No.2).
Merge CodingRulesAndAdvice.lyx into Development.lyx
2020-11-11 18:27:06 +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_body
\end_document
Reference in New Issue Copy Permalink