From: "Mcnamara, John" <john.mcnamara@intel.com>
To: Thomas Monjalon <thomas@monjalon.net>,
"Walsh, Conor" <conor.walsh@intel.com>,
"david.marchand@redhat.com" <david.marchand@redhat.com>,
"Yigit, Ferruh" <ferruh.yigit@intel.com>,
"Richardson, Bruce" <bruce.richardson@intel.com>,
"Burakov, Anatoly" <anatoly.burakov@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH] doc/contributing/documentation: add info about including code
Date: Wed, 21 Apr 2021 14:17:26 +0000 [thread overview]
Message-ID: <SN6PR11MB308605669721F4610C995623FC479@SN6PR11MB3086.namprd11.prod.outlook.com> (raw)
In-Reply-To: <7938996.8XznLcKUNL@thomas>
> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Wednesday, April 21, 2021 11:31 AM
> To: Walsh, Conor <conor.walsh@intel.com>; david.marchand@redhat.com;
> Yigit, Ferruh <ferruh.yigit@intel.com>; Richardson, Bruce
> <bruce.richardson@intel.com>; Burakov, Anatoly
> <anatoly.burakov@intel.com>; Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org
> Subject: Re: [PATCH] doc/contributing/documentation: add info about
> including code
> >
> > 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 general objection to including code snippets this way then we could get someone to work on refactoring the sample code docs to use it.
John
next prev parent reply other threads:[~2021-04-21 14:17 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-21 9:11 Conor Walsh
2021-04-21 10:21 ` Mcnamara, John
2021-04-21 10:31 ` Thomas Monjalon
2021-04-21 14:17 ` Mcnamara, John [this message]
2021-04-21 14:21 ` Thomas Monjalon
2021-04-27 9:54 ` David Marchand
2021-04-27 9:54 ` David Marchand
2021-05-03 21:02 ` Thomas Monjalon
2021-05-04 9:32 ` Burakov, Anatoly
2021-05-04 9:59 ` Thomas Monjalon
2021-05-04 10:35 ` Ferruh Yigit
2021-05-04 10:44 ` Thomas Monjalon
2021-05-04 11:15 ` Ferruh Yigit
2021-05-04 11:56 ` Thomas Monjalon
2021-05-05 12:02 ` Burakov, Anatoly
2021-05-06 13:50 ` Walsh, Conor
2021-05-06 16:40 ` [dpdk-dev] [PATCH v2] doc/contributing/doc: " Conor Walsh
2021-05-07 9:54 ` Burakov, Anatoly
2021-05-07 13:15 ` Thomas Monjalon
2021-05-19 21:36 ` Thomas Monjalon
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=SN6PR11MB308605669721F4610C995623FC479@SN6PR11MB3086.namprd11.prod.outlook.com \
--to=john.mcnamara@intel.com \
--cc=anatoly.burakov@intel.com \
--cc=bruce.richardson@intel.com \
--cc=conor.walsh@intel.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--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).