CHANGELOG.md: init

docs/mysql-admutils-compatibility.md

@@ -10,17 +10,19 @@ cargo build
 
 These symlinks are also included in the deb packages.
 
-### Known deviations from the original programs
+### Known deviations from `mysql-admutils`' behaviour
 
-- Added flags for database configuration, not present in the original programs
-- `--help` output is formatted by clap in a modern style.
-- `mysql-dbadm edit-perm` uses the new implementation. Parsing the old logic was
-  too complex to be worth porting, and since the action is inherently interactive,
+- `--help` output is formatted by clap in a different style.
+- `mysql-dbadm edit-perm` uses the new privilege editor implementation. Replicating
+  the old behaviour
   there shoulnd't have been any (or at least very few) scripts relying on the old
   command API or behavior.
-- The new tools use the modern implementation to find it's configuration. If you compiled
-  the old programs with `--sysconfdir=<somewhere>`, you might have to provide `--config-file`
-  where the old program would just work by itself.
-- The order in which some things are validated (e.g. whether you own a user, whether the
+- The new tools use the new implementation to find it's configuration file, and uses the
+  new configuration format. See the example config and installation instructions for more
+  information about how to configure the software.
+- The order in which input is validated (e.g. whether you own a user, whether the
   contains illegal characters, whether the user does or does not exist) might be different
-  from the original program, leading to the same command giving the errors in a different order.
+  from the original program, leading to the same command reporting different errors.
+- Arguments are de-duplicated, meaning that if you run something like
+  `mysql-dbadm create user_db1 user_db2 user_db1`, the program will only try to create
+  the `user_db1` once. The old program would attempt to create it twice, failing the second time.