Bug 1528261

Summary: remove --pool-inactive from thin_trim manpage
Product: Red Hat Enterprise Linux 7 Reporter: Jakub Krysl <jkrysl>
Component: device-mapper-persistent-dataAssignee: Joe Thornber <thornber>
Status: CLOSED ERRATA QA Contact: Lin Li <lilin>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 7.5CC: agk, heinzm, jbrassow, lvm-team, mcsontos, msnitzer, rhandlin, tborcin, thornber
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: device-mapper-persistent-data-0.8.5-2.el7 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of:
: 1774000 (view as bug list) Environment:
Last Closed: 2020-03-31 20:11:26 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1774000    

Description Jakub Krysl 2017-12-21 11:21:55 UTC
Description of problem:
Option --pool-inactive is still listed in thin_trim manpage but not in thin_trim --help:
# man thin_trim
NAME
       thin_trim - Issue discard requests for free pool space (offline tool).

SYNOPSIS
       thin_trim [options] --metadata-dev {device|file} --data-dev {device|file}

DESCRIPTION
       thin_trim sends discard requests to the pool device for unprovisioned areas.

       This tool cannot be run on live metadata.

OPTIONS
       -h, --help
              Print help and exit.

       -V, --version
              Print version information and exit.

       --pool-inactive
              Indicates you are aware the pool should be inactive.

           Suppresses a warning message and prompt.

# thin_trim --help
Usage: thin_trim [options] --metadata-dev {device|file} --data-dev {device|file}
Options:
  {-h|--help}
  {-V|--version}

According to message given when this option is used, the option is obsolete and should be removed from manpage too.
# thin_trim --pool-inactive --metadata-dev dev --data-dev dev                       
--pool-inactive no longer required since we ensure the metadata device is opened exclusively. 

Version-Release number of selected component (if applicable):
device-mapper-persistent-data-0.7.3-3.el7.x86_64

How reproducible:
100%

Steps to Reproduce:
1. man thin_trim
2. thin_trim --help
1. thin_trim --pool-inactive --metadata-dev dev --data-dev dev                       
--pool-inactive no longer required since we ensure the metadata device is opened exclusively. 

Actual results:
--pool-inactive option in manpage but not --help

Expected results:
The option --pool-inactive is gone from manpage

Additional info:

Comment 2 Jakub Krysl 2019-10-02 11:41:03 UTC
Mass migration to lilin.

Comment 5 Lin Li 2019-11-29 07:17:49 UTC
Reproduced on device-mapper-persistent-data-0.8.5-1.el7
[root@storageqe-71 ~]# rpm -qa | grep device-mapper-persistent-data
device-mapper-persistent-data-0.8.5-1.el7.x86_64

[root@storageqe-71 ~]# man thin_trim
NAME
       thin_trim  -  Issue  discard  requests  for free pool space
       (offline tool).

SYNOPSIS
       thin_trim [options] --metadata-dev {device|file} --data-dev {device|file}
DESCRIPTION
       thin_trim sends discard requests to  the  pool  device  for
       unprovisioned areas.

       This tool cannot be run on live metadata.

OPTIONS
       -h, --help
              Print help and exit.

       -V, --version
              Print version information and exit.

       --pool-inactive           <-------------------------------------------------------
              Indicates you are aware the pool should be inactive.     

           Suppresses a warning message and prompt.



Verified on device-mapper-persistent-data-0.8.5-2.el7
[root@storageqe-71 ~]# rpm -qa | grep device-mapper-persistent-data
device-mapper-persistent-data-0.8.5-2.el7.x86_64

[root@storageqe-71 ~]# man thin_trim
NAME
       thin_trim - Issue discard requests for free pool space (offline tool).

SYNOPSIS
       thin_trim [options] --metadata-dev {device|file} --data-dev {device|file}

DESCRIPTION
       thin_trim  sends  discard  requests  to  the pool device for unprovisioned
       areas.

       This tool cannot be run on live metadata.

OPTIONS
       -h, --help
              Print help and exit.
       -V, --version
              Print version information and exit.




Test result: ---pool-inactive removed from thin_trim manpage

Comment 7 errata-xmlrpc 2020-03-31 20:11:26 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2020:1188