X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FDevelopment.lyx;h=18f0861f1579fb849dd7e73c508372ed799da1ba;hb=239b9919ffe28338d789e6dc9122228f77ab77a7;hp=34e39c2b55a115034fc0a1731bb56fa3018cccf0;hpb=a588bddec50ece1ed00491e05801bcf90a0e618a;p=lyx.git diff --git a/lib/doc/Development.lyx b/lib/doc/Development.lyx index 34e39c2b55..18f0861f15 100644 --- a/lib/doc/Development.lyx +++ b/lib/doc/Development.lyx @@ -1,5 +1,5 @@ #LyX 2.3 created this file. For more info see http://www.lyx.org/ -\lyxformat 508 +\lyxformat 527 \begin_document \begin_header \save_transient_properties true @@ -25,6 +25,7 @@ logicalmkup \font_osf false \font_sf_scale 100 100 \font_tt_scale 100 100 +\use_microtype false \graphics default \default_output_format pdf2 \output_sync 1 @@ -77,7 +78,8 @@ logicalmkup \tocdepth 4 \paragraph_separation indent \paragraph_indentation default -\quotes_language english +\quotes_style english +\dynamic_quotes 0 \papercolumns 1 \papersides 2 \paperpagestyle headings @@ -458,30 +460,6 @@ src/version.h . \end_layout -\begin_layout Enumerate -Update the range of file formats in the array -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -format_relation -\end_layout - -\end_inset - - in -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -lib/lyx2lyx/LyX.py -\end_layout - -\end_inset - -. -\end_layout - \begin_layout Enumerate \begin_inset CommandInset label LatexCommand label @@ -612,7 +590,8 @@ name "enu:updatefiles" \end_inset -Update LyX's .lyx documentation files to the new format. +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 @@ -686,7 +665,52 @@ gen_lfuns.py \end_inset before being converted to the latest format. - Finally, commit using +\begin_inset Newline newline +\end_inset + + +\begin_inset Note Greyedout +status open + +\begin_layout Plain Layout + +\series bold +Note: +\series default + Only commit file format changes in the doc files if these files are using + the new feature of the new file format. + The reason is rule +\begin_inset space ~ +\end_inset + + +\begin_inset CommandInset ref +LatexCommand ref +reference "enu:The-fileformat-of" + +\end_inset + + of the documentation policies described in sec. +\begin_inset space ~ +\end_inset + + +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:Documentation-policies" + +\end_inset + +. +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Enumerate +Finally, commit using \begin_inset Flex Code status collapsed @@ -743,7 +767,7 @@ updatedocs.py \end_layout \begin_layout Standard -Note that we do not automatically any local layout used in the +Note that we do not automatically update any local layout used in the \begin_inset Flex Code status collapsed @@ -2005,13 +2029,26 @@ src/tex2lyx/test \end_layout \begin_layout Itemize -In the appearing MSVC program right-click on the project +In the appearing MSVC program assure that you build the +\emph on +Release +\emph default + version, then right-click on the project \family sans updatetex2lyxtests \family default - in the project explorer and chose + in the project explorer and choose then \family sans -Create +Project +\begin_inset space ~ +\end_inset + +Only\SpecialChar menuseparator +Rebuild +\begin_inset space ~ +\end_inset + +only \family default . \end_layout @@ -3357,7 +3394,7 @@ If the export did not fail previously but led to wrong output (PDF, say), status collapsed \begin_layout Plain Layout -Non-failing test with wrong output should be labeledas +Non-failing test with wrong output should be labeled as \begin_inset Quotes eld \end_inset @@ -3401,9 +3438,17 @@ unreliable:nonstandard \begin_inset Quotes erd \end_inset - or testing on a system withonly a subset of TeXLive installed), ignore + 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 - ressources and try again. + resources and try again. +\end_layout + +\begin_layout Itemize +Check the log file Testing/Temporary/LastTest.log. + 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. \end_layout \begin_layout Paragraph @@ -3783,8 +3828,10 @@ erratic Tests depending on local configuration or the phase of the moon. \end_layout \begin_layout Description -varying_versions Test depending on TeX distribution, package versions or - OS. +varying_versions Tests depending on e.g. + OS or version of a non-TeX-Live dependency. + Note that a full, up-to-date TeX Live installation is required so this + sublabel is about versions of other dependencies. \end_layout \begin_layout Description @@ -3874,7 +3921,7 @@ Input Each test which passed 'ignoredTests' \begin_layout Labeling \labelwidthstring 00.00.0000 -Output Stop if test selected, gain label 'unreliable'. +Output Gain label 'unreliable', proceed with checking for 'inverted'. \end_layout \end_deeper @@ -3889,7 +3936,7 @@ invertedTests \begin_deeper \begin_layout Labeling \labelwidthstring 00.00.0000 -Input Each test which passed 'unreliableTests' +Input Each test which passed 'ignoredTests' \end_layout \begin_layout Labeling @@ -3928,14 +3975,18 @@ The following table may clarify label assignement \end_layout \begin_layout Standard +\begin_inset space \hspace{} +\length -3cm +\end_inset + + \begin_inset Tabular - + - - - - - + + + + @@ -3993,15 +4044,6 @@ Assigned label \end_layout -\end_inset - - -\begin_inset Text - -\begin_layout Plain Layout - -\end_layout - \end_inset @@ -4028,7 +4070,8 @@ test property \begin_inset Text \begin_layout Plain Layout -ignoredTests +ignored\SpecialChar softhyphen +Tests \end_layout \end_inset @@ -4037,7 +4080,8 @@ ignoredTests \begin_inset Text \begin_layout Plain Layout -unreliableTests +unreliable\SpecialChar softhyphen +Tests \end_layout \end_inset @@ -4046,16 +4090,18 @@ unreliableTests \begin_inset Text \begin_layout Plain Layout -invertedTests +inverted\SpecialChar softhyphen +Tests \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -suspendedTests +suspended\SpecialChar softhyphen +Tests \end_layout \end_inset @@ -4072,15 +4118,6 @@ export \begin_inset Text -\begin_layout Plain Layout -unreliable -\end_layout - -\end_inset - - -\begin_inset Text - \begin_layout Plain Layout inverted \end_layout @@ -4134,7 +4171,7 @@ Yes \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4155,15 +4192,6 @@ Yes \begin_inset Text -\begin_layout Plain Layout - -\end_layout - -\end_inset - - -\begin_inset Text - \begin_layout Plain Layout - \end_layout @@ -4199,94 +4227,19 @@ No \end_inset - -\begin_inset Text - -\begin_layout Plain Layout -Yes -\end_layout - -\end_inset - - -\begin_inset Text - -\begin_layout Plain Layout -- -\end_layout - -\end_inset - - -\begin_inset Text - -\begin_layout Plain Layout -- -\end_layout - -\end_inset - - -\begin_inset Text - -\begin_layout Plain Layout -- -\end_layout - -\end_inset - - -\begin_inset Text - -\begin_layout Plain Layout -+ -\end_layout - -\end_inset - - -\begin_inset Text - -\begin_layout Plain Layout -- -\end_layout - -\end_inset - - -\begin_inset Text - -\begin_layout Plain Layout -- -\end_layout - -\end_inset - - + \begin_inset Text \begin_layout Plain Layout - -\end_layout - +If Yes, +\begin_inset Newline newline \end_inset - - - - -\begin_inset Text - -\begin_layout Plain Layout - -\end_layout +add label +\begin_inset Newline newline \end_inset - - -\begin_inset Text -\begin_layout Plain Layout -No +'unreliable' \end_layout \end_inset @@ -4300,7 +4253,7 @@ Yes \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4325,15 +4278,6 @@ Yes - \end_layout -\end_inset - - -\begin_inset Text - -\begin_layout Plain Layout -- -\end_layout - \end_inset @@ -4383,7 +4327,7 @@ WILL_FAIL \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4404,15 +4348,6 @@ No \begin_inset Text -\begin_layout Plain Layout -- -\end_layout - -\end_inset - - -\begin_inset Text - \begin_layout Plain Layout + \end_layout @@ -4466,7 +4401,7 @@ No \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4491,15 +4426,6 @@ No - \end_layout -\end_inset - - -\begin_inset Text - -\begin_layout Plain Layout -- -\end_layout - \end_inset @@ -5175,6 +5101,12 @@ No. \end_layout \begin_layout Section +\begin_inset CommandInset label +LatexCommand label +name "sec:Documentation-policies" + +\end_inset + Documentation policies \end_layout @@ -5226,7 +5158,7 @@ PDF (pdflatex) \begin_inset Quotes erd \end_inset - after your changes. + or the document's default output format after your changes. \end_layout \begin_layout Enumerate @@ -5249,6 +5181,12 @@ reference "enu:If-you-are" \end_layout \begin_layout Enumerate +\begin_inset CommandInset label +LatexCommand label +name "enu:The-fileformat-of" + +\end_inset + 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