Restructured the Release Notes documentation into a more useful structure
that is easier to use and to update between releases.
The main changes are:
* Each release version has it's own section with New Features,
Resolved Issues, Known Issues and API/ABI Changes.
* Redundant sections have been removed.
* The FAQ section have been moved to a standalone document.
* The Known Issues tables have been changed to definition lists.
Signed-off-by: John McNamara
---
doc/guides/faq/faq.rst | 240 +
doc/guides/faq/index.rst| 42 +
doc/guides/index.rst|1 +
doc/guides/rel_notes/deprecation.rst|7 +-
doc/guides/rel_notes/faq.rst| 228 -
doc/guides/rel_notes/index.rst | 14 +-
doc/guides/rel_notes/known_issues.rst | 1232 ++-
doc/guides/rel_notes/new_features.rst | 129 ---
doc/guides/rel_notes/rel_description.rst| 145 +--
doc/guides/rel_notes/release_1_8.rst| 64 ++
doc/guides/rel_notes/release_2_0.rst| 133 +++
doc/guides/rel_notes/release_2_1.rst| 69 ++
doc/guides/rel_notes/resolved_issues.rst| 1395 ---
doc/guides/rel_notes/supported_features.rst | 396
doc/guides/rel_notes/supported_os.rst | 14 +-
doc/guides/rel_notes/updating_apps.rst | 136 ---
16 files changed, 1061 insertions(+), 3184 deletions(-)
create mode 100644 doc/guides/faq/faq.rst
create mode 100644 doc/guides/faq/index.rst
delete mode 100644 doc/guides/rel_notes/faq.rst
delete mode 100644 doc/guides/rel_notes/new_features.rst
create mode 100644 doc/guides/rel_notes/release_1_8.rst
create mode 100644 doc/guides/rel_notes/release_2_0.rst
create mode 100644 doc/guides/rel_notes/release_2_1.rst
delete mode 100644 doc/guides/rel_notes/resolved_issues.rst
delete mode 100644 doc/guides/rel_notes/supported_features.rst
delete mode 100644 doc/guides/rel_notes/updating_apps.rst
diff --git a/doc/guides/faq/faq.rst b/doc/guides/faq/faq.rst
new file mode 100644
index 000..7b2394c
--- /dev/null
+++ b/doc/guides/faq/faq.rst
@@ -0,0 +1,240 @@
+.. BSD LICENSE
+Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+* Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in
+the documentation and/or other materials provided with the
+distribution.
+* Neither the name of Intel Corporation nor the names of its
+contributors may be used to endorse or promote products derived
+from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+What does "EAL: map_all_hugepages(): open failed: Permission denied Cannot
init memory" mean?
+-
+
+This is most likely due to the test application not being run with sudo to
promote the user to a superuser.
+Alternatively, applications can also be run as regular user.
+For more information, please refer to :doc:`DPDK Getting Started Guide
`.
+
+
+If I want to change the number of TLB Hugepages allocated, how do I remove the
original pages allocated?
+
+
+The number of pages allocated can be seen by executing the following command::
+
+ grep Huge /proc/meminfo
+
+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.
+If you look in the directory, you will see ``n`` number of 2M pages files. If
