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

Errors or omissions in documentation of option files syntax

    XMLWordPrintable

Details

    • Bug
    • Status: Closed (View Workflow)
    • Minor
    • Resolution: Fixed
    • None
    • N/A
    • Documentation
    • None

    Description

      The manual https://mariadb.com/kb/en/configuring-mariadb-with-option-files/#option-file-syntax
      Configuring MariaDB with Option Files – Option File Syntax
      has some errors or omissions. I checked with the mariadb client that comes with version 11.4.
      1. "The syntax of the MariaDB option files are:"
      is itself bad syntax. It should be
      "The syntax of the MariaDB option files is:"
      2. "Lines starting with # are comments."
      is incomplete because such comments can start after the start of a line. It should be
      "# is the start of a comment as far as the end of a line.
      3. There's nothing about semicolons. Somewhere, probably just after the bit about #, should be
      "Lines starting with ; are comments."
      4. "Option groups use the syntax [group-name]."
      This is vague, it doesn't say where. It should be
      "Option groups begin with a line containing a group name inside square brackets: [group-name].
      5. "Dashes (-) and underscores (_) in options are interchangeable."
      I believe elsewhere in the manual it's slightly more common to call "-" 0x2d a hyphen.
      And I believe it would be a bug if user=ad-min is the same as user=ad_min. It should be
      "Hyphens (-) and underscores (_) in option names are interchangeable."
      See also MDEV-13989.
      6. "Double quotes can be used to quote values "
      Single quotes can be used too, unless allowing them is an error. It should be
      "Double quotes or single quotes can be used to quote values."
      By the way, user=admin and user="'admin'" are the same thing though I won't pretend to care.

      Attachments

        Activity

          People

            stefan.hinz Stefan Hinz
            Peter Gulutzan Peter Gulutzan
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Git Integration

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