[applied] fedabipkgdiff.rst: Sort options documentation alphabetically
Commit Message
Hello,
While looking at something else, I realized that the documentation
bullet points of the command line options are not alphabetically
sorted in doc/manuals/fedabipkgdiff.rst. This makes it hard to look
for a particular option.
Fixed thus.
* doc/manuals/fedabipkgdiff.rst: Sort the documentation of options
alphabetically.
Signed-off-by: Dodji Seketeli <dodji@redhat.com>
Applied to the mainline.
---
doc/manuals/fedabipkgdiff.rst | 106 +++++++++++++++++++---------------
1 file changed, 61 insertions(+), 45 deletions(-)
@@ -60,55 +60,46 @@ change reports that might be considered as false positives to users.
Options
=======
- * ``--help | -h``
+ * ``--abipkgdiff`` <path/to/abipkgdiff>
- Display a short help about the command and exit.
+ Specify an alternative abipkgdiff instead of the one installed in system.
- * ``--dry-run``
- Don't actually perform the ABI comparison. Details about what is
- going to be done are emitted on standard output.
+ * ``--all-subpackages``
- * ``--debug``
+ Instructs the tool to also compare the ABI of the binaries in the
+ sub-packages of the packages specified.
- Emit debugging messages about the execution of the program.
- Details about each method invocation, including input parameters
- and returned values, are emitted.
- * ``--traceback``
+ * ``--clean-cache``
- Show traceback when an exception raised. This is useful for
- developers of the tool itself to know more exceptional errors.
+ If you want to clean cache both before and after ABI comparison,
+ ``--clean-cache`` is the convenient way for you to save typing of two
+ options at same time.
- * ``--server`` <URL>
- Specifies the URL of the `Koji`_ XMLRPC service the tool talks to.
- The default value of this option is http://koji.fedoraproject.org/kojihub.
+ * ``--clean-cache-after``
- * ``--topurl`` <URL>
+ Clean cache after ABI comparison.
- Specifies the URL of the package store the tool downloads RPMs
- from. The default value of this option is https://kojipkgs.fedoraproject.org.
- * ``--from`` <distro>
+ * ``--clean-cache-before``
- Specifies the name of the baseline `Fedora`_ distribution in which to
- find the first `build`_ that is used for comparison. The
- ``distro`` value can be any valid value of the RPM macro
- ``%{?dist}`` for `Fedora`_, for example, ``fc4``, ``fc23``, ``fc25``.
+ Clean cache before ABI comparison.
- * ``--to`` <distro>
- Specifies the name of the `Fedora`_ distribution in which to find
- the `build`_ that is compared against the baseline specified by
- option ``--from``. The ``distro`` value could be any valid value
- of the RPM macro ``%{?dist}`` for `Fedora`_, for example, ``fc4``,
- ``fc23``.
+ * ``--debug``
- * ``--all-subpackages``
+ Emit debugging messages about the execution of the program.
+ Details about each method invocation, including input parameters
+ and returned values, are emitted.
+
+
+ * ``--dry-run``
+
+ Don't actually perform the ABI comparison. Details about what is
+ going to be done are emitted on standard output.
- Instructs the tool to also compare the ABI of the binaries in the
- sub-packages of the packages specified.
* ``--dso-only``
@@ -116,10 +107,18 @@ Options
provided, the tool compares the ABI of all ELF binaries found in
the packages.
- * ``--suppressions`` <*path-to-suppresions*>
- Use a :ref:`suppression specification <suppr_spec_label>` file
- located at *path-to-suppressions*.
+ * ``--from`` <distro>
+
+ Specifies the name of the baseline `Fedora`_ distribution in which to
+ find the first `build`_ that is used for comparison. The
+ ``distro`` value can be any valid value of the RPM macro
+ ``%{?dist}`` for `Fedora`_, for example, ``fc4``, ``fc23``, ``fc25``.
+
+
+ * ``--help | -h``
+
+ Display a short help about the command and exit.
* ``--no-default-suppression``
@@ -127,6 +126,7 @@ Options
Do not load the :ref:`default suppression specification files
<fedabipkgdiff_default_supprs_label>`.
+
* ``--no-devel-pkg``
Do not take associated development packages into account when
@@ -137,6 +137,12 @@ Options
defined in public header files available from the packages being
compared.
+ * ``--server`` <URL>
+
+ Specifies the URL of the `Koji`_ XMLRPC service the tool talks to.
+ The default value of this option is http://koji.fedoraproject.org/kojihub.
+
+
* ``--show-identical-binaries``
Show the names of the all binaries compared, including the
@@ -144,23 +150,33 @@ Options
not provided, only binaries with ABI changes are mentionned in the
output.
- * ``--abipkgdiff`` <path/to/abipkgdiff>
- Specify an alternative abipkgdiff instead of the one installed in system.
+ * ``--suppressions`` <*path-to-suppresions*>
- * ``--clean-cache-before``
+ Use a :ref:`suppression specification <suppr_spec_label>` file
+ located at *path-to-suppressions*.
- Clean cache before ABI comparison.
- * ``--clean-cache-after``
+ * ``--to`` <distro>
- Clean cache after ABI comparison.
+ Specifies the name of the `Fedora`_ distribution in which to find
+ the `build`_ that is compared against the baseline specified by
+ option ``--from``. The ``distro`` value could be any valid value
+ of the RPM macro ``%{?dist}`` for `Fedora`_, for example, ``fc4``,
+ ``fc23``.
- * ``--clean-cache``
- If you want to clean cache both before and after ABI comparison,
- ``--clean-cache`` is the convenient way for you to save typing of two
- options at same time.
+ * ``--topurl`` <URL>
+
+ Specifies the URL of the package store the tool downloads RPMs
+ from. The default value of this option is https://kojipkgs.fedoraproject.org.
+
+
+ * ``--traceback``
+
+ Show traceback when an exception raised. This is useful for
+ developers of the tool itself to know more exceptional errors.
+
.. _build: