Mercurial > hg > easyhg-kdiff3
comparison kdiff3/doc/en/index.docbook @ 77:1184fc843210
KDiff3-0.9.92
author | joachim99 |
---|---|
date | Mon, 16 Apr 2007 21:26:08 +0000 |
parents | f7dad0aa6146 |
children |
comparison
equal
deleted
inserted
replaced
76:257ccb866dc3 | 77:1184fc843210 |
---|---|
27 </author> | 27 </author> |
28 <!-- TRANS:ROLES_OF_TRANSLATORS --> | 28 <!-- TRANS:ROLES_OF_TRANSLATORS --> |
29 </authorgroup> | 29 </authorgroup> |
30 | 30 |
31 <copyright> | 31 <copyright> |
32 <year>2002-2006</year> | 32 <year>2002-2007</year> |
33 <holder>Joachim Eibl</holder> | 33 <holder>Joachim Eibl</holder> |
34 </copyright> | 34 </copyright> |
35 <!-- Translators: put here the copyright notice of the translation --> | 35 <!-- Translators: put here the copyright notice of the translation --> |
36 <!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook | 36 <!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook |
37 and in the FDL itself on how to use it. --> | 37 and in the FDL itself on how to use it. --> |
42 need them for translation coordination ! | 42 need them for translation coordination ! |
43 Please respect the format of the date (YYYY-MM-DD) and of the version | 43 Please respect the format of the date (YYYY-MM-DD) and of the version |
44 (V.MM.LL), it could be used by automation scripts. | 44 (V.MM.LL), it could be used by automation scripts. |
45 Do NOT change these in the translation. --> | 45 Do NOT change these in the translation. --> |
46 | 46 |
47 <date>2006-05-14</date> | 47 <date>2007-31-03</date> |
48 <releaseinfo>0.9.90</releaseinfo> | 48 <releaseinfo>0.9.92</releaseinfo> |
49 | 49 |
50 | 50 |
51 <abstract> | 51 <abstract> |
52 <para> | 52 <para> |
53 &kdiff3; is a file and directory diff and merge tool which | 53 &kdiff3; is a file and directory diff and merge tool which |
61 <listitem><para>supports Unicode, UTF-8 and other file encodings,</para></listitem> | 61 <listitem><para>supports Unicode, UTF-8 and other file encodings,</para></listitem> |
62 <listitem><para>prints differences,</para></listitem> | 62 <listitem><para>prints differences,</para></listitem> |
63 <listitem><para>supports version control keyword and history merging.</para></listitem> | 63 <listitem><para>supports version control keyword and history merging.</para></listitem> |
64 </itemizedlist> | 64 </itemizedlist> |
65 </para><para> | 65 </para><para> |
66 This document describes &kdiff3;-version 0.9.89. | 66 This document describes &kdiff3;-version 0.9.92. |
67 </para> | 67 </para> |
68 </abstract> | 68 </abstract> |
69 | 69 |
70 <!-- This is a set of Keywords for indexing by search engines. | 70 <!-- This is a set of Keywords for indexing by search engines. |
71 Please at least include KDE, the KDE package it is in, the name | 71 Please at least include KDE, the KDE package it is in, the name |
441 (if available) third diff view. &kdiff3; will immediately recalculate the differences everytime you do this. | 441 (if available) third diff view. &kdiff3; will immediately recalculate the differences everytime you do this. |
442 and will align the chosen lines. Of course some of the previously matching lines in between | 442 and will align the chosen lines. Of course some of the previously matching lines in between |
443 might not match anymore. | 443 might not match anymore. |
444 </para><para> | 444 </para><para> |
445 Currently merging doesn't support the use of manual diff help. | 445 Currently merging doesn't support the use of manual diff help. |
446 </para></sect2><sect2 id="joinsplitsections"><title>Manually Joining and Splitting Diff Sections</title><para> | |
447 In some cases &kdiff3; will see too many or too few diff sections for merging. In such a | |
448 case you can join or split existing sections. | |
449 </para><para> | |
450 Add new sections by first selecting text in the lines that belong together in either input window (as for copying to the clipboard). | |
451 Then choose "Split Diff At Selection" in the "Merge" menu. | |
452 Splits will be added above the first line and below the last line of the selected text. | |
453 If you only want to add one section, then select text beginning at another section-split. | |
454 </para><para> | |
455 For joining sections in either input window select something in the lines from the sections to join. | |
456 (You can join several sections in one step too.) Then choose "Join selected Diffs" in the "Merge"-menu. | |
446 </para></sect2> | 457 </para></sect2> |
447 </sect1> | 458 </sect1> |
448 | 459 |
449 | 460 |
450 <sect1 id="merging"><title>Merging And The Merge Output Editor Window</title> | 461 <sect1 id="merging"><title>Merging And The Merge Output Editor Window</title> |
552 "Automatically Solve History Conflicts". | 563 "Automatically Solve History Conflicts". |
553 </para><para> | 564 </para><para> |
554 Usually the version control history begins with a line containing the keyword "$Log$". | 565 Usually the version control history begins with a line containing the keyword "$Log$". |
555 This must be matched by the "History start regular expression"-option. | 566 This must be matched by the "History start regular expression"-option. |
556 &kdiff3; detects which subsequent lines are in the history by analysing the leading characters | 567 &kdiff3; detects which subsequent lines are in the history by analysing the leading characters |
557 that came before the "$Log$"-keyword. If the same "leading comment" also appears in the following | 568 that came before the "$Log$"-keyword. If the same "leading comment"-characters also appears in the following |
558 lines, then they are also included in the history. | 569 lines, then they are also included in the history. |
559 </para><para> | 570 </para><para> |
560 During each check-in the VCS writes a unique line specifying version-, date- and time-information | 571 During each check-in the VCS writes a unique line specifying version-, date- and time-information |
561 followed by lines with user comments. | 572 followed by lines with user comments. |
562 These lines form one history-entry. This history section grows with every check-in and the | 573 These lines form one history-entry. This history section grows with every check-in and the |
616 </screen> | 627 </screen> |
617 For details about regular expressions please see the | 628 For details about regular expressions please see the |
618 <ulink url="http://doc.trolltech.com/3.3/qregexp.html#details">regular expression documentation by Trolltech</ulink>. | 629 <ulink url="http://doc.trolltech.com/3.3/qregexp.html#details">regular expression documentation by Trolltech</ulink>. |
619 Note that "\s" (with lowercase "s") matches any white space and "\S" (with uppercase "S") matches any non-white-space. | 630 Note that "\s" (with lowercase "s") matches any white space and "\S" (with uppercase "S") matches any non-white-space. |
620 In our example the history entry start contains first the version info with reg. exp. "\\main\\\S+", the date consisting of day "[0-9]+", month "(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)" and year "[0-9][0-9][0-9][0-9]", the time "[0-9][0-9]:[0-9][0-9]:[0-9][0-9]" and finally the developers login name ".*". | 631 In our example the history entry start contains first the version info with reg. exp. "\\main\\\S+", the date consisting of day "[0-9]+", month "(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)" and year "[0-9][0-9][0-9][0-9]", the time "[0-9][0-9]:[0-9][0-9]:[0-9][0-9]" and finally the developers login name ".*". |
621 Note that the leading comment (in the example "**") will already be removed by &kdiff3; | 632 </para><para> |
633 Note that the "leading comment"-characters (in the example "**") will already be removed by &kdiff3; | |
622 before trying to match, hence the regular expression begins with a match for none or more white-space characters "\s*". | 634 before trying to match, hence the regular expression begins with a match for none or more white-space characters "\s*". |
635 Because comment characters can differ in each file (e.g. C/C++ uses other comment characters than a Perl script) | |
636 &kdiff3; takes care of the leading comment characters and you should not specify them in the regular expression. | |
623 </para><para> | 637 </para><para> |
624 If you require a sorted history. Then the sortkey must be calculated. For this the | 638 If you require a sorted history. Then the sortkey must be calculated. For this the |
625 relevant parts in the regular expression must be grouped by parentheses. | 639 relevant parts in the regular expression must be grouped by parentheses. |
626 (The extra parentheses can also stay in if history sorting is disabled.) | 640 (The extra parentheses can also stay in if history sorting is disabled.) |
627 <screen> | 641 <screen> |
638 Finally the resulting sort key for the first history entry start line will be: | 652 Finally the resulting sort key for the first history entry start line will be: |
639 <screen> | 653 <screen> |
640 2001 04 0002 10:45:41 integration_branch_12 tom | 654 2001 04 0002 10:45:41 integration_branch_12 tom |
641 </screen> | 655 </screen> |
642 </para><para> | 656 </para><para> |
643 For more information also see <link linkend="diffmergeoptions">Diff and Merge Settings</link>. | 657 For more information also see <link linkend="mergeoptions">Merge Settings</link>. |
644 </para> | 658 </para> |
645 </sect2> | 659 </sect2> |
646 </sect1> | 660 </sect1> |
647 | 661 |
648 <sect1 id="navigation"><title>Navigation And Editing</title> | 662 <sect1 id="navigation"><title>Navigation And Editing</title> |
847 <varlistentry><term><emphasis> Line end style:</emphasis></term><listitem><para> When saving you can select what line | 861 <varlistentry><term><emphasis> Line end style:</emphasis></term><listitem><para> When saving you can select what line |
848 end style you prefer. The default setting is the common choice for the used operating system. </para></listitem></varlistentry> | 862 end style you prefer. The default setting is the common choice for the used operating system. </para></listitem></varlistentry> |
849 </variablelist> | 863 </variablelist> |
850 </sect2> | 864 </sect2> |
851 | 865 |
852 <sect2 id="diffmergeoptions"><title>Diff and Merge Settings</title> | 866 <sect2 id="diffoptions"><title>Diff Settings</title> |
853 <para> | 867 <para> |
854 When comparing files, &kdiff3; first it tries to match lines that are equal | 868 When comparing files, &kdiff3; first it tries to match lines that are equal |
855 in all input files. Only during this step it might ignore white space. The | 869 in all input files. Only during this step it might ignore white space. The |
856 second step compares each line. In this step white space will not be ignored. | 870 second step compares each line. In this step white space will not be ignored. |
857 Also during the merge white space will not be ignored. | 871 Also during the merge white space will not be ignored. |
884 </para></listitem></varlistentry> | 898 </para></listitem></varlistentry> |
885 <varlistentry><term><emphasis>Try Hard:</emphasis></term><listitem><para> | 899 <varlistentry><term><emphasis>Try Hard:</emphasis></term><listitem><para> |
886 Try hard to find an even smaller delta. (Default is on.) This will probably | 900 Try hard to find an even smaller delta. (Default is on.) This will probably |
887 be effective for complicated and big files. And slow for very big files. | 901 be effective for complicated and big files. And slow for very big files. |
888 </para></listitem></varlistentry> | 902 </para></listitem></varlistentry> |
903 </variablelist> | |
904 </sect2> | |
905 | |
906 <sect2 id="mergeoptions"><title>Merge Settings</title> | |
907 <variablelist> | |
889 <varlistentry><term><emphasis>Auto Advance Delay (ms):</emphasis></term><listitem><para> When in auto-advance-mode this setting specifies | 908 <varlistentry><term><emphasis>Auto Advance Delay (ms):</emphasis></term><listitem><para> When in auto-advance-mode this setting specifies |
890 how long to show the result of the selection before jumping to the next unsolved | 909 how long to show the result of the selection before jumping to the next unsolved |
891 conflict. | 910 conflict. |
892 </para></listitem></varlistentry> | 911 </para></listitem></varlistentry> |
893 <varlistentry><term><emphasis>White space 2/3-file merge default:</emphasis></term><listitem><para> | 912 <varlistentry><term><emphasis>White space 2/3-file merge default:</emphasis></term><listitem><para> |
926 If left empty, then no sorting will be done. | 945 If left empty, then no sorting will be done. |
927 See also <link linkend="vcskeywordsmergesupport">Automatic Merge ...</link> | 946 See also <link linkend="vcskeywordsmergesupport">Automatic Merge ...</link> |
928 </para></listitem></varlistentry> | 947 </para></listitem></varlistentry> |
929 <varlistentry><term><emphasis>Merge version control history on merge start:</emphasis></term><listitem><para> | 948 <varlistentry><term><emphasis>Merge version control history on merge start:</emphasis></term><listitem><para> |
930 If activated &kdiff3; runs the automatic history merging using aforementioned options when a merge is started. | 949 If activated &kdiff3; runs the automatic history merging using aforementioned options when a merge is started. |
950 </para></listitem></varlistentry> | |
951 <varlistentry><term><emphasis>Max number of history entries:</emphasis></term><listitem><para> | |
952 &kdiff3; truncates the history list after the specified number of entries. Use -1 to avoid truncation. (Default is -1). | |
931 </para></listitem></varlistentry> | 953 </para></listitem></varlistentry> |
932 <varlistentry><term><emphasis>Test your regular expressions</emphasis></term><listitem><para> | 954 <varlistentry><term><emphasis>Test your regular expressions</emphasis></term><listitem><para> |
933 This button shows a dialog that allows you to improve and test the regular expressions above. | 955 This button shows a dialog that allows you to improve and test the regular expressions above. |
934 Just copy the respective data from your files into the example lines. The "Match results" | 956 Just copy the respective data from your files into the example lines. The "Match results" |
935 will immediately show whether the match succeeds or not. | 957 will immediately show whether the match succeeds or not. |
2023 | 2045 |
2024 <para> | 2046 <para> |
2025 &kdiff3; - File and Directory Comparison and Merge Tool | 2047 &kdiff3; - File and Directory Comparison and Merge Tool |
2026 </para> | 2048 </para> |
2027 <para> | 2049 <para> |
2028 Program copyright 2002-2006 Joachim Eibl <email>joachim.eibl at gmx.de</email> | 2050 Program copyright 2002-2007 Joachim Eibl <email>joachim.eibl at gmx.de</email> |
2029 </para> | 2051 </para> |
2030 <para> | 2052 <para> |
2031 Several cool ideas and bugreports came from colleagues and many people out in the Wild Wild Web. Thank you! | 2053 Several cool ideas and bugreports came from colleagues and many people out in the Wild Wild Web. Thank you! |
2032 </para> | 2054 </para> |
2033 | 2055 |
2034 <para> | 2056 <para> |
2035 Documentation Copyright © 2002-2006 Joachim Eibl <email>joachim.eibl at gmx.de</email> | 2057 Documentation Copyright © 2002-2007 Joachim Eibl <email>joachim.eibl at gmx.de</email> |
2036 </para> | 2058 </para> |
2037 | 2059 |
2038 <!-- TRANS:CREDIT_FOR_TRANSLATORS --> | 2060 <!-- TRANS:CREDIT_FOR_TRANSLATORS --> |
2039 | 2061 |
2040 &underFDL; <!-- FDL: do not remove --> | 2062 &underFDL; <!-- FDL: do not remove --> |