From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id A600B3857C4A for ; Sat, 16 Apr 2022 15:04:03 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org A600B3857C4A Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-446-fnDRPV8gOruJ56pbjnkuhw-1; Sat, 16 Apr 2022 11:04:00 -0400 X-MC-Unique: fnDRPV8gOruJ56pbjnkuhw-1 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id E4EB3899EC4; Sat, 16 Apr 2022 15:03:59 +0000 (UTC) Received: from redhat.com (unknown [10.2.16.77]) by smtp.corp.redhat.com (Postfix) with ESMTPS id D535E9E64; Sat, 16 Apr 2022 15:03:59 +0000 (UTC) Received: from fche by redhat.com with local (Exim 4.94.2) (envelope-from ) id 1nfjxu-0005Dl-Pq; Sat, 16 Apr 2022 11:03:58 -0400 Date: Sat, 16 Apr 2022 11:03:58 -0400 From: "Frank Ch. Eigler" To: Milian Wolff Cc: elfutils-devel@sourceware.org Subject: Re: Questions regarding debuginfod.h API Message-ID: <20220416150358.GA19820@redhat.com> References: <5817622.lOV4Wx5bFT@agathemoarbauer> <12359040.Dq0kRfdbeh@milian-workstation> <20220408194432.GB23295@redhat.com> <15044726.Ck1BFTr2H8@milian-workstation> MIME-Version: 1.0 In-Reply-To: <15044726.Ck1BFTr2H8@milian-workstation> User-Agent: Mutt/1.12.0 (2019-05-25) X-Scanned-By: MIMEDefang 2.79 on 10.11.54.5 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=us-ascii Content-Disposition: inline X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H5, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.4 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on server2.sourceware.org X-BeenThere: elfutils-devel@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Elfutils-devel mailing list List-Unsubscribe: , List-Archive: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 16 Apr 2022 15:04:05 -0000 Hi - > > > My `debuginfod.h` also does not show any (useful) inline API > > > documentation for most of that file. Could this please be improved? > > > The doxygen for dwfl is great and can be read directly together with > > > the code, > > > > As they say, patches welcome. :-) The header contains some curt > > comments documenting each function. > > Would you be OK with me simply copying over the contents from the man page > over to doxygen? Or is there a better process in place to prevent such kind of > documentation duplication? I would have expected that the man pages for API > documentation are generated from e.g. doxygen which does not seem to be the > case here? Correct, elfutils does not have much API documentation generally. The debuginfod parts are a recent addition that buck that trend. :-) I don't have a strong opinion about doxygen syntax markup or tooling dependence, per se. OTOH I would not want to see documentation duplication or loss of man pages. - FChE