Details
-
Bug
-
Status: Closed (View Workflow)
-
Major
-
Resolution: Fixed
-
None
-
Notable changes
Description
This report is about documentation. I see that the category no longer exists but suppose somebody can forward it.
In
https://mariadb.com/docs/connectors/mariadb-connector-c/api-functions/mysql_optionsv
("mysql_optionsv")
these examples exist:
...
|
mysql_optionsv(mysql, MYSQL_OPT_NONBLOCK, 0);
|
...
|
mysql_optionsv(mysql, MYSQL_OPT_CAN_HANDLE_EXPIRED_PASSWORDS, 1);
|
...
|
mysql_optionsv(mysql, MYSQL_OPT_MAX_ALLOWED_PACKET, 0x40000000);
|
...
|
mysql_optionsv(mysql, MYSQL_OPT_NET_BUFFER_LENGTH, 0x40000000);
|
...
|
mysql_optionsv(mysql, MARIADB_OPT_PORT, 3307);
|
...
|
mysql_optionsv(mysql, MARIADB_OPT_FOUND_ROWS, 1);
|
...
|
mysql_optionsv(mysql, MARIADB_OPT_MULTI_RESULTS, 1);
|
...
|
mysql_optionsv(mysql, MYSQL_ENABLE_CLEARTEXT_PLUGIN, 1);
|
...
|
mysql_optionsv(mysql, MYSQL_SECURE_AUTH, 1);
|
...
|
mysql_optionsv(mysql, MYSQL_OPT_CONNECT_ATTR_RESET, 0);
|
These are all passing numeric literal values for a const void *.
The rest of this report is for
In https://mariadb.com/docs/server/server-management/install-and-upgrade-mariadb/configuring-mariadb/configuring-mariadb-with-option-files
("Configuring MariaDB with Option Files")
2.
The default MariaDB option file is called my.cnf (or mariadb.cnf) ...
But later on the same page:
On Linux, Unix, or Mac OS X, the default option file is called my.cnf.
And later on the same page there are several mentions of my.cnf, only.
Possible solution: don't mention mariadb.cnf.
3.
The effect of the configuration options are ...
Change to "effects" since the verb is "are".
4.
When the DEFAULT_SYSCONFDIR cmake option was not defined, MariaDB looks for the MariaDB option file in the following locations in the following order:
and
When the DEFAULT_SYSCONFDIR cmake option was defined, MariaDB looks for the MariaDB option file in the following locations in the following order:
I think "If" would be better than "When", and "option files" not "option file" – MariaDB looks for more than one.
5.
On Windows, the option file can be called either my.ini or my.cnf. MariaDB looks for the MariaDB option file in the following locations in the following order:
Again, MariaDB looks for "option files".
6.
... and then you could another option file ...
should be: "and then you could have another option file"
7.
... should be placed after ...
should be: "should be placed later".
8.
The syntax of the MariaDB option files are:
should be: "The syntax of the MariaDB option files is:"
And the line that follows this has a bad format.
9.
Dashes (-) and underscores (_) in options are interchangeable.
should be: "Dashes (-) and underscores (_) in option names are interchangeable.
10.
, , , \b, \s, \", \', and
are recognized as character escapes ...
where I see ,,, I assume there is an intent to show a special character perhaps reverse-solidus n
11.
... which includes both MariaDB and MySQL clients.
should be: "including both the mariadb client and the mysql client."
(maybe with links)
12.
... which includes both MariaDB Server and MySQL Server.
(repeated in a few places)
should be: "... for both MariaDB Server and MySQL Server."
13.
[mariadb-show]
Here I'll note that mariadb-show goes bad because it reads [client] group, for example
pgulutzan@pgulutzan-VirtualBox:~$ mariadb-show
|
mariadb-show: unknown variable 'init_command=SELECT 5;'
|
mariadb-show: unknown variable 'connect_timeout=109'
|
mariadb-show: unknown variable 'read_timeout=1000'
|
mariadb-show: unknown variable 'retry_count=1000'
|
14.
(in the --print-defaults example) (twice)
--max_allowed_packet=1GB
yes this works but elsewhere it's clear that the correct ending is G not GB.