[Buildroot] Newbie: My first buildroot package: szip

[Thomas Petazzoni]

Dear Williams Jr., Ernest L.,

On Wed, 31 Dec 2014 03:58:06 +0000, Williams Jr., Ernest L. wrote:

> ======= Begin Config.in ==============================================
> config BR2_PACKAGE_SZIP
>         bool "szip"
>         help
>          Szip is an implementation of the extended-Rice lossless compression algorithm. 
>          The Consultative Committee on Space Data Systems (CCSDS) has adopted the 
>          extended-Rice algorithm for international standards for space applications[1,6,7]. 
>          Szip is reported to provide fast and effective compression, specifically for 
>          the EOS data generated by the NASA Earth Observatory System (EOS)[1]. 
>          It was originally developed at University of New Mexico (UNM) and 
>          integrated with HDF4 by UNM researchers and developers.  
> 
>           http://www.hdfgroup.org/doc_resource/SZIP
> ============ End Config.in ============================================

This looks good, with some minor issues:

 * Indentation for 'bool' and 'help' should be one tab
 * Indentation for the help text should be one tab + two spaces
 * The help text should be wrapped to not go over 72 columns

Also, you may want to check if szip needs MMU support, or other
toolchain features (largefile, etc.).

> ################################################################################
> #
> # szip
> #
> ################################################################################
> 
> SZIP_VERSION = 2.1
> SZIP_SOURCE = szip-$(SZIP_VERSION).tar.gz

This line is not needed, as this is the default.

> SZIP_SITE = http://www.hdfgroup.org/ftp/lib-external/szip/2.1/src
> SZIP_LICENSE = szip license
> SZIP_LICENSE_FILES = COPYING
> SZIP_INSTALL_STAGING = YES
> 
> $(eval $(autotools-package))

Other than that, szip.mk looks good.


> [ernesto at localhost package]$ diff -c Config.in Config.in.orig
> *** Config.in   2014-12-30 17:36:57.044105994 -0800
> --- Config.in.orig      2014-12-30 19:42:29.344642576 -0800
> ***************
> *** 575,581 ****
>         source "package/lzo/Config.in"
>         source "package/snappy/Config.in"
>         source "package/zlib/Config.in"
> -       source "package/szip/Config.in"

This patch is obviously reversed: the szip line should be added, not
removed.

> Please tell me how to submit this new package as a patch set.
> Also, please let me know if I did the above procedure properly.

You will have to learn a little bit of Git. This will not be a lost
investment done only for Buildroot: Git is now the version control
system used by the vast majority of open-source projects.

You can read
http://buildroot.org/downloads/manual/manual.html#submitting-patches
for some details, but those details assume a little bit of familiarity
with Git.

Maybe http://rypress.com/tutorials/git/patch-workflows is a good
starting point?

Best regards,

Thomas
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com