diff mbox

new package: libqmi

Message ID 1361144807-22896-1-git-send-email-shawn7400@gmail.com
State Superseded
Headers show

Commit Message

Shawn J. Goff Feb. 17, 2013, 11:46 p.m. UTC 
From: "Shawn J. Goff" <shawn.goff@accelecon.com>

libqmi includes a library and command line interface for interacting with
modems that speak the QMI protocol.
---
 package/libqmi/Config.in                           |   5 +
 .../libqmi-Add-files-created-by-autogen.patch      |  29 ++
 .../libqmi-Add-files-created-by-gtkdocize.patch    | 309 +++++++++++++++++++++
 package/libqmi/libqmi.mk                           |  21 ++
 4 files changed, 364 insertions(+)
 create mode 100644 package/libqmi/Config.in
 create mode 100644 package/libqmi/libqmi-Add-files-created-by-autogen.patch
 create mode 100644 package/libqmi/libqmi-Add-files-created-by-gtkdocize.patch
 create mode 100644 package/libqmi/libqmi.mk

Comments

Thomas Petazzoni April 7, 2013, 8:33 p.m. UTC | #1 
Shawn,

Thanks a lot for your contribution. Some comments below.

On Sun, 17 Feb 2013 18:46:47 -0500, shawn7400@gmail.com wrote:
> From: "Shawn J. Goff" <shawn.goff@accelecon.com>
> 
> libqmi includes a library and command line interface for interacting with
> modems that speak the QMI protocol.
> ---
>  package/libqmi/Config.in                           |   5 +
>  .../libqmi-Add-files-created-by-autogen.patch      |  29 ++
>  .../libqmi-Add-files-created-by-gtkdocize.patch    | 309 +++++++++++++++++++++

I think we prefer lower-case filenames for patches.

>  package/libqmi/libqmi.mk                           |  21 ++

Your patch lacks the change to package/Config.in. For now, your
package doesn't appear anywhere in menuconfig.

>  4 files changed, 364 insertions(+)
>  create mode 100644 package/libqmi/Config.in
>  create mode 100644 package/libqmi/libqmi-Add-files-created-by-autogen.patch
>  create mode 100644 package/libqmi/libqmi-Add-files-created-by-gtkdocize.patch
>  create mode 100644 package/libqmi/libqmi.mk
> 
> diff --git a/package/libqmi/Config.in b/package/libqmi/Config.in
> new file mode 100644
> index 0000000..6cb1b81
> --- /dev/null
> +++ b/package/libqmi/Config.in
> @@ -0,0 +1,5 @@
> +config BR2_PACKAGE_LIBQMI
> +	bool "libqmi"
> +	depends on BR2_PACKAGE_LIBGLIB2

This should be:

	select BR2_PACKAGE_LIBGLIB2
	depends on BR2_USE_WCHAR # libglib2 -> gettext

> +	help
> +    libqmi is a library for interacting with devices that use Qualcomm's QMI protocol.

Indentation of the help text should be one tab plus two spaces. This
line should also be wrapped at around ~72 columns. And you should add
an empty new line, and the URL of the upstream project.

> diff --git a/package/libqmi/libqmi-Add-files-created-by-autogen.patch b/package/libqmi/libqmi-Add-files-created-by-autogen.patch
> new file mode 100644
> index 0000000..55ac746
> --- /dev/null
> +++ b/package/libqmi/libqmi-Add-files-created-by-autogen.patch
> @@ -0,0 +1,29 @@
> +From 6d4db1bde5f9f0883468dbead27a41ac98430e9a Mon Sep 17 00:00:00 2001
> +From: "Shawn J. Goff" <shawnjgoff@gmail.com>
> +Date: Wed, 26 Sep 2012 15:21:48 -0400
> +Subject: [PATCH 2/2] Add files created by autogen
> +

I think we generally prefer a hook in POST_PATCH_HOOKS to create those
files using 'touch'.

> diff --git a/package/libqmi/libqmi-Add-files-created-by-gtkdocize.patch b/package/libqmi/libqmi-Add-files-created-by-gtkdocize.patch
> new file mode 100644
> index 0000000..bae0dee
> --- /dev/null
> +++ b/package/libqmi/libqmi-Add-files-created-by-gtkdocize.patch
> @@ -0,0 +1,309 @@
> +From 5fd915fb74d35bc67b007b5f7659109954daa837 Mon Sep 17 00:00:00 2001
> +From: "Shawn J. Goff" <shawnjgoff@gmail.com>
> +Date: Wed, 26 Sep 2012 15:20:23 -0400
> +Subject: [PATCH 1/2] Add files created by gtkdocize
> +
> +---
> + gtk-doc.make  | 280 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> + m4/gtk-doc.m4 |   1 +
> + 2 files changed, 281 insertions(+)
> + create mode 100644 gtk-doc.make
> + create mode 100644 m4/gtk-doc.m4

Hum, there's really no other way? I.e the package doesn't build at all
if you don't do this?

> diff --git a/package/libqmi/libqmi.mk b/package/libqmi/libqmi.mk
> new file mode 100644
> index 0000000..6ae6b64
> --- /dev/null
> +++ b/package/libqmi/libqmi.mk
> @@ -0,0 +1,21 @@
> +#############################################################
> +#
> +# libqmi
> +#
> +#############################################################

One empty new line between the header and the first variable.

> +LIBQMI_VERSION = 9e60ef6c0f3e6ac579fb360481488c5ed00382cc

I see that this project has some tags for versions, the latest being
1.2.0. Any reason for using an apparently 'random' Git commit? The
1.2.0 has been tagged 3 weeks ago, so it's not very old.

> +LIBQMI_SITE = git://anongit.freedesktop.org/libqmi
> +LIBQMI_SITE_METHOD = git

I think the site method is not needed here since your site starts with
git://.

> +LIBQMI_AUTORECONF = YES
> +LIBQMI_AUTORECONF_OPT = --force --install --verbose
> +LIBQMI_INSTALL_STAGING = YES
> +LIBQMI_CONF_OPT = --with-docs=no\
> +                  --enable-gtk-doc-html=no\
> +                  --enable-gtk-doc=no\
> +                  --enable-gtk-doc-pdf=no\
> +                  --with-tests=no\
> +                  --with-traces=no

Once space before each backslash please.

> +LIBQMI_DEPENDENCIES = libglib2
> +
> +$(eval $(autotools-package))

It would be good to add the licensing informations:

LIBQMI_LICENSE = LGPLv2+ (library), GPLv2+ (programs)
LIBQMI_LICENSE_FILES = COPYING

Thanks!

Thomas
diff mbox

Patch

diff --git a/package/libqmi/Config.in b/package/libqmi/Config.in
new file mode 100644
index 0000000..6cb1b81
--- /dev/null
+++ b/package/libqmi/Config.in
@@ -0,0 +1,5 @@ 
+config BR2_PACKAGE_LIBQMI
+	bool "libqmi"
+	depends on BR2_PACKAGE_LIBGLIB2
+	help
+    libqmi is a library for interacting with devices that use Qualcomm's QMI protocol.
diff --git a/package/libqmi/libqmi-Add-files-created-by-autogen.patch b/package/libqmi/libqmi-Add-files-created-by-autogen.patch
new file mode 100644
index 0000000..55ac746
--- /dev/null
+++ b/package/libqmi/libqmi-Add-files-created-by-autogen.patch
@@ -0,0 +1,29 @@ 
+From 6d4db1bde5f9f0883468dbead27a41ac98430e9a Mon Sep 17 00:00:00 2001
+From: "Shawn J. Goff" <shawnjgoff@gmail.com>
+Date: Wed, 26 Sep 2012 15:21:48 -0400
+Subject: [PATCH 2/2] Add files created by autogen
+
+---
+ ChangeLog | 1 +
+ README    | 1 +
+ 3 files changed, 3 insertions(+)
+ create mode 100644 ChangeLog
+ create mode 100644 README
+
+diff --git a/ChangeLog b/ChangeLog
+new file mode 100644
+index 0000000..8b13789
+--- /dev/null
++++ b/ChangeLog
+@@ -0,0 +1 @@
++
+diff --git a/README b/README
+new file mode 100644
+index 0000000..8b13789
+--- /dev/null
++++ b/README
+@@ -0,0 +1 @@
++
+-- 
+1.7.12
+
diff --git a/package/libqmi/libqmi-Add-files-created-by-gtkdocize.patch b/package/libqmi/libqmi-Add-files-created-by-gtkdocize.patch
new file mode 100644
index 0000000..bae0dee
--- /dev/null
+++ b/package/libqmi/libqmi-Add-files-created-by-gtkdocize.patch
@@ -0,0 +1,309 @@ 
+From 5fd915fb74d35bc67b007b5f7659109954daa837 Mon Sep 17 00:00:00 2001
+From: "Shawn J. Goff" <shawnjgoff@gmail.com>
+Date: Wed, 26 Sep 2012 15:20:23 -0400
+Subject: [PATCH 1/2] Add files created by gtkdocize
+
+---
+ gtk-doc.make  | 280 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ m4/gtk-doc.m4 |   1 +
+ 2 files changed, 281 insertions(+)
+ create mode 100644 gtk-doc.make
+ create mode 100644 m4/gtk-doc.m4
+
+diff --git a/gtk-doc.make b/gtk-doc.make
+new file mode 100644
+index 0000000..1f75dfd
+--- /dev/null
++++ b/gtk-doc.make
+@@ -0,0 +1,280 @@
++# -*- mode: makefile -*-
++
++####################################
++# Everything below here is generic #
++####################################
++
++if GTK_DOC_USE_LIBTOOL
++GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
++GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
++GTKDOC_RUN = $(LIBTOOL) --mode=execute
++else
++GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
++GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
++GTKDOC_RUN =
++endif
++
++# We set GPATH here; this gives us semantics for GNU make
++# which are more like other make's VPATH, when it comes to
++# whether a source that is a target of one rule is then
++# searched for in VPATH/GPATH.
++#
++GPATH = $(srcdir)
++
++TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
++
++SETUP_FILES = \
++	$(content_files)		\
++	$(DOC_MAIN_SGML_FILE)		\
++	$(DOC_MODULE)-sections.txt	\
++	$(DOC_MODULE)-overrides.txt
++
++EXTRA_DIST = 				\
++	$(HTML_IMAGES)			\
++	$(SETUP_FILES)
++
++DOC_STAMPS=setup-build.stamp scan-build.stamp tmpl-build.stamp sgml-build.stamp \
++	html-build.stamp pdf-build.stamp \
++	tmpl.stamp sgml.stamp html.stamp pdf.stamp
++
++SCANOBJ_FILES = 		 \
++	$(DOC_MODULE).args 	 \
++	$(DOC_MODULE).hierarchy  \
++	$(DOC_MODULE).interfaces \
++	$(DOC_MODULE).prerequisites \
++	$(DOC_MODULE).signals
++
++REPORT_FILES = \
++	$(DOC_MODULE)-undocumented.txt \
++	$(DOC_MODULE)-undeclared.txt \
++	$(DOC_MODULE)-unused.txt
++
++CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
++
++if ENABLE_GTK_DOC
++if GTK_DOC_BUILD_HTML
++HTML_BUILD_STAMP=html-build.stamp
++else
++HTML_BUILD_STAMP=
++endif
++if GTK_DOC_BUILD_PDF
++PDF_BUILD_STAMP=pdf-build.stamp
++else
++PDF_BUILD_STAMP=
++endif
++
++all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
++else
++all-local:
++endif
++
++docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
++
++$(REPORT_FILES): sgml-build.stamp
++
++#### setup ####
++
++setup-build.stamp:
++	-@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
++	    echo '  DOC   Preparing build'; \
++	    files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \
++	    if test "x$$files" != "x" ; then \
++	        for file in $$files ; do \
++	            test -f $(abs_srcdir)/$$file && \
++	                cp -pu $(abs_srcdir)/$$file $(abs_builddir)/ || true; \
++	        done; \
++	    fi; \
++	    test -d $(abs_srcdir)/tmpl && \
++	        { cp -rp $(abs_srcdir)/tmpl $(abs_builddir)/; \
++	        chmod -R u+w $(abs_builddir)/tmpl; } \
++	fi
++	@touch setup-build.stamp
++
++#### scan ####
++
++scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
++	@echo '  DOC   Scanning header files'
++	@_source_dir='' ; \
++	for i in $(DOC_SOURCE_DIR) ; do \
++	    _source_dir="$${_source_dir} --source-dir=$$i" ; \
++	done ; \
++	gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
++	@if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
++	    echo "  DOC   Introspecting gobjects"; \
++	    scanobj_options=""; \
++	    gtkdoc-scangobj 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
++	    if test "$(?)" = "0"; then \
++	        if test "x$(V)" = "x1"; then \
++	            scanobj_options="--verbose"; \
++	        fi; \
++	    fi; \
++	    CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
++	    gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \
++	else \
++	    for i in $(SCANOBJ_FILES) ; do \
++	        test -f $$i || touch $$i ; \
++	    done \
++	fi
++	@touch scan-build.stamp
++
++$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
++	@true
++
++#### templates ####
++
++tmpl-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
++	@echo '  DOC   Rebuilding template files'
++	@gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
++	@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
++	  if test -w $(abs_srcdir) ; then \
++	    cp -rp $(abs_builddir)/tmpl $(abs_srcdir)/; \
++	  fi \
++	fi
++	@touch tmpl-build.stamp
++
++tmpl.stamp: tmpl-build.stamp
++	@true
++
++$(srcdir)/tmpl/*.sgml:
++	@true
++
++#### xml ####
++
++sgml-build.stamp: tmpl.stamp $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files)
++	@echo '  DOC   Building XML'
++	@-chmod -R u+w $(srcdir)
++	@_source_dir='' ; \
++	for i in $(DOC_SOURCE_DIR) ; do \
++	    _source_dir="$${_source_dir} --source-dir=$$i" ; \
++	done ; \
++	gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_source_dir} $(MKDB_OPTIONS)
++	@touch sgml-build.stamp
++
++sgml.stamp: sgml-build.stamp
++	@true
++
++#### html ####
++
++html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
++	@echo '  DOC   Building HTML'
++	@rm -rf html
++	@mkdir html
++	@mkhtml_options=""; \
++	gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
++	if test "$(?)" = "0"; then \
++	  if test "x$(V)" = "x1"; then \
++	    mkhtml_options="$$mkhtml_options --verbose"; \
++	  fi; \
++	fi; \
++	gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-path"; \
++	if test "$(?)" = "0"; then \
++	  mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
++	fi; \
++	cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
++	-@test "x$(HTML_IMAGES)" = "x" || \
++	for file in $(HTML_IMAGES) ; do \
++	  if test -f $(abs_srcdir)/$$file ; then \
++	    cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
++	  fi; \
++	  if test -f $(abs_builddir)/$$file ; then \
++	    cp $(abs_builddir)/$$file $(abs_builddir)/html; \
++	  fi; \
++	done;
++	@echo '  DOC   Fixing cross-references'
++	@gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
++	@touch html-build.stamp
++
++#### pdf ####
++
++pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
++	@echo '  DOC   Building PDF'
++	@rm -f $(DOC_MODULE).pdf
++	@mkpdf_options=""; \
++	gtkdoc-mkpdf 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
++	if test "$(?)" = "0"; then \
++	  if test "x$(V)" = "x1"; then \
++	    mkpdf_options="$$mkpdf_options --verbose"; \
++	  fi; \
++	fi; \
++	if test "x$(HTML_IMAGES)" != "x"; then \
++	  for img in $(HTML_IMAGES); do \
++	    part=`dirname $$img`; \
++	    echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
++	    if test $$? != 0; then \
++	      mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
++	    fi; \
++	  done; \
++	fi; \
++	gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
++	@touch pdf-build.stamp
++
++##############
++
++clean-local:
++	@rm -f *~ *.bak
++	@rm -rf .libs
++
++distclean-local:
++	@rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
++	    $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
++	@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
++	    rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \
++	    rm -rf tmpl; \
++	fi
++
++maintainer-clean-local: clean
++	@rm -rf xml html
++
++install-data-local:
++	@installfiles=`echo $(builddir)/html/*`; \
++	if test "$$installfiles" = '$(builddir)/html/*'; \
++	then echo 1>&2 'Nothing to install' ; \
++	else \
++	  if test -n "$(DOC_MODULE_VERSION)"; then \
++	    installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
++	  else \
++	    installdir="$(DESTDIR)$(TARGET_DIR)"; \
++	  fi; \
++	  $(mkinstalldirs) $${installdir} ; \
++	  for i in $$installfiles; do \
++	    echo ' $(INSTALL_DATA) '$$i ; \
++	    $(INSTALL_DATA) $$i $${installdir}; \
++	  done; \
++	  if test -n "$(DOC_MODULE_VERSION)"; then \
++	    mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
++	      $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
++	  fi; \
++	  $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
++	fi
++
++uninstall-local:
++	@if test -n "$(DOC_MODULE_VERSION)"; then \
++	  installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
++	else \
++	  installdir="$(DESTDIR)$(TARGET_DIR)"; \
++	fi; \
++	rm -rf $${installdir}
++
++#
++# Require gtk-doc when making dist
++#
++if ENABLE_GTK_DOC
++dist-check-gtkdoc:
++else
++dist-check-gtkdoc:
++	@echo "*** gtk-doc must be installed and enabled in order to make dist"
++	@false
++endif
++
++dist-hook: dist-check-gtkdoc dist-hook-local
++	@mkdir $(distdir)/tmpl
++	@mkdir $(distdir)/html
++	@-cp ./tmpl/*.sgml $(distdir)/tmpl
++	@cp ./html/* $(distdir)/html
++	@-cp ./$(DOC_MODULE).pdf $(distdir)/
++	@-cp ./$(DOC_MODULE).types $(distdir)/
++	@-cp ./$(DOC_MODULE)-sections.txt $(distdir)/
++	@cd $(distdir) && rm -f $(DISTCLEANFILES)
++	@$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
++
++.PHONY : dist-hook-local docs
+diff --git a/m4/gtk-doc.m4 b/m4/gtk-doc.m4
+new file mode 100644
+index 0000000..d214c6a
+--- /dev/null
++++ b/m4/gtk-doc.m4
+@@ -0,0 +1 @@
++/usr/share/aclocal/gtk-doc.m4
+\ No newline at end of file
+-- 
+1.7.12
+
diff --git a/package/libqmi/libqmi.mk b/package/libqmi/libqmi.mk
new file mode 100644
index 0000000..6ae6b64
--- /dev/null
+++ b/package/libqmi/libqmi.mk
@@ -0,0 +1,21 @@ 
+#############################################################
+#
+# libqmi
+#
+#############################################################
+LIBQMI_VERSION = 9e60ef6c0f3e6ac579fb360481488c5ed00382cc
+LIBQMI_SITE = git://anongit.freedesktop.org/libqmi
+LIBQMI_SITE_METHOD = git
+LIBQMI_AUTORECONF = YES
+LIBQMI_AUTORECONF_OPT = --force --install --verbose
+LIBQMI_INSTALL_STAGING = YES
+LIBQMI_CONF_OPT = --with-docs=no\
+                  --enable-gtk-doc-html=no\
+                  --enable-gtk-doc=no\
+                  --enable-gtk-doc-pdf=no\
+                  --with-tests=no\
+                  --with-traces=no
+
+LIBQMI_DEPENDENCIES = libglib2
+
+$(eval $(autotools-package))