diff mbox series

[v5,2/3] doc: add missing index entry for thread

Message ID 1675197017-11287-3-git-send-email-roretzla@linux.microsoft.com (mailing list archive)
State Superseded, archived
Delegated to: David Marchand
Headers
Series [v5,1/3] eal: add rte control thread create API |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Tyler Retzlaff Jan. 31, 2023, 8:30 p.m. UTC 
  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

David Marchand Feb. 7, 2023, 3:39 p.m. UTC | #1 
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>
Tyler Retzlaff Feb. 7, 2023, 9:39 p.m. UTC | #2 
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
diff mbox series

Patch

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)
 
 - **debug**:
   [jobstats](@ref rte_jobstats.h),