From 018a9345d680ee6d199a671ea9b7e3ceea35ab96 Mon Sep 17 00:00:00 2001 From: Dodji Seketeli Date: Fri, 17 Jul 2015 11:14:46 +0200 Subject: [PATCH] Fix '--' being rendered as '-' in html manuals * doc/manuals/abicompat.rst: Quote options as verbatim. * doc/manuals/abidiff.rst: Likewise. * doc/manuals/abidw.rst: Likewise. * doc/manuals/abilint.rst: Likewise. * doc/manuals/abipkgdiff.rst: Likewise. Signed-off-by: Dodji Seketeli --- doc/manuals/abicompat.rst | 14 +++++------ doc/manuals/abidiff.rst | 50 +++++++++++++++++++------------------- doc/manuals/abidw.rst | 12 ++++----- doc/manuals/abilint.rst | 13 +++++----- doc/manuals/abipkgdiff.rst | 12 ++++----- 5 files changed, 51 insertions(+), 50 deletions(-) diff --git a/doc/manuals/abicompat.rst b/doc/manuals/abicompat.rst index 3bf55157..547c648b 100644 --- a/doc/manuals/abicompat.rst +++ b/doc/manuals/abicompat.rst @@ -24,15 +24,15 @@ Invocation Options ======= - * --help + * ``--help`` Display a short help about the command and exit. - * --list-undefined-symbols|-u + * ``--list-undefined-symbols | -u`` Display the list of undefined symbols of the application and exit. - * --show-base-names|-b + * ``--show-base-names | -b`` In the resulting report emitted by the tool, this option makes the application and libraries be referred to by their base names only; @@ -40,28 +40,28 @@ Options scripts that wants to compare names of the application and libraries independently of what their directory names are. - * --app-debug-info-dir + * ``--app-debug-info-dir`` Set the path to the directory under which the debug information of the application is supposed to be laid out. This is useful for application binaries for which the debug info is in a separate set of files. - * --lib-debug-info-dir1 + * ``--lib-debug-info-dir1`` Set the path to the directory under which the debug information of the first version of the shared library is supposed to be laid out. This is useful for shared library binaries for which the debug info is in a separate set of files. - * --lib-debug-info-dir2 + * ``--lib-debug-info-dir2`` Set the path to the directory under which the debug information of the second version of the shared library is supposed to be laid out. This is useful for shared library binaries for which the debug info is in a separate set of files. - * --weak-mode + * ``--weak-mode`` This triggers the weak mode of ``abicompat``. In this mode, only one version of the library is required. That is, abicompat is diff --git a/doc/manuals/abidiff.rst b/doc/manuals/abidiff.rst index c9260b89..c6551cc6 100644 --- a/doc/manuals/abidiff.rst +++ b/doc/manuals/abidiff.rst @@ -28,11 +28,11 @@ Invocation Options ======= - * --help + * ``--help`` Display a short help about the command and exit. - * --debug-info-dir1 | --d1 <*di-path1*> + * ``--debug-info-dir1 | --d1`` <*di-path1*> For cases where the debug information for *first-shared-library* is split out into a separate file, tells ``abidiff`` where to find @@ -47,71 +47,71 @@ Options information installed by your system's package manager because then ``abidiff`` knows where to find it. - * --debug-info-dir2 | --d2 <*di-path2*> + * ``--debug-info-dir2 | --d2`` <*di-path2*> Like ``--debug-info-dir1``, this options tells ``abidiff`` where to find the split debug information for the *second-shared-library* file. - * --stat + * ``--stat`` Rather than displaying the detailed ABI differences between *first-shared-library* and *second-shared-library*, just display some summary statistics about these differences. - * --symtabs + * ``--symtabs`` Only display the symbol tables of the *first-shared-library* and *second-shared-library*. - * --deleted-fns + * ``--deleted-fns`` In the resulting report about the differences between *first-shared-library* and *second-shared-library*, only display the globally defined functions that got deleted from *first-shared-library*. - * --changed-fns + * ``--changed-fns`` In the resulting report about the differences between *first-shared-library* and *second-shared-library*, only display the changes in sub-types of the global functions defined in *first-shared-library*. - * --added-fns + * ``--added-fns`` In the resulting report about the differences between *first-shared-library* and *second-shared-library*, only display the globally defined functions that were added to *second-shared-library*. - * --deleted-vars + * ``--deleted-vars`` In the resulting report about the differences between *first-shared-library* and *second-shared-library*, only display the globally defined variables that were deleted from *first-shared-library*. - * --changed-vars + * ``--changed-vars`` In the resulting report about the differences between *first-shared-library* and *second-shared-library*, only display the changes in the sub-types of the global variables defined in *first-shared-library* - * --added-vars + * ``--added-vars`` In the resulting report about the differences between *first-shared-library* and *second-shared-library*, only display the global variables that were added (defined) to *second-shared-library*. - * --no-linkage-name + * ``--no-linkage-name`` In the resulting report, do not display the linkage names of the added, removed, or changed functions or variables. - * --no-unreferenced-symbols + * ``--no-unreferenced-symbols`` In the resulting report, do not display change information about function and variable symbols that are not referenced by any debug @@ -120,12 +120,12 @@ Options added or removed symbols. - * --suppressions <*path-to-suppressions*> + * ``--suppressions`` <*path-to-suppressions*> Use a :ref:`suppression specification ` file located at *path-to-suppressions*. - * --drop <*regex*> + * ``--drop`` <*regex*> When reading the *first-shared-library* and *second-shared-library* ELF input files, drop the globally defined @@ -133,7 +133,7 @@ Options *regex*. As a result, no change involving these functions or variables will be emitted in the diff report. - * --drop-fn <*regex*> + * ``--drop-fn`` <*regex*> When reading the *first-shared-library* and *second-shared-library* ELF input files, drop the globally defined @@ -141,13 +141,13 @@ Options result, no change involving these functions will be emitted in the diff report. - * --drop-var <*regex*> + * ``--drop-var`` <*regex*> When reading the *first-shared-library* and *second-shared-library* ELF input files, drop the globally defined variables matching a the regular expression *regex*. - * --keep <*regex*> + * ``--keep`` <*regex*> When reading the *first-shared-library* and *second-shared-library* ELF input files, keep the globally defined @@ -155,7 +155,7 @@ Options *regex*. All other functions and variables are dropped on the floor and will thus not appear in the resulting diff report. - * --keep-fn <*regex*> + * ``--keep-fn`` <*regex*> When reading the *first-shared-library* and *second-shared-library* ELF input files, keep the globally defined @@ -163,7 +163,7 @@ Options other functions are dropped on the floor and will thus not appear in the resulting diff report. - * --keep-var <*regex*> + * ``--keep-var`` <*regex*> When reading the *first-shared-library* and *second-shared-library* ELF input files, keep the globally defined @@ -171,32 +171,32 @@ Options variables are dropped on the floor and will thus not appear in the resulting diff report. - * --harmless + * ``--harmless`` In the diff report, display only the :ref:`harmless ` changes. By default, the harmless changes are filtered out of the diff report keep the clutter to a minimum and have a greater change to spot real ABI issues. - * --no-harmful + * ``--no-harmful`` In the diff report, do not display the :ref:`harmful ` changes. By default, only the harmful changes are displayed in diff report. - * --redundant + * ``--redundant`` In the diff report, do display redundant changes. A redundant change is a change that has been displayed elsewhere in the report. - * --no-redundant + * ``--no-redundant`` In the diff report, do *NOT* display redundant changes. A redundant change is a change that has been displayed elsewhere in the report. This option is switched on by default. - * --dump-diff-tree + * ``--dump-diff-tree`` After the diff report, emit a textual representation of the diff nodes tree used by the comparison engine to represent the changed diff --git a/doc/manuals/abidw.rst b/doc/manuals/abidw.rst index ad209aa8..c832b693 100644 --- a/doc/manuals/abidw.rst +++ b/doc/manuals/abidw.rst @@ -20,11 +20,11 @@ Invocation Options ======= - * --help + * ``--help`` Display a short help about the command and exit. - * --debug-info-dir <*dir-path*> + * ``--debug-info-dir`` <*dir-path*> In cases where the debug info for *path-to-elf-file* is in a separate file that is located in a non-standard place, this tells @@ -39,13 +39,13 @@ Options installed by your system's package manager because then ``abidw`` knows where to find it. - * --out-file <*file-path*> + * ``--out-file`` <*file-path*> This option instructs ``abidw`` to emit the XML representation of *path-to-elf-file* into the file *file-path*, rather than emitting it to its standard output. - * --check-alternate-debug-info <*elf-path*> + * ``--check-alternate-debug-info`` <*elf-path*> If the debug info for the file *elf-path* contains a reference to an `alternate debug info `_ file, ``abidw`` checks @@ -54,13 +54,13 @@ Options alternate debug info file found. Otherwise, it emits an error code. - * --check-alternate-debug-info-base-name <*elf-path*> + * ``--check-alternate-debug-info-base-name`` <*elf-path*> Like ``--check-alternate-debug-info``, but in the success message, only mention the base name of the debug info file; not its full path. - * --load-all-types + * ``--load-all-types`` By default, ``libabigail`` (and thus ``abidw``) only loads types that are reachable from functions and variables declarations that diff --git a/doc/manuals/abilint.rst b/doc/manuals/abilint.rst index b4f5798a..625cbec1 100644 --- a/doc/manuals/abilint.rst +++ b/doc/manuals/abilint.rst @@ -27,11 +27,12 @@ abilint [options] [] Options ======= - * --help + * ``--help`` Display a short help message and exits. - * --debug-info-dir <*path*> + * ``--debug-info-dir`` <*path*> + When reading an `ELF`_ input file which debug information is split out into a separate file, this options tells ``abilint`` where to find that separate debug information file. @@ -45,22 +46,22 @@ Options information installed by your system's package manager because then ``abidiff`` knows where to find it. - * --diff + * ``--diff`` For XML inputs, perform a text diff between the input and the memory model saved back to disk. This can help to spot issues in the handling of the XML format by the underlying Libabigail library. - * --noout + * ``--noout`` Do not display anything on standard output. The return code of the command is the only way to know if the command succeeded. - * --stdin|-- + * ``--stdin | --`` Read the input content from standard input. - * --tu + * ``--tu`` Expect the input XML to represent a single translation unit. diff --git a/doc/manuals/abipkgdiff.rst b/doc/manuals/abipkgdiff.rst index 2cef1492..732aee0a 100644 --- a/doc/manuals/abipkgdiff.rst +++ b/doc/manuals/abipkgdiff.rst @@ -32,34 +32,34 @@ Invocation Options ======= - * --help + * ``--help`` Display a short help about the command and exit. - * --debug-info-pkg1|--d1 + * ``--debug-info-pkg1 | --d1`` For cases where the debug information for *package1* is split out into a separate file, tells ``abipkgdiff`` where to find that separate debug information package. - * --debug-info-pkg2|--d2 + * ``--debug-info-pkg2 | --d2`` For cases where the debug information for *package2* is split out into a separate file, tells ``abipkgdiff`` where to find that separate debug information package. - * --dso-only + * ``--dso-only`` Compare ELF files that are shared libraries, only. Do not compare executable files, for instance. - * --redundant + * ``--redundant`` In the diff reports, do display redundant changes. A redundant change is a change that has been displayed elsewhere in a given report. - * --verbose + * ``--verbose`` Emit verbose progress messages.