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 0975A42C30; Mon, 5 Jun 2023 07:21:17 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D994140A7F; Mon, 5 Jun 2023 07:21:16 +0200 (CEST) Received: from mail-qt1-f180.google.com (mail-qt1-f180.google.com [209.85.160.180]) by mails.dpdk.org (Postfix) with ESMTP id 168B04003C for ; Mon, 5 Jun 2023 07:21:15 +0200 (CEST) Received: by mail-qt1-f180.google.com with SMTP id d75a77b69052e-3f6b9ad956cso33193591cf.1 for ; Sun, 04 Jun 2023 22:21:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1685942474; x=1688534474; 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=M61k5Iy0cmPKlPlENXiEUWfjbmnub9KOfshWCZKtFhI=; b=Nh2+MKFSvThlfM3xbln34UD8vRh2FmcRqnSRJ4/fFDFd7l3qGvmxKS9g7V1jKstiCB jAEdtWlzf3Pn9gGmnknr6i6e+xot0j4fdo4/LZJUNWEXRdJ/QxgJ/hH6BP54zffNrBxS SjAYhv8GBaLIzFHkbJM67HxuLQUzfCqg8ph6kzKftGpz+jU3WAAjwIBI6jeclScoxtUl 4qvjSolhv2qRMynlpMwfDVyHCfl37TTS/pUQAi1rA54sENcJElpuky4p5sPezN4ZYapL bdDR+h8x1Kqj3BeZE/QW/RJNjyphdGj2IYUvwlsA4HjfgoFa/NK/XgeyWqIUR0XnzX+f 1UZA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1685942474; x=1688534474; 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=M61k5Iy0cmPKlPlENXiEUWfjbmnub9KOfshWCZKtFhI=; b=U6JLhQXIJkEgZmuN7RUscQ5Nx6Tvwa9dV5zOtze7sTis9o286C4+6AtJVYjEjB9ssq MzfVjveMNiI/JB3vLqjwpFZmR1NmV0l54hkW6hABo275/R0DpI93isEbhmPyXEcZMWo3 TQCYTtJVcOclksFlTF6shZwcKuJKCTAXHlC1FKAd/rjaLUYGD9Hu26cWI6w8we/z0/Ca q8LKIWqNiXCE4aWPHqsmoLyVk/NcAsT1AsHymPojb3F1XuXskmcapop5iYkH3yFi2BUV cwI6GjUimc5mKOs0pASwNJwk+NqXIRJY+JblN9+gQBbKiWrVj8c3no6YrCNFUAAGOuSR V3pg== X-Gm-Message-State: AC+VfDzJau5K8kIACoc1HEPoa1G6D1SSDsFr51P3H7ObafV+8lEMUC9j ow9hsjHvfaVkcde+kbC2CMJX8DWw8kabK5uxW3c= X-Google-Smtp-Source: ACHHUZ5wAu8RITuO3Q1hl/Yuz7F156L46IKcAMYcgbayzkxfUrVR4ilL7YQnQr0TY31n6ef/t79eYFXytxUrMzs30UM= X-Received: by 2002:a05:622a:12:b0:3f6:bdc2:1293 with SMTP id x18-20020a05622a001200b003f6bdc21293mr6662679qtw.20.1685942474278; Sun, 04 Jun 2023 22:21:14 -0700 (PDT) MIME-Version: 1.0 References: <20230601153801.118616-1-bruce.richardson@intel.com> In-Reply-To: <20230601153801.118616-1-bruce.richardson@intel.com> From: Jerin Jacob Date: Mon, 5 Jun 2023 10:50:48 +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 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 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 > + > +mandb =3D find_program('mandb', required: false) > +if mandb.found() and get_option('enable_docs') and meson.version().versi= on_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 > +endif > -- > 2.39.2 >