From patchwork Sat Aug 8 09:59:41 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Stein X-Patchwork-Id: 254651 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-10.1 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0DACBC433E1 for ; Sat, 8 Aug 2020 10:00:17 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id D8B9020855 for ; Sat, 8 Aug 2020 10:00:16 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=mailbox.org header.i=@mailbox.org header.b="Q5bwh7as"; dkim=pass (2048-bit key) header.d=mailbox.org header.i=@mailbox.org header.b="TW+GYkQI" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726076AbgHHKAP (ORCPT ); Sat, 8 Aug 2020 06:00:15 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55482 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726128AbgHHKAM (ORCPT ); Sat, 8 Aug 2020 06:00:12 -0400 Received: from mout-p-202.mailbox.org (mout-p-202.mailbox.org [IPv6:2001:67c:2050::465:202]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1D9BAC061A27 for ; Sat, 8 Aug 2020 03:00:11 -0700 (PDT) Received: from smtp2.mailbox.org (smtp2.mailbox.org [80.241.60.241]) (using TLSv1.2 with cipher ECDHE-RSA-CHACHA20-POLY1305 (256/256 bits)) (No client certificate requested) by mout-p-202.mailbox.org (Postfix) with ESMTPS id 4BNyQK4VNlzQky8 for ; Sat, 8 Aug 2020 12:00:09 +0200 (CEST) Authentication-Results: hefe.heinlein-support.de (amavisd-new); dkim=pass (2048-bit key) reason="pass (just generated, assumed good)" header.d=mailbox.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=mailbox.org; s=mail20150812; t=1596880806; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Vld3sRAoYgi6sLOlaHm+XUV3hV/NXu3wU0JZvzH6euY=; b=Q5bwh7asu8UhpGjuRnJelYOGjv1pwSRVsdTxOuZvr2eUkRr703UreAH3PZ0TizqYDgblJF o4W4sbCf7c1SyVrQL4p0fsck5ZUXVn15uVH9pTBb4N5FBISmT/tZH3FALQx8P7uNgERdEN gFbsTTKdobqpv22ImsPWUjZOzsQFEcozzH4nQA402eomAcUxj8TqDtpbrwKTIcMkGuYavB vbCHkZJRV4KcLD1ZliyLHibOyPmJbN2F0nF42zTg0mEs7+O6yFjKMH7X7Nn7b2QEoiPSM1 9ayf3dzFAB+nmTwtS1WbKrBRITs87im1X4oaLw7zmkvqLguusxoD8D2zBaOl0A== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=mailbox.org; h= content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:date:subject:subject:from:from:received; s= mail20150812; t=1596880805; bh=mBasGfyea+gR6Q/Z4T3A32lzi7WO9s8Fu Vc96tiW9S8=; b=TW+GYkQIXr9Oa64Tv9yA+XRfHnVmM6KD/pv7xOHBZsjjT596M UtqX9uGEsA9aL2DBFr+zWL+aFtJlO1TmZyc79qm0oJ+cDFFmeKoTBWdM609nAGjv Veh6XFD5NoeBcbFQgylB0P/z1QAQGXMm83LweMl8ij0tYSlqv5SrfZxsZvNziu6A YkAPodr+pChpJQHf+nc9KwxAz1XFI/BpSIkFwtNHHnCzyk/97T5ZXJar1EpsqwfE dPsrcNTNfjVt4RG5vC5KdWinAb/zLDDtpjlLKCvKfUix8XPW06NbBDrCxO04s8VF Ot3NsKva73Ubx2z6qiTPBJdDZVZAJzYggyVfQ== X-Virus-Scanned: amavisd-new at heinlein-support.de Received: from smtp2.mailbox.org ([80.241.60.241]) by hefe.heinlein-support.de (hefe.heinlein-support.de [91.198.250.172]) (amavisd-new, port 10030) with ESMTP id 02YMX0uxevPe; Sat, 8 Aug 2020 12:00:05 +0200 (CEST) From: Alexander Stein To: linux-gpio@vger.kernel.org Cc: Alexander Stein Subject: [libgpiod] [PATCH 2/5] doc: Use autotoolized Doxyfile Date: Sat, 8 Aug 2020 11:59:41 +0200 Message-Id: <20200808095944.188479-3-alexander.stein@mailbox.org> In-Reply-To: <20200808095944.188479-1-alexander.stein@mailbox.org> References: <20200808095944.188479-1-alexander.stein@mailbox.org> MIME-Version: 1.0 X-MBO-SPAM-Probability: X-Rspamd-Score: -8.55 / 15.00 / 15.00 X-Rspamd-Queue-Id: 5AE5617AD X-Rspamd-UID: f14da5 Sender: linux-gpio-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org This has several advantages: * More simplified Makefile.am * Actually used doxygen config is available as a file * Building doc out-of-tree is possible Signed-off-by: Alexander Stein --- .gitignore | 1 + Doxyfile => Doxyfile.in | 3 ++- Makefile.am | 4 +--- configure.ac | 1 + 4 files changed, 5 insertions(+), 4 deletions(-) rename Doxyfile => Doxyfile.in (95%) diff --git a/.gitignore b/.gitignore index 488d9d6..a77efde 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ doc # autotools stuff .deps/ .libs/ +Doxyfile Makefile Makefile.in aclocal.m4 diff --git a/Doxyfile b/Doxyfile.in similarity index 95% rename from Doxyfile rename to Doxyfile.in index b194095..8c6d591 100644 --- a/Doxyfile +++ b/Doxyfile.in @@ -10,6 +10,7 @@ # General configuration PROJECT_NAME = libgpiod +PROJECT_NUMBER = @VERSION_STR@ OUTPUT_DIRECTORY = doc OUTPUT_LANGUAGE = English EXTRACT_ALL = NO @@ -48,7 +49,7 @@ WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_FORMAT = WARN_LOGFILE = -INPUT = include/gpiod.h +INPUT = @top_srcdir@/include/gpiod.h @top_srcdir@/bindings/cxx/gpiod.hpp SOURCE_BROWSER = YES INLINE_SOURCES = NO REFERENCED_BY_RELATION = YES diff --git a/Makefile.am b/Makefile.am index d3f57b2..72e6a25 100644 --- a/Makefile.am +++ b/Makefile.am @@ -29,9 +29,7 @@ SUBDIRS += bindings if HAS_DOXYGEN doc: - @(cat Doxyfile; \ - echo PROJECT_NUMBER = $(VERSION_STR); \ - echo INPUT += bindings/cxx/gpiod.hpp) | doxygen - + @doxygen Doxyfile .PHONY: doc clean-local: diff --git a/configure.ac b/configure.ac index 008499d..c2d9f99 100644 --- a/configure.ac +++ b/configure.ac @@ -207,6 +207,7 @@ if test "x$has_doxygen" = xfalse then AC_MSG_NOTICE([doxygen not found - documentation cannot be generated]) fi +AM_COND_IF([HAS_DOXYGEN], [AC_CONFIG_FILES([Doxyfile])]) if test "x$cross_compiling" = xno then From patchwork Sat Aug 8 09:59:42 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Stein X-Patchwork-Id: 254650 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-10.1 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 596D6C433E0 for ; Sat, 8 Aug 2020 10:06:39 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 335C62075D for ; Sat, 8 Aug 2020 10:06:39 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=mailbox.org header.i=@mailbox.org header.b="sxb+AZjQ"; dkim=pass (2048-bit key) header.d=mailbox.org header.i=@mailbox.org header.b="Hd2mcJhk" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726152AbgHHKGi (ORCPT ); Sat, 8 Aug 2020 06:06:38 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56474 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725980AbgHHKGi (ORCPT ); Sat, 8 Aug 2020 06:06:38 -0400 Received: from mout-p-101.mailbox.org (mout-p-101.mailbox.org [IPv6:2001:67c:2050::465:101]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 07845C061756 for ; Sat, 8 Aug 2020 03:06:37 -0700 (PDT) Received: from smtp2.mailbox.org (smtp2.mailbox.org [80.241.60.241]) (using TLSv1.2 with cipher ECDHE-RSA-CHACHA20-POLY1305 (256/256 bits)) (No client certificate requested) by mout-p-101.mailbox.org (Postfix) with ESMTPS id 4BNyQJ5JN9zKmTV for ; Sat, 8 Aug 2020 12:00:08 +0200 (CEST) Authentication-Results: spamfilter02.heinlein-hosting.de (amavisd-new); dkim=pass (2048-bit key) reason="pass (just generated, assumed good)" header.d=mailbox.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=mailbox.org; s=mail20150812; t=1596880806; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Q8+gLN/gdN2uwfZ6qrYoBtS0wfS1575iXb0EuFttOvE=; b=sxb+AZjQkz2eNfvXxZitSwm3sXRWB21Wf0m77GnAB7e6O3bQ+30E+wvoBOVNlBlbYKBnW3 xszxJnaL4qAKs4XS2FLZ5OsG4uPd7QoVCSGL1onzpdMlKO5YbGwNVlrcNcEUObk+qt9Knv BNPOS8m/qknZI/6PmIUMDpRtpp0B0WuPbnb/qU375yro5FTIQoVEtzLPEyIt5ksHvDHvWK d3EGnFwi2WLQLgQ96EJhhIHzVQEoMJau0rgqAeCZhEOdEwnhSG8+OwP8dDWUU/z7JHJIu0 a63FwHgWTz9n9theF8OUYBA6Msm14jQNegeDikHmlPTyAAspOnM+E5Jtrc1RWQ== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=mailbox.org; h= content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:date:subject:subject:from:from:received; s= mail20150812; t=1596880806; bh=6IuW3QAarK45Ye9np9TfdLagimv9nMDQw AagzmcSwWY=; b=Hd2mcJhkDWvVh7WLjRDejQ1nn3oEB4L4CktMvkpl90AGbKjez sf+pjDCrgMcubONlCi1UKaFipxjpz3inBJeN9lBaexKuwDJrAzSkVojdwEX67TC3 C5Z5ql4k6W032U8vODY6bjoQOhw17pUkfdab/xtjixYOIvH3xj8cL/PHcYNgmNon HcGbm5e1M9lYBGSUnwmQfrf81PHdzg096UevhJBmJanPGDPvyuQ+DB6quA/qmIAq ArFzyw0oF4Fh22AmoMZaH/PsCNaPxN8vlRHZimmO0oOQQ558xBuiFSbkcDJEfOpx cKmjhndNjYPHNHkkrEISCgNUsDoFVZFAdxRXQ== X-Virus-Scanned: amavisd-new at heinlein-support.de Received: from smtp2.mailbox.org ([80.241.60.241]) by spamfilter02.heinlein-hosting.de (spamfilter02.heinlein-hosting.de [80.241.56.116]) (amavisd-new, port 10030) with ESMTP id LyDfOgxoBpS1; Sat, 8 Aug 2020 12:00:06 +0200 (CEST) From: Alexander Stein To: linux-gpio@vger.kernel.org Cc: Alexander Stein Subject: [libgpiod] [PATCH 3/5] doc: Fix doxygen warning Date: Sat, 8 Aug 2020 11:59:42 +0200 Message-Id: <20200808095944.188479-4-alexander.stein@mailbox.org> In-Reply-To: <20200808095944.188479-1-alexander.stein@mailbox.org> References: <20200808095944.188479-1-alexander.stein@mailbox.org> MIME-Version: 1.0 X-MBO-SPAM-Probability: X-Rspamd-Score: -5.67 / 15.00 / 15.00 X-Rspamd-Queue-Id: E31C417B5 X-Rspamd-UID: bc3096 Sender: linux-gpio-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org This fixes the warning warning: argument 'a4wide' for option PAPER_TYPE is not a valid enum value Using the default: a4! Signed-off-by: Alexander Stein --- Doxyfile.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doxyfile.in b/Doxyfile.in index 8c6d591..813ab31 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -79,7 +79,7 @@ TREEVIEW_WIDTH = 250 GENERATE_LATEX = NO LATEX_OUTPUT = COMPACT_LATEX = NO -PAPER_TYPE = a4wide +PAPER_TYPE = a4 EXTRA_PACKAGES = LATEX_HEADER = PDF_HYPERLINKS = NO From patchwork Sat Aug 8 09:59:44 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Stein X-Patchwork-Id: 254649 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-10.1 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id DC353C433E1 for ; Sat, 8 Aug 2020 10:06:39 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id BC0D92075D for ; Sat, 8 Aug 2020 10:06:39 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=mailbox.org header.i=@mailbox.org header.b="NrJTpDj8"; dkim=pass (2048-bit key) header.d=mailbox.org header.i=@mailbox.org header.b="NWlLcu6R" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1725980AbgHHKGj (ORCPT ); Sat, 8 Aug 2020 06:06:39 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56478 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726190AbgHHKGi (ORCPT ); Sat, 8 Aug 2020 06:06:38 -0400 Received: from mout-p-101.mailbox.org (mout-p-101.mailbox.org [IPv6:2001:67c:2050::465:101]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 95C4FC061A27 for ; Sat, 8 Aug 2020 03:06:38 -0700 (PDT) Received: from smtp2.mailbox.org (smtp2.mailbox.org [IPv6:2001:67c:2050:105:465:1:2:0]) (using TLSv1.2 with cipher ECDHE-RSA-CHACHA20-POLY1305 (256/256 bits)) (No client certificate requested) by mout-p-101.mailbox.org (Postfix) with ESMTPS id 4BNyQK2pYMzKmrf for ; Sat, 8 Aug 2020 12:00:09 +0200 (CEST) Authentication-Results: spamfilter04.heinlein-hosting.de (amavisd-new); dkim=pass (2048-bit key) reason="pass (just generated, assumed good)" header.d=mailbox.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=mailbox.org; s=mail20150812; t=1596880807; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=1F1TiS/llMSlRFBhEU+mAwyr4zGbGajeXGcSzv26sAY=; b=NrJTpDj8I4HWdwAVjlrsJqJi/O13ErNJr0f4maqTsxErXWnMnoBANBOt7+clfcc0yC2Kvn zkM0ZUL61cq8+iD4eUK7GQFlWmwUihs1uXX7VkP3SL3d8wZWVxZ94L7j9BUJPkL3VPJvlS 86WynGniqLTCH3qNFfdjHylN9QmoJ5Rg8oozy6a3oXLqRe3CNB7tr9X+7eSuzT1Shj7WP4 zbhWp1DgHCotmB57GGZfqUwuspnyoGIlP4UfJFIHifNPDRKUPu8ejKA82+D8KwHuQM6XfG 0TC4/6ulXDGHvj8YKNHKE9i2fctFv3YyrEMsCZHRsUO9YUku4tsuUA4tJWn2hw== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=mailbox.org; h= content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:date:subject:subject:from:from:received; s= mail20150812; t=1596880806; bh=x5T7ui+O9aMTi+N6iqjPE8ZpTFc2TrncW qia6FcNsJ8=; b=NWlLcu6RfRVZcv7n7TDUAuglaRp83iSm7CtKA9rwsi0kU+BO+ tnP1XTO1fQu1JBMExh5PXeX/C0vnC2pE1LB0D3j6wZYCVRzpNSWa0m5mnGuKl+r2 bO4QKIkDnb6zpdRysqZIJxMiw2UzdpXRrH7ef98SqguVH7IeQPU/E4cdntKMd9d7 npXdtX0pJQjJ9v5yxKZGS+z1KAM74GYs19AXXthGFt6DBXMy1hz8dlCqcQifIhVc vcwN6BB22JMt+B/lRUbaRYHLAVOOch6c3ly1464833G55ghPDc95fYDuN2cMm3KU 5M/ahCOroaLhAX9esP5ycE52CSGol8DTWoqzA== X-Virus-Scanned: amavisd-new at heinlein-support.de Received: from smtp2.mailbox.org ([80.241.60.241]) by spamfilter04.heinlein-hosting.de (spamfilter04.heinlein-hosting.de [80.241.56.122]) (amavisd-new, port 10030) with ESMTP id IY6J1vydltCz; Sat, 8 Aug 2020 12:00:06 +0200 (CEST) From: Alexander Stein To: linux-gpio@vger.kernel.org Cc: Alexander Stein Subject: [libgpiod] [PATCH 5/5] doc: Add @file to headers Date: Sat, 8 Aug 2020 11:59:44 +0200 Message-Id: <20200808095944.188479-6-alexander.stein@mailbox.org> In-Reply-To: <20200808095944.188479-1-alexander.stein@mailbox.org> References: <20200808095944.188479-1-alexander.stein@mailbox.org> MIME-Version: 1.0 X-MBO-SPAM-Probability: X-Rspamd-Score: -5.67 / 15.00 / 15.00 X-Rspamd-Queue-Id: 882DB17BE X-Rspamd-UID: fdab8f Sender: linux-gpio-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org This is necessary to have a file reference linked in the file list. Also strip the top_srcdir from paths Signed-off-by: Alexander Stein --- Doxyfile.in | 2 +- bindings/cxx/gpiod.hpp | 4 ++++ include/gpiod.h | 4 ++++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/Doxyfile.in b/Doxyfile.in index 4abad2d..be2d250 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -22,7 +22,7 @@ BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES ALWAYS_DETAILED_SEC = NO FULL_PATH_NAMES = NO -STRIP_FROM_PATH = +STRIP_FROM_PATH = @top_srcdir@ INTERNAL_DOCS = NO STRIP_CODE_COMMENTS = YES CASE_SENSE_NAMES = YES diff --git a/bindings/cxx/gpiod.hpp b/bindings/cxx/gpiod.hpp index 59719aa..8dfc172 100644 --- a/bindings/cxx/gpiod.hpp +++ b/bindings/cxx/gpiod.hpp @@ -23,6 +23,10 @@ class line_iter; class chip_iter; struct line_event; +/** + * @file gpiod.hpp + */ + /** * @defgroup gpiod_cxx C++ bindings * @{ diff --git a/include/gpiod.h b/include/gpiod.h index 58de66f..d1f9830 100644 --- a/include/gpiod.h +++ b/include/gpiod.h @@ -16,6 +16,10 @@ extern "C" { #endif +/** + * @file gpiod.h + */ + /** * @mainpage libgpiod public API *