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 55BD842DD0; Tue, 4 Jul 2023 10:21:38 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 306AF40F18; Tue, 4 Jul 2023 10:21:38 +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 64A4540E03 for ; Tue, 4 Jul 2023 10:21:36 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1688458895; 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=enn6m69vzBAqq55shYIuTCQKPnS49jU6qLoDH63ds4w=; b=VpXMxhjUAVOyg/L1CWfyIh6bJzRKI1xWracurHwDf9wO4YJWOxXSvguszlyeFX3UTQzl5V rtQpfeITOxfZWnHNyFU5FGjzULe4JgJdAcEJCTX6+qXgRIIHU3u2+nCqBjeeB+Kx6ucbTm Oa3XGsFLP9UDKMF1yi1arHND3BraTt4= Received: from mail-oi1-f197.google.com (mail-oi1-f197.google.com [209.85.167.197]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-256-hwGFeXuTMiaigXjdm6NvGQ-1; Tue, 04 Jul 2023 04:21:34 -0400 X-MC-Unique: hwGFeXuTMiaigXjdm6NvGQ-1 Received: by mail-oi1-f197.google.com with SMTP id 5614622812f47-3a1c2d69709so4845543b6e.1 for ; Tue, 04 Jul 2023 01:21:34 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1688458894; x=1691050894; 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=enn6m69vzBAqq55shYIuTCQKPnS49jU6qLoDH63ds4w=; b=YhRD0Ed/grxZEDtfJFWelKl3xeI4vXQ4yz0rXyoxs58HPcRB/cY3/BOYgpCbANQwWH cAHkIQT8T4OJFpffTBZnpNYo3ZGQ6hV922gn3e4SEFb1kCeka6UN2VPCWjbAUzWpaVRR dOkfdLaYv+1FTxufUJkhzdmILEmusUpBUydc1V3d2ylUhIHjYF9KfvyoxZRdzg302AMo ncNvFjkOmBdwySV5Pn+tvfYNVgwQofIjBc0oFtrNnN6bCamyKX+zj6RGhIQH9bldJeoh ekH+E5kUAYTwaeaLvRyq3hOd8MQjM7h6S133B2ZQ3BJDM8q8cf/d+ic93fGAEhTKxE44 31hQ== X-Gm-Message-State: AC+VfDzMF3vgG9Sj4KPBqdp0qC/qL9nO6d1seSkl79jOFD3WTFbPT30L zq1IgG8kCsgKgTLCGF+t3jZGO34f7CYhfKgqJGMTTxMediq8gB4LjhIByHPprCVkXWnRYYJtPJJ uGSof4yZhtcXoHeKU2wU= X-Received: by 2002:a05:6808:130b:b0:3a3:72f7:1d40 with SMTP id y11-20020a056808130b00b003a372f71d40mr17888033oiv.0.1688458894056; Tue, 04 Jul 2023 01:21:34 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ6D7wINw0nubbmB+TtymR4fJ3Enfi3UqQj2enscXgIEgjZGtrRIJuesrtJxmfW6RoMRCAPSwI2gdDD8+Pt+QIg= X-Received: by 2002:a05:6808:130b:b0:3a3:72f7:1d40 with SMTP id y11-20020a056808130b00b003a372f71d40mr17888028oiv.0.1688458893860; Tue, 04 Jul 2023 01:21:33 -0700 (PDT) MIME-Version: 1.0 References: <20230601153801.118616-1-bruce.richardson@intel.com> <20230606131230.70428-1-bruce.richardson@intel.com> In-Reply-To: <20230606131230.70428-1-bruce.richardson@intel.com> From: David Marchand Date: Tue, 4 Jul 2023 10:21:22 +0200 Message-ID: Subject: Re: [PATCH v2] doc: build manpages as well as html output To: Bruce Richardson 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 Tue, Jun 6, 2023 at 3:13=E2=80=AFPM Bruce Richardson wrote: > > Doxygen can produce manpage output as well as html output for the DPDK > APIs. However, we need to do this as a separate task as the manpage > output needs to be placed in a different location post-install to the > html output (/usr/local/share/man vs /usr/local/share/doc/). > > Changes required are: > * Add configurable options for manpage output and html output to the > doxygen config template. (Remove option for html output path as it's > always "html") > * Modify API meson.build file to configure two separate doxygen config > files, for HTML and manpages respectively. > * Change doxygen wrapper script to have separate output log files for > the manpage and HTML jobs, to avoid conflicts > * Add "custom_targets" to meson.build file to build the HTML pages and > the manpages, with individual install locations for each. > * Where supported by meson version, call "mandb" post-install to update > the man database to ensure the new manpages can be found. > > Signed-off-by: Bruce Richardson Nice.. we should have done this sooner :-). Reviewed-by: David Marchand 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? --=20 David Marchand