Merge branch 'master' of git.lyx.org:lyx

[lyx.git] / lib / doc / Development.lyx

diff --git a/lib/doc/Development.lyx b/lib/doc/Development.lyx
index 624c61e8824a286d556a6d1981f4012b424a00bd..cbf4f5b3b5f943285729fd54118450b7ad743679 100644 (file)
--- a/lib/doc/Development.lyx
+++ b/lib/doc/Development.lyx
@@ -27,7 +27,7 @@ logicalmkup
 \font_tt_scale 100 100
 \graphics default
 \default_output_format pdf2
-\output_sync 0
+\output_sync 1
 \bibtex_command default
 \index_command default
 \paperfontsize 12
@@ -332,6 +332,12 @@ Implement and test the new feature, including the reading and writing of
 \end_layout
 
 \begin_layout Enumerate
+\begin_inset CommandInset label
+LatexCommand label
+name "enu:Describe_format"
+
+\end_inset
+
 Describe the new format in 
 \begin_inset Flex Code
 status collapsed
@@ -385,6 +391,12 @@ lib/lyx2lyx/LyX.py
 \end_layout
 
 \begin_layout Enumerate
+\begin_inset CommandInset label
+LatexCommand label
+name "enu:Add-an-entry"
+
+\end_inset
+
 Add an entry to both format lists (for conversion and reversion) in
 \begin_inset Newline newline
 \end_inset
@@ -552,49 +564,39 @@ python development/tools/updatedocs.py
 \end_inset
 
 .
- Then, revert the change to 
+ Look at the resulting changes using the command 
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
-LFUNs.lyx
+git diff
 \end_layout
 
 \end_inset
 
- because that file is meant to be generated separately: 
+.
+ If anything looks surprising, please investigate.
+ Keep in mind that the case of 
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
-git checkout lib/doc/LFUNs.lyx
-\end_layout
-
-\end_inset
-
-
-\begin_inset Note Note
-status collapsed
-
-\begin_layout Plain Layout
-TODO: this step should be done within updatedocs.py
+LFUNs.lyx
 \end_layout
 
 \end_inset
 
-.
- Look at the resulting changes using the command 
+ is special, because it is first generated with 
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
-git diff
+gen_lfuns.py
 \end_layout
 
 \end_inset
 
-.
- If anything looks surprising, please investigate.
+ before being converted to the latest format.
  Finally, commit using 
 \begin_inset Flex Code
 status collapsed
@@ -684,6 +686,96 @@ Updating the file format number of bind/ui files
 \end_layout
 
 \begin_layout Standard
+A change to the functionality of existing LFUNs can require a conversion
+ of 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.bind
+\end_layout
+
+\end_inset
+
+ and 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.ui
+\end_layout
+
+\end_inset
+
+ files, and therefore an increment of the LFUN format, as well as a conversion
+ of Info insets in 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.lyx
+\end_layout
+
+\end_inset
+
+ files for manuals.
+ The latter cannot be done automatically and requires also a \SpecialChar LyX
+ format increase
+ (think of e.g.
+ someone who might have made a set of \SpecialChar LyX
+ teaching manuals for use in their
+ own group)
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+\begin_inset Flex URL
+status open
+
+\begin_layout Plain Layout
+
+http://www.lyx.org/trac/ticket/9794
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+.
+\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
+
+
+\end_layout
+
+\begin_layout Enumerate
 See step 
 \begin_inset CommandInset ref
 LatexCommand ref
@@ -721,6 +813,82 @@ bash development/tools/updatelfuns.sh
 .
 \end_layout
 
+\begin_layout Enumerate
+Update Info insets in 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.lyx
+\end_layout
+
+\end_inset
+
+ files.
+ To do so, increment the \SpecialChar LyX
+ format and proceed as in 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:update_lyx_files"
+
+\end_inset
+
+, steps 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "enu:Describe_format"
+
+\end_inset
+
+-
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "enu:updatefiles"
+
+\end_inset
+
+.
+ In the lyx2lyx implementation (
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "enu:Add-an-entry"
+
+\end_inset
+
+th step), implement a conversion similar to the one in 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+prefs2prefs_lfuns.py
+\end_layout
+
+\end_inset
+
+ above, as well as a corresponding reversion; for this one can use 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+convert_info_insets
+\end_layout
+
+\end_inset
+
+ from 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lib/lyx2lyx/lyx2lyx_tools.py
+\end_layout
+
+\end_inset
+
+.
+ 
+\end_layout
+
 \begin_layout Subsection
 Backporting new styles to the stable version
 \end_layout
@@ -1894,7 +2062,6 @@ We are still working on getting the tests to run in parallel.
  pass when run sequentially.
  A reasonable approach is to first run the tests in parallel and then run
  the failed tests sequentially.
- 
 \end_layout
 
 \begin_layout Standard
@@ -1929,6 +2096,35 @@ rerun-failed
 
 \end_layout
 
+\begin_layout Standard
+When specifying a subset of the tests (e.g.
+ using 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+\SpecialChar nobreakdash
+R <pattern>
+\end_layout
+
+\end_inset
+
+), the same subset must be specified when using the 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+\SpecialChar nobreakdash
+\SpecialChar nobreakdash
+rerun-failed
+\end_layout
+
+\end_inset
+
+ option because it is the test numbers that are used to index which tests
+ failed on the previous run.
+\end_layout
+
 \begin_layout Standard
 \noindent
 Note that some tests cannot be run in parallel.