[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
- https://github.com/zfsonlinux/zfs/blob/master/cmd/arc_summary
+     * arcstat.py : Print out ZFS ARC Statistics exported via kstat(1)
+     * dbufstat.py : Print out statistics for all cached dmu buffers
  
-     * arcstat.py : Print out ZFS ARC Statistics exported via kstat(1)
- https://github.com/zfsonlinux/zfs/tree/master/cmd/arcstat
- 
-     * dbufstat.py : Print out statistics for all cached dmu buffers
- https://github.com/zfsonlinux/zfs/blob/master/cmd/dbufstat
  
  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 and list file using 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.
+ 
+ To get this expected result :
+ 
+ $ dpkg -L zfsutils-linux | egrep -i "arc|dbuf"
+   /usr/sbin/arc_summary
+   /usr/sbin/arcstat
+   /usr/sbin/dbufstat
+ 
+ [Other Info]
+  
+  * Upstream (ZoL) is reluctant to change it at upstream code level.
+ 
+  * 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

** 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
- 
+     * 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 and list file using dpkg -L zfsutils-linux |
- egrep "arc|dbufstat"
+  * Install zfsutils-linux
+  * List files 
  
-    /usr/sbin/arc_summary.py
-    /usr/sbin/arcstat.py
-    /usr/sbin/dbufstat.py
+  $ 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
+  * 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.
  
  To get this expected result :
  
  $ dpkg -L zfsutils-linux | egrep -i "arc|dbuf"
-   /usr/sbin/arc_summary
-   /usr/sbin/arcstat
-   /usr/sbin/dbufstat
+   /usr/sbin/arc_summary
+   /usr/sbin/arcstat
+   /usr/sbin/dbufstat
  
  [Other Info]
-  
-  * Upstream (ZoL) is reluctant to change it at upstream code level.
  
-  * This has been flag by Adam Conrad :
- https://bugs.launchpad.net/ubuntu/+source/zfs-
- linux/+bug/1574342/comments/19
+  * Upstream (ZoL) is reluctant to change it at upstream code level.
+    https://bugs.launchpad.net/ubuntu/+source/zfs-linux/+bug/1628279/comments/2
  
-  * Debian policy : https://www.debian.org/doc/debian-policy/ch-
- files.html#s-scripts
+  * 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

** 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]
+ 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.
+ 
+ Ideally, this should be fixed and upstreamed to Debian (or to zfslinux upstream) as well.
  
  [Test Case]
  
   * Install zfsutils-linux
-  * List files 
+  * List files
  
-  $ dpkg -L zfsutils-linux | egrep "arc|dbufstat"
+  $ 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.
- 
- To get this expected result :
+ 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
  
  [Other Info]
  
   * Upstream (ZoL) is reluctant to change it at upstream code level.
-    https://bugs.launchpad.net/ubuntu/+source/zfs-linux/+bug/1628279/comments/2
+ 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:
  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

  [Other Info]

   * 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