From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id CC0A942FC4; Thu, 3 Aug 2023 11:18:25 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 5DA9A4282D; Thu, 3 Aug 2023 11:18:25 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mails.dpdk.org (Postfix) with ESMTP id A89A14161A for ; Thu, 3 Aug 2023 11:18:24 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1691054304; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=UTz279mn6gRI+SYMIaBqtbujqQo3hdHUrY98eEywYPE=; b=he+8QeeKVr5mnRLXmrWpV9e4oa51PEPQxGbI4Z8P2u5EEpSwvbB+h95Jp821yUmWutf84W jgfEXvGXEPEHYBZPpHl2ucFc37OfItqjw7isyK8QDIC5yoVqh5HUjl+Ro01baJ3ox4KEgA nBnPttrGHE94MINKW0aDaT1w7TQ+ohk= Received: from mail-pj1-f72.google.com (mail-pj1-f72.google.com [209.85.216.72]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-696-yVCjmP8dMwyWRSxs6IIJbQ-1; Thu, 03 Aug 2023 05:18:22 -0400 X-MC-Unique: yVCjmP8dMwyWRSxs6IIJbQ-1 Received: by mail-pj1-f72.google.com with SMTP id 98e67ed59e1d1-267f68fdc30so461194a91.1 for ; Thu, 03 Aug 2023 02:18:22 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1691054302; x=1691659102; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=UTz279mn6gRI+SYMIaBqtbujqQo3hdHUrY98eEywYPE=; b=lR4qF21wKNDk6vjmk4NQSCL4AmtwcszDD/8+TY8J20qvfay6MnyyFZsDDaHwqYeZkv B03+Ek5p4ufU2otrSNty4bp3e2RE90+RhRNQOCoclZrQisice5xB6rzCukdMOThZB4zK uRf6ODIzqwqGBJMpW4VhG7RfCE4kqLuzukN+gqHlLlcLviNDxUzfumdP9KrjvyHnspBE K/PjUeO6Aw4Dhn0KfG4NgoZa3XOPB7pGnSc/5DQgwVbyDqNAeMthqgAs8swlxbJvG6rG X+XgBSD5CxIWiF9q5R8SQgMeg7FMGdl2PNykFJZjyUn+IaGEJ6t7jQMFAyjGIgMQ+I1T VtrQ== X-Gm-Message-State: ABy/qLabBCS7yvJ6vT+hdUSejw8eFLBwkExm9ciNkjUgkBoMF5CIRXSW mjRCDLf1miWVQDaHExYXXb8L4LVh/iU8EtkOSblfplOCABnLv9coE1lRbJKE9r7i0XoFJdxbsPu 5iKfEgQCqi9WXmmhUk6c= X-Received: by 2002:a17:90a:3801:b0:268:1b60:5031 with SMTP id w1-20020a17090a380100b002681b605031mr16215685pjb.12.1691054301816; Thu, 03 Aug 2023 02:18:21 -0700 (PDT) X-Google-Smtp-Source: APBJJlHp+FIROL0XbMbdIdva1Hj+WsN+7qrbLqG3lY2apaOdQPzvZIchf+1lEAj9mKLanDf2/Z8D1u4AN7WU6jJPkqc= X-Received: by 2002:a17:90a:3801:b0:268:1b60:5031 with SMTP id w1-20020a17090a380100b002681b605031mr16215676pjb.12.1691054301579; Thu, 03 Aug 2023 02:18:21 -0700 (PDT) MIME-Version: 1.0 References: <20230601153801.118616-1-bruce.richardson@intel.com> <20230606131230.70428-1-bruce.richardson@intel.com> In-Reply-To: From: David Marchand Date: Thu, 3 Aug 2023 11:18:09 +0200 Message-ID: Subject: Re: [PATCH v2] doc: build manpages as well as html output To: Bruce Richardson , Thomas Monjalon Cc: dev@dpdk.org, jerinjacobk@gmail.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On Mon, Jul 17, 2023 at 1:09=E2=80=AFPM Bruce Richardson wrote: > > There may be some polishing to do later. > > Looking at the result for rte_eal_init, I see that the generated > > manual starts with a reference to the rte_eal.h header with a path > > relative to its location in the DPDK tree. > > $ MANPATH=3Dbuild-gcc/install/share/man man rte_eal_init | head -5 > > lib/eal/include/rte_eal.h(3) > > DPDK > > > > lib/eal/include/rte_eal.h(3) > > > > NAME > > lib/eal/include/rte_eal.h > > > > At least, it is possible to ask for this header man with "man > > rte_eal.h", but it is a bit confusing. > > Is there something we can do on this side? > > > > Not sure, not really familiar with how doxygen works generating manpages > and the options supported, etc. etc. Mainly I just looked at the > build-system side to support this, since I really missed having manpages > for DPDK functions to quickly check parameter order. doxygen is invoked on the sources tree, so this is probably the reason why such path is in the generated manual. Maybe Thomas has an idea how we could handle this. In any case, I am fine with this patch as it is now. --=20 David Marchand