3742 zfs comments need cleaner, more consistent style
Submitted by:   Will Andrews <willa@spectralogic.com>
Submitted by:   Alan Somers <alans@spectralogic.com>
Reviewed by:    Matthew Ahrens <mahrens@delphix.com>
Reviewed by:    George Wilson <george.wilson@delphix.com>
Reviewed by:    Eric Schrock <eric.schrock@delphix.com>

*** 136,147 ****
  #define ZFS_SHARES_DIR          "SHARES"
  #define ZFS_SA_ATTRS            "SA_ATTRS"
  
  #define ZFS_MAX_BLOCKSIZE       (SPA_MAXBLOCKSIZE)
  
- /* Path component length */
  /*
   * The generic fs code uses MAXNAMELEN to represent
   * what the largest component length is.  Unfortunately,
   * this length includes the terminating NULL.  ZFS needs
   * to tell the users via pathconf() and statvfs() what the
   * true maximum length of a component is, excluding the NULL.
--- 136,148 ----
  #define ZFS_SHARES_DIR          "SHARES"
  #define ZFS_SA_ATTRS            "SA_ATTRS"
  
  #define ZFS_MAX_BLOCKSIZE       (SPA_MAXBLOCKSIZE)
  
  /*
+  * Path component length
+  *
   * The generic fs code uses MAXNAMELEN to represent
   * what the largest component length is.  Unfortunately,
   * this length includes the terminating NULL.  ZFS needs
   * to tell the users via pathconf() and statvfs() what the
   * true maximum length of a component is, excluding the NULL.
*** 232,257 ****
   * Convert between znode pointers and vnode pointers
   */
  #define ZTOV(ZP)        ((ZP)->z_vnode)
  #define VTOZ(VP)        ((znode_t *)(VP)->v_data)
  
! /*
!  * ZFS_ENTER() is called on entry to each ZFS vnode and vfs operation.
!  * ZFS_EXIT() must be called before exitting the vop.
!  * ZFS_VERIFY_ZP() verifies the znode is valid.
!  */
  #define ZFS_ENTER(zfsvfs) \
          { \
                  rrw_enter_read(&(zfsvfs)->z_teardown_lock, FTAG); \
                  if ((zfsvfs)->z_unmounted) { \
                          ZFS_EXIT(zfsvfs); \
                          return (EIO); \
                  } \
          }
  
  #define ZFS_EXIT(zfsvfs) rrw_exit(&(zfsvfs)->z_teardown_lock, FTAG)
  
  #define ZFS_VERIFY_ZP(zp) \
          if ((zp)->z_sa_hdl == NULL) { \
                  ZFS_EXIT((zp)->z_zfsvfs); \
                  return (EIO); \
          } \
--- 233,256 ----
   * Convert between znode pointers and vnode pointers
   */
  #define ZTOV(ZP)        ((ZP)->z_vnode)
  #define VTOZ(VP)        ((znode_t *)(VP)->v_data)
  
! /* Called on entry to each ZFS vnode and vfs operation  */
  #define ZFS_ENTER(zfsvfs) \
          { \
                  rrw_enter_read(&(zfsvfs)->z_teardown_lock, FTAG); \
                  if ((zfsvfs)->z_unmounted) { \
                          ZFS_EXIT(zfsvfs); \
                          return (EIO); \
                  } \
          }
  
+ /* Must be called before exiting the vop */
  #define ZFS_EXIT(zfsvfs) rrw_exit(&(zfsvfs)->z_teardown_lock, FTAG)
  
+ /* Verifies the znode is valid */
  #define ZFS_VERIFY_ZP(zp) \
          if ((zp)->z_sa_hdl == NULL) { \
                  ZFS_EXIT((zp)->z_zfsvfs); \
                  return (EIO); \
          } \
*** 267,285 ****
  #define ZFS_OBJ_HOLD_TRYENTER(zfsvfs, obj_num) \
          mutex_tryenter(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
  #define ZFS_OBJ_HOLD_EXIT(zfsvfs, obj_num) \
          mutex_exit(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
  
! /*
!  * Macros to encode/decode ZFS stored time values from/to struct timespec
!  */
  #define ZFS_TIME_ENCODE(tp, stmp)               \
  {                                               \
          (stmp)[0] = (uint64_t)(tp)->tv_sec;     \
          (stmp)[1] = (uint64_t)(tp)->tv_nsec;    \
  }
  
  #define ZFS_TIME_DECODE(tp, stmp)               \
  {                                               \
          (tp)->tv_sec = (time_t)(stmp)[0];               \
          (tp)->tv_nsec = (long)(stmp)[1];                \
  }
--- 266,283 ----
  #define ZFS_OBJ_HOLD_TRYENTER(zfsvfs, obj_num) \
          mutex_tryenter(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
  #define ZFS_OBJ_HOLD_EXIT(zfsvfs, obj_num) \
          mutex_exit(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
  
! /* Encode ZFS stored time values from a struct timespec */
  #define ZFS_TIME_ENCODE(tp, stmp)               \
  {                                               \
          (stmp)[0] = (uint64_t)(tp)->tv_sec;     \
          (stmp)[1] = (uint64_t)(tp)->tv_nsec;    \
  }
  
+ /* Decode ZFS stored time values to a struct timespec */
  #define ZFS_TIME_DECODE(tp, stmp)               \
  {                                               \
          (tp)->tv_sec = (time_t)(stmp)[0];               \
          (tp)->tv_nsec = (long)(stmp)[1];                \
  }