[v5,2/3] doc: add missing index entry for thread
Checks
Commit Message
Add missing thread index referencing rte_thread.h under the basic
topic.
Signed-off-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
---
doc/api/doxy-api-index.md | 1 +
1 file changed, 1 insertion(+)
Comments
On Tue, Jan 31, 2023 at 9:30 PM Tyler Retzlaff
<roretzla@linux.microsoft.com> wrote:
>
> Add missing thread index referencing rte_thread.h under the basic
> topic.
>
> Signed-off-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
> ---
> doc/api/doxy-api-index.md | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
> index de488c7..e8ed51a 100644
> --- a/doc/api/doxy-api-index.md
> +++ b/doc/api/doxy-api-index.md
> @@ -211,6 +211,7 @@ The public API headers are grouped by topics:
> [config file](@ref rte_cfgfile.h),
> [key/value args](@ref rte_kvargs.h),
> [string](@ref rte_string_fns.h)
> + [thread](@ref rte_thread.h)
A , is missing on the line before.
This can be seen in the rendered html:
"basic: bitops, approx fraction, random, config file, key/value args,
string thread"
I'll fix when applying.
Reviewed-by: David Marchand <david.marchand@redhat.com>
On Tue, Feb 07, 2023 at 04:39:06PM +0100, David Marchand wrote:
> On Tue, Jan 31, 2023 at 9:30 PM Tyler Retzlaff
> <roretzla@linux.microsoft.com> wrote:
> >
> > Add missing thread index referencing rte_thread.h under the basic
> > topic.
> >
> > Signed-off-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
> > ---
> > doc/api/doxy-api-index.md | 1 +
> > 1 file changed, 1 insertion(+)
> >
> > diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
> > index de488c7..e8ed51a 100644
> > --- a/doc/api/doxy-api-index.md
> > +++ b/doc/api/doxy-api-index.md
> > @@ -211,6 +211,7 @@ The public API headers are grouped by topics:
> > [config file](@ref rte_cfgfile.h),
> > [key/value args](@ref rte_kvargs.h),
> > [string](@ref rte_string_fns.h)
> > + [thread](@ref rte_thread.h)
>
> A , is missing on the line before.
> This can be seen in the rendered html:
> "basic: bitops, approx fraction, random, config file, key/value args,
> string thread"
sorry, just me being a derp. i will fix it in the next version since
need a new rev for moving the test to test_threads.c
>
> I'll fix when applying.
>
> Reviewed-by: David Marchand <david.marchand@redhat.com>
>
>
> --
> David Marchand
@@ -211,6 +211,7 @@ The public API headers are grouped by topics:
[config file](@ref rte_cfgfile.h),
[key/value args](@ref rte_kvargs.h),
[string](@ref rte_string_fns.h)
+ [thread](@ref rte_thread.h)
- **debug**:
[jobstats](@ref rte_jobstats.h),