| Message ID | 1461794375-15214-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | New |
| Headers | show |
why are these patches submitted against api-next? they are not related to any api changes as I can see? (you are the one that know these stuffs: I guess you have a good reason that I am just missing...:-) ) Christophe On 27 April 2016 at 23:59, Mike Holmes <mike.holmes@linaro.org> wrote: > ascidoctor is a python asciidoc interpreter it has greater capabilities > than asciidoc which is a perl based interpreter > > The resulting style sheet improvements result in more professional > looking docs that can be further enhanced with our own css at some > point. > > This also supports including code snippets in the documentation from the > doxygen specification files. > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > --- > DEPENDENCIES | 2 +- > doc/Makefile.inc | 4 ++-- > doc/users-guide/users-guide-tm.adoc | 18 +++++++++--------- > 3 files changed, 12 insertions(+), 12 deletions(-) > > diff --git a/DEPENDENCIES b/DEPENDENCIES > index c83fc36..678b62a 100644 > --- a/DEPENDENCIES > +++ b/DEPENDENCIES > @@ -252,4 +252,4 @@ The tested version of doxygen is 1.8.8 > > 5.2.1 HTML > # Debian/Ubuntu > - $ apt-get install asciidoc source-highlight librsvg2-bin > + $ apt-get install asciidoctor source-highlight librsvg2-bin > diff --git a/doc/Makefile.inc b/doc/Makefile.inc > index c0b641e..643b1d4 100644 > --- a/doc/Makefile.inc > +++ b/doc/Makefile.inc > @@ -7,6 +7,6 @@ VPATH=$(top_builddir)/doc/images > dot -T svg $^ -o $@ > > .adoc.html: > - asciidoc $(ASCIIDOC_FLAGS) --out-file=$@ $< > + asciidoctor $(ASCIIDOC_FLAGS) --out-file=$@ $< > > -ASCIIDOC_FLAGS =-a data-uri -b html5 -a icons -a toc2 -a max-width=55em > +ASCIIDOC_FLAGS =-a data-uri -b html5 -a icons=font -a toc2 > diff --git a/doc/users-guide/users-guide-tm.adoc > b/doc/users-guide/users-guide-tm.adoc > index 132fdc1..5dc2190 100644 > --- a/doc/users-guide/users-guide-tm.adoc > +++ b/doc/users-guide/users-guide-tm.adoc > @@ -269,7 +269,7 @@ result in faster operation and/or less memory used. > [source,c] > ---- > > - odp_tm_params_init(&tm_params); /* <1> */ > + odp_tm_params_init(&tm_params); // <1> > tm_params.pktio = egress_pktio; > tm = odp_tm_create(“Example TM”, &tm_params); > > @@ -285,11 +285,11 @@ result in faster operation and/or less memory used. > tmq_B2 = odp_tm_queue_create(tm, &queue_params); > tmq_C2 = odp_tm_queue_create(tm, &queue_params); > > - odp_tm_node_params_init(&node_params); /* <2> */ > + odp_tm_node_params_init(&node_params); // <2> > node_params.level = 1; > tm_node_1 = odp_tm_node_create(tm, “TmNode1”, &node_params); > > - odp_tm_queue_connect(tmq_A1, tm_node_1); /* <3> */ > + odp_tm_queue_connect(tmq_A1, tm_node_1); // <3> > odp_tm_queue_connect(tmq_B1, tm_node_1); > odp_tm_queue_connect(tmq_A2, tm_node_1); > odp_tm_queue_connect(tmq_B2, tm_node_1); > @@ -302,7 +302,7 @@ code does is create a scheduler PROFILE, which is > effectively a registered set > of common scheduler parameters. NOTE that this uses some pseudocode below > instead of real C code so as to be more concise. */ > > - odp_tm_sched_params_init(&sched_params); /* <4> */ > + odp_tm_sched_params_init(&sched_params); // <4> > sched_params.sched_modes = { ODP_TM_FRAME_BASED_WEIGHTS, … }; > sched_params.sched_weights = { 8, 8, 8, … }; > sched_profile_RR = odp_tm_sched_create(“SchedProfileRR”, > &sched_params); > @@ -311,24 +311,24 @@ instead of real C code so as to be more concise. */ > sched_params.sched_weights = { 8, 8, 8, … }; > sched_profile_FQ = odp_tm_sched_create(“SchedProfileFQ”, > &sched_params); > > - odp_tm_queue_sched_config(tm_node_1, tmq_A1, sched_profile_RR); /* <5> > */ > + odp_tm_queue_sched_config(tm_node_1, tmq_A1, sched_profile_RR); // <5> > odp_tm_queue_sched_config(tm_node_1, tmq_B1, sched_profile_RR); > odp_tm_queue_sched_config(tm_node_1, tmq_A2, sched_profile_FQ); > odp_tm_queue_sched_config(tm_node_1, tmq_B2, sched_profile_FQ); > odp_tm_queue_sched_config(tm_node_1, tmq_C2, sched_profile_FQ); > > - odp_tm_node_params_init(&node_params); /* <6> */ > + odp_tm_node_params_init(&node_params); // <6> > node_params.level = 2; > tm_node_2 = odp_tm_node_create(tm, “TmNode2”, &node_params); > > - odp_tm_node_connect(tm_node_1, tm_node_2); /* <7> */ > + odp_tm_node_connect(tm_node_1, tm_node_2); // <7> > > - odp_tm_sched_params_init(&sched_params); /* <8> */ > + odp_tm_sched_params_init(&sched_params); // <8> > sched_params.sched_modes = { ODP_TM_BYTE_BASED_WEIGHTS, … }; > sched_params.sched_weights = { 8, 16, 24, … }; > sched_profile_WFQ = odp_tm_sched_create(“SchedProfileWFQ”, > &sched_params); > > - odp_tm_node_sched_config(tm_node_2, tm_node_1, sched_profile_WFQ); /* > <9> */ > + odp_tm_node_sched_config(tm_node_2, tm_node_1, sched_profile_WFQ); // > <9> > ---- > > <1> Create a tm system, since that is a precursor to creating tm_queues. > -- > 2.7.4 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp >
On 28 April 2016 at 02:08, Christophe Milard <christophe.milard@linaro.org> wrote: > why are these patches submitted against api-next? they are not related to > any api changes as I can see? > (you are the one that know these stuffs: I guess you have a good reason > that I am just missing...:-) )\ > You need these changes to allow the second patch that does touch the include directory and so it is api-next > > Christophe > > On 27 April 2016 at 23:59, Mike Holmes <mike.holmes@linaro.org> wrote: > >> ascidoctor is a python asciidoc interpreter it has greater capabilities >> than asciidoc which is a perl based interpreter >> >> The resulting style sheet improvements result in more professional >> looking docs that can be further enhanced with our own css at some >> point. >> >> This also supports including code snippets in the documentation from the >> doxygen specification files. >> >> Signed-off-by: Mike Holmes <mike.holmes@linaro.org> >> --- >> DEPENDENCIES | 2 +- >> doc/Makefile.inc | 4 ++-- >> doc/users-guide/users-guide-tm.adoc | 18 +++++++++--------- >> 3 files changed, 12 insertions(+), 12 deletions(-) >> >> diff --git a/DEPENDENCIES b/DEPENDENCIES >> index c83fc36..678b62a 100644 >> --- a/DEPENDENCIES >> +++ b/DEPENDENCIES >> @@ -252,4 +252,4 @@ The tested version of doxygen is 1.8.8 >> >> 5.2.1 HTML >> # Debian/Ubuntu >> - $ apt-get install asciidoc source-highlight librsvg2-bin >> + $ apt-get install asciidoctor source-highlight librsvg2-bin >> diff --git a/doc/Makefile.inc b/doc/Makefile.inc >> index c0b641e..643b1d4 100644 >> --- a/doc/Makefile.inc >> +++ b/doc/Makefile.inc >> @@ -7,6 +7,6 @@ VPATH=$(top_builddir)/doc/images >> dot -T svg $^ -o $@ >> >> .adoc.html: >> - asciidoc $(ASCIIDOC_FLAGS) --out-file=$@ $< >> + asciidoctor $(ASCIIDOC_FLAGS) --out-file=$@ $< >> >> -ASCIIDOC_FLAGS =-a data-uri -b html5 -a icons -a toc2 -a max-width=55em >> +ASCIIDOC_FLAGS =-a data-uri -b html5 -a icons=font -a toc2 >> diff --git a/doc/users-guide/users-guide-tm.adoc >> b/doc/users-guide/users-guide-tm.adoc >> index 132fdc1..5dc2190 100644 >> --- a/doc/users-guide/users-guide-tm.adoc >> +++ b/doc/users-guide/users-guide-tm.adoc >> @@ -269,7 +269,7 @@ result in faster operation and/or less memory used. >> [source,c] >> ---- >> >> - odp_tm_params_init(&tm_params); /* <1> */ >> + odp_tm_params_init(&tm_params); // <1> >> tm_params.pktio = egress_pktio; >> tm = odp_tm_create(“Example TM”, &tm_params); >> >> @@ -285,11 +285,11 @@ result in faster operation and/or less memory used. >> tmq_B2 = odp_tm_queue_create(tm, &queue_params); >> tmq_C2 = odp_tm_queue_create(tm, &queue_params); >> >> - odp_tm_node_params_init(&node_params); /* <2> */ >> + odp_tm_node_params_init(&node_params); // <2> >> node_params.level = 1; >> tm_node_1 = odp_tm_node_create(tm, “TmNode1”, &node_params); >> >> - odp_tm_queue_connect(tmq_A1, tm_node_1); /* <3> */ >> + odp_tm_queue_connect(tmq_A1, tm_node_1); // <3> >> odp_tm_queue_connect(tmq_B1, tm_node_1); >> odp_tm_queue_connect(tmq_A2, tm_node_1); >> odp_tm_queue_connect(tmq_B2, tm_node_1); >> @@ -302,7 +302,7 @@ code does is create a scheduler PROFILE, which is >> effectively a registered set >> of common scheduler parameters. NOTE that this uses some pseudocode >> below >> instead of real C code so as to be more concise. */ >> >> - odp_tm_sched_params_init(&sched_params); /* <4> */ >> + odp_tm_sched_params_init(&sched_params); // <4> >> sched_params.sched_modes = { ODP_TM_FRAME_BASED_WEIGHTS, … }; >> sched_params.sched_weights = { 8, 8, 8, … }; >> sched_profile_RR = odp_tm_sched_create(“SchedProfileRR”, >> &sched_params); >> @@ -311,24 +311,24 @@ instead of real C code so as to be more concise. */ >> sched_params.sched_weights = { 8, 8, 8, … }; >> sched_profile_FQ = odp_tm_sched_create(“SchedProfileFQ”, >> &sched_params); >> >> - odp_tm_queue_sched_config(tm_node_1, tmq_A1, sched_profile_RR); /* >> <5> */ >> + odp_tm_queue_sched_config(tm_node_1, tmq_A1, sched_profile_RR); // <5> >> odp_tm_queue_sched_config(tm_node_1, tmq_B1, sched_profile_RR); >> odp_tm_queue_sched_config(tm_node_1, tmq_A2, sched_profile_FQ); >> odp_tm_queue_sched_config(tm_node_1, tmq_B2, sched_profile_FQ); >> odp_tm_queue_sched_config(tm_node_1, tmq_C2, sched_profile_FQ); >> >> - odp_tm_node_params_init(&node_params); /* <6> */ >> + odp_tm_node_params_init(&node_params); // <6> >> node_params.level = 2; >> tm_node_2 = odp_tm_node_create(tm, “TmNode2”, &node_params); >> >> - odp_tm_node_connect(tm_node_1, tm_node_2); /* <7> */ >> + odp_tm_node_connect(tm_node_1, tm_node_2); // <7> >> >> - odp_tm_sched_params_init(&sched_params); /* <8> */ >> + odp_tm_sched_params_init(&sched_params); // <8> >> sched_params.sched_modes = { ODP_TM_BYTE_BASED_WEIGHTS, … }; >> sched_params.sched_weights = { 8, 16, 24, … }; >> sched_profile_WFQ = odp_tm_sched_create(“SchedProfileWFQ”, >> &sched_params); >> >> - odp_tm_node_sched_config(tm_node_2, tm_node_1, sched_profile_WFQ); /* >> <9> */ >> + odp_tm_node_sched_config(tm_node_2, tm_node_1, sched_profile_WFQ); // >> <9> >> ---- >> >> <1> Create a tm system, since that is a precursor to creating tm_queues. >> -- >> 2.7.4 >> >> _______________________________________________ >> lng-odp mailing list >> lng-odp@lists.linaro.org >> https://lists.linaro.org/mailman/listinfo/lng-odp >> > > -- Mike Holmes Technical Manager - Linaro Networking Group Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs "Work should be fun and collaborative, the rest follows"
For Part 1: Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> On Wed, Apr 27, 2016 at 4:59 PM, Mike Holmes <mike.holmes@linaro.org> wrote: > ascidoctor is a python asciidoc interpreter it has greater capabilities > than asciidoc which is a perl based interpreter > > The resulting style sheet improvements result in more professional > looking docs that can be further enhanced with our own css at some > point. > > This also supports including code snippets in the documentation from the > doxygen specification files. > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > --- > DEPENDENCIES | 2 +- > doc/Makefile.inc | 4 ++-- > doc/users-guide/users-guide-tm.adoc | 18 +++++++++--------- > 3 files changed, 12 insertions(+), 12 deletions(-) > > diff --git a/DEPENDENCIES b/DEPENDENCIES > index c83fc36..678b62a 100644 > --- a/DEPENDENCIES > +++ b/DEPENDENCIES > @@ -252,4 +252,4 @@ The tested version of doxygen is 1.8.8 > > 5.2.1 HTML > # Debian/Ubuntu > - $ apt-get install asciidoc source-highlight librsvg2-bin > + $ apt-get install asciidoctor source-highlight librsvg2-bin > diff --git a/doc/Makefile.inc b/doc/Makefile.inc > index c0b641e..643b1d4 100644 > --- a/doc/Makefile.inc > +++ b/doc/Makefile.inc > @@ -7,6 +7,6 @@ VPATH=$(top_builddir)/doc/images > dot -T svg $^ -o $@ > > .adoc.html: > - asciidoc $(ASCIIDOC_FLAGS) --out-file=$@ $< > + asciidoctor $(ASCIIDOC_FLAGS) --out-file=$@ $< > > -ASCIIDOC_FLAGS =-a data-uri -b html5 -a icons -a toc2 -a max-width=55em > +ASCIIDOC_FLAGS =-a data-uri -b html5 -a icons=font -a toc2 > diff --git a/doc/users-guide/users-guide-tm.adoc > b/doc/users-guide/users-guide-tm.adoc > index 132fdc1..5dc2190 100644 > --- a/doc/users-guide/users-guide-tm.adoc > +++ b/doc/users-guide/users-guide-tm.adoc > @@ -269,7 +269,7 @@ result in faster operation and/or less memory used. > [source,c] > ---- > > - odp_tm_params_init(&tm_params); /* <1> */ > + odp_tm_params_init(&tm_params); // <1> > tm_params.pktio = egress_pktio; > tm = odp_tm_create(“Example TM”, &tm_params); > > @@ -285,11 +285,11 @@ result in faster operation and/or less memory used. > tmq_B2 = odp_tm_queue_create(tm, &queue_params); > tmq_C2 = odp_tm_queue_create(tm, &queue_params); > > - odp_tm_node_params_init(&node_params); /* <2> */ > + odp_tm_node_params_init(&node_params); // <2> > node_params.level = 1; > tm_node_1 = odp_tm_node_create(tm, “TmNode1”, &node_params); > > - odp_tm_queue_connect(tmq_A1, tm_node_1); /* <3> */ > + odp_tm_queue_connect(tmq_A1, tm_node_1); // <3> > odp_tm_queue_connect(tmq_B1, tm_node_1); > odp_tm_queue_connect(tmq_A2, tm_node_1); > odp_tm_queue_connect(tmq_B2, tm_node_1); > @@ -302,7 +302,7 @@ code does is create a scheduler PROFILE, which is > effectively a registered set > of common scheduler parameters. NOTE that this uses some pseudocode below > instead of real C code so as to be more concise. */ > > - odp_tm_sched_params_init(&sched_params); /* <4> */ > + odp_tm_sched_params_init(&sched_params); // <4> > sched_params.sched_modes = { ODP_TM_FRAME_BASED_WEIGHTS, … }; > sched_params.sched_weights = { 8, 8, 8, … }; > sched_profile_RR = odp_tm_sched_create(“SchedProfileRR”, > &sched_params); > @@ -311,24 +311,24 @@ instead of real C code so as to be more concise. */ > sched_params.sched_weights = { 8, 8, 8, … }; > sched_profile_FQ = odp_tm_sched_create(“SchedProfileFQ”, > &sched_params); > > - odp_tm_queue_sched_config(tm_node_1, tmq_A1, sched_profile_RR); /* <5> > */ > + odp_tm_queue_sched_config(tm_node_1, tmq_A1, sched_profile_RR); // <5> > odp_tm_queue_sched_config(tm_node_1, tmq_B1, sched_profile_RR); > odp_tm_queue_sched_config(tm_node_1, tmq_A2, sched_profile_FQ); > odp_tm_queue_sched_config(tm_node_1, tmq_B2, sched_profile_FQ); > odp_tm_queue_sched_config(tm_node_1, tmq_C2, sched_profile_FQ); > > - odp_tm_node_params_init(&node_params); /* <6> */ > + odp_tm_node_params_init(&node_params); // <6> > node_params.level = 2; > tm_node_2 = odp_tm_node_create(tm, “TmNode2”, &node_params); > > - odp_tm_node_connect(tm_node_1, tm_node_2); /* <7> */ > + odp_tm_node_connect(tm_node_1, tm_node_2); // <7> > > - odp_tm_sched_params_init(&sched_params); /* <8> */ > + odp_tm_sched_params_init(&sched_params); // <8> > sched_params.sched_modes = { ODP_TM_BYTE_BASED_WEIGHTS, … }; > sched_params.sched_weights = { 8, 16, 24, … }; > sched_profile_WFQ = odp_tm_sched_create(“SchedProfileWFQ”, > &sched_params); > > - odp_tm_node_sched_config(tm_node_2, tm_node_1, sched_profile_WFQ); /* > <9> */ > + odp_tm_node_sched_config(tm_node_2, tm_node_1, sched_profile_WFQ); // > <9> > ---- > > <1> Create a tm system, since that is a precursor to creating tm_queues. > -- > 2.7.4 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp >
diff --git a/DEPENDENCIES b/DEPENDENCIES index c83fc36..678b62a 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -252,4 +252,4 @@ The tested version of doxygen is 1.8.8 5.2.1 HTML # Debian/Ubuntu - $ apt-get install asciidoc source-highlight librsvg2-bin + $ apt-get install asciidoctor source-highlight librsvg2-bin diff --git a/doc/Makefile.inc b/doc/Makefile.inc index c0b641e..643b1d4 100644 --- a/doc/Makefile.inc +++ b/doc/Makefile.inc @@ -7,6 +7,6 @@ VPATH=$(top_builddir)/doc/images dot -T svg $^ -o $@ .adoc.html: - asciidoc $(ASCIIDOC_FLAGS) --out-file=$@ $< + asciidoctor $(ASCIIDOC_FLAGS) --out-file=$@ $< -ASCIIDOC_FLAGS =-a data-uri -b html5 -a icons -a toc2 -a max-width=55em +ASCIIDOC_FLAGS =-a data-uri -b html5 -a icons=font -a toc2 diff --git a/doc/users-guide/users-guide-tm.adoc b/doc/users-guide/users-guide-tm.adoc index 132fdc1..5dc2190 100644 --- a/doc/users-guide/users-guide-tm.adoc +++ b/doc/users-guide/users-guide-tm.adoc @@ -269,7 +269,7 @@ result in faster operation and/or less memory used. [source,c] ---- - odp_tm_params_init(&tm_params); /* <1> */ + odp_tm_params_init(&tm_params); // <1> tm_params.pktio = egress_pktio; tm = odp_tm_create(“Example TM”, &tm_params); @@ -285,11 +285,11 @@ result in faster operation and/or less memory used. tmq_B2 = odp_tm_queue_create(tm, &queue_params); tmq_C2 = odp_tm_queue_create(tm, &queue_params); - odp_tm_node_params_init(&node_params); /* <2> */ + odp_tm_node_params_init(&node_params); // <2> node_params.level = 1; tm_node_1 = odp_tm_node_create(tm, “TmNode1”, &node_params); - odp_tm_queue_connect(tmq_A1, tm_node_1); /* <3> */ + odp_tm_queue_connect(tmq_A1, tm_node_1); // <3> odp_tm_queue_connect(tmq_B1, tm_node_1); odp_tm_queue_connect(tmq_A2, tm_node_1); odp_tm_queue_connect(tmq_B2, tm_node_1); @@ -302,7 +302,7 @@ code does is create a scheduler PROFILE, which is effectively a registered set of common scheduler parameters. NOTE that this uses some pseudocode below instead of real C code so as to be more concise. */ - odp_tm_sched_params_init(&sched_params); /* <4> */ + odp_tm_sched_params_init(&sched_params); // <4> sched_params.sched_modes = { ODP_TM_FRAME_BASED_WEIGHTS, … }; sched_params.sched_weights = { 8, 8, 8, … }; sched_profile_RR = odp_tm_sched_create(“SchedProfileRR”, &sched_params); @@ -311,24 +311,24 @@ instead of real C code so as to be more concise. */ sched_params.sched_weights = { 8, 8, 8, … }; sched_profile_FQ = odp_tm_sched_create(“SchedProfileFQ”, &sched_params); - odp_tm_queue_sched_config(tm_node_1, tmq_A1, sched_profile_RR); /* <5> */ + odp_tm_queue_sched_config(tm_node_1, tmq_A1, sched_profile_RR); // <5> odp_tm_queue_sched_config(tm_node_1, tmq_B1, sched_profile_RR); odp_tm_queue_sched_config(tm_node_1, tmq_A2, sched_profile_FQ); odp_tm_queue_sched_config(tm_node_1, tmq_B2, sched_profile_FQ); odp_tm_queue_sched_config(tm_node_1, tmq_C2, sched_profile_FQ); - odp_tm_node_params_init(&node_params); /* <6> */ + odp_tm_node_params_init(&node_params); // <6> node_params.level = 2; tm_node_2 = odp_tm_node_create(tm, “TmNode2”, &node_params); - odp_tm_node_connect(tm_node_1, tm_node_2); /* <7> */ + odp_tm_node_connect(tm_node_1, tm_node_2); // <7> - odp_tm_sched_params_init(&sched_params); /* <8> */ + odp_tm_sched_params_init(&sched_params); // <8> sched_params.sched_modes = { ODP_TM_BYTE_BASED_WEIGHTS, … }; sched_params.sched_weights = { 8, 16, 24, … }; sched_profile_WFQ = odp_tm_sched_create(“SchedProfileWFQ”, &sched_params); - odp_tm_node_sched_config(tm_node_2, tm_node_1, sched_profile_WFQ); /* <9> */ + odp_tm_node_sched_config(tm_node_2, tm_node_1, sched_profile_WFQ); // <9> ---- <1> Create a tm system, since that is a precursor to creating tm_queues.
ascidoctor is a python asciidoc interpreter it has greater capabilities than asciidoc which is a perl based interpreter The resulting style sheet improvements result in more professional looking docs that can be further enhanced with our own css at some point. This also supports including code snippets in the documentation from the doxygen specification files. Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- DEPENDENCIES | 2 +- doc/Makefile.inc | 4 ++-- doc/users-guide/users-guide-tm.adoc | 18 +++++++++--------- 3 files changed, 12 insertions(+), 12 deletions(-)