diff --git a/doc/changes.rst b/doc/changes.rst index 2e7df98b1..538aa2a46 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -2,7 +2,7 @@ Changes in DNF5 in comparison to DNF ==================================== -The chapter describe differences between `DNF5` (https://github.com/rpm-software-management/dnf5) and `DNF` +The chapter describe differences between ``DNF5`` (https://github.com/rpm-software-management/dnf5) and ``DNF`` (https://github.com/rpm-software-management/dnf) Changes on the API: @@ -15,7 +15,7 @@ Use PackageSet iterator to access the data instead. Package::get_epoch() -------------------- -The return type was changed from `unsigned long` to `std::string`. +The return type was changed from ``unsigned long`` to ``std::string``. DNF: Package.size, libdnf: dnf_package_get_size() @@ -32,18 +32,18 @@ The functions were dropped as unneeded. The installonly packages are taken direc Query::filter() - HY_PKG_UPGRADES_BY_PRIORITY, HY_PKG_OBSOLETES_BY_PRIORITY, HY_PKG_LATEST_PER_ARCH_BY_PRIORITY --------------------------------------------------------------------------------------------------------------- The priority filter was separated into a standalone method. -Combine `query.filter_priority()` with `query.filter_latest_evr()` or another filter to achieve the original +Combine ``query.filter_priority()`` with ``query.filter_latest_evr()`` or another filter to achieve the original functionality. Query::filter() - HY_PKG_LATEST ------------------------------- -The filter was replaced with `filter_latest_evr()` which has the same behavior as `HY_PKG_LATEST_PER_ARCH` +The filter was replaced with ``filter_latest_evr()`` which has the same behavior as ``HY_PKG_LATEST_PER_ARCH`` ConfigMain::proxy_auth_method() and ConfigRepo::proxy_auth_method() ------------------------------------------------------------------- -The return types were changed. `OptionEnum` was replaced by `OptionStringSet`. +The return types were changed. ``OptionEnum`` was replaced by ``OptionStringSet``. A combination of several authentication methods (for example "basic" and "digest") can now be used. This allows using a list of authentication methods in configuration files and the DNF5 command line "--setopt=proxy_auth_method=". @@ -52,118 +52,128 @@ This allows using a list of authentication methods in configuration files and th Changes on the command line: ============================ -Commands cannot have optional subcommands and optional arguments. Is some cases subcommand can have the same string as -an argument. It means there is a difficulty to find advisory for package with the name `list`, `info`, or `summary`. -`dnf history info ` -> `dnf history --info ` -`dnf updateinfo info` -> `dnf updateinfo --info` +Commands cannot have optional subcommands and optional arguments. Optional subcommands were ambiguous, it wasn't clear +whether the input is a command argument or a subcommand. If present, subcommands are now mandatory. +``dnf history `` -> ``dnf history info `` +``dnf updateinfo`` -> ``dnf updateinfo summary`` -Options that cannot be applied to all command or can be applied but without any effect should be removed from general -options and implemented only for related commands -`--best`, `--nobest` are only related several transaction commands +Options that cannot be applied to all commands or can be applied but without any effect should be removed from general +options and implemented only for related commands. +For example: ``--best``, ``--nobest`` are related to only several transaction commands. -Renaming boolean options to format `--