diff mbox

[dpdk-dev,v2] doc: include fail-safe PMD in release note

Message ID 1501860784-17481-1-git-send-email-gaetan.rivet@6wind.com (mailing list archive)
State Accepted, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Gaëtan Rivet Aug. 4, 2017, 3:33 p.m. UTC 
  Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
---

v2:

  - Move the note to the proper sub-section.
    Thanks Ferruh

 doc/guides/nics/fail_safe.rst          | 2 ++
 doc/guides/rel_notes/release_17_08.rst | 6 +++++-
 2 files changed, 7 insertions(+), 1 deletion(-)

Comments

Thomas Monjalon Aug. 6, 2017, 1:17 p.m. UTC | #1 
04/08/2017 17:33, Gaetan Rivet:
> Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
> ---
> --- a/doc/guides/nics/fail_safe.rst
> +++ b/doc/guides/nics/fail_safe.rst
> +.. _fail_safe:
> +

No need of such anchor at the beginning of a doc.

>  Fail-safe poll mode driver library
>  ==================================

> --- a/doc/guides/rel_notes/release_17_08.rst
> +++ b/doc/guides/rel_notes/release_17_08.rst
> +* **Added Fail-Safe PMD**
> +
> +  Added the new Fail-Safe PMD. This virtual device allows applications to
> +  support seamless hotplug of devices. See the :ref:`Fail-Safe documentation<fail_safe>`
> +  for more details about this driver.

Replaced the :ref: by a :doc: link.

With this change, applied, thanks
diff mbox

Patch

diff --git a/doc/guides/nics/fail_safe.rst b/doc/guides/nics/fail_safe.rst
index 34ecae2..a3caf10 100644
--- a/doc/guides/nics/fail_safe.rst
+++ b/doc/guides/nics/fail_safe.rst
@@ -27,6 +27,8 @@ 
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+.. _fail_safe:
+
 Fail-safe poll mode driver library
 ==================================
 
diff --git a/doc/guides/rel_notes/release_17_08.rst b/doc/guides/rel_notes/release_17_08.rst
index 343331e..482578a 100644
--- a/doc/guides/rel_notes/release_17_08.rst
+++ b/doc/guides/rel_notes/release_17_08.rst
@@ -205,6 +205,11 @@  New Features
   to verify functionality and measure the performance parameters of DPDK
   eventdev devices.
 
+* **Added Fail-Safe PMD**
+
+  Added the new Fail-Safe PMD. This virtual device allows applications to
+  support seamless hotplug of devices. See the :ref:`Fail-Safe documentation<fail_safe>`
+  for more details about this driver.
 
 Resolved Issues
 ---------------
@@ -233,7 +238,6 @@  EAL
 Drivers
 ~~~~~~~
 
-
 Libraries
 ~~~~~~~~~