From 044b4a3b49b67adfe53e0e88f9adf847a25fad61 Mon Sep 17 00:00:00 2001
From: Jacob Gilbert <jacob.gilbert@protonmail.com>
Date: Mon, 15 Feb 2021 15:07:45 -0800
Subject: gr-blocks: deprecate print_pdu port of message_debug block

Having two print ports on this block has confused a number of people,
most recently issue #4191, and combining them is straightforward and
should make this block easier to use. The print_pdu formatting is now
be applied on the print port if the message is a PDU.

Signed-off-by: Jacob Gilbert <jacob.gilbert@protonmail.com>
---
 gr-blocks/lib/message_debug_impl.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'gr-blocks/lib/message_debug_impl.h')

diff --git a/gr-blocks/lib/message_debug_impl.h b/gr-blocks/lib/message_debug_impl.h
index c9fc65391c..b7eba50160 100644
--- a/gr-blocks/lib/message_debug_impl.h
+++ b/gr-blocks/lib/message_debug_impl.h
@@ -30,7 +30,8 @@ private:
      * This port receives messages from the scheduler's message
      * handling mechanism and prints it to stdout. This message
      * handler function is only meant to be used by the scheduler to
-     * handle messages posted to port 'print'.
+     * handle messages posted to port 'print'. If the message is a
+     * PDU, special formatting will be applied.
      *
      * \param msg A pmt message passed from the scheduler's message handling.
      */
@@ -39,6 +40,8 @@ private:
     /*!
      * \brief PDU formatted messages received in this port are printed to stdout.
      *
+     * DEPRECATED as of 3.10 use print() for all printing!
+     *
      * This port receives messages from the scheduler's message
      * handling mechanism and prints it to stdout. This message
      * handler function is only meant to be used by the scheduler to
-- 
cgit v1.2.3