DPDK patches and discussions
 help / color / mirror / Atom feed

From: "Mcnamara, John" <john.mcnamara@intel.com>
To: Eelco Chaudron <echaudro@redhat.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH] doc: Adds reference to use mlockall() in the Programmer's guide
Date: Fri, 29 Sep 2017 15:44:16 +0000	[thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE23EDB1BA1@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <138d85856e7b5c6c09abfccdb885927458120be8.1506689397.git.echaudro@redhat.com>

Hi Eelco,

Thanks for that. It is always good to get doc improvements.
Some minor comments below.


> -----Original Message-----
> From: Eelco Chaudron [mailto:echaudro@redhat.com]
> Sent: Friday, September 29, 2017 1:51 PM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org
> Subject: [PATCH] doc: Adds reference to use mlockall() in the Programmer's
> guide

The title should be lowercase (except for known acronyms), <= 50 characters
and the verb should be in the imperative. This is explained in the  Contributor's
Guide:

http://dpdk.org/doc/guides/contributing/patches.html#commit-messages-subject-line

Also you can check with the DPDK check-git-log.sh tool:

    $ devtools/check-git-log.sh 
    Wrong headline uppercase:
        doc: Adds reference to use mlockall() in the Programmer's guide
    Headline too long:
        doc: Adds reference to use mlockall() in the Programmer's guide

I'd suggest a title like:

    doc: add use of mlockall to programmers guide

> 
> diff --git a/doc/guides/prog_guide/writing_efficient_code.rst
> b/doc/guides/prog_guide/writing_efficient_code.rst
> index 8223aceea..3975026ce 100644
> --- a/doc/guides/prog_guide/writing_efficient_code.rst
> +++ b/doc/guides/prog_guide/writing_efficient_code.rst
> @@ -105,6 +105,20 @@ meaning that if all memory access operations are done
> on the first channel only,
> 
>  By default, the  :ref:`Mempool Library <Mempool_Library>` spreads the
> addresses of objects among memory channels.
> 
> +Locking memory pages
> +~~~~~~~~~~~~~~~~~~~~

Add a blank line after a header+underline.

> +The underlying operating system is allowed to load/unload memory pages at
> its own discretion.
> +These page loads could impact the performance, as the process is on hold
> when the kernel fetches them.
> +
> +To avoid these you could pre-load, and lock them into memory with the
> mlockall() call.

Include the function call in backquotes: ``mlockall()``.

Thanks,

John

Reviewed-by: John McNamara <john.mcnamara@intel.com>

next prev parent reply	other threads:[~2017-09-29 15:44 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-29 12:50 Eelco Chaudron
2017-09-29 15:44 ` Mcnamara, John [this message]
2017-10-02 10:22   ` Eelco Chaudron

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=B27915DBBA3421428155699D51E4CFE23EDB1BA1@IRSMSX103.ger.corp.intel.com \
    --to=john.mcnamara@intel.com \
    --cc=dev@dpdk.org \
    --cc=echaudro@redhat.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

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).