MDEV-20556 Remove references to "xtrabackup" and "innobackupex" in mariabackup --help

2 files changed, 41 insertions, 143 deletions

diff --git a/extra/mariabackup/innobackupex.cc b/extra/mariabackup/innobackupex.cc
index fefd81dc1be..c4c8ec7f17b 100644
--- a/extra/mariabackup/innobackupex.cc
+++ b/extra/mariabackup/innobackupex.cc
@@ -214,7 +214,7 @@ ibx_mode_t ibx_mode = IBX_MODE_BACKUP;
 
 static struct my_option ibx_long_options[] =
 {
-	{"version", 'v', "print xtrabackup version information",
+	{"version", 'v', "print version information",
 	 (uchar *) &opt_ibx_version, (uchar *) &opt_ibx_version, 0,
 	 GET_BOOL, NO_ARG, 0, 0, 0, 0, 0, 0},
 
@@ -257,12 +257,11 @@ static struct my_option ibx_long_options[] =
 	 (uchar *) &opt_ibx_slave_info, (uchar *) &opt_ibx_slave_info, 0,
 	 GET_BOOL, NO_ARG, 0, 0, 0, 0, 0, 0},
 
-	{"incremental", OPT_INCREMENTAL, "This option tells xtrabackup to "
-	 "create an incremental backup, rather than a full one. It is passed "
-	 "to the xtrabackup child process. When this option is specified, "
+	{"incremental", OPT_INCREMENTAL,
+	 "Create an incremental backup, rather than a full one. When this option is specified, "
 	 "either --incremental-lsn or --incremental-basedir can also be given. "
-	 "If neither option is given, option --incremental-basedir is passed "
-	 "to xtrabackup by default, set to the first timestamped backup "
+	 "If neither option is given, option --incremental-basedir is used "
+	 "by default, set to the first timestamped backup "
 	 "directory in the backup base directory.",
 	 (uchar *) &opt_ibx_incremental, (uchar *) &opt_ibx_incremental, 0,
 	 GET_BOOL, NO_ARG, 0, 0, 0, 0, 0, 0},
@@ -377,14 +376,14 @@ static struct my_option ibx_long_options[] =
 	{"incremental-history-name", OPT_INCREMENTAL_HISTORY_NAME,
 	 "This option specifies the name of the backup series stored in the "
 	 "PERCONA_SCHEMA.xtrabackup_history history record to base an "
-	 "incremental backup on. Xtrabackup will search the history table "
+	 "incremental backup on. Backup will search the history table "
 	 "looking for the most recent (highest innodb_to_lsn), successful "
 	 "backup in the series and take the to_lsn value to use as the "
 	 "starting lsn for the incremental backup. This will be mutually "
 	 "exclusive with --incremental-history-uuid, --incremental-basedir "
 	 "and --incremental-lsn. If no valid lsn can be found (no series by "
-	 "that name, no successful backups by that name) xtrabackup will "
-	 "return with an error. It is used with the --incremental option.",
+	 "that name, no successful backups by that name), "
+	 "an error will be returned. It is used with the --incremental option.",
 	 (uchar*) &opt_ibx_incremental_history_name,
 	 (uchar*) &opt_ibx_incremental_history_name, 0, GET_STR,
 	 REQUIRED_ARG, 0, 0, 0, 0, 0, 0},
@@ -394,8 +393,8 @@ static struct my_option ibx_long_options[] =
 	 "stored in the PERCONA_SCHEMA.xtrabackup_history to base an "
 	 "incremental backup on. --incremental-history-name, "
 	 "--incremental-basedir and --incremental-lsn. If no valid lsn can be "
-	 "found (no success record with that uuid) xtrabackup will return "
-	 "with an error. It is used with the --incremental option.",
+	 "found (no success record with that uuid), an error will be returned."
+	 " It is used with the --incremental option.",
 	 (uchar*) &opt_ibx_incremental_history_uuid,
 	 (uchar*) &opt_ibx_incremental_history_uuid, 0, GET_STR,
 	 REQUIRED_ARG, 0, 0, 0, 0, 0, 0},
@@ -424,7 +423,7 @@ static struct my_option ibx_long_options[] =
 	{"include", OPT_INCLUDE,
 	 "This option is a regular expression to be matched against table "
 	 "names in databasename.tablename format. It is passed directly to "
-	 "xtrabackup's --tables option. See the xtrabackup documentation for "
+	 "--tables option. See the documentation for "
 	 "details.",
 	 (uchar*) &opt_ibx_include,
 	 (uchar*) &opt_ibx_include, 0, GET_STR,
@@ -474,12 +473,6 @@ static struct my_option ibx_long_options[] =
 	 (uchar*) &opt_ibx_lock_wait_threshold, 0, GET_UINT,
 	 REQUIRED_ARG, 60, 0, 0, 0, 0, 0},
 
-	{"debug-sleep-before-unlock", OPT_DEBUG_SLEEP_BEFORE_UNLOCK,
-	 "This is a debug-only option used by the XtraBackup test suite.",
-	 (uchar*) &opt_ibx_debug_sleep_before_unlock,
-	 (uchar*) &opt_ibx_debug_sleep_before_unlock, 0, GET_UINT,
-	 REQUIRED_ARG, 0, 0, 0, 0, 0, 0},
-
 	{"safe-slave-backup-timeout", OPT_SAFE_SLAVE_BACKUP_TIMEOUT,
 	 "How many seconds --safe-slave-backup should wait for "
 	 "Slave_open_temp_tables to become zero. (default 300)",
@@ -492,22 +485,20 @@ static struct my_option ibx_long_options[] =
 	We put them here with only purpose for them to showup in
 	innobackupex --help output */
 
-	{"close_files", OPT_CLOSE_FILES, "Do not keep files opened. This "
-	 "option is passed directly to xtrabackup. Use at your own risk.",
+	{"close_files", OPT_CLOSE_FILES, "Do not keep files opened."
+	" Use at your own risk.",
 	 (uchar*) &ibx_xb_close_files, (uchar*) &ibx_xb_close_files, 0,
 	 GET_BOOL, NO_ARG, 0, 0, 0, 0, 0, 0},
 
-	{"compress", OPT_COMPRESS, "This option instructs xtrabackup to "
-	 "compress backup copies of InnoDB data files. It is passed directly "
-	 "to the xtrabackup child process. Try 'xtrabackup --help' for more "
-	 "details.", (uchar*) &ibx_xtrabackup_compress_alg,
+	{"compress", OPT_COMPRESS, "This option instructs backup to "
+	 "compress backup copies of InnoDB data files."
+	 , (uchar*) &ibx_xtrabackup_compress_alg,
 	 (uchar*) &ibx_xtrabackup_compress_alg, 0,
 	 GET_STR, OPT_ARG, 0, 0, 0, 0, 0, 0},
 
 	{"compress-threads", OPT_COMPRESS_THREADS,
 	 "This option specifies the number of worker threads that will be used "
-	 "for parallel compression. It is passed directly to the xtrabackup "
-	 "child process. Try 'xtrabackup --help' for more details.",
+	 "for parallel compression.",
 	 (uchar*) &ibx_xtrabackup_compress_threads,
 	 (uchar*) &ibx_xtrabackup_compress_threads,
 	 0, GET_UINT, REQUIRED_ARG, 1, 1, UINT_MAX, 0, 0, 0},
@@ -518,17 +509,15 @@ static struct my_option ibx_long_options[] =
 	 (uchar*) &ibx_xtrabackup_compress_chunk_size,
 	 0, GET_ULL, REQUIRED_ARG, (1 << 16), 1024, ULONGLONG_MAX, 0, 0, 0},
 
-	{"export", OPT_EXPORT, "This option is passed directly to xtrabackup's "
-	 "--export option. It enables exporting individual tables for import "
-	 "into another server. See the xtrabackup documentation for details.",
+	{"export", OPT_EXPORT, " enables exporting individual tables for import "
+	 "into another server.",
 	 (uchar*) &ibx_xtrabackup_export, (uchar*) &ibx_xtrabackup_export,
 	 0, GET_BOOL, NO_ARG, 0, 0, 0, 0, 0, 0},
 
 	{"extra-lsndir", OPT_EXTRA_LSNDIR, "This option specifies the "
 	 "directory in which to save an extra copy of the "
 	 "\"xtrabackup_checkpoints\" file. The option accepts a string "
-	 "argument. It is passed directly to xtrabackup's --extra-lsndir "
-	 "option. See the xtrabackup documentation for details.",
+	 "argument.",
 	 (uchar*) &ibx_xtrabackup_extra_lsndir,
 	 (uchar*) &ibx_xtrabackup_extra_lsndir,
 	 0, GET_STR, REQUIRED_ARG, 0, 0, 0, 0, 0, 0},
@@ -550,7 +539,7 @@ static struct my_option ibx_long_options[] =
 	 0, GET_STR, REQUIRED_ARG, 0, 0, 0, 0, 0, 0},
 
 	{"incremental-force-scan", OPT_INCREMENTAL_FORCE_SCAN,
-	 "This options tells xtrabackup to perform full scan of data files "
+	 "Perform full scan of data files "
 	 "for taking an incremental backup even if full changed page bitmap "
 	 "data is available to enable the backup without the full scan.",
 	 (uchar*)&ibx_xtrabackup_incremental_force_scan,
@@ -576,10 +565,8 @@ static struct my_option ibx_long_options[] =
 	 0, GET_STR, REQUIRED_ARG, 0, 0, 0, 0, 0, 0},
 
 	{"parallel", OPT_PARALLEL, "On backup, this option specifies the "
-	 "number of threads the xtrabackup child process should use to back "
-	 "up files concurrently.  The option accepts an integer argument. It "
-	 "is passed directly to xtrabackup's --parallel option. See the "
-	 "xtrabackup documentation for details.",
+	 "number of threads to use to back "
+	 "up files concurrently.  The option accepts an integer argument.",
 	 (uchar*) &ibx_xtrabackup_parallel, (uchar*) &ibx_xtrabackup_parallel,
 	 0, GET_INT, REQUIRED_ARG, 1, 1, INT_MAX, 0, 0, 0},
 
@@ -587,23 +574,21 @@ static struct my_option ibx_long_options[] =
 	{"stream", OPT_STREAM, "This option specifies the format in which to "
 	 "do the streamed backup.  The option accepts a string argument. The "
 	 "backup will be done to STDOUT in the specified format. Currently, "
-	 "the only supported formats are tar and mbstream/xbstream. This "
-	 "option is passed directly to xtrabackup's --stream option.",
+	 "the only supported formats are tar and mbstream/xbstream.",
 	 (uchar*) &ibx_xtrabackup_stream_str,
 	 (uchar*) &ibx_xtrabackup_stream_str, 0, GET_STR,
 	 REQUIRED_ARG, 0, 0, 0, 0, 0, 0},
 
 	{"tables-file", OPT_TABLES_FILE, "This option specifies the file in "
 	 "which there are a list of names of the form database.  The option "
-	 "accepts a string argument.table, one per line. The option is passed "
-	 "directly to xtrabackup's --tables-file option.",
+	 "accepts a string argument.table, one per line.",
 	 (uchar*) &ibx_xtrabackup_tables_file,
 	 (uchar*) &ibx_xtrabackup_tables_file,
 	 0, GET_STR, REQUIRED_ARG, 0, 0, 0, 0, 0, 0},
 
 	{"throttle", OPT_THROTTLE, "This option specifies a number of I/O "
 	 "operations (pairs of read+write) per second.  It accepts an integer "
-	 "argument.  It is passed directly to xtrabackup's --throttle option.",
+	 "argument.",
 	 (uchar*) &ibx_xtrabackup_throttle, (uchar*) &ibx_xtrabackup_throttle,
 	 0, GET_LONG, REQUIRED_ARG, 0, 0, LONG_MAX, 0, 1, 0},
 
@@ -615,11 +600,10 @@ static struct my_option ibx_long_options[] =
 	 0, 0, 0, 0, 0, 0},
 
 	{"use-memory", OPT_USE_MEMORY, "This option accepts a string argument "
-	 "that specifies the amount of memory in bytes for xtrabackup to use "
+	 "that specifies the amount of memory in bytes to use "
 	 "for crash recovery while preparing a backup. Multiples are supported "
 	 "providing the unit (e.g. 1MB, 1GB). It is used only with the option "
-	 "--apply-log. It is passed directly to xtrabackup's --use-memory "
-	 "option. See the xtrabackup documentation for details.",
+	 "--apply-log.",
 	 (uchar*) &ibx_xtrabackup_use_memory,
 	 (uchar*) &ibx_xtrabackup_use_memory,
 	 0, GET_LL, REQUIRED_ARG, 100*1024*1024L, 1024*1024L, LONGLONG_MAX, 0,
@@ -641,7 +625,7 @@ static struct my_option ibx_long_options[] =
 
 static void usage(void)
 {
-	puts("Open source backup tool for InnoDB and XtraDB\n\
+	puts("Open source backup tool\n\
 \n\
 Copyright (C) 2009-2015 Percona LLC and/or its affiliates.\n\
 Portions Copyright (C) 2000, 2011, MySQL AB & Innobase Oy. All Rights Reserved.\n\
@@ -692,7 +676,7 @@ innobackupex [--decompress]\n\
 \n\
 DESCRIPTION\n\
 \n\
-The first command line above makes a hot backup of a MySQL database.\n\
+The first command line above makes a hot backup of a database.\n\
 By default it creates a backup directory (named by the current date\n\
 	and time) in the given backup root directory.  With the --no-timestamp\n\
 option it does not create a time-stamped backup directory, but it puts\n\
@@ -702,22 +686,18 @@ indexes in all databases or in all of the databases specified with the\n\
 --databases option.  The created backup contains .frm, .MRG, .MYD,\n\
 .MYI, .MAD, .MAI, .TRG, .TRN, .ARM, .ARZ, .CSM, CSV, .opt, .par, and\n\
 InnoDB data and log files.  The MY.CNF options file defines the\n\
-location of the database.  This command connects to the MySQL server\n\
-using the mysql client program, and runs xtrabackup as a child\n\
-process.\n\
+location of the database.\n\
 \n\
 The --apply-log command prepares a backup for starting a MySQL\n\
 server on the backup. This command recovers InnoDB data files as specified\n\
 in BACKUP-DIR/backup-my.cnf using BACKUP-DIR/ib_logfile0,\n\
 and creates new InnoDB log files as specified in BACKUP-DIR/backup-my.cnf.\n\
-The BACKUP-DIR should be the path to a backup directory created by\n\
-xtrabackup. This command runs xtrabackup as a child process, but it does not \n\
-connect to the database server.\n\
+The BACKUP-DIR should be the path to a backup directory\n\
 \n\
 The --copy-back command copies data, index, and log files\n\
 from the backup directory back to their original locations.\n\
 The MY.CNF options file defines the original location of the database.\n\
-The BACKUP-DIR is the path to a backup directory created by xtrabackup.\n\
+The BACKUP-DIR is the path to a backup directory.\n\
 \n\
 The --move-back command is similar to --copy-back with the only difference that\n\
 it moves files to their original locations rather than copies them. As this\n\
diff --git a/extra/mariabackup/xtrabackup.cc b/extra/mariabackup/xtrabackup.cc
index d4e7114f635..dc6227b6b7b 100644
--- a/extra/mariabackup/xtrabackup.cc
+++ b/extra/mariabackup/xtrabackup.cc
@@ -267,8 +267,6 @@ it every INNOBASE_WAKE_INTERVAL'th step. */
 ulong	innobase_active_counter	= 0;
 
 
-static char *xtrabackup_debug_sync = NULL;
-
 my_bool xtrabackup_incremental_force_scan = FALSE;
 
 /*
@@ -1059,7 +1057,7 @@ enum options_xtrabackup
 struct my_option xb_client_options[]= {
     {"verbose", 'V', "display verbose output", (G_PTR *) &verbose,
      (G_PTR *) &verbose, 0, GET_BOOL, NO_ARG, FALSE, 0, 0, 0, 0, 0},
-    {"version", 'v', "print xtrabackup version information",
+    {"version", 'v', "print version information",
      (G_PTR *) &xtrabackup_version, (G_PTR *) &xtrabackup_version, 0, GET_BOOL,
      NO_ARG, 0, 0, 0, 0, 0, 0},
     {"target-dir", OPT_XTRA_TARGET_DIR, "destination directory",
@@ -1356,8 +1354,8 @@ struct my_option xb_client_options[]= {
      "starting lsn for the incremental backup. This will be mutually "
      "exclusive with --incremental-history-uuid, --incremental-basedir "
      "and --incremental-lsn. If no valid lsn can be found (no series by "
-     "that name, no successful backups by that name) xtrabackup will "
-     "return with an error. It is used with the --incremental option.",
+     "that name, no successful backups by that name), an error will be returned."
+     " It is used with the --incremental option.",
      (uchar *) &opt_incremental_history_name,
      (uchar *) &opt_incremental_history_name, 0, GET_STR, REQUIRED_ARG, 0, 0,
      0, 0, 0, 0},
@@ -1367,8 +1365,8 @@ struct my_option xb_client_options[]= {
      "stored in the PERCONA_SCHEMA.xtrabackup_history to base an "
      "incremental backup on. --incremental-history-name, "
      "--incremental-basedir and --incremental-lsn. If no valid lsn can be "
-     "found (no success record with that uuid) xtrabackup will return "
-     "with an error. It is used with the --incremental option.",
+     "found (no success record with that uuid), an error will be returned."
+     " It is used with the --incremental option.",
      (uchar *) &opt_incremental_history_uuid,
      (uchar *) &opt_incremental_history_uuid, 0, GET_STR, REQUIRED_ARG, 0, 0,
      0, 0, 0, 0},
@@ -1425,11 +1423,6 @@ struct my_option xb_client_options[]= {
      (uchar *) &opt_lock_wait_threshold, (uchar *) &opt_lock_wait_threshold, 0,
      GET_UINT, REQUIRED_ARG, 60, 0, 0, 0, 0, 0},
 
-    {"debug-sleep-before-unlock", OPT_DEBUG_SLEEP_BEFORE_UNLOCK,
-     "This is a debug-only option used by the XtraBackup test suite.",
-     (uchar *) &opt_debug_sleep_before_unlock,
-     (uchar *) &opt_debug_sleep_before_unlock, 0, GET_UINT, REQUIRED_ARG, 0, 0,
-     0, 0, 0, 0},
 
     {"safe-slave-backup-timeout", OPT_SAFE_SLAVE_BACKUP_TIMEOUT,
      "How many seconds --safe-slave-backup should wait for "
@@ -1439,9 +1432,9 @@ struct my_option xb_client_options[]= {
      0, 0, 0, 0, 0},
 
     {"binlog-info", OPT_BINLOG_INFO,
-     "This option controls how XtraBackup should retrieve server's binary log "
+     "This option controls how backup should retrieve server's binary log "
      "coordinates corresponding to the backup. Possible values are OFF, ON, "
-     "LOCKLESS and AUTO. See the XtraBackup manual for more information",
+     "LOCKLESS and AUTO.",
      &opt_binlog_info, &opt_binlog_info, &binlog_info_typelib, GET_ENUM,
      OPT_ARG, BINLOG_INFO_AUTO, 0, 0, 0, 0, 0},
 
@@ -1615,13 +1608,6 @@ struct my_option xb_server_options[] =
    &dbug_option, &dbug_option, 0, GET_STR, OPT_ARG,
    0, 0, 0, 0, 0, 0},
 #endif
-#ifndef __WIN__
-  {"debug-sync", OPT_XTRA_DEBUG_SYNC,
-   "Debug sync point. This is only used by the xtrabackup test suite",
-   (G_PTR*) &xtrabackup_debug_sync,
-   (G_PTR*) &xtrabackup_debug_sync,
-   0, GET_STR, REQUIRED_ARG, 0, 0, 0, 0, 0, 0},
-#endif
 
   {"innodb_checksum_algorithm", OPT_INNODB_CHECKSUM_ALGORITHM,
   "The algorithm InnoDB uses for page checksumming. [CRC32, STRICT_CRC32, "
@@ -1665,7 +1651,7 @@ struct my_option xb_server_options[] =
    REQUIRED_ARG, 0, 0, UINT_MAX, 0, 1, 0},
 
   {"lock-ddl-per-table", OPT_LOCK_DDL_PER_TABLE, "Lock DDL for each table "
-   "before xtrabackup starts to copy it and until the backup is completed.",
+   "before backup starts to copy it and until the backup is completed.",
    (uchar*) &opt_lock_ddl_per_table, (uchar*) &opt_lock_ddl_per_table, 0,
    GET_BOOL, NO_ARG, 0, 0, 0, 0, 0, 0},
 
@@ -1696,60 +1682,6 @@ struct my_option xb_server_options[] =
 
 uint xb_server_options_count = array_elements(xb_server_options);
 
-#ifndef __WIN__
-static int debug_sync_resumed;
-
-static void sigcont_handler(int sig);
-
-static void sigcont_handler(int sig __attribute__((unused)))
-{
-	debug_sync_resumed= 1;
-}
-#endif
-
-static inline
-void
-debug_sync_point(const char *name)
-{
-#ifndef __WIN__
-	FILE	*fp;
-	pid_t	pid;
-	char	pid_path[FN_REFLEN];
-
-	if (xtrabackup_debug_sync == NULL) {
-		return;
-	}
-
-	if (strcmp(xtrabackup_debug_sync, name)) {
-		return;
-	}
-
-	pid = getpid();
-
-	snprintf(pid_path, sizeof(pid_path), "%s/xtrabackup_debug_sync",
-		 xtrabackup_target_dir);
-	fp = fopen(pid_path, "w");
-	if (fp == NULL) {
-		die("Can't open open %s", pid_path);
-	}
-	fprintf(fp, "%u\n", (uint) pid);
-	fclose(fp);
-
-	msg("mariabackup: DEBUG: Suspending at debug sync point '%s'. "
-	    "Resume with 'kill -SIGCONT %u'.", name, (uint) pid);
-
-	debug_sync_resumed= 0;
-	kill(pid, SIGSTOP);
-	while (!debug_sync_resumed) {
-		sleep(1);
-	}
-
-	/* On resume */
-	msg("mariabackup: DEBUG: removing the pid file.");
-	my_delete(pid_path, MYF(MY_WME));
-#endif
-}
-
 
 static std::set<std::string> tables_for_export;
 
@@ -3109,8 +3041,6 @@ static bool xtrabackup_copy_logfile(bool last = false)
 	log_copy_scanned_lsn = start_lsn;
 	pthread_cond_broadcast(&scanned_lsn_cond);
 	pthread_mutex_unlock(&backup_mutex);
-
-	debug_sync_point("xtrabackup_copy_logfile_pause");
 	return(false);
 }
 
@@ -3242,8 +3172,6 @@ data_copy_thread_func(
 	*/
 	my_thread_init();
 
-	debug_sync_point("data_copy_thread_func");
-
 	while ((node = datafiles_iter_next(ctxt->it)) != NULL) {
 		DBUG_MARIABACKUP_EVENT("before_copy", node->space->name);
 		DBUG_EXECUTE_FOR_KEY("wait_innodb_redo_before_copy", node->space->name,
@@ -3774,8 +3702,6 @@ xb_load_tablespaces()
 	if (err != DB_SUCCESS) {
 		return(err);
 	}
-
-	debug_sync_point("xtrabackup_load_tablespaces_pause");
 	DBUG_MARIABACKUP_EVENT("after_load_tablespaces", 0);
 	return(DB_SUCCESS);
 }
@@ -4660,8 +4586,6 @@ fail_before_log_copying_thread_start:
 	if (!flush_changed_page_bitmaps()) {
 		goto fail;
 	}
-	debug_sync_point("xtrabackup_suspend_at_start");
-
 
 	ut_a(xtrabackup_parallel > 0);
 
@@ -6881,12 +6805,6 @@ static int main_low(char** argv)
 		}
 	}
 
-#ifndef __WIN__
-	if (xtrabackup_debug_sync) {
-		signal(SIGCONT, sigcont_handler);
-	}
-#endif
-
 	/* --backup */
 	if (xtrabackup_backup && !xtrabackup_backup_func()) {
 		return(EXIT_FAILURE);