From: Thomas Monjalon <thomas@monjalon.net>
To: Conor Walsh <conor.walsh@intel.com>,
bruce.richardson@intel.com, "Burakov,
Anatoly" <anatoly.burakov@intel.com>
Cc: john.mcnamara@intel.com, david.marchand@redhat.com,
ferruh.yigit@intel.com, dev@dpdk.org, conor.fogarty@intel.com
Subject: Re: [dpdk-dev] [PATCH v2] doc/contributing/doc: add info about including code
Date: Fri, 07 May 2021 15:15:34 +0200 [thread overview]
Message-ID: <42643189.82yYazPPtX@thomas> (raw)
In-Reply-To: <86c40b7f-1035-c8ab-f10a-bb9b3146249b@intel.com>
07/05/2021 11:54, Burakov, Anatoly:
> On 06-May-21 5:40 PM, Conor Walsh wrote:
> > +* ``start-after`` and ``end-before`` can use any text within a given file,
> > + however it may be difficult to find unique text within your code to mark the
> > + start and end of your snippets. In these cases, it is recommended to include
>
> Such lenient attitude still leaves room for accidental changes (e.g.
> typo fixes, whitespace reformatting, language fixes etc.). I would've
> preferred the scissor syntax to be mandatory for all comment snippets
> for documentation. However, risk is pretty low so i can live with that :)
Compiling the documentation is part of any reasonnable test,
so the risk is very low.
> > + explicit tags in your code to denote these locations for documentation purposes.
> > + The accepted format for these comments is:
next prev parent reply other threads:[~2021-05-07 13:15 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-21 9:11 [dpdk-dev] [PATCH] doc/contributing/documentation: " Conor Walsh
2021-04-21 10:21 ` Mcnamara, John
2021-04-21 10:31 ` Thomas Monjalon
2021-04-21 14:17 ` Mcnamara, John
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 [this message]
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=42643189.82yYazPPtX@thomas \
--to=thomas@monjalon.net \
--cc=anatoly.burakov@intel.com \
--cc=bruce.richardson@intel.com \
--cc=conor.fogarty@intel.com \
--cc=conor.walsh@intel.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=john.mcnamara@intel.com \
/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).