[diffoscope] 01/01: Update terminology used in docs about exclusion options. Thanks to Paul Wise for the idea. (Closes: #893324)

[Chris Lamb]

This is an automated email from the git hooks/post-receive script.

lamby pushed a commit to branch master
in repository diffoscope.

commit 0da118a131f95811c158c5d47e4d620d01a233ea
Author: Chris Lamb <lamby at debian.org>
Date:   Tue Mar 20 08:59:24 2018 -0400

    Update terminology used in docs about exclusion options. Thanks to Paul Wise for the idea. (Closes: #893324)
---
 diffoscope/main.py | 35 +++++++++++++++++++----------------
 1 file changed, 19 insertions(+), 16 deletions(-)

diff --git a/diffoscope/main.py b/diffoscope/main.py
index 794931a..1634204 100644
--- a/diffoscope/main.py
+++ b/diffoscope/main.py
@@ -177,27 +177,30 @@ def create_parser():
                         help='Treat absent files as empty')
     group3.add_argument('--exclude', dest='excludes',
                         metavar='GLOB_PATTERN', action='append', default=[],
-                        help='Exclude/ignore files that match %(metavar)s')
+                        help='Exclude files that match %(metavar)s. Use this '
+                        'option to ignore files based on their names.')
     group3.add_argument('--exclude-command', dest='exclude_commands',
                         metavar='REGEX_PATTERN', action='append', default=[],
-                        help='Exclude/ignore commands that match %(metavar)s. For '
-                        "example, '^readelf.*\s--debug-dump=info' takes by far "
-                        'the longest time, and differences here are probably '
-                        'only secondary differences caused by something that '
-                        'is already represented elsewhere in the diff.')
+                        help='Exclude commands that match %(metavar)s. For '
+                        "example '^readelf.*\s--debug-dump=info' can take a long "
+                        'time and differences here are likely secondary '
+                        'differences caused by something represented '
+                        'elsewhere. Use this option to disable commands that '
+                        'use a lot of resources.')
     group3.add_argument('--exclude-directory-metadata', '--no-exclude-directory-metadata',
                         action=BooleanAction, default=None,
-                        help='Exclude/ignore directory metadata.  Useful if '
-                        'comparing files whose filesystem-level metadata is not '
-                        'intended to be distributed to other systems. For '
-                        "example, this is true for most distros' package "
-                        'builders, but not true for the output of commands like '
-                        '`make install`. '
+                        help='Exclude directory metadata. Useful if comparing '
+                        'files whose filesystem-level metadata is not intended '
+                        'to be distributed to other systems. This is true for '
+                        'most distributions package builders, but not true '
+                        'for the output of commands such as `make install`. '
                         'Metadata of archive members remain un-excluded. '
-                        'Default: False if comparing two directories, else '
-                        'True. Note that "file" metadata is actually a '
-                        'property of its containing directory, and is not '
-                        'relevant when distributing the file across systems.')
+                        'Use this option to ignore permissions, timestamps, '
+                        'xattrs etc. Default: False if comparing two ',
+                        'directories, else True. Note that "file" metadata '
+                        'actually a property of its containing directory, '
+                        'and is not relevant when distributing the file across '
+                        'systems.')
     group3.add_argument('--fuzzy-threshold', type=int,
                         help='Threshold for fuzzy-matching '
                         '(0 to disable, %(default)s is default, 400 is high fuzziness)',

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/diffoscope.git