Uploaded image for project: 'MariaDB Server'
  1. MariaDB Server
  2. MDEV-28671

Presentation of aliases in `mariadbd --verbose --help` is highly redundant

    XMLWordPrintable

Details

    Description

      There are many mariadbd command-line options and system variables which have aliases or alternate names:

      In some cases (e.g. --old-alter-table vs. --alter-algorithm), some of the names are deprecated.

      In other cases (e.g. --tmp-memory-table-size vs. --tmp-table-size), there's no clear distinction in terms of deprecation/preference.

      In all cases, the options/variable are listed multiple times in the mariadb --verbose --help output, with:

      • Almost entirely redundant content.
      • No consistent way in which the aliases or other names are presented.

      In order to simplify the documentation, it would be beneficial to combine the listing of these options in the verbose help text.

      Examples of how options with multiple names are shown now

      $ mariadbd --verbose --help
      		 
        ...
      		 
        --alter-algorithm[=name] 
                            Specify the alter table algorithm. One of: DEFAULT, COPY,
      		 
                            INPLACE, NOCOPY, INSTANT
      		 
        …
      		 
        --old-alter-table[=name] 
                            Alias for alter_algorithm. Deprecated. Use
      		 
                            --alter-algorithm instead.. One of: DEFAULT, COPY, 
                            INPLACE, NOCOPY, INSTANT
      		 
        ...
      		 
        --tmp-memory-table-size=# 
                            If an internal in-memory temporary table exceeds this
      		 
                            size, MariaDB will automatically convert it to an on-disk
      		 
                            MyISAM or Aria table. Same as tmp_table_size.
      		 
        --tmp-table-size=#  Alias for tmp_memory_table_size. If an internal in-memory
      		 
                            temporary table exceeds this size, MariaDB will
      		 
                            automatically convert it to an on-disk MyISAM or Aria
      		 
                            table.

      How these should be shown

      This format will considerably shorten the verbose help output, enable users to quickly recognize aliases, and identify which of those aliases are deprecated.

      $ mariadbd --verbose --help
      		 
        ...
      		 
        --alter-algorithm[=name] 
        --old-alter-table[=name]    (Deprecated)
      		 
                            Specify the alter table algorithm. One of: DEFAULT, COPY,
      		 
                            INPLACE, NOCOPY, INSTANT
      		 
        …
      		 
        --tmp-memory-table-size=# 
        --tmp-table-size=#
      		 
                            If an internal in-memory temporary table exceeds this
      		 
                            size, MariaDB will automatically convert it to an on-disk
      		 
                            MyISAM or Aria table.

      Attachments

        Issue Links

          blocks

          Task - A task that needs to be done. MDEV-29297 remove aliases of system variables

          • Major - Major loss of function.
          • Open

          Bug - A problem which impairs or prevents the functions of the product. MDEV-30731 Deprecated variables are not consistently highlighted

          • Major - Major loss of function.
          • Open
          includes

          Bug - A problem which impairs or prevents the functions of the product. MDEV-25275 Remove temp-pool option and/or deprecate it properly

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Closed

          Bug - A problem which impairs or prevents the functions of the product. MDEV-30332 PLUGIN_VAR_DEPRECATED fails to throw a warning on startup

          • Critical - Crashes, loss of data, severe memory leak.
          • Closed
          relates to

          Bug - A problem which impairs or prevents the functions of the product. MDEV-33503 innodb_log_files_in_group is quietly ignored

          • Major - Major loss of function.
          • Confirmed

          Activity

            People

              Unassigned Unassigned
              dlenski Daniel Lenski (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              11 Start watching this issue

              Dates

                Created:
                Updated:

                Git Integration

                  Error rendering 'com.xiplink.jira.git.jira_git_plugin:git-issue-webpanel'. Please contact your Jira administrators.