[Bug 1628279] Re: python utilities script suffix (.py) should be removed as per Policy 10.4

[Eric Desrochers]

** Description changed:

  [Impact]
  
  The zfs utilities scripts shipped with debian and ubuntu such as :
  
      * arc_summary.py : Provides a summary of the statistics
      * arcstat.py : Print out ZFS ARC Statistics exported via kstat(1)
      * dbufstat.py : Print out statistics for all cached dmu buffers
  
  should be renamed according to Policy 10.4 :
  https://www.debian.org/doc/debian-policy/ch-files.html#s-scripts
  
  "When scripts are installed into a directory in the system PATH, the
  script name should not include an extension such as .sh or .pl that
  denotes the scripting language currently used to implement it."
  
  Ideally, this should be fixed and upstreamed to Debian (or to zfslinux
  upstream) as well.
  
  [Test Case]
  
   * Install zfsutils-linux
   * List files
  
   $ dpkg -L zfsutils-linux | egrep "arc|dbufstat"
     /usr/sbin/arc_summary.py
     /usr/sbin/arcstat.py
     /usr/sbin/dbufstat.py
  
  [Regression Potential]
  
   * none expected, this is a trivial change that simply rename the
  scripts to remove the extension (.py) with a simple 'mv' before the
  dh_install invocation in order to get this expected result :
  
  $ dpkg -L zfsutils-linux | egrep -i "arc|dbuf"
    /usr/sbin/arc_summary
    /usr/sbin/arcstat
    /usr/sbin/dbufstat
  
+ Yakkety include the renaming as shown above.
+ 
+ Xenial will have a symlink to not break user experience until next release upgrade:
+ https://bugs.launchpad.net/ubuntu/xenial/+source/zfs-linux/+bug/1628279/comments/19
+ 
+ So user will be able to use both for instance : arcstat.py or arcstat
+ 
+ 
  [Other Info]
  
   * Justification/argument for Xenial
  https://bugs.launchpad.net/ubuntu/+source/zfs-linux/+bug/1628279/comments/13
  https://bugs.launchpad.net/ubuntu/+source/zfs-linux/+bug/1628279/comments/14
  
  * Debian bug
  https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=839645
  
   * Upstream (ZoL) is reluctant to change it at upstream code level.
  https://bugs.launchpad.net/ubuntu/+source/zfs-linux/+bug/1628279/comments/2
  
   * This has been flag by Adam Conrad
  https://bugs.launchpad.net/ubuntu/+source/zfs-linux/+bug/1574342/comments/19
  
   * Debian policy
  https://www.debian.org/doc/debian-policy/ch-files.html#s-scripts

-- 
You received this bug notification because you are a member of Ubuntu
Sponsors Team, which is subscribed to the bug report.
https://bugs.launchpad.net/bugs/1628279

Title:
  python utilities script suffix (.py) should be removed as per Policy
  10.4

Status in zfs-linux package in Ubuntu:
  Fix Released
Status in zfs-linux source package in Xenial:
  In Progress

Bug description:
  [Impact]

  The zfs utilities scripts shipped with debian and ubuntu such as :

      * arc_summary.py : Provides a summary of the statistics
      * arcstat.py : Print out ZFS ARC Statistics exported via kstat(1)
      * dbufstat.py : Print out statistics for all cached dmu buffers

  should be renamed according to Policy 10.4 :
  https://www.debian.org/doc/debian-policy/ch-files.html#s-scripts

  "When scripts are installed into a directory in the system PATH, the
  script name should not include an extension such as .sh or .pl that
  denotes the scripting language currently used to implement it."

  Ideally, this should be fixed and upstreamed to Debian (or to zfslinux
  upstream) as well.

  [Test Case]

   * Install zfsutils-linux
   * List files

   $ dpkg -L zfsutils-linux | egrep "arc|dbufstat"
     /usr/sbin/arc_summary.py
     /usr/sbin/arcstat.py
     /usr/sbin/dbufstat.py

  [Regression Potential]

   * none expected, this is a trivial change that simply rename the
  scripts to remove the extension (.py) with a simple 'mv' before the
  dh_install invocation in order to get this expected result :

  $ dpkg -L zfsutils-linux | egrep -i "arc|dbuf"
    /usr/sbin/arc_summary
    /usr/sbin/arcstat
    /usr/sbin/dbufstat

  Yakkety include the renaming as shown above.

  Xenial will have a symlink to not break user experience until next release upgrade:
  https://bugs.launchpad.net/ubuntu/xenial/+source/zfs-linux/+bug/1628279/comments/19

  So user will be able to use both for instance : arcstat.py or arcstat

  
  [Other Info]

   * Justification/argument for Xenial
  https://bugs.launchpad.net/ubuntu/+source/zfs-linux/+bug/1628279/comments/13
  https://bugs.launchpad.net/ubuntu/+source/zfs-linux/+bug/1628279/comments/14

  * Debian bug
  https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=839645

   * Upstream (ZoL) is reluctant to change it at upstream code level.
  https://bugs.launchpad.net/ubuntu/+source/zfs-linux/+bug/1628279/comments/2

   * This has been flag by Adam Conrad
  https://bugs.launchpad.net/ubuntu/+source/zfs-linux/+bug/1574342/comments/19

   * Debian policy
  https://www.debian.org/doc/debian-policy/ch-files.html#s-scripts

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/zfs-linux/+bug/1628279/+subscriptions