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>

          --- old/usr/src/uts/common/fs/zfs/sys/zio_compress.h
          +++ new/usr/src/uts/common/fs/zfs/sys/zio_compress.h

   1    1  /*
   2    2   * CDDL HEADER START
   3    3   *
   4    4   * The contents of this file are subject to the terms of the
   5    5   * Common Development and Distribution License (the "License").
   6    6   * You may not use this file except in compliance with the License.
   7    7   *
   8    8   * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9    9   * or http://www.opensolaris.org/os/licensing.
  10   10   * See the License for the specific language governing permissions
  11   11   * and limitations under the License.
  12   12   *
  13   13   * When distributing Covered Code, include this CDDL HEADER in each
  14   14   * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15   15   * If applicable, add the following below this CDDL HEADER, with the
  16   16   * fields enclosed by brackets "[]" replaced with your own identifying
  17   17   * information: Portions Copyright [yyyy] [name of copyright owner]
  18   18   *
  19   19   * CDDL HEADER END
  20   20   */
  21   21  
  22   22  /*
  23   23   * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  24   24   * Use is subject to license terms.
  25   25   */
  26   26  /*
  27   27   * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
  28   28   */

  29   29  
  30   30  #ifndef _SYS_ZIO_COMPRESS_H
  31   31  #define _SYS_ZIO_COMPRESS_H
  32   32  
  33   33  #include <sys/zio.h>
  34   34  
  35   35  #ifdef  __cplusplus
  36   36  extern "C" {
  37   37  #endif
  38   38  
  39      -/*
  40      - * Common signature for all zio compress/decompress functions.
  41      - */
       39 +/* Common signature for all zio compress functions. */
  42   40  typedef size_t zio_compress_func_t(void *src, void *dst,
  43   41      size_t s_len, size_t d_len, int);
       42 +/* Common signature for all zio decompress functions. */
  44   43  typedef int zio_decompress_func_t(void *src, void *dst,
  45   44      size_t s_len, size_t d_len, int);
  46   45  
  47   46  /*
  48   47   * Information about each compression function.
  49   48   */
  50   49  typedef struct zio_compress_info {
  51   50          zio_compress_func_t     *ci_compress;   /* compression function */
  52   51          zio_decompress_func_t   *ci_decompress; /* decompression function */
  53   52          int                     ci_level;       /* level parameter */

  54   53          char                    *ci_name;       /* algorithm name */
  55   54  } zio_compress_info_t;
  56   55  
  57   56  extern zio_compress_info_t zio_compress_table[ZIO_COMPRESS_FUNCTIONS];
  58   57  
  59   58  /*
  60   59   * Compression routines.
  61   60   */
  62   61  extern size_t lzjb_compress(void *src, void *dst, size_t s_len, size_t d_len,
  63   62      int level);
  64   63  extern int lzjb_decompress(void *src, void *dst, size_t s_len, size_t d_len,
  65   64      int level);
  66   65  extern size_t gzip_compress(void *src, void *dst, size_t s_len, size_t d_len,
  67   66      int level);
  68   67  extern int gzip_decompress(void *src, void *dst, size_t s_len, size_t d_len,
  69   68      int level);
  70   69  extern size_t zle_compress(void *src, void *dst, size_t s_len, size_t d_len,
  71   70      int level);
  72   71  extern int zle_decompress(void *src, void *dst, size_t s_len, size_t d_len,
  73   72      int level);
  74   73  extern size_t lz4_compress(void *src, void *dst, size_t s_len, size_t d_len,
  75   74      int level);
  76   75  extern int lz4_decompress(void *src, void *dst, size_t s_len, size_t d_len,
  77   76      int level);
  78   77  
  79   78  /*
  80   79   * Compress and decompress data if necessary.
  81   80   */
  82   81  extern size_t zio_compress_data(enum zio_compress c, void *src, void *dst,
  83   82      size_t s_len);
  84   83  extern int zio_decompress_data(enum zio_compress c, void *src, void *dst,
  85   84      size_t s_len, size_t d_len);
  86   85  
  87   86  #ifdef  __cplusplus
  88   87  }
  89   88  #endif
  90   89  
  91   90  #endif  /* _SYS_ZIO_COMPRESS_H */

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX