1 <?xml version="1.0" encoding="UTF-8"?>
\r
2 <!DOCTYPE preface SYSTEM "../../dtd/dblite.dtd">
\r
3 <preface id="tsvn-preface">
\r
4 <title>Preface</title>
\r
6 <graphic srccredit="TortoiseGit Logo" fileref="images/TortoiseGit_logo_hor468x64.png" scalefit="1" width="100%"/>
\r
13 Do you work in a team?
\r
18 Has it ever happened that you were working on a file,
\r
19 and someone else was working on the same file at the same time?
\r
20 Did you lose your changes to that file because of that?
\r
25 Have you ever saved a file, and then wanted to
\r
26 revert the changes you made? Have you ever wished you
\r
27 could see what a file looked like some time ago?
\r
32 Have you ever found a bug in your project and
\r
33 wanted to know when that bug got into your files?
\r
39 If you answered <quote>yes</quote> to one of these questions, then
\r
40 TortoiseGit is for you! Just read on to find out how TortoiseGit
\r
41 can help you in your work. It's not that difficult.
\r
44 <!-- =================================================================== -->
\r
45 <!-- ======================== SECTION 1 ============================== -->
\r
46 <!-- =================================================================== -->
\r
47 <sect1 id="tsvn-preface-audience">
\r
48 <title>Audience</title>
\r
50 This book is written for computer literate folk who want to
\r
51 use Subversion to manage their data, but are uncomfortable using the
\r
52 command line client to do so. Since TortoiseGit is a windows shell
\r
53 extension it's assumed that the user is familiar with the windows
\r
54 explorer and knows how to use it.
\r
57 <!-- =================================================================== -->
\r
58 <!-- ======================== SECTION 1a ============================= -->
\r
59 <!-- =================================================================== -->
\r
60 <sect1 id="tsvn-preface-readingguide">
\r
61 <title>Reading Guide</title>
\r
63 This <xref linkend="tsvn-preface"/> explains a little about the
\r
64 TortoiseGit project, the community of people who work on it, and
\r
65 the licensing conditions for using it and distributing it.
\r
68 The <xref linkend="tsvn-introduction"/> explains what TortoiseGit is,
\r
69 what it does, where it comes from and the basics for installing it
\r
73 In <xref linkend="tsvn-basics"/> we give a short introduction
\r
74 to the <emphasis>Subversion</emphasis> revision control system which
\r
75 underlies TortoiseGit. This is borrowed from the documentation for the
\r
76 Subversion project and explains the different approaches to version
\r
77 control, and how Subversion works.
\r
80 Even most Subversion users will never have to set up a server themselves.
\r
81 The next chapter deals with how to set up such a server, and is useful
\r
85 The chapter on <xref linkend="tsvn-repository"/> explains how to set up
\r
86 a local repository, which is useful for testing Subversion and TortoiseGit
\r
87 using a single PC. It also explains a bit about repository administration
\r
88 which is also relevant to repositories located on a server.
\r
91 The <xref linkend="tsvn-dug"/> is the most important section as
\r
92 it explains all the main features of TortoiseGit and how to use them.
\r
93 It takes the form of a tutorial, starting with checking out a working copy,
\r
94 modifying it, committing your changes, etc. It then progresses to more
\r
98 <xref linkend="tsvn-subwcrev"/> is a separate program included with TortoiseGit
\r
99 which can extract the information from your working copy and write it into a
\r
100 file. This is useful for including build information in your projects.
\r
103 The <xref linkend="tsvn-howto"/> section answers some common questions
\r
104 about performing tasks which are not explicitly covered elsewhere.
\r
107 The section on <xref linkend="tsvn-automation"/> shows how the
\r
108 TortoiseGit GUI dialogs can be called from the command line. This is useful
\r
109 for scripting where you still need user interaction.
\r
112 The <xref linkend="tsvn-cli"/> give a correlation
\r
113 between TortoiseGit commands and their equivalents in the Subversion
\r
114 command line client <literal>svn.exe</literal>.
\r
117 <!-- =================================================================== -->
\r
118 <!-- ======================== SECTION 2 ============================== -->
\r
119 <!-- =================================================================== -->
\r
120 <sect1 id="tsvn-preface-source">
\r
121 <title>TortoiseGit is free!</title>
\r
123 TortoiseGit is free. You don't have to pay to use it, and you can use it
\r
124 any way you want. It is developed under the GNU General Public License (GPL).
\r
127 TortoiseGit is an Open Source project. That means you have full
\r
128 read access to the source code of this program. You can browse it
\r
130 <ulink url="http://TortoiseGit.tigris.org/svn/TortoiseGit/">
\r
131 <citetitle>http://TortoiseGit.tigris.org/svn/TortoiseGit/</citetitle>
\r
133 You will be prompted to enter username and password.
\r
134 The username is <literal>guest</literal>, and the password must be left blank.
\r
135 The most recent version (where we're currently working) is located under
\r
136 <filename>/trunk/</filename>,
\r
137 and the released versions are located under
\r
138 <filename>/tags/</filename>.
\r
141 <!-- =================================================================== -->
\r
142 <!-- ======================== SECTION 3 ============================== -->
\r
143 <!-- =================================================================== -->
\r
144 <sect1 id="tsvn-preface-community">
\r
145 <title>Community</title>
\r
147 Both TortoiseGit and Subversion are developed by a community of
\r
148 people who are working on those projects. They come from different
\r
149 countries all over the world and joined together to create wonderful
\r
153 <!-- =================================================================== -->
\r
154 <!-- ======================== SECTION 4 ============================== -->
\r
155 <!-- =================================================================== -->
\r
156 <sect1 id="tsvn-preface-acknowledgements">
\r
157 <title>Acknowledgments</title>
\r
160 <term>Tim Kemp</term>
\r
163 for founding the TortoiseGit project
\r
168 <term>Stefan Küng</term>
\r
171 for the hard work to get TortoiseGit to what it is now
\r
176 <term>Lübbe Onken</term>
\r
179 for the beautiful icons, logo, bug hunting, translating and
\r
180 managing the translations
\r
185 <term>Simon Large</term>
\r
188 for helping with the documentation and bug hunting
\r
193 <term>The Subversion Book</term>
\r
196 for the great introduction to Subversion and its
\r
197 chapter 2 which we copied here
\r
202 <term>The Tigris Style project</term>
\r
205 for some of the styles which are reused in this documentation
\r
210 <term>Our Contributors</term>
\r
213 for the patches, bug reports and new ideas, and for
\r
214 helping others by answering questions on our mailing list.
\r
219 <term>Our Donators</term>
\r
222 for many hours of joy with the music they sent us
\r
228 <!-- ================================================================= -->
\r
229 <!-- ======================== SECTION 5 ============================== -->
\r
230 <!-- ================================================================= -->
\r
231 <sect1 id="tsvn-preface-terminoloty">
\r
232 <title>Terminology used in this document</title>
\r
234 To make reading the docs easier, the names of all the screens and Menus
\r
235 from TortoiseGit are marked up in a different font.
\r
236 The <guilabel>Log Dialog</guilabel> for instance.
\r
239 A menu choice is indicated with an arrow.
\r
241 <guimenu>TortoiseGit</guimenu>
\r
242 <guimenuitem>Show Log</guimenuitem>
\r
244 means: select <emphasis>Show Log</emphasis> from the
\r
245 <emphasis>TortoiseGit</emphasis> context menu.
\r
248 Where a local context menu appears within one of the TortoiseGit
\r
249 dialogs, it is shown like this:
\r
251 <guimenu>Context Menu</guimenu>
\r
252 <guimenuitem>Save As ...</guimenuitem>
\r
256 User Interface Buttons are indicated like this:
\r
257 Press <guibutton>OK</guibutton> to continue.
\r
260 User Actions are indicated using a bold font.
\r
261 <keycap>Alt+A</keycap>: press the
\r
262 <keycap>Alt</keycap>-Key on your keyboard and while holding it down
\r
263 press the <keycap>A</keycap>-Key as well.
\r
264 <action>Right-drag</action>: press the right mouse button and while
\r
265 holding it down <emphasis>drag</emphasis> the items to the new location.
\r
268 System output and keyboard input is indicated with a
\r
269 <literal>different</literal> font as well.
\r
273 Important notes are marked with an icon.
\r
278 Tips that make your life easier.
\r
283 Places where you have to be careful what you are doing.
\r
288 Where extreme care has to be taken, data corruption or other
\r
289 nasty things may occur if these warnings are ignored.
\r
292 <graphic srccredit="hide" fileref="images/background.png" scalefit="1" width="100%"/>
\r