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 238B4459BF; Tue, 17 Sep 2024 17:10:35 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D262B402D8; Tue, 17 Sep 2024 17:10:34 +0200 (CEST) Received: from mail-wm1-f52.google.com (mail-wm1-f52.google.com [209.85.128.52]) by mails.dpdk.org (Postfix) with ESMTP id 0840540261 for ; Tue, 17 Sep 2024 17:10:34 +0200 (CEST) Received: by mail-wm1-f52.google.com with SMTP id 5b1f17b1804b1-42cde6b5094so46719045e9.3 for ; Tue, 17 Sep 2024 08:10:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1726585833; x=1727190633; darn=dpdk.org; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :from:to:cc:subject:date:message-id:reply-to; bh=Q4e+vBqPmzvevmRamgAuHDJdySCg11B91bMnU8hvlys=; b=M/6fV67M4GrwhK2SJqCO6zi5NgOXN7JMrV3UJ6Dvwcz+GqfRNJYfWeh2aTPGCMXXso qmTeXwoEIORtSgq0rE+iQuR0mXozSLv+da3Y7FvEHiZkywC7PpSb3z6chZWwVPfqEf9a HXOx4rnMgsILP3NEW10NXUqvc+fqhPmgQKaWUr/0t3Fy4UNtoIXnui+X1RLGi7558oBM 3qtiDSvRs28my9ZKjf2CTvd+3L2QhvbawIsymOJy5A6bTZM5m5+icotlA7HF3iEVXusl u6gbZ7J2HYkO/AFZuRvAFD6othG8BDSlrq2I0jy3g8colhI5AHkceOAFkAWKDNawH/qo Ef5A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1726585833; x=1727190633; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=Q4e+vBqPmzvevmRamgAuHDJdySCg11B91bMnU8hvlys=; b=KoAnoC8vgxaHokguqtz2ShN/hFkxMOql7+WMln1x6/Y6LIeWERACax8cmq7F3Oxl5T Gdc8xK2OotbG25Hx8iKdzCfuApdQpcyt5z6pvJ/cqUp2K5z1lEWFIkN6ghM4dP4OSjRF MJCslwg4pzjAsF+ossXoaCsKFIyGf3tZH2gPmmmeooEzp8Bd7n0gMVbbaq5s/SbLV9g8 cgfyV4RYCU/dkhAZ0FW4kJN0L0LbpPvrNvGqzXVeL6WeCf4ixg0zTcTIqU9NwEvcE6BN gF/xgEMSLH9JyUaTfdFICRp+Sj4MZW6N/fuPbeCjyY+68ahjct0+0wUNpB1+38FFHjL8 43Dg== X-Forwarded-Encrypted: i=1; AJvYcCXjO3VWe0+Qyt1tlpltxIbYZbAV6CncefIxYsi8OnV59pGSX+iORL4RbcbBC+fI4ZFfR2g=@dpdk.org X-Gm-Message-State: AOJu0YzZ8KekVdtvhuwitHmOf+AQWkhBRxsnTOwp2ZuzraXzjIN8nXSn uWDldE+PP4Os1u32KqV39qhLn83jeueXD/EqzA3IN/BfWpae1uRZpw11R5UfbRE= X-Google-Smtp-Source: AGHT+IHbYD0mc5ur7jMN07pYtL+8WTKOhi8MQlf4MmHeAjoJMr6knwUW2GFC6Jvr5hFNTp+NZg/4Eg== X-Received: by 2002:a05:600c:4f0c:b0:42c:c401:6d86 with SMTP id 5b1f17b1804b1-42cdb57da28mr112623515e9.27.1726585833417; Tue, 17 Sep 2024 08:10:33 -0700 (PDT) Received: from [192.168.0.113] ([84.245.121.62]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-42d9b15d2besm139672415e9.25.2024.09.17.08.10.31 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Tue, 17 Sep 2024 08:10:33 -0700 (PDT) Message-ID: <1f824927-f3dd-4e0e-9e05-0f95505953dc@pantheon.tech> Date: Tue, 17 Sep 2024 17:10:30 +0200 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v19 5/5] dts: add API doc generation To: Thomas Monjalon Cc: Honnappa.Nagarahalli@arm.com, jspewock@iol.unh.edu, probb@iol.unh.edu, paul.szczepanek@arm.com, Luca.Vizzarro@arm.com, npratte@iol.unh.edu, dmarx@iol.unh.edu, alex.chapman@arm.com, dev@dpdk.org, Bruce Richardson References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <13597798.dW097sEU6C@thomas> <80f57b93-eb91-48b1-ada9-d23fd45f8a59@pantheon.tech> <10586268.nUPlyArG6x@thomas> Content-Language: en-US From: =?UTF-8?Q?Juraj_Linke=C5=A1?= In-Reply-To: <10586268.nUPlyArG6x@thomas> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit 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 16. 9. 2024 14:48, Thomas Monjalon wrote: > 16/09/2024 10:51, Juraj Linkeš: >> On 12. 9. 2024 22:09, Thomas Monjalon wrote: >>> 21/08/2024 17:02, Juraj Linkeš: >>>> + req_deps = _get_dependencies(_DTS_DEP_FILE_PATH) >>>> + req_deps.pop('python') >>>> + >>>> + for req_dep, dep_data in (req_deps | _EXTRA_DEPS).items(): >>> >>> Please could you explain somewhere why _EXTRA_DEPS is needed? >> >> I'll add this comment above the variable: >> # The names of packages used in import statements may be different from >> distribution package names. >> # We get distribution package names from pyproject.toml. >> # _EXTRA_DEPS adds those import names which don't match their >> distribution package name. > > Good > Ack. > >>> I feel the need for dependencies should be explained in the script. >> >> From my point of view, the script gets the dependencies and it's up to >> the caller how they use the list of dependencies. >> >> The caller is conf.py and there's a bit of an explanation: >> # Get missing DTS dependencies. Add path to buildtools to find the >> get_missing_imports function. >> >> And then: >> # Ignore missing imports from DTS dependencies. >> >> So basically get the dependencies so we know what to ignore. >> >> But I could add something to the script if this is not enough. > > The unclear part is how it works without these dependencies. > It's a bit unclear to me as well. The docs [0] don't say much and the only thing I found is that object paths from third party libraries are a bit different: without dependencies: fabric.Connection with dependencies: fabric.connection.Connection Everything else seems to be the same. Do we want to document this and if so, where would be the best place? In the script or conf.py? [0] https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_mock_imports > >>>> +# initialize common Doxygen configuration >>>> +cdata = configuration_data() >>>> + >>>> +subdir('dts') >>> >>> Why inserting DTS first before generating DPDK API doc? >> >> I wanted to put it before subdir_done(). Maybe we could put >> subdir('dts') in the else branch and also at the end of the meson.build >> file. That could be better. > > Yes > Ok, I'll make the change. > >>>> + # Intersphinx allows linking to external projects, such as Python docs. >>>> + intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} >>> >>> I'm not sure about the need for this intersphinx. >> >> It's not stricly needed, but it produces better documentation, with >> links to Python docs for classes and other things found there. >> >> For example: >> :class:`~argparse.Action` in a docstring will link to >> https://docs.python.org/3/library/argparse.html#argparse.Action > > If you think it helps, I'm fine. > Absolutely, it'll make the docs easier to use. >