List:Commits« Previous MessageNext Message »
From:john.russell Date:October 18 2010 4:41pm
Subject:svn commit - mysqldoc@docsrva: r23190 - trunk/mysql-enterprise-backup-3.5
View as plain text  
Author: jrussell
Date: 2010-10-18 18:41:47 +0200 (Mon, 18 Oct 2010)
New Revision: 23190

Log:
Cleaned up the early overview, planning, and installation sections.


Modified:
   trunk/mysql-enterprise-backup-3.5/manual.xml


Modified: trunk/mysql-enterprise-backup-3.5/manual.xml
===================================================================
--- trunk/mysql-enterprise-backup-3.5/manual.xml	2010-10-18 16:31:41 UTC (rev 23189)
+++ trunk/mysql-enterprise-backup-3.5/manual.xml	2010-10-18 16:41:47 UTC (rev 23190)
Changed blocks: 8, Lines Added: 45, Lines Deleted: 40; 8509 bytes

@@ -31,9 +31,9 @@
       performs <link linkend="glos_hot_backup">hot backup</link>
       operations for MySQL databases. The product is architected for
       efficient and reliable backups of tables created by the
-      <link linkend="glos_innodb">InnoDB storage engine</link>. On UNIX
-      and Linux systems, it can also back up tables from MyISAM and
-      other storage engines.
+      <link linkend="glos_innodb">InnoDB storage engine</link>. For
+      completeness, it can also back up tables from MyISAM and other
+      storage engines.
     </para>
 
     <bridgehead>Hot Backups</bridgehead>

@@ -70,24 +70,28 @@
       <link linkend="glos_innobackup_command">&hlbackup; command</link>,
       depending on the kinds of tables you are backing up.
       <literal>&llbackup;</literal> is the simple and efficient way to
-      back up InnoDB tables only. <literal>&hlbackup;</literal> is the
-      more flexible way to back up both InnoDB tables and tables from
-      other storage engines at the same time.
+      back up InnoDB tables only, with many command-line options so that
+      you can build your own backup script around it.
+      <literal>&hlbackup;</literal> is the more flexible way to back up
+      both InnoDB tables and tables from other storage engines at the
+      same time; it also does other things that you would otherwise code
+      into your own script, such as creating a timestamped subdirectory
+      for each backup.
     </para>
 
     <bridgehead>Performance and Space Considerations</bridgehead>
 
     <para>
-      In planning your backup strategy, you must choose the balance
-      between the overhead of performing the backup (CPU cycles, storage
-      space, and network traffic), and the time needed to restore the
-      data during planned maintenance or when disaster strikes. Using
+      In planning your backup strategy, you choose the balance between
+      the overhead of performing the backup (CPU cycles, storage space,
+      and network traffic), and the time needed to restore the data
+      during planned maintenance or when disaster strikes. Using
       features such as
       <link linkend="glos_incremental_backup">incremental backups</link>
       and <link linkend="glos_compressed_backup">compressed
       backups</link> saves on storage space, and network traffic if you
       keep the backup data on a different server. Compression adds some
-      CPU overhead to the backup process, Incremental backup requires
+      CPU overhead to the backup process; incremental backup requires
       additional processing to make the backup ready to restore. For
       disaster recovery, when speed to restore the data is critical, you
       might prefer to have the backup data already prepared and

@@ -122,25 +126,25 @@
     <para>
       The files, as they are originally copied, form a
       <link linkend="glos_raw_backup">raw backup</link> that requires
-      further processing to be ready to be restored. You must then run
-      the <link linkend="glos_apply">apply</link> step, which updates
-      the backup files based on the changes recorded in the
+      further processing to be ready to be restored. You then run the
+      <link linkend="glos_apply">apply</link> step, which updates the
+      backup files based on the changes recorded in the
       <literal>ibbackup_logfile</literal> file, producing a
       <link linkend="glos_prepared_backup">prepared backup</link>. At
       this point, the backup data corresponds to a single point in time.
       The files are now ready to be restored to their original location,
-      or for testing or other use of the backup data by running
-      <literal>mysqld</literal> in a new data directory.
+      or for some other use, such as testing or deployment as a
+      replication slave.
     </para>
 
     <para>
-      To properly restore InnoDB tables to their original state, you
-      must also have the corresponding
-      <link linkend="glos_frm_file">.FRM files</link> along with the
-      backup data. Otherwise, the table definitions could be missing or
-      outdated if someone has run <literal>ALTER TABLE</literal> or
-      <literal>DROP TABLE</literal> statements since the backup. Copying
-      the <literal>.FRM</literal> files is automated by the
+      To restore InnoDB tables to their original state, you must also
+      have the corresponding <link linkend="glos_frm_file">.FRM
+      files</link> along with the backup data. Otherwise, the table
+      definitions could be missing or outdated, if someone has run
+      <literal>ALTER TABLE</literal> or <literal>DROP TABLE</literal>
+      statements since the backup. Copying the <literal>.FRM</literal>
+      files is automated by the
       <link linkend="glos_innobackup_command">&hlbackup; command</link>.
       If you rely on the lower-level
       <link linkend="glos_ibbackup_command">&llbackup; command</link>

@@ -149,10 +153,10 @@
     </para>
 
     <para>
-      The <link linkend="glos_myd_files">.MYD files</link>,
+      The <literal>&hlbackup;</literal> command can also back up the
+      <link linkend="glos_myd_files">.MYD files</link>,
       <link linkend="glos_myi_files">.MYI files</link>, and associated
-      <literal>.FRM</literal> files for MyISAM tables can also be backed
-      up by the <literal>&hlbackup;</literal> command. The same applies
+      <literal>.FRM</literal> files for MyISAM tables. The same applies
       to files with other extensions, as shown in
       <link linkend="known-file-extensions">this list</link>. MyISAM
       tables and these other types of files cannot be backed up in the

@@ -172,6 +176,8 @@
       <secondary>installation</secondary>
     </indexterm>
 
+<!-- JDR: confirm install details with Ingo. -->
+
     <para>
       The MySQL Enterprise Backup product is packaged as either an
       archive file (<literal>.tgz</literal>, archived with

@@ -183,8 +189,6 @@
 
     <bridgehead>Installing on Unix and Linux Systems</bridgehead>
 
-<!-- JDR: confirm install details with Ingo. -->
-
     <para>
       For all Linux and Unix systems, the product is available as a
       <literal>.tgz</literal> file. Unpack this file as follows:

@@ -226,7 +230,7 @@
 
     <para>
       Choose the option to add this directory to the windows
-      <literal>PATH</literal> setting, so that you can run the
+      <literal>%PATH%</literal> setting, so that you can run the
       <literal>&llbackup;</literal> command from a command prompt.
     </para>
 

@@ -4491,24 +4495,25 @@
 <programlisting>
 Henry Spencer's Regular-Expression Library (RegEX-Spencer)
 
-Copyright 1992, 1993, 1994 Henry Spencer.  All rights reserved.
+Copyright 1992, 1993, 1994, 1997 Henry Spencer. All rights reserved.
 This software is not subject to any license of the American Telephone
-and Telegraph Company or of the Regents of the University of California.
+and Telegraph Company or of the Regents of the University of
+California.
 
-Permission is granted to anyone to use this software for any purpose on
-any computer system, and to alter it and redistribute it, subject
+Permission is granted to anyone to use this software for any purpose 
+on any computer system, and to alter it and redistribute it, subject 
 to the following restrictions:
 
-1. The author is not responsible for the consequences of use of this
-   software, no matter how awful, even if they arise from flaws in it.
+1. The author is not responsible for the consequences of use of this 
+software, no matter how awful, even if they arise from flaws in it.
 
-2. The origin of this software must not be misrepresented, either by
-   explicit claim or by omission.  Since few users ever read sources,
-   credits must appear in the documentation.
+2. The origin of this software must not be misrepresented, either by 
+explicit claim or by omission. Since few users ever read sources, 
+credits must appear in the documentation.
 
 3. Altered versions must be plainly marked as such, and must not be
-   misrepresented as being the original software.  Since few users
-   ever read sources, credits must appear in the documentation.
+misrepresented as being the original software.  Since few users ever 
+read sources, credits must appear in the documentation.
 
 4. This notice may not be removed or altered.
 </programlisting>


Thread
svn commit - mysqldoc@docsrva: r23190 - trunk/mysql-enterprise-backup-3.5john.russell18 Oct