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

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

[Gaetan Rivet]

Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
---
 doc/guides/nics/fail_safe.rst          | 2 ++
 doc/guides/rel_notes/release_17_08.rst | 5 +++++
 2 files changed, 7 insertions(+)

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..7558368 100644
--- a/doc/guides/rel_notes/release_17_08.rst
+++ b/doc/guides/rel_notes/release_17_08.rst
@@ -233,6 +233,11 @@ EAL
 Drivers
 ~~~~~~~
 
+* **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.
 
 Libraries
 ~~~~~~~~~
-- 
2.1.4

Re: [dpdk-dev] [PATCH] doc: include fail-safe PMD in release note

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Gaetan Rivet
> Sent: Friday, August 4, 2017 4:05 PM
> To: dev@dpdk.org
> Cc: Yigit, Ferruh <ferruh.yigit@intel.com>; Gaetan Rivet
> <gaetan.rivet@6wind.com>
> Subject: [dpdk-dev] [PATCH] doc: include fail-safe PMD in release note
> 
> Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>

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

Re: [dpdk-dev] [PATCH] doc: include fail-safe PMD in release note

[Ferruh Yigit]

On 8/4/2017 4:04 PM, Gaetan Rivet wrote:
> Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
> ---
>  doc/guides/nics/fail_safe.rst          | 2 ++
>  doc/guides/rel_notes/release_17_08.rst | 5 +++++
>  2 files changed, 7 insertions(+)
> 
> 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..7558368 100644
> --- a/doc/guides/rel_notes/release_17_08.rst
> +++ b/doc/guides/rel_notes/release_17_08.rst
> @@ -233,6 +233,11 @@ EAL
>  Drivers
>  ~~~~~~~

This is under "Resolved Issues" section.
Can you please move this to the "New Features" section?

Thanks,
ferruh

>  
> +* **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.
>  
>  Libraries
>  ~~~~~~~~~
> 

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

[Gaetan Rivet]

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

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
 ~~~~~~~~~
 
-- 
2.1.4

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

[Thomas Monjalon]

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