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 432DE429E9; Tue, 25 Apr 2023 10:20:49 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 35F4F40A7E; Tue, 25 Apr 2023 10:20:49 +0200 (CEST) Received: from mail-ed1-f44.google.com (mail-ed1-f44.google.com [209.85.208.44]) by mails.dpdk.org (Postfix) with ESMTP id 47B90400D7 for ; Tue, 25 Apr 2023 10:20:48 +0200 (CEST) Received: by mail-ed1-f44.google.com with SMTP id 4fb4d7f45d1cf-504eac2f0b2so9390853a12.3 for ; Tue, 25 Apr 2023 01:20:48 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon-tech.20221208.gappssmtp.com; s=20221208; t=1682410848; x=1685002848; 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=QhSOCJHEDm/S/2EEBPwnkt6YkLJDq1EN7WkFlt9FUos=; b=BI4mZ8JfPWHaCF3tu5qjt/5o9yhRRgRMegKeDRTH3fSUYVM0hvoCHC5dvXS9kIQMtk +F5/2pu7TDWpcz0d+oF+beGRg0mW484R4k62KY9dY4LNXnRTU0md+S0y3s04HN7suupD wVN+y1qOTRkCfEssv7jB1Ub9m2+wtuq+7or2UDubtTKZJXAbkoA6rLqfKUPFSg+K6azc 0s81UqcB+CalZ/4WDPiGb6gG4VP1/xpP/kDHPhol0OhgSZEy8GaF1mlfCzScoUiLMW6t 9T2x74QWUNUUjlYoWS08k5qg1BO7G228nVklxAI5WkRXCFDQs71L9QM2wassxCtVPDG3 MwVw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682410848; x=1685002848; 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=QhSOCJHEDm/S/2EEBPwnkt6YkLJDq1EN7WkFlt9FUos=; b=S8c0veSFglNatrWZ/5IGXfzfOeO4LLsnqgLjB8MV4a26tNd1R50+e6zeGCn2pr73XJ +nTVw4TneTHoQvJNucdhGCHAGck2Ipt9/w/dQOt1eVLRAZYT5+TONr7qM+GoDY7Vd4tG A+pPQFC/27V3+njnmj3z/e7m7EsN1H2J/1VMQUUTIAJrliL/JpezxIkovPn9uW4kWEwW dcZ65zA4h5P2PKTQtrSx8pkchj1PHtB8MN4s+eTF8z1q9YAGPpxaGs6qMjZnrA1fuVnf dnLpjq7biv77vKvRk0HO1JhRCWhrn61o0ro0fK2rwdog8F+/Ws64MdlZp2SL33chvIqO 5D7Q== X-Gm-Message-State: AAQBX9dMwXK7kjpvtYXbrxXq5as37jlzeFr87YH4Rj1kpwzngj46QIDU yIF1yXv+N4T4hqOSvjwQem7RmHO0eIKGPhQvIGdfgyLiKylYsXd1YrxNuuBSvAkczEU0atdpZv/ FeNNdHq2XDNpHst7RvH0+gX5s56Q= X-Google-Smtp-Source: AKy350Yh02yJxLy+bPXdAkPuuH/j5p083pwCB0GeYTwonxNL7g51o2IJaZ7yRRDDnALYoL2He1lOA0dxUxUTdNq9MYY= X-Received: by 2002:a17:907:168d:b0:94a:82ca:12e5 with SMTP id hc13-20020a170907168d00b0094a82ca12e5mr15420013ejc.45.1682410847799; Tue, 25 Apr 2023 01:20:47 -0700 (PDT) MIME-Version: 1.0 References: <20230323104040.484708-1-juraj.linkes@pantheon.tech> In-Reply-To: From: =?UTF-8?Q?Juraj_Linke=C5=A1?= Date: Tue, 25 Apr 2023 10:20:36 +0200 Message-ID: Subject: Re: [RFC PATCH v1 0/4] dts: add dts api docs 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 Mon, Apr 3, 2023 at 11:42=E2=80=AFAM Bruce Richardson wrote: > > On Mon, Apr 03, 2023 at 11:17:06AM +0200, Juraj Linke=C5=A1 wrote: > > Hi Bruce, Thomas, > > The meson integration is kinda all over the place. I wanted to use t= he > > existing conf.py Sphinx config file, but I also wanted to keep the d= ocs > > separated (because of extra DTS api docs dependencies), so the vario= us > > pieces are in different places (the config file in one place, meson > > code in dts directory and generated Sphinx docs are in a new directo= ry > > in the api build dir, separate from the rest of the Sphinx html). > > The big thing here is that I didn't figure out how to separate the d= ts > > api build from the rest of the docs. I don't know how the -Denable_d= ocs > > option is supposed to work. I wanted to use -Denable_dts_docs in the > > same fashion to decouple the builds, but it doesn't seem to work. > > Reading the code I think the original option doesn't actually do > > anything - does it work? How is it supposed to work? > > Thanks, > > Juraj > > The enable_docs option works by selectively enabling the doc build tasks > using the "build_by_default" parameter on them. > See http://git.dpdk.org/dpdk/tree/doc/guides/meson.build#n23 for an > example. The custom_target for sphinx is not a dependency of any other > task, so whether it gets run or not depends entirely on whether the > "build_by_default" and/or "install" options are set. > > As usual, there may be other stuff that needs cleaning up on this, but > that's how it works for now, anyway. [And it does actually work, last I > tested it :-)] I looked into this and as is so frequently the case, we're both right. :-) When running according to docs, that is with: 1. meson setup doc_build 2. ninja -C doc_build doc it doesn't matter what enable_docs is set to, it always builds the docs. But in the full build it does control whether docs are built, i.e.: 1. meson setup doc_build 2. ninja -C doc_build doesn't build the docs, whereas: 1. meson setup doc_build -Denable_docs=3Dtrue 2. ninja -C doc_build builds the docs. Now the problem in this version is when doing just the doc build (ninja -C doc_build doc) both DPDK and DTS docs are built and I'd like to separate those (because DTS doc build has additional dependencies). I'm thinking the following would be a good solution within the current paradigm: 1. The -Denable_docs=3Dtrue and -Denable_dts_docs=3Dtrue options to separate doc builds for the full build. 2. Separate dts doc dir for the doc build ("ninja -C doc_build doc" for DPDK docs and "ninja -C doc_build dts" (or maybe some other dir) for DTS docs). What do you think? Juraj > > /Bruce