Currently the documentation describes how to add code snippets to the
docs using code blocks. This can be problematic as the code snippets
in the docs may fall out of sync with the actual code it is referencing
within DPDK. This patch adds instructions to the contribution guide
about how to include
> -Original Message-
> From: Walsh, Conor
> Sent: Wednesday, April 21, 2021 10:12 AM
> To: Mcnamara, John ; tho...@monjalon.net;
> david.march...@redhat.com; Yigit, Ferruh ;
> Richardson, Bruce ; Burakov, Anatoly
>
> Cc: dev@dpdk.org; Walsh, Conor
> Subject: [PATCH] doc/contributing/docu
21/04/2021 12:21, Mcnamara, John:
> From: Walsh, Conor
> > Currently the documentation describes how to add code snippets to the docs
> > using code blocks. This can be problematic as the code snippets in the
> > docs may fall out of sync with the actual code it is referencing within
> > DPDK. Thi
> -Original Message-
> From: Thomas Monjalon
> Sent: Wednesday, April 21, 2021 11:31 AM
> To: Walsh, Conor ; david.march...@redhat.com;
> Yigit, Ferruh ; Richardson, Bruce
> ; Burakov, Anatoly
> ; Mcnamara, John
> Cc: dev@dpdk.org
> Subject: Re: [PATCH] doc/contributing/documentation: a
21/04/2021 16:17, Mcnamara, John:
> From: Thomas Monjalon
> > >
> > > This is a very good suggestion and I think we should encourage doc
> > > writers to use this when including code in the documentation.
> >
> > Yes, and we should try to clean-up existing code snippets.
>
> If there is no gener
On Wed, Apr 21, 2021 at 11:12 AM Conor Walsh wrote:
>
> Currently the documentation describes how to add code snippets to the
> docs using code blocks. This can be problematic as the code snippets
> in the docs may fall out of sync with the actual code it is referencing
> within DPDK. This patch a
On Wed, Apr 21, 2021 at 4:21 PM Thomas Monjalon wrote:
>
> 21/04/2021 16:17, Mcnamara, John:
> > From: Thomas Monjalon
> > > >
> > > > This is a very good suggestion and I think we should encourage doc
> > > > writers to use this when including code in the documentation.
> > >
> > > Yes, and we s
21/04/2021 11:11, Conor Walsh:
> + The following will include a snippet from the skeleton sample app::
> +
> + .. literalinclude:: ../../../examples/skeleton/basicfwd.c
> +:language: c
> +:start-after: Display the port MAC address.
> +:end-before: Enable RX in promiscu
On 03-May-21 10:02 PM, Thomas Monjalon wrote:
21/04/2021 11:11, Conor Walsh:
+ The following will include a snippet from the skeleton sample app::
+
+ .. literalinclude:: ../../../examples/skeleton/basicfwd.c
+:language: c
+:start-after: Display the port MAC address.
+
04/05/2021 11:32, Burakov, Anatoly:
> On 03-May-21 10:02 PM, Thomas Monjalon wrote:
> > 21/04/2021 11:11, Conor Walsh:
> >> + The following will include a snippet from the skeleton sample app::
> >> +
> >> + .. literalinclude:: ../../../examples/skeleton/basicfwd.c
> >> +:language: c
On 5/4/2021 10:59 AM, Thomas Monjalon wrote:
> 04/05/2021 11:32, Burakov, Anatoly:
>> On 03-May-21 10:02 PM, Thomas Monjalon wrote:
>>> 21/04/2021 11:11, Conor Walsh:
+ The following will include a snippet from the skeleton sample app::
+
+ .. literalinclude:: ../../../examples
04/05/2021 12:35, Ferruh Yigit:
> On 5/4/2021 10:59 AM, Thomas Monjalon wrote:
> > 04/05/2021 11:32, Burakov, Anatoly:
> >> On 03-May-21 10:02 PM, Thomas Monjalon wrote:
> >>> 21/04/2021 11:11, Conor Walsh:
> + The following will include a snippet from the skeleton sample app::
> +
> >>>
On 5/4/2021 11:44 AM, Thomas Monjalon wrote:
> 04/05/2021 12:35, Ferruh Yigit:
>> On 5/4/2021 10:59 AM, Thomas Monjalon wrote:
>>> 04/05/2021 11:32, Burakov, Anatoly:
On 03-May-21 10:02 PM, Thomas Monjalon wrote:
> 21/04/2021 11:11, Conor Walsh:
>> + The following will include a snipp
04/05/2021 13:15, Ferruh Yigit:
> On 5/4/2021 11:44 AM, Thomas Monjalon wrote:
> > 04/05/2021 12:35, Ferruh Yigit:
> >> On 5/4/2021 10:59 AM, Thomas Monjalon wrote:
> >>> 04/05/2021 11:32, Burakov, Anatoly:
> On 03-May-21 10:02 PM, Thomas Monjalon wrote:
> > 21/04/2021 11:11, Conor Walsh:
On 04-May-21 12:56 PM, Thomas Monjalon wrote:
04/05/2021 13:15, Ferruh Yigit:
On 5/4/2021 11:44 AM, Thomas Monjalon wrote:
04/05/2021 12:35, Ferruh Yigit:
On 5/4/2021 10:59 AM, Thomas Monjalon wrote:
04/05/2021 11:32, Burakov, Anatoly:
On 03-May-21 10:02 PM, Thomas Monjalon wrote:
21/04/202
> >>> 21/04/2021 11:11, Conor Walsh:
> + The following will include a snippet from the skeleton sample
> app::
> +
> + .. literalinclude:: ../../../examples/skeleton/basicfwd.c
> +:language: c
> +:start-after: Display the port
16 matches
Mail list logo
