X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FDevelopment.lyx;h=845f22aaa6f89feb78a2205c37350c17b35a95b5;hb=5480cfd19a5dd0541c4b007807d67fa9c085d754;hp=6f2267e45e0857d24de225c82a7228802f6c25ee;hpb=b856a3ad9b7b561d19743a97be4166be7a3d73dc;p=lyx.git diff --git a/lib/doc/Development.lyx b/lib/doc/Development.lyx index 6f2267e45e..845f22aaa6 100644 --- a/lib/doc/Development.lyx +++ b/lib/doc/Development.lyx @@ -1,5 +1,5 @@ -#LyX 2.2 created this file. For more info see http://www.lyx.org/ -\lyxformat 508 +#LyX 2.3 created this file. For more info see http://www.lyx.org/ +\lyxformat 544 \begin_document \begin_header \save_transient_properties true @@ -25,6 +25,8 @@ logicalmkup \font_osf false \font_sf_scale 100 100 \font_tt_scale 100 100 +\use_microtype false +\use_dash_ligatures true \graphics default \default_output_format pdf2 \output_sync 1 @@ -77,7 +79,10 @@ logicalmkup \tocdepth 4 \paragraph_separation indent \paragraph_indentation default -\quotes_language english +\is_math_indent 0 +\math_numbering_side default +\quotes_style english +\dynamic_quotes 0 \papercolumns 1 \papersides 2 \paperpagestyle headings @@ -86,6 +91,7 @@ logicalmkup \html_math_output 0 \html_css_as_file 0 \html_be_strict true +\use_minted 0 \end_header \begin_body @@ -458,30 +464,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 +594,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 +669,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 +771,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 @@ -1102,37 +1130,6 @@ lyx2lyx New layouts and modules \end_layout -\begin_layout Standard -\begin_inset Note Greyedout -status open - -\begin_layout Description -Note: This section is currently only a proposal under discussion. - Please correct/amend as suited. - Remove this note once a consensus is found. -\end_layout - -\begin_layout Plain Layout -See the thread -\begin_inset Quotes eld -\end_inset - -Proposal for a guide on updating layouts -\begin_inset Quotes erd -\end_inset - - for details and background -\end_layout - -\begin_layout Plain Layout -http://permalink.gmane.org/gmane.editors.lyx.devel/161126 -\end_layout - -\end_inset - - -\end_layout - \begin_layout Subsection \begin_inset CommandInset label LatexCommand label @@ -1165,6 +1162,7 @@ officially supported \begin_inset CommandInset href LatexCommand href target "https://wiki.lyx.org/Layouts/Layouts" +literal "false" \end_inset @@ -1174,7 +1172,7 @@ target "https://wiki.lyx.org/Layouts/Layouts" \begin_layout Standard 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. + After some discussion, it was decided that this is not needed. \begin_inset Foot status open @@ -1184,6 +1182,7 @@ See LatexCommand href name "the thread “Proposal for a guide on updating layouts”" target "http://permalink.gmane.org/gmane.editors.lyx.devel/161202" +literal "false" \end_inset @@ -1439,6 +1438,37 @@ Modules do not need a template, only an example, which is strongly encouraged Layouts for document classes with incompatible versions \end_layout +\begin_layout Standard +\begin_inset Note Greyedout +status open + +\begin_layout Description +Note: This section is currently only a proposal under discussion. + Please correct/amend as suited. + Remove this note once a consensus is found. +\end_layout + +\begin_layout Plain Layout +See the thread +\begin_inset Quotes eld +\end_inset + +Proposal for a guide on updating layouts +\begin_inset Quotes erd +\end_inset + + for details and background +\end_layout + +\begin_layout Plain Layout +http://permalink.gmane.org/gmane.editors.lyx.devel/161126 +\end_layout + +\end_inset + + +\end_layout + \begin_layout Standard Every now and then, there are changes to LaTeX document classes that break backwards compatibility. @@ -2005,13 +2035,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 @@ -3193,7 +3236,7 @@ status collapsed status collapsed \begin_layout Plain Layout -development/autotests/suspiciousTests +development/autotests/invertedTests \end_layout \end_inset @@ -3333,15 +3376,15 @@ inverted \emph on uninvert \emph default - the test by removing the labeling pattern from + the test by removing the pattern from the \begin_inset Quotes eld \end_inset -suspiciousTests +invertedTests \begin_inset Quotes erd \end_inset -) (see + file) (see \begin_inset CommandInset ref LatexCommand ref reference "par:Inverted-tests" @@ -3353,11 +3396,15 @@ reference "par:Inverted-tests" \begin_layout Itemize If the export did not fail previously but led to wrong output (PDF, say), - it is in fact an improvement when the test now fails, label it as +\begin_inset Foot +status collapsed + +\begin_layout Plain Layout +Non-failing test with wrong output should be labeled as \begin_inset Quotes eld \end_inset -unreliable:wrong:output +unreliable:wrong_output \begin_inset Quotes erd \end_inset @@ -3371,9 +3418,25 @@ reference "par:Unreliable-tests" ). \end_layout +\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" + +\end_inset + +). +\end_layout + \begin_layout Itemize -In case of tests failing due to missing requirements (when only a subset - of TeXLive is installed or a test labeled +In case of tests failing due to missing requirements (tests labeled \begin_inset Quotes eld \end_inset @@ -3381,8 +3444,17 @@ unreliable:nonstandard \begin_inset Quotes erd \end_inset - fails), ignore the failure, ask for someone else to run the test, or install - the missing ressources and try again. + 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. +\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 @@ -3401,7 +3473,7 @@ Test cases whose name matches a pattern in the file status collapsed \begin_layout Plain Layout -development/autotests/suspiciousTests +development/autotests/invertedTests \end_layout \end_inset @@ -3456,7 +3528,7 @@ The following sublabels are currently present in status collapsed \begin_layout Plain Layout -suspiciousTests +invertedTests \end_layout \end_inset @@ -3522,12 +3594,20 @@ otherwise, add a pattern here. \end_deeper \begin_layout Description -attic Documents in the attic. - (Kept for reference and format conversion test.) +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 + +. \end_layout \begin_layout Subparagraph -suspended +suspended tests \end_layout \begin_layout Standard @@ -3702,43 +3782,45 @@ status collapsed \end_layout -\begin_layout Description -nonstandard Documents with additional requirements, e.g. - a class or package file not in TeXLive. - -\begin_inset Note Note -status open +\begin_layout Standard +The following sublabels are currently present in +\begin_inset Flex Code +status collapsed \begin_layout Plain Layout -TODO: rename to "extra"? +unreliableTests \end_layout \end_inset - -\end_layout - -\begin_deeper -\begin_layout Standard -These tests are labeled as -\family typewriter -'nonstandard'. +: \end_layout -\end_deeper \begin_layout Description -erratic Tests depending on local configuration, OS, TeX distribution, package - versions, or the phase of the moon. +nonstandard Documents with additional requirements, e.g. + a class or package file not in TeXLive. \begin_inset Note Note status open \begin_layout Plain Layout -TODO: use -\emph on -erratic -\emph default - only for the phase-of-moon dependency? +TODO: rename to +\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 + +? \end_layout \end_inset @@ -3746,20 +3828,25 @@ erratic \end_layout -\begin_deeper -\begin_layout Standard -These tests are labeled as -\family typewriter -'erratic'. +\begin_layout Description +erratic Tests depending on local configuration or the phase of the moon. + +\end_layout + +\begin_layout Description +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 -\end_deeper \begin_layout Description wrong \begin_inset space ~ \end_inset -output Export does not fail but the resulting document has errors. +output Export does not fail but the resulting document has (undetected) + errors. \end_layout \begin_deeper @@ -3770,11 +3857,7 @@ status open \begin_layout Plain Layout \paragraph_spacing single -These tests are actually not -\emph on -unreliable -\emph default - but +These tests are in a strict sense not unreliable but \emph on invalid \emph default @@ -3831,8 +3914,8 @@ Output Stop if tests not selected here \end_deeper \begin_layout Description -unreliableTests: Tests selected either pass or fail, but that is dependent - on the system where the test is run. +unreliableTests: Tests selected pass or fail dependent on the system where + the test is run. Selected tests gain the label 'unreliable'. \end_layout @@ -3844,12 +3927,12 @@ 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 \begin_layout Description -suspiciousTests +invertedTests \begin_inset space \space{} \end_inset @@ -3859,17 +3942,18 @@ suspiciousTests \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 \labelwidthstring 00.00.0000 -Output Stop if not selected. +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'. \end_layout \begin_layout Standard -The following file is meant as subselections of 'suspiciousTests'. - If neither subselection applies, test gains labels 'export' and 'inverted' +The following filter perfoms a subselection of 'invertedTests': \end_layout \begin_layout Description @@ -3881,7 +3965,7 @@ suspendedTests Tests selected here gain the label 'suspended' but _not_ \begin_deeper \begin_layout Labeling \labelwidthstring 00.00.0000 -Input Each test selected by 'suspiciousTests' +Input Each test selected by 'invertedTests' \end_layout \begin_layout Labeling @@ -3897,17 +3981,18 @@ The following table may clarify label assignement \end_layout \begin_layout Standard +\begin_inset space \hspace{} +\length -3cm +\end_inset + + \begin_inset Tabular - + - - - - - - - - + + + + @@ -3917,7 +4002,7 @@ The following table may clarify label assignement \begin_inset Text \begin_layout Plain Layout -Test found in file: +Test matching pattern in file: \end_layout \end_inset @@ -3949,16 +4034,16 @@ Test found in file: \end_inset - + \begin_inset Text \begin_layout Plain Layout -Marked in ctest, Assigned label +Assigned label \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -3967,7 +4052,7 @@ Marked in ctest, Assigned label \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -3976,153 +4061,159 @@ Marked in ctest, Assigned label \end_inset - + \begin_inset Text \begin_layout Plain Layout - +test property \end_layout \end_inset - + + + \begin_inset Text \begin_layout Plain Layout - +ignored\SpecialChar softhyphen +Tests \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout - +unreliable\SpecialChar softhyphen +Tests \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout - +inverted\SpecialChar softhyphen +Tests \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout - +suspended\SpecialChar softhyphen +Tests \end_layout \end_inset - - - + \begin_inset Text \begin_layout Plain Layout -Ignored +export \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -Unreliable +inverted \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -Suspicious +suspended \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -Suspended + \end_layout \end_inset - -\begin_inset Text - + + + +\begin_inset Text + \begin_layout Plain Layout -export +Yes \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout - +- \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -unreliable +- \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout - +- \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -inverted +- \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout - +- \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -suspended +- \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4133,38 +4224,46 @@ suspended - + \begin_inset Text \begin_layout Plain Layout -Yes +No \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -- +If Yes, +\begin_inset Newline newline +\end_inset + +add label +\begin_inset Newline newline +\end_inset + +'unreliable' \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -- +Yes \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -- +Yes \end_layout \end_inset @@ -4187,29 +4286,67 @@ Yes \end_inset - + \begin_inset Text \begin_layout Plain Layout -- ++ \end_layout \end_inset - + +\begin_inset Text + +\begin_layout Plain Layout +WILL_FAIL +\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 +No +\end_layout + \end_inset \begin_inset Text \begin_layout Plain Layout -- ++ \end_layout \end_inset @@ -4218,12 +4355,12 @@ Yes \begin_inset Text \begin_layout Plain Layout -- ++ \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4236,27 +4373,27 @@ Yes \begin_inset Text \begin_layout Plain Layout -- +WILL_FAIL \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -No + \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -Yes + \end_layout \end_inset @@ -4265,12 +4402,12 @@ Yes \begin_inset Text \begin_layout Plain Layout -- +No \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4279,16 +4416,16 @@ Yes \end_inset - + \begin_inset Text \begin_layout Plain Layout -- ++ \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4297,7 +4434,7 @@ Yes \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4306,54 +4443,88 @@ Yes \end_inset - + \begin_inset Text \begin_layout Plain Layout -+ + \end_layout \end_inset - + + + +\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 + + filter, this would be far less complicated: +\end_layout + +\begin_layout Plain Layout +\begin_inset Tabular + + + + + + + + + + + \begin_inset Text \begin_layout Plain Layout -- +Test matching pattern in file: \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 -- +Label \end_layout \end_inset - - - + \begin_inset Text \begin_layout Plain Layout @@ -4362,47 +4533,49 @@ Yes \end_inset - + \begin_inset Text \begin_layout Plain Layout -No + \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -Yes +test property \end_layout \end_inset + + \begin_inset Text \begin_layout Plain Layout -Yes +ignoredTests \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -- +unreliableTests \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -- +invertedTests \end_layout \end_inset @@ -4411,7 +4584,7 @@ Yes \begin_inset Text \begin_layout Plain Layout -- +export \end_layout \end_inset @@ -4420,68 +4593,68 @@ Yes \begin_inset Text \begin_layout Plain Layout -- +unreliable \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -+ +inverted \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -- + \end_layout \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 @@ -4490,43 +4663,45 @@ Yes \end_inset - + \begin_inset Text \begin_layout Plain Layout -No +- \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -- + \end_layout \end_inset - + + + \begin_inset Text \begin_layout Plain Layout -+ +No \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -- +Yes \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4539,7 +4714,7 @@ No \begin_inset Text \begin_layout Plain Layout -+ +- \end_layout \end_inset @@ -4553,7 +4728,7 @@ No \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4566,14 +4741,14 @@ No \begin_inset Text \begin_layout Plain Layout -- + \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4582,34 +4757,34 @@ No \end_inset - + \begin_inset Text \begin_layout Plain Layout - +No \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -No +Yes \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout -- ++ \end_layout \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4618,7 +4793,7 @@ No \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4627,20 +4802,40 @@ No \end_inset - + \begin_inset Text \begin_layout Plain Layout -- +WILL_FAIL \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 +No \end_layout \end_inset @@ -4649,7 +4844,7 @@ No \begin_inset Text \begin_layout Plain Layout -- ++ \end_layout \end_inset @@ -4663,7 +4858,7 @@ No \end_inset - + \begin_inset Text \begin_layout Plain Layout @@ -4676,7 +4871,7 @@ No \begin_inset Text \begin_layout Plain Layout -- + \end_layout \end_inset @@ -4687,6 +4882,11 @@ No \end_inset +\end_layout + +\end_inset + + \end_layout \begin_layout Subsubsection @@ -4732,7 +4932,18 @@ Keytests \end_layout \begin_layout Standard -Automated tests based on the "MonKey Testing" keytest program. +Automated tests based on the "MonKey Testing" keytest program are enabled + if the necessary dependencies are found and if the CMake flag +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +-DLYX_ENABLE_KEYTESTS=ON +\end_layout + +\end_inset + + is used. They are documented in the README document in \begin_inset Flex Code status collapsed @@ -4745,7 +4956,6 @@ development/autotests subfolder of the \SpecialChar LyX source code distribution. - T \end_layout \begin_layout Subsubsection @@ -4897,9 +5107,98 @@ No. \end_layout \begin_layout Section +\begin_inset CommandInset label +LatexCommand label +name "sec:Documentation-policies" + +\end_inset + Documentation policies \end_layout +\begin_layout Subsection +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 + +If you are not the maintainer of a doc file or a chapter/section, you MUST + use change tracking so that the maintainer could review your changes +\end_layout + +\begin_layout Enumerate +Respect the formatting of the document. + The different files use different formatting styles. + 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 +All changes you make to a file in one language MUST also go the file in + the other actively maintained languages. + Normally the maintainer does this for you, if you are the maintainer, you + must do this by copying or changing the changed or added text to the other + files so that the translators sees the blue underlined text and know what + they have to translate and what was changed. +\end_layout + +\begin_layout Enumerate +You MUST assure that the document is compilable as +\begin_inset Quotes eld +\end_inset + +PDF (pdflatex) +\begin_inset Quotes erd +\end_inset + + or the document's default output format after your changes. +\end_layout + +\begin_layout Enumerate +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. + 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" + +\end_inset + +. + You can immediately commit to master as well. +\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 + port/backport changes to from master/branch. +\end_layout + \begin_layout Standard The main documentation consists of these files: \end_layout @@ -4994,46 +5293,5 @@ Customization.lyx this manual covers information how to customize \SpecialChar L distributions (meaning be as objective as possible). \end_layout -\begin_layout Standard -There are only 4 -\begin_inset space ~ -\end_inset - -rules in editing the docs: -\end_layout - -\begin_layout Enumerate -If you are not the maintainer of a doc file or a chapter/section, you MUST - use change tracking so that the maintainer could review your changes -\end_layout - -\begin_layout Enumerate -Respect the formatting of the document. - The different files use different formatting styles. - That is OK and has historic reasons nobody fully know ;-). - But it is important to be consistent within one file. -\end_layout - -\begin_layout Enumerate -All changes you make to a file in one language MUST also go the file in - the other actively maintained languages. - Normally the maintainer does this for you, if you are the maintainer, you - must do this by copying or changing the changed or added text to the other - files so that the translators sees the blue underlined text and know what - they have to translate and what was changed. -\end_layout - -\begin_layout Enumerate -You MUST assure that the document is compilable as -\begin_inset Quotes eld -\end_inset - -PDF (pdflatex) -\begin_inset Quotes erd -\end_inset - - after your changes. -\end_layout - \end_body \end_document