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 4B0E142C3E; Tue, 6 Jun 2023 11:46:56 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2BFD140A84; Tue, 6 Jun 2023 11:46:56 +0200 (CEST) Received: from mail-ua1-f50.google.com (mail-ua1-f50.google.com [209.85.222.50]) by mails.dpdk.org (Postfix) with ESMTP id 7AB8140697 for ; Tue, 6 Jun 2023 11:46:54 +0200 (CEST) Received: by mail-ua1-f50.google.com with SMTP id a1e0cc1a2514c-786d10951d8so1827016241.3 for ; Tue, 06 Jun 2023 02:46:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686044814; x=1688636814; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=Ka9gpTjUMhMvhQHQFKPZybv6ZPhI5XFpPaHmP1jwTDs=; b=d6LTBuFdyRC07l54ZZSQj8j98JDzh6SjLFxKfhnOdSeZeImGxYf9ZfJaKS2oI0WdwB FiWiuN9u+eIMvdMVRlIhjiABBeAhikc59ej9HqN6+2BoZ/tqWHVBQVym8rGunGf9W6bi 68qaEorxoUrz6/AXhg+GrG+oWUH7WyycUne6ranMGkdayi9LOyhMJaqEwVs7inQKqqUc LdXLVbteVcQ2rJ0WAkUBNUuAIW8kCOlfYlsP72yO0l5ZGxBVJm24Bfo+f6jvA0klTZT+ wdW7DTry/M9BvjsOTpnFcC7M2v7e9nPfx111v2RN/04ClpEwpLAd0IXly5C+YK0rwjZk Ia7w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686044814; x=1688636814; 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=Ka9gpTjUMhMvhQHQFKPZybv6ZPhI5XFpPaHmP1jwTDs=; b=DIk2W2MMAcaMBnC9OYh6AtSBdbDt60T40Ip720uwhzKE0VEnyte1T05R4PUktb4zvB 5JQavd6U/D83Re0tCs/CfI4+00DY4U5ZqCNSVu0frVarz0zoJ8dZdi/UcCQlbcRBYbTo 1PbINElT3M2vCN4madF1VhS2BfljjcqBI9hIglN5MtkxizUDdOmO2OS2keYVeM2+ejcF ziPD2bazHsyFTvBayQrPsj2Jc0c9585sbfFG+J5gX8I3IfRC3BNmJRpRPTkn0MpBhl+B m9e1FAvuxXAITIl8DxrEi04z0wRHd6J49dS8bKiRgQlsJbuXaVgD7lqtBfYhuZhH81U7 RUXA== X-Gm-Message-State: AC+VfDzmvrq9a+BPW/dUmxFWVODgjm9/d+4L9jrBOv/X+J3YnBIGZeUT yr0AXshr+B0dSnHD7Xe300WRaNSg6bHC3JNFauBEl+zf/zGnRmjO X-Google-Smtp-Source: ACHHUZ4hB+WBSQdTfAVWEmrBEk2QDCzqHUcQTZUSY+g5MTeE5EMK//VhoUCufDTtlDPFzZ0OFt0aT44u8uMPnQffMw0= X-Received: by 2002:a67:f7d5:0:b0:43b:5737:ea75 with SMTP id a21-20020a67f7d5000000b0043b5737ea75mr680036vsp.26.1686044813634; Tue, 06 Jun 2023 02:46:53 -0700 (PDT) MIME-Version: 1.0 References: <20230601153801.118616-1-bruce.richardson@intel.com> In-Reply-To: From: Jerin Jacob Date: Tue, 6 Jun 2023 15:16:27 +0530 Message-ID: Subject: Re: [PATCH] doc: build manpages as well as html output To: Bruce Richardson Cc: dev@dpdk.org 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 2:49=E2=80=AFPM Bruce Richardson wrote: > > On Mon, Jun 05, 2023 at 10:50:48AM +0530, Jerin Jacob wrote: > > On Thu, Jun 1, 2023 at 9:08=E2=80=AFPM Bruce Richardson > > wrote: > > > > > > Doxygen can produce manpage output as well as html output for the DPD= K > > > 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 confi= g > > > 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 an= d > > > the manpages, with individual install locations for each. > > > * Where supported by meson version, call "mandb" post-install to upda= te > > > the man database to ensure the new manpages can be found. > > > > > > Signed-off-by: Bruce Richardson > > > > > + > > > +mandb =3D find_program('mandb', required: false) > > > +if mandb.found() and get_option('enable_docs') and meson.version().v= ersion_compare('>=3D0.55.0') > > > + meson.add_install_script(mandb) > > > > It does not look like just executing mandb it is adding these man > > pages to database > > > > log: > > Running custom install script '/usr/bin/mandb' > > Purging old database entries in /home/jerin/.local/man... > > Processing manual pages under /home/jerin/.local/man... > > Checking for stray cats under /home/jerin/.local/man... > > Processing manual pages under /home/jerin/.local/man/cat1... > > Purging old database entries in /home/jerin/.local/share/man... > > Processing manual pages under /home/jerin/.local/share/man... > > Checking for stray cats under /home/jerin/.local/share/man... > > Processing manual pages under /home/jerin/.local/share/man/cat1... > > 0 man subdirectories contained newer manual pages. > > 0 manual pages were added. > > 0 stray cats were added. > > 0 old database entries were purged. > > > > [main][dpdk.org] $ man rte_flow_create > > No manual entry for rte_flow_create > > > > # Following works by providing the path i.e man pages created properly > > only db update is missing > > man --manpath=3D/tmp/i/usr/local/share/man/ rte_flow_create > > > Yes, that is correct. > > If you install to a non-standard location, then yes you need to update > manpath yourself. However, in case you install to a "standard" location, > then running mandb will update the database for you. I believe this is th= e > behaviour we should have. I view it as the same as installing binaries in= a > standard vs non-standard path - if the binaries are placed in a standard > location then they are found automatically, but if installed in a custom > location, then the user is responsible for ensuring all paths are correct= . OK. Then I think, we can move "meson.add_install_script(mandb)" invocation under !DESTDIR not provided. As if DESTDIR is provided then there is no use for mandb. > > /Bruce