DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Juraj Linkeš" <juraj.linkes@pantheon.tech>
To: Thomas Monjalon <thomas@monjalon.net>
Cc: Honnappa.Nagarahalli@arm.com, bruce.richardson@intel.com,
	jspewock@iol.unh.edu, probb@iol.unh.edu, paul.szczepanek@arm.com,
	Luca.Vizzarro@arm.com, npratte@iol.unh.edu, dev@dpdk.org
Subject: Re: [PATCH v8 5/5] dts: add API doc generation
Date: Thu, 1 Aug 2024 15:03:07 +0200	[thread overview]
Message-ID: <9cfefccb-0190-46d3-8942-c8c82da38f99@pantheon.tech> (raw)
In-Reply-To: <10378083.0AQdONaE2F@thomas>



On 30. 7. 2024 15:51, Thomas Monjalon wrote:
> 12/07/2024 10:57, Juraj Linkeš:
>> The tool used to generate DTS API docs is Sphinx, which is already in
>> use in DPDK. The same configuration is used to preserve style with one
>> DTS-specific configuration (so that the DPDK docs are unchanged) that
>> modifies how the sidebar displays the content.
> 
> What is changed in the sidebar?
> 

These are the two changes:
html_theme_options = {
     'collapse_navigation': False,
     'navigation_depth': -1,
}

The first allows you to explore the structure without needing to enter 
any specific section - it puts the + at each section so everything is 
expandable.
The second just means that each section can be fully expanded (there's 
no limit).

> 
>> --- a/doc/api/doxy-api-index.md
>> +++ b/doc/api/doxy-api-index.md
>> @@ -244,3 +244,6 @@ The public API headers are grouped by topics:
>>     [experimental APIs](@ref rte_compat.h),
>>     [ABI versioning](@ref rte_function_versioning.h),
>>     [version](@ref rte_version.h)
>> +
>> +- **tests**:
>> +  [**DTS**](@dts_api_main_page)
> 
> OK looks good
> 
> 
>> --- a/doc/api/doxy-api.conf.in
>> +++ b/doc/api/doxy-api.conf.in
>> @@ -124,6 +124,8 @@ SEARCHENGINE            = YES
>>   SORT_MEMBER_DOCS        = NO
>>   SOURCE_BROWSER          = YES
>>   
>> +ALIASES                 = "dts_api_main_page=@DTS_API_MAIN_PAGE@"
> 
> Why is it needed?
> That's the only way to reference it in doxy-api-index.md?
> Would be nice to explain in the commit log.
> 

I can add something to the commit log. The questions are answered below, 
in your other related comment.

>> --- a/doc/api/meson.build
>> +++ b/doc/api/meson.build
>> +# A local reference must be relative to the main index.html page
>> +# The path below can't be taken from the DTS meson file as that would
>> +# require recursive subdir traversal (doc, dts, then doc again)
> 
> This comment is really obscure.
> 

I guess it is. I just wanted to explain that there's not way to do this 
without spelling out the path this way. At least I didn't find a way.
Should I remove the comment or reword it?

>> +cdata.set('DTS_API_MAIN_PAGE', join_paths('..', 'dts', 'html', 'index.html'))
> 
> Oh I think I get it:
> 	- DTS_API_MAIN_PAGE is the Meson variable
> 	- dts_api_main_page is the Doxygen variable
> 

Yes, this is a way to make it work. Maybe there's something else (I'm 
not that familiar with Doxygen), but from what I can tell, there wasn't 
a command line option that would set a variable (passing the path form 
Meson to Doxygen) and nothing else I found worked.

Is this solution ok? If we want to explore something else, is there 
someone with more experience with Doxygen who could help?

> 
>> +# Napoleon enables the Google format of Python doscstrings, used in DTS
>> +# Intersphinx allows linking to external projects, such as Python docs, also used in DTS
> 
> Close sentences with a dot, it is easier to read.
> 

Ack.

>> +extensions = ['sphinx.ext.napoleon', 'sphinx.ext.intersphinx']
>> +
>> +# DTS Python docstring options
>> +autodoc_default_options = {
>> +    'members': True,
>> +    'member-order': 'bysource',
>> +    'show-inheritance': True,
>> +}
>> +autodoc_class_signature = 'separated'
>> +autodoc_typehints = 'both'
>> +autodoc_typehints_format = 'short'
>> +autodoc_typehints_description_target = 'documented'
>> +napoleon_numpy_docstring = False
>> +napoleon_attr_annotations = True
>> +napoleon_preprocess_types = True
>> +add_module_names = False
>> +toc_object_entries = True
>> +toc_object_entries_show_parents = 'hide'
>> +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
>> +
>> +dts_root = environ.get('DTS_ROOT')
> 
> Why does it need to be passed as an environment variable?
> Isn't it a fixed absolute path?
> 

The path to DTS needs to be passed in some way (and added to sys.path) 
so that Sphinx knows where the sources are in order to import them.

Do you want us to not pass the path, but just hardcode it here? I didn't 
really think about that, maybe that could work.

>> +if dts_root:
>> +    path.append(dts_root)
>> +    # DTS Sidebar config
>> +    html_theme_options = {
>> +        'collapse_navigation': False,
>> +        'navigation_depth': -1,
>> +    }
> 
> [...]
> 
>> +To build DTS API docs, install the dependencies with Poetry, then enter its shell:
> 
> I don't plan to use Poetry on my machine.
> Can we simply describe the dependencies even if the versions are not specified?
> 

The reason we don't list the dependencies anywhere is that doing it with 
Poetry is much easier (and a bit safer, as Poetry is going to install 
tested versions).

But I can add references to the two relevant sections of 
dts/pyproject.toml which contain the dependencies with a note that they 
can be installed with pip (and I guess that would be another 
dependency), but at that point it's that not much different than using 
Poetry.

>> +
>> +.. code-block:: console
>> +
>> +   poetry install --no-root --with docs
>> +   poetry shell
>> +
>> +The documentation is built using the standard DPDK build system.
>> +After executing the meson command and entering Poetry's shell, build the documentation with:
>> +
>> +.. code-block:: console
>> +
>> +   ninja -C build dts-doc
> 
> Don't we rely on the Meson option "enable_docs"?

I had a discussion about this with Bruce, but I can't find it anywhere, 
so here's what I remember:
1. We didn't want to tie the dts api doc build to dpdk doc build because 
of the dependencies.
2. There's a way to build docs without the enable_docs option (running 
ninja with the target), which is what we added for dts. This doesn't tie 
the dts api doc build to the dpdk doc build.
3. We had an "enable_dts_docs" Meson option in the past (to keep it 
separate from dpdk doc build), but decided to drop it. My memory is hazy 
on this, but I think it was, again, because of the additional steps 
needed to bring up the dependency (poetry shell) - at that point, 
supporting just the ninja build way is sufficient. Bruce may shed more 
light on this.

>> +
>> +The output is generated in ``build/doc/api/dts/html``.
>> +
>> +.. Note::
> 
> In general the RST expressions are lowercase.
> 

Ack.

>> +
>> +   Make sure to fix any Sphinx warnings when adding or updating docstrings,
>> +   and also run the ``devtools/dts-check-format.sh`` script and address any issues it finds.
> 
> It looks like something to write in the contributing guide.
> 

I could add it there, where is the right place? In patches.rst, section 
"Checking the Patches"?

> 
>> +++ b/dts/doc/meson.build
>> @@ -0,0 +1,27 @@
>> +# SPDX-License-Identifier: BSD-3-Clause
>> +# Copyright(c) 2023 PANTHEON.tech s.r.o.
>> +
>> +sphinx = find_program('sphinx-build', required: false)
>> +sphinx_apidoc = find_program('sphinx-apidoc', required: false)
>> +
>> +if not sphinx.found() or not sphinx_apidoc.found()
> 
> You should include the option "enable_docs" here.
> 
>> +    subdir_done()
>> +endif
> 
> 
> 

  reply	other threads:[~2024-08-01 13:03 UTC|newest]

Thread overview: 393+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-23 10:40 [RFC PATCH v1 0/4] dts: add dts api docs Juraj Linkeš
2023-03-23 10:40 ` [RFC PATCH v1 1/4] dts: code adjustments for sphinx Juraj Linkeš
2023-03-23 10:40 ` [RFC PATCH v1 2/4] dts: add doc generation dependencies Juraj Linkeš
2023-03-23 10:40 ` [RFC PATCH v1 3/4] dts: add doc generation Juraj Linkeš
2023-03-23 10:40 ` [RFC PATCH v1 4/4] dts: format docstrigs to google format Juraj Linkeš
2023-04-28 19:33   ` Jeremy Spewock
2023-04-03  9:17 ` [RFC PATCH v1 0/4] dts: add dts api docs Juraj Linkeš
2023-04-03  9:42   ` Bruce Richardson
2023-04-25  8:20     ` Juraj Linkeš
2023-04-25  8:44       ` Bruce Richardson
2023-04-25  8:57         ` Juraj Linkeš
2023-04-25  9:43           ` Bruce Richardson
2023-05-03 11:33             ` Juraj Linkeš
2023-05-04 12:37 ` [RFC PATCH v2 " Juraj Linkeš
2023-05-04 12:37   ` [RFC PATCH v2 1/4] dts: code adjustments for sphinx Juraj Linkeš
2023-05-04 12:37   ` [RFC PATCH v2 2/4] dts: add doc generation dependencies Juraj Linkeš
2023-05-04 12:37   ` [RFC PATCH v2 3/4] dts: add doc generation Juraj Linkeš
2023-05-04 12:45     ` Bruce Richardson
2023-05-05  7:53       ` Juraj Linkeš
2023-05-05 10:24         ` Bruce Richardson
2023-05-05 10:41           ` Juraj Linkeš
2023-05-05 10:56     ` Bruce Richardson
2023-05-05 11:13       ` Juraj Linkeš
2023-05-05 13:28         ` Bruce Richardson
2023-05-09  9:23           ` Juraj Linkeš
2023-05-09  9:40             ` Bruce Richardson
2023-05-10 12:19               ` Juraj Linkeš
2023-05-04 12:37   ` [RFC PATCH v2 4/4] dts: format docstrigs to google format Juraj Linkeš
2023-05-05 14:06   ` [RFC PATCH v2 0/4] dts: add dts api docs Bruce Richardson
2023-05-09 15:28     ` Juraj Linkeš
2023-05-11  8:55     ` Juraj Linkeš
2023-05-11  9:14   ` [RFC PATCH v3 " Juraj Linkeš
2023-05-11  9:14     ` [RFC PATCH v3 1/4] dts: code adjustments for sphinx Juraj Linkeš
2023-05-11  9:14     ` [RFC PATCH v3 2/4] dts: add doc generation dependencies Juraj Linkeš
2023-05-11  9:14     ` [RFC PATCH v3 3/4] dts: add doc generation Juraj Linkeš
2023-05-11  9:14     ` [RFC PATCH v3 4/4] dts: format docstrigs to google format Juraj Linkeš
2023-06-21 18:27       ` Jeremy Spewock
2023-05-17 16:56     ` [RFC PATCH v3 0/4] dts: add dts api docs Bruce Richardson
2023-05-22  9:17       ` Juraj Linkeš
2023-08-31 10:04     ` [RFC PATCH v4 " Juraj Linkeš
2023-08-31 10:04       ` [RFC PATCH v4 1/4] dts: code adjustments for sphinx Juraj Linkeš
2023-10-22 14:30         ` Yoan Picchi
2023-10-23  6:44           ` Juraj Linkeš
2023-10-23 11:52             ` Yoan Picchi
2023-10-24  6:39               ` Juraj Linkeš
2023-10-24 12:21                 ` Yoan Picchi
2023-08-31 10:04       ` [RFC PATCH v4 2/4] dts: add doc generation dependencies Juraj Linkeš
2023-10-27 15:27         ` Yoan Picchi
2023-08-31 10:04       ` [RFC PATCH v4 3/4] dts: add doc generation Juraj Linkeš
2023-09-20  7:08         ` Juraj Linkeš
2023-10-26 16:43         ` Yoan Picchi
2023-10-27  9:52           ` Juraj Linkeš
2023-08-31 10:04       ` [RFC PATCH v4 4/4] dts: format docstrigs to google format Juraj Linkeš
2023-09-01 17:02         ` Jeremy Spewock
2023-10-31 12:10         ` Yoan Picchi
2023-11-02 10:17           ` Juraj Linkeš
2023-11-06 17:15       ` [PATCH v5 00/23] dts: add dts api docs Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 01/23] dts: code adjustments for doc generation Juraj Linkeš
2023-11-08 13:35           ` Yoan Picchi
2023-11-15  7:46             ` Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 02/23] dts: add docstring checker Juraj Linkeš
2023-11-07 17:38           ` Yoan Picchi
2023-11-06 17:15         ` [PATCH v5 03/23] dts: add basic developer docs Juraj Linkeš
2023-11-07 14:39           ` Yoan Picchi
2023-11-08  9:01             ` Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 04/23] dts: exceptions docstring update Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 05/23] dts: settings " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 06/23] dts: logger and " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 07/23] dts: dts runner and main " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 08/23] dts: test suite " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 09/23] dts: test result " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 10/23] dts: config " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 11/23] dts: remote session " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 12/23] dts: interactive " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 13/23] dts: port and virtual device " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 14/23] dts: cpu " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 15/23] dts: os session " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 16/23] dts: posix and linux sessions " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 17/23] dts: node " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 18/23] dts: sut and tg nodes " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 19/23] dts: base traffic generators " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 20/23] dts: scapy tg " Juraj Linkeš
2023-11-06 17:15         ` [PATCH v5 21/23] dts: test suites " Juraj Linkeš
2023-11-06 17:16         ` [PATCH v5 22/23] dts: add doc generation dependencies Juraj Linkeš
2023-11-06 17:16         ` [PATCH v5 23/23] dts: add doc generation Juraj Linkeš
2023-11-08 12:53         ` [PATCH v6 01/23] dts: code adjustments for " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 02/23] dts: add docstring checker Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 03/23] dts: add basic developer docs Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 04/23] dts: exceptions docstring update Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 05/23] dts: settings " Juraj Linkeš
2023-11-08 16:17             ` Yoan Picchi
2023-11-15 10:09               ` Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 06/23] dts: logger and " Juraj Linkeš
2023-11-08 17:14             ` Yoan Picchi
2023-11-15 10:11               ` Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 07/23] dts: dts runner and main " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 08/23] dts: test suite " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 09/23] dts: test result " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 10/23] dts: config " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 11/23] dts: remote session " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 12/23] dts: interactive " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 13/23] dts: port and virtual device " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 14/23] dts: cpu " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 15/23] dts: os session " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 16/23] dts: posix and linux sessions " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 17/23] dts: node " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 18/23] dts: sut and tg nodes " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 19/23] dts: base traffic generators " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 20/23] dts: scapy tg " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 21/23] dts: test suites " Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 22/23] dts: add doc generation dependencies Juraj Linkeš
2023-11-08 16:00             ` Yoan Picchi
2023-11-15 10:00               ` Juraj Linkeš
2023-11-08 12:53           ` [PATCH v6 23/23] dts: add doc generation Juraj Linkeš
2023-11-15 13:09             ` [PATCH v7 00/21] dts: docstrings update Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 01/21] dts: code adjustments for doc generation Juraj Linkeš
2023-11-16 21:04                 ` Jeremy Spewock
2023-11-20 16:10                   ` Juraj Linkeš
2023-11-20 16:02                 ` Yoan Picchi
2023-11-15 13:09               ` [PATCH v7 02/21] dts: add docstring checker Juraj Linkeš
2023-11-20 16:03                 ` Yoan Picchi
2023-11-15 13:09               ` [PATCH v7 03/21] dts: add basic developer docs Juraj Linkeš
2023-11-20 16:03                 ` Yoan Picchi
2023-11-15 13:09               ` [PATCH v7 04/21] dts: exceptions docstring update Juraj Linkeš
2023-11-20 16:22                 ` Yoan Picchi
2023-11-20 16:35                   ` Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 05/21] dts: settings " Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 06/21] dts: logger and utils " Juraj Linkeš
2023-11-20 16:23                 ` Yoan Picchi
2023-11-20 16:36                   ` Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 07/21] dts: dts runner and main " Juraj Linkeš
2023-11-16 21:51                 ` Jeremy Spewock
2023-11-20 16:13                   ` Juraj Linkeš
2023-11-20 17:43                 ` Yoan Picchi
2023-11-21  9:10                   ` Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 08/21] dts: test suite " Juraj Linkeš
2023-11-16 22:16                 ` Jeremy Spewock
2023-11-20 16:25                   ` Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 09/21] dts: test result " Juraj Linkeš
2023-11-16 22:47                 ` Jeremy Spewock
2023-11-20 16:33                   ` Juraj Linkeš
2023-11-30 21:20                     ` Jeremy Spewock
2023-11-15 13:09               ` [PATCH v7 10/21] dts: config " Juraj Linkeš
2023-11-21 15:08                 ` Yoan Picchi
2023-11-22 10:42                   ` Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 11/21] dts: remote session " Juraj Linkeš
2023-11-21 15:36                 ` Yoan Picchi
2023-11-22 11:13                   ` Juraj Linkeš
2023-11-22 11:25                     ` Yoan Picchi
2023-11-15 13:09               ` [PATCH v7 12/21] dts: interactive " Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 13/21] dts: port and virtual device " Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 14/21] dts: cpu " Juraj Linkeš
2023-11-21 17:45                 ` Yoan Picchi
2023-11-22 11:18                   ` Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 15/21] dts: os session " Juraj Linkeš
2023-11-22 11:50                 ` Yoan Picchi
2023-11-22 13:27                   ` Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 16/21] dts: posix and linux sessions " Juraj Linkeš
2023-11-22 13:24                 ` Yoan Picchi
2023-11-22 13:35                   ` Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 17/21] dts: node " Juraj Linkeš
2023-11-22 12:18                 ` Yoan Picchi
2023-11-22 13:28                   ` Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 18/21] dts: sut and tg nodes " Juraj Linkeš
2023-11-22 13:12                 ` Yoan Picchi
2023-11-22 13:34                   ` Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 19/21] dts: base traffic generators " Juraj Linkeš
2023-11-21 16:20                 ` Yoan Picchi
2023-11-22 11:38                   ` Juraj Linkeš
2023-11-22 11:56                     ` Yoan Picchi
2023-11-22 13:11                       ` Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 20/21] dts: scapy tg " Juraj Linkeš
2023-11-21 16:33                 ` Yoan Picchi
2023-11-22 13:18                   ` Juraj Linkeš
2023-11-15 13:09               ` [PATCH v7 21/21] dts: test suites " Juraj Linkeš
2023-11-16 17:36                 ` Yoan Picchi
2023-11-20 10:17                   ` Juraj Linkeš
2023-11-20 12:50                     ` Yoan Picchi
2023-11-22 13:40                       ` Juraj Linkeš
2023-11-23 15:13               ` [PATCH v8 00/21] dts: docstrings update Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 01/21] dts: code adjustments for doc generation Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 02/21] dts: add docstring checker Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 03/21] dts: add basic developer docs Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 04/21] dts: exceptions docstring update Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 05/21] dts: settings " Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 06/21] dts: logger and utils " Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 07/21] dts: dts runner and main " Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 08/21] dts: test suite " Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 09/21] dts: test result " Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 10/21] dts: config " Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 11/21] dts: remote session " Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 12/21] dts: interactive " Juraj Linkeš
2023-11-30 21:49                   ` Jeremy Spewock
2023-12-04  9:50                     ` Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 13/21] dts: port and virtual device " Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 14/21] dts: cpu " Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 15/21] dts: os session " Juraj Linkeš
2023-12-01 17:33                   ` Jeremy Spewock
2023-12-04  9:53                     ` Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 16/21] dts: posix and linux sessions " Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 17/21] dts: node " Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 18/21] dts: sut and tg nodes " Juraj Linkeš
2023-12-01 18:06                   ` Jeremy Spewock
2023-12-04 10:02                     ` Juraj Linkeš
2023-12-04 11:02                       ` Bruce Richardson
2023-11-23 15:13                 ` [PATCH v8 19/21] dts: base traffic generators " Juraj Linkeš
2023-12-01 18:05                   ` Jeremy Spewock
2023-12-04 10:03                     ` Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 20/21] dts: scapy tg " Juraj Linkeš
2023-12-01 18:17                   ` Jeremy Spewock
2023-12-04 10:07                     ` Juraj Linkeš
2023-11-23 15:13                 ` [PATCH v8 21/21] dts: test suites " Juraj Linkeš
2023-12-01 16:00                 ` [PATCH v8 00/21] dts: docstrings update Yoan Picchi
2023-12-01 18:23                   ` Jeremy Spewock
2023-12-04 10:24                 ` [PATCH v9 " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 01/21] dts: code adjustments for doc generation Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 02/21] dts: add docstring checker Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 03/21] dts: add basic developer docs Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 04/21] dts: exceptions docstring update Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 05/21] dts: settings " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 06/21] dts: logger and utils " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 07/21] dts: dts runner and main " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 08/21] dts: test suite " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 09/21] dts: test result " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 10/21] dts: config " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 11/21] dts: remote session " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 12/21] dts: interactive " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 13/21] dts: port and virtual device " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 14/21] dts: cpu " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 15/21] dts: os session " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 16/21] dts: posix and linux sessions " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 17/21] dts: node " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 18/21] dts: sut and tg nodes " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 19/21] dts: base traffic generators " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 20/21] dts: scapy tg " Juraj Linkeš
2023-12-04 10:24                   ` [PATCH v9 21/21] dts: test suites " Juraj Linkeš
2023-12-05 18:39                     ` Jeremy Spewock
2023-12-21 11:48                   ` [PATCH v9 00/21] dts: docstrings update Thomas Monjalon
2023-11-15 13:36             ` [PATCH v1 0/2] dts: api docs generation Juraj Linkeš
2023-11-15 13:36               ` [PATCH v1 1/2] dts: add doc generation dependencies Juraj Linkeš
2023-11-15 13:36               ` [PATCH v1 2/2] dts: add doc generation Juraj Linkeš
2024-01-22 12:00               ` [PATCH v2 0/3] dts: API docs generation Juraj Linkeš
2024-01-22 12:00                 ` [PATCH v2 1/3] dts: add doc generation dependencies Juraj Linkeš
2024-01-22 12:00                 ` [PATCH v2 2/3] dts: add API doc sources Juraj Linkeš
2024-01-22 12:00                 ` [PATCH v2 3/3] dts: add API doc generation Juraj Linkeš
2024-01-22 16:35               ` [PATCH v3 0/3] dts: API docs generation Juraj Linkeš
2024-01-22 16:35                 ` [PATCH v3 1/3] dts: add doc generation dependencies Juraj Linkeš
2024-01-22 16:35                 ` [PATCH v3 2/3] dts: add API doc sources Juraj Linkeš
2024-01-22 16:35                 ` [PATCH v3 3/3] dts: add API doc generation Juraj Linkeš
2024-01-29 17:09                   ` Jeremy Spewock
     [not found]                   ` <CAJvnSUCNjo0p-yhROF1MNLKhjiAw2QTyTHO2hpOaVVUn0xnJ0A@mail.gmail.com>
2024-02-29 18:12                     ` Nicholas Pratte
2024-04-12 10:14               ` [PATCH v4 0/3] dts: API docs generation Juraj Linkeš
2024-04-12 10:14                 ` [PATCH v4 1/3] dts: add doc generation dependencies Juraj Linkeš
2024-05-31 10:42                   ` Luca Vizzarro
2024-06-14 14:32                   ` Jeremy Spewock
2024-04-12 10:14                 ` [PATCH v4 2/3] dts: add API doc sources Juraj Linkeš
2024-05-31 10:43                   ` Luca Vizzarro
2024-06-14 14:32                   ` Jeremy Spewock
2024-04-12 10:14                 ` [PATCH v4 3/3] dts: add API doc generation Juraj Linkeš
2024-05-31 10:43                   ` Luca Vizzarro
2024-04-29 13:49                 ` [PATCH v4 0/3] dts: API docs generation Jeremy Spewock
2024-04-29 14:12                   ` Patrick Robb
2024-06-24 13:26               ` [PATCH v5 0/4] " Juraj Linkeš
2024-06-24 13:26                 ` [PATCH v5 1/4] dts: update params and parser docstrings Juraj Linkeš
2024-06-24 13:26                 ` [PATCH v5 2/4] dts: add doc generation dependencies Juraj Linkeš
2024-06-24 13:26                 ` [PATCH v5 3/4] dts: add API doc sources Juraj Linkeš
2024-06-24 13:26                 ` [PATCH v5 4/4] dts: add API doc generation Juraj Linkeš
2024-06-24 13:45               ` [PATCH v6 0/4] dts: API docs generation Juraj Linkeš
2024-06-24 13:45                 ` [PATCH v6 1/4] dts: update params and parser docstrings Juraj Linkeš
2024-06-24 13:45                 ` [PATCH v6 2/4] dts: add doc generation dependencies Juraj Linkeš
2024-06-24 13:45                 ` [PATCH v6 3/4] dts: add API doc sources Juraj Linkeš
2024-06-24 13:46                 ` [PATCH v6 4/4] dts: add API doc generation Juraj Linkeš
2024-06-24 13:53                   ` Bruce Richardson
2024-06-24 14:08                   ` Juraj Linkeš
2024-06-24 14:25                   ` Thomas Monjalon
2024-06-24 14:25               ` [PATCH v7 0/4] dts: API docs generation Juraj Linkeš
2024-06-24 14:25                 ` [PATCH v7 1/4] dts: update params and parser docstrings Juraj Linkeš
2024-06-24 15:37                   ` Luca Vizzarro
2024-06-24 14:25                 ` [PATCH v7 2/4] dts: add doc generation dependencies Juraj Linkeš
2024-06-24 14:25                 ` [PATCH v7 3/4] dts: add API doc sources Juraj Linkeš
2024-06-24 14:25                 ` [PATCH v7 4/4] dts: add API doc generation Juraj Linkeš
2024-07-12  8:57               ` [PATCH v8 0/5] dts: API docs generation Juraj Linkeš
2024-07-12  8:57                 ` [PATCH v8 1/5] dts: update params and parser docstrings Juraj Linkeš
2024-07-12  8:57                 ` [PATCH v8 2/5] dts: add doc generation dependencies Juraj Linkeš
2024-07-12  8:57                 ` [PATCH v8 3/5] dts: add API doc sources Juraj Linkeš
2024-07-12  8:57                 ` [PATCH v8 4/5] doc: guides and API meson improvements Juraj Linkeš
2024-07-30 13:28                   ` Thomas Monjalon
2024-08-01 10:02                     ` Juraj Linkeš
2024-07-12  8:57                 ` [PATCH v8 5/5] dts: add API doc generation Juraj Linkeš
2024-07-30 13:51                   ` Thomas Monjalon
2024-08-01 13:03                     ` Juraj Linkeš [this message]
2024-08-01 15:07                       ` Thomas Monjalon
2024-08-02 10:48                         ` Juraj Linkeš
2024-08-02 13:53                           ` Thomas Monjalon
2024-08-05  9:04                             ` Juraj Linkeš
2024-08-01  9:18               ` [PATCH v9 0/5] dts: API docs generation Juraj Linkeš
2024-08-01  9:18                 ` [PATCH v9 1/5] dts: update params and parser docstrings Juraj Linkeš
2024-08-01  9:18                 ` [PATCH v9 2/5] dts: add doc generation dependencies Juraj Linkeš
2024-08-01  9:18                 ` [PATCH v9 3/5] dts: add API doc sources Juraj Linkeš
2024-08-01  9:18                 ` [PATCH v9 4/5] doc: guides and API meson improvements Juraj Linkeš
2024-08-01  9:18                 ` [PATCH v9 5/5] dts: add API doc generation Juraj Linkeš
2024-08-01  9:37               ` [PATCH v10 0/5] dts: API docs generation Juraj Linkeš
2024-08-01  9:37                 ` [PATCH v10 1/5] dts: update params and parser docstrings Juraj Linkeš
2024-08-01  9:37                 ` [PATCH v10 2/5] dts: add doc generation dependencies Juraj Linkeš
2024-08-01  9:37                 ` [PATCH v10 3/5] dts: add API doc sources Juraj Linkeš
2024-08-01  9:37                 ` [PATCH v10 4/5] doc: guides and API meson improvements Juraj Linkeš
2024-08-01  9:37                 ` [PATCH v10 5/5] dts: add API doc generation Juraj Linkeš
2024-08-05 13:59               ` [PATCH v11 0/5] dts: API docs generation Juraj Linkeš
2024-08-05 13:59                 ` [PATCH v11 1/5] dts: update params and parser docstrings Juraj Linkeš
2024-08-05 13:59                 ` [PATCH v11 2/5] dts: add doc generation dependencies Juraj Linkeš
2024-08-05 13:59                 ` [PATCH v11 3/5] dts: add API doc sources Juraj Linkeš
2024-08-05 13:59                 ` [PATCH v11 4/5] doc: meson doc API build dir variable Juraj Linkeš
2024-08-05 13:59                 ` [PATCH v11 5/5] dts: add API doc generation Juraj Linkeš
2024-08-06  6:13               ` [PATCH v12 0/5] dts: API docs generation Juraj Linkeš
2024-08-06  6:13                 ` [PATCH v12 1/5] dts: update params and parser docstrings Juraj Linkeš
2024-08-06  6:13                 ` [PATCH v12 2/5] dts: add doc generation dependencies Juraj Linkeš
2024-08-06  6:13                 ` [PATCH v12 3/5] dts: add API doc sources Juraj Linkeš
2024-08-06  6:14                 ` [PATCH v12 4/5] doc: meson doc API build dir variable Juraj Linkeš
2024-08-06  6:14                 ` [PATCH v12 5/5] dts: add API doc generation Juraj Linkeš
2024-08-06  8:46               ` [PATCH v13 0/6] API docs generation Juraj Linkeš
2024-08-06  8:46                 ` [PATCH v13 1/6] dts: update params and parser docstrings Juraj Linkeš
2024-08-06  8:46                 ` [PATCH v13 2/6] dts: replace the or operator in third party types Juraj Linkeš
2024-08-06  8:46                 ` [PATCH v13 3/6] dts: add doc generation dependencies Juraj Linkeš
2024-08-06  8:46                 ` [PATCH v13 4/6] dts: add API doc sources Juraj Linkeš
2024-08-06  8:46                 ` [PATCH v13 5/6] doc: meson doc API build dir variable Juraj Linkeš
2024-08-06  8:46                 ` [PATCH v13 6/6] dts: add API doc generation Juraj Linkeš
2024-08-06 11:17               ` [PATCH v14 0/6] API docs generation Juraj Linkeš
2024-08-06 11:17                 ` [PATCH v14 1/6] dts: update params and parser docstrings Juraj Linkeš
2024-08-06 11:17                 ` [PATCH v14 2/6] dts: replace the or operator in third party types Juraj Linkeš
2024-08-06 11:17                 ` [PATCH v14 3/6] dts: add doc generation dependencies Juraj Linkeš
2024-08-06 11:17                 ` [PATCH v14 4/6] dts: add API doc sources Juraj Linkeš
2024-08-06 11:17                 ` [PATCH v14 5/6] doc: meson doc API build dir variable Juraj Linkeš
2024-08-06 11:17                 ` [PATCH v14 6/6] dts: add API doc generation Juraj Linkeš
2024-08-06 15:19               ` [PATCH v15 0/5] API docs generation Juraj Linkeš
2024-08-06 15:19                 ` [PATCH v15 1/5] dts: update params and parser docstrings Juraj Linkeš
2024-08-06 15:19                 ` [PATCH v15 2/5] dts: replace the or operator in third party types Juraj Linkeš
2024-08-07 13:34                   ` Luca Vizzarro
2024-08-07 14:24                     ` Juraj Linkeš
2024-08-06 15:19                 ` [PATCH v15 3/5] dts: add doc generation dependencies Juraj Linkeš
2024-08-06 15:19                 ` [PATCH v15 4/5] dts: add API doc sources Juraj Linkeš
2024-08-06 15:19                 ` [PATCH v15 5/5] dts: add API doc generation Juraj Linkeš
2024-08-07 10:41                   ` Thomas Monjalon
2024-08-07 12:03                     ` Juraj Linkeš
2024-08-07 12:27                       ` Thomas Monjalon
2024-08-07 13:12                         ` Juraj Linkeš
2024-08-08 12:27                           ` Thomas Monjalon
2024-08-08  8:54               ` [PATCH v16 0/5] API docs generation Juraj Linkeš
2024-08-08  8:54                 ` [PATCH v16 1/5] dts: update params and parser docstrings Juraj Linkeš
2024-08-09 18:31                   ` Jeremy Spewock
2024-08-08  8:54                 ` [PATCH v16 2/5] dts: replace the or operator in third party types Juraj Linkeš
2024-08-09 19:03                   ` Jeremy Spewock
2024-08-12  7:58                     ` Juraj Linkeš
2024-08-08  8:54                 ` [PATCH v16 3/5] dts: add doc generation dependencies Juraj Linkeš
2024-08-09 19:04                   ` Jeremy Spewock
2024-08-08  8:54                 ` [PATCH v16 4/5] dts: add API doc sources Juraj Linkeš
2024-08-08  8:54                 ` [PATCH v16 5/5] dts: add API doc generation Juraj Linkeš
2024-08-09 19:04                   ` Jeremy Spewock
2024-08-12  8:08                     ` Juraj Linkeš
2024-08-14 15:05               ` [PATCH v17 0/5] API docs generation Juraj Linkeš
2024-08-14 15:05                 ` [PATCH v17 1/5] dts: update params and parser docstrings Juraj Linkeš
2024-08-14 18:50                   ` Jeremy Spewock
2024-08-14 15:05                 ` [PATCH v17 2/5] dts: replace the or operator in third party types Juraj Linkeš
2024-08-14 18:50                   ` Jeremy Spewock
2024-08-14 15:05                 ` [PATCH v17 3/5] dts: add doc generation dependencies Juraj Linkeš
2024-08-14 18:50                   ` Jeremy Spewock
2024-08-14 15:05                 ` [PATCH v17 4/5] dts: add API doc sources Juraj Linkeš
2024-08-14 15:05                 ` [PATCH v17 5/5] dts: add API doc generation Juraj Linkeš
2024-08-14 18:50                   ` Jeremy Spewock
2024-08-19 14:37                   ` Dean Marx
2024-08-19 17:53                     ` Dean Marx
2024-08-20  8:31                       ` Juraj Linkeš
2024-08-19 17:49                   ` Dean Marx
2024-08-20 13:18               ` [PATCH v18 0/5] API docs generation Juraj Linkeš
2024-08-20 13:18                 ` [PATCH v18 1/5] dts: update params and parser docstrings Juraj Linkeš
2024-08-20 13:18                 ` [PATCH v18 2/5] dts: replace the or operator in third party types Juraj Linkeš
2024-08-20 13:18                 ` [PATCH v18 3/5] dts: add doc generation dependencies Juraj Linkeš
2024-08-20 13:18                 ` [PATCH v18 4/5] dts: add API doc sources Juraj Linkeš
2024-08-20 13:18                 ` [PATCH v18 5/5] dts: add API doc generation Juraj Linkeš
2024-08-21 15:02               ` [PATCH v19 0/5] DTS API docs generation Juraj Linkeš
2024-08-21 15:02                 ` [PATCH v19 1/5] dts: update params and parser docstrings Juraj Linkeš
2024-08-21 15:02                 ` [PATCH v19 2/5] dts: replace the or operator in third party types Juraj Linkeš
2024-09-02 10:56                   ` Luca Vizzarro
2024-08-21 15:02                 ` [PATCH v19 3/5] dts: add doc generation dependencies Juraj Linkeš
2024-09-02 10:56                   ` Luca Vizzarro
2024-08-21 15:02                 ` [PATCH v19 4/5] dts: add API doc sources Juraj Linkeš
2024-08-21 15:02                 ` [PATCH v19 5/5] dts: add API doc generation Juraj Linkeš
2024-08-21 15:24                   ` Dean Marx
2024-09-02 10:57                   ` Luca Vizzarro
2024-09-12 20:09                   ` Thomas Monjalon
2024-09-16  8:51                     ` Juraj Linkeš
2024-09-16 12:48                       ` Thomas Monjalon
2024-09-17 15:10                         ` Juraj Linkeš
2024-09-18  7:38                 ` [PATCH v19 0/5] DTS API docs generation Juraj Linkeš

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=9cfefccb-0190-46d3-8942-c8c82da38f99@pantheon.tech \
    --to=juraj.linkes@pantheon.tech \
    --cc=Honnappa.Nagarahalli@arm.com \
    --cc=Luca.Vizzarro@arm.com \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=jspewock@iol.unh.edu \
    --cc=npratte@iol.unh.edu \
    --cc=paul.szczepanek@arm.com \
    --cc=probb@iol.unh.edu \
    --cc=thomas@monjalon.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).