doc: fix references to /dev/huge
diff mbox series

Message ID 20200623055559.19068-1-sarosh.arif@emumba.com
State Accepted
Delegated to: Thomas Monjalon
Headers show
Series
  • doc: fix references to /dev/huge
Related show

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/Intel-compilation fail Compilation issues
ci/checkpatch success coding style OK

Commit Message

Sarosh Arif June 23, 2020, 5:55 a.m. UTC
change /dev/huge to /dev/hugepages

Bugzilla ID: 492
Signed-off-by: Sarosh Arif <sarosh.arif@emumba.com>
---
 doc/guides/faq/faq.rst       | 2 +-
 doc/guides/nics/thunderx.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Thomas Monjalon July 5, 2020, 8:44 p.m. UTC | #1
23/06/2020 07:55, Sarosh Arif:
> change /dev/huge to /dev/hugepages
> 
> Bugzilla ID: 492
> Signed-off-by: Sarosh Arif <sarosh.arif@emumba.com>

Please could you explain why /dev/hugepages must be used,
in the commit log for the record?

FYI, a similar change was done in the website by Stephen.
Sarosh Arif July 6, 2020, 8:01 a.m. UTC | #2
On Mon, Jul 6, 2020 at 1:44 AM Thomas Monjalon <thomas@monjalon.net> wrote:

> 23/06/2020 07:55, Sarosh Arif:
> > change /dev/huge to /dev/hugepages
> >
> > Bugzilla ID: 492
> > Signed-off-by: Sarosh Arif <sarosh.arif@emumba.com>
>
> Please could you explain why /dev/hugepages must be used,
> in the commit log for the record?
>

 The path /dev/huge does not exist, the correct path is  /dev/hugepages, so
for the sake of accuracy in the documentation it should be changed.

>
> FYI, a similar change was done in the website by Stephen.
>

This bug was submitted by Stephen on bugzilla, I took notice of it and
submitted a patch to correct it. This bug is not yet corrected on the
website.
Burakov, Anatoly July 28, 2020, 10:17 a.m. UTC | #3
On 05-Jul-20 9:44 PM, Thomas Monjalon wrote:
> 23/06/2020 07:55, Sarosh Arif:
>> change /dev/huge to /dev/hugepages
>>
>> Bugzilla ID: 492
>> Signed-off-by: Sarosh Arif <sarosh.arif@emumba.com>
> 
> Please could you explain why /dev/hugepages must be used,
> in the commit log for the record?
> 
> FYI, a similar change was done in the website by Stephen.
> 

/dev/hugepages is the default path used by systemd (check 
dev-hugepages.mount unit) so this is the correct path.
Thomas Monjalon July 30, 2020, 11:31 p.m. UTC | #4
06/07/2020 10:01, Sarosh Arif:
> On Mon, Jul 6, 2020 at 1:44 AM Thomas Monjalon <thomas@monjalon.net> wrote:
> 
> > 23/06/2020 07:55, Sarosh Arif:
> > > change /dev/huge to /dev/hugepages
> > >
> > > Bugzilla ID: 492
> > > Signed-off-by: Sarosh Arif <sarosh.arif@emumba.com>
> >
> > Please could you explain why /dev/hugepages must be used,
> > in the commit log for the record?
> >
> 
>  The path /dev/huge does not exist, the correct path is  /dev/hugepages, so
> for the sake of accuracy in the documentation it should be changed.

The directory can be created.
As Anatoly said, the reason is that it is the default path
on most systems.

> >
> > FYI, a similar change was done in the website by Stephen.
> >
> 
> This bug was submitted by Stephen on bugzilla, I took notice of it and
> submitted a patch to correct it. This bug is not yet corrected on the
> website.

It is fixed in the website.


Applied with more explanations.

Patch
diff mbox series

diff --git a/doc/guides/faq/faq.rst b/doc/guides/faq/faq.rst
index f19c1389b..bb1df7dc8 100644
--- a/doc/guides/faq/faq.rst
+++ b/doc/guides/faq/faq.rst
@@ -18,7 +18,7 @@  The number of pages allocated can be seen by executing the following command::
 
 Once all the pages are mmapped by an application, they stay that way.
 If you start a test application with less than the maximum, then you have free pages.
-When you stop and restart the test application, it looks to see if the pages are available in the ``/dev/huge`` directory and mmaps them.
+When you stop and restart the test application, it looks to see if the pages are available in the ``/dev/hugepages`` directory and mmaps them.
 If you look in the directory, you will see ``n`` number of 2M pages files. If you specified 1024, you will see 1024 page files.
 These are then placed in memory segments to get contiguous memory.
 
diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst
index f42133e54..b1ef9eba5 100644
--- a/doc/guides/nics/thunderx.rst
+++ b/doc/guides/nics/thunderx.rst
@@ -156,7 +156,7 @@  This section provides instructions to configure SR-IOV with Linux OS.
       -netdev tap,id=net0,ifname=tap0,script=/etc/qemu-ifup_thunder \
       -device virtio-net-device,netdev=net0 \
       -serial stdio \
-      -mem-path /dev/huge
+      -mem-path /dev/hugepages
 
 #. Enable **VFIO-NOIOMMU** mode (optional):