[Commit-gnuradio] [gnuradio] 04/13: Fix inconsistent naming and docstring

[git]

This is an automated email from the git hooks/post-receive script.

jcorgan pushed a commit to branch master
in repository gnuradio.

commit 6643727f8a2465c88c58803b9455fe0c529cc1c0
Author: Bolin Hsu <address@hidden>
Date:   Sat Mar 29 22:00:16 2014 -0700

    Fix inconsistent naming and docstring
    
    (1) In the XML files, all keys except "log" are used as parameter names.
    (2) Most files use the parameter name "log" to flip logging.
        So change the ones that use "logging" or "debug" to "log".
    (3) packet_mod constructor does not have the argument payload_length.
    (4) Add missing args to some docstrings
    (5) Resolve inconsistency between gmsk_demod code and doc
---
 gr-digital/grc/digital_constellation_modulator.xml | 2 +-
 gr-digital/grc/digital_dxpsk_demod.xml             | 2 +-
 gr-digital/grc/digital_dxpsk_mod.xml               | 2 +-
 gr-digital/grc/digital_gfsk_demod.xml              | 2 +-
 gr-digital/grc/digital_gfsk_mod.xml                | 2 +-
 gr-digital/grc/digital_gmsk_demod.xml              | 2 +-
 gr-digital/grc/digital_gmsk_mod.xml                | 2 +-
 gr-digital/grc/digital_psk_demod.xml               | 2 +-
 gr-digital/grc/digital_psk_mod.xml                 | 2 +-
 gr-digital/grc/digital_qam_demod.xml               | 2 +-
 gr-digital/grc/digital_qam_mod.xml                 | 2 +-
 gr-digital/python/digital/gmsk.py                  | 6 +++---
 gr-digital/python/digital/packet_utils.py          | 2 ++
 grc/grc_gnuradio/blks2/packet.py                   | 2 +-
 14 files changed, 17 insertions(+), 15 deletions(-)

diff --git a/gr-digital/grc/digital_constellation_modulator.xml 
b/gr-digital/grc/digital_constellation_modulator.xml
index 7b7ce24..9905197 100644
--- a/gr-digital/grc/digital_constellation_modulator.xml
+++ b/gr-digital/grc/digital_constellation_modulator.xml
@@ -86,7 +86,7 @@
     </option>
   </param>
   <param>
-    <name>Logging</name>
+    <name>Log</name>
     <key>log</key>
     <value>False</value>
     <type>bool</type>
diff --git a/gr-digital/grc/digital_dxpsk_demod.xml 
b/gr-digital/grc/digital_dxpsk_demod.xml
index 1c6314d..5b26d5b 100644
--- a/gr-digital/grc/digital_dxpsk_demod.xml
+++ b/gr-digital/grc/digital_dxpsk_demod.xml
@@ -114,7 +114,7 @@
                </option>
        </param>
        <param>
-               <name>Logging</name>
+               <name>Log</name>
                <key>log</key>
                <value>False</value>
                <type>bool</type>
diff --git a/gr-digital/grc/digital_dxpsk_mod.xml 
b/gr-digital/grc/digital_dxpsk_mod.xml
index 08a95f1..02da100 100644
--- a/gr-digital/grc/digital_dxpsk_mod.xml
+++ b/gr-digital/grc/digital_dxpsk_mod.xml
@@ -91,7 +91,7 @@
                </option>
        </param>
        <param>
-               <name>Logging</name>
+               <name>Log</name>
                <key>log</key>
                <value>False</value>
                <type>bool</type>
diff --git a/gr-digital/grc/digital_gfsk_demod.xml 
b/gr-digital/grc/digital_gfsk_demod.xml
index ce3024d..cbea39e 100644
--- a/gr-digital/grc/digital_gfsk_demod.xml
+++ b/gr-digital/grc/digital_gfsk_demod.xml
@@ -70,7 +70,7 @@
                </option>
        </param>
        <param>
-               <name>Logging</name>
+               <name>Log</name>
                <key>log</key>
                <value>False</value>
                <type>bool</type>
diff --git a/gr-digital/grc/digital_gfsk_mod.xml 
b/gr-digital/grc/digital_gfsk_mod.xml
index 2d6cd1e..08e2c84 100644
--- a/gr-digital/grc/digital_gfsk_mod.xml
+++ b/gr-digital/grc/digital_gfsk_mod.xml
@@ -49,7 +49,7 @@
                </option>
        </param>
        <param>
-               <name>Logging</name>
+               <name>Log</name>
                <key>log</key>
                <value>False</value>
                <type>bool</type>
diff --git a/gr-digital/grc/digital_gmsk_demod.xml 
b/gr-digital/grc/digital_gmsk_demod.xml
index e037b8e..4d57f1a 100644
--- a/gr-digital/grc/digital_gmsk_demod.xml
+++ b/gr-digital/grc/digital_gmsk_demod.xml
@@ -63,7 +63,7 @@
                </option>
        </param>
        <param>
-               <name>Logging</name>
+               <name>Log</name>
                <key>log</key>
                <value>False</value>
                <type>bool</type>
diff --git a/gr-digital/grc/digital_gmsk_mod.xml 
b/gr-digital/grc/digital_gmsk_mod.xml
index ede7680..77f52ca 100644
--- a/gr-digital/grc/digital_gmsk_mod.xml
+++ b/gr-digital/grc/digital_gmsk_mod.xml
@@ -42,7 +42,7 @@
                </option>
        </param>
        <param>
-               <name>Logging</name>
+               <name>Log</name>
                <key>log</key>
                <value>False</value>
                <type>bool</type>
diff --git a/gr-digital/grc/digital_psk_demod.xml 
b/gr-digital/grc/digital_psk_demod.xml
index 2e0e86e..36e803a 100644
--- a/gr-digital/grc/digital_psk_demod.xml
+++ b/gr-digital/grc/digital_psk_demod.xml
@@ -120,7 +120,7 @@
     </option>
   </param>
   <param>
-    <name>Logging</name>
+    <name>Log</name>
     <key>log</key>
     <value>False</value>
     <type>bool</type>
diff --git a/gr-digital/grc/digital_psk_mod.xml 
b/gr-digital/grc/digital_psk_mod.xml
index cafcf4e..e778884 100644
--- a/gr-digital/grc/digital_psk_mod.xml
+++ b/gr-digital/grc/digital_psk_mod.xml
@@ -100,7 +100,7 @@
     </option>
   </param>
   <param>
-    <name>Logging</name>
+    <name>Log</name>
     <key>log</key>
     <value>False</value>
     <type>bool</type>
diff --git a/gr-digital/grc/digital_qam_demod.xml 
b/gr-digital/grc/digital_qam_demod.xml
index 5aaec1b..21ccba8 100644
--- a/gr-digital/grc/digital_qam_demod.xml
+++ b/gr-digital/grc/digital_qam_demod.xml
@@ -121,7 +121,7 @@
     </option>
   </param>
   <param>
-    <name>Logging</name>
+    <name>Log</name>
     <key>log</key>
     <value>False</value>
     <type>bool</type>
diff --git a/gr-digital/grc/digital_qam_mod.xml 
b/gr-digital/grc/digital_qam_mod.xml
index 4d73d9a..435ca70 100644
--- a/gr-digital/grc/digital_qam_mod.xml
+++ b/gr-digital/grc/digital_qam_mod.xml
@@ -100,7 +100,7 @@
     </option>
   </param>
   <param>
-    <name>Logging</name>
+    <name>Log</name>
     <key>log</key>
     <value>False</value>
     <type>bool</type>
diff --git a/gr-digital/python/digital/gmsk.py 
b/gr-digital/python/digital/gmsk.py
index 9a44837..012c91f 100644
--- a/gr-digital/python/digital/gmsk.py
+++ b/gr-digital/python/digital/gmsk.py
@@ -66,7 +66,7 @@ class gmsk_mod(gr.hier_block2):
         samples_per_symbol: samples per baud >= 2 (integer)
         bt: Gaussian filter bandwidth * symbol time (float)
         verbose: Print information about modulator? (boolean)
-        debug: Print modulation data to files? (boolean)
+        log: Print modulation data to files? (boolean)
     """
 
     def __init__(self,
@@ -176,12 +176,12 @@ class gmsk_demod(gr.hier_block2):
     
     Args:
         samples_per_symbol: samples per baud (integer)
-        verbose: Print information about modulator? (boolean)
-        log: Print modualtion data to files? (boolean)
         gain_mu: controls rate of mu adjustment (float)
         mu: fractional delay [0.0, 1.0] (float)
         omega_relative_limit: sets max variation in omega (float)
         freq_error: bit rate error as a fraction (float)
+        verbose: Print information about modulator? (boolean)
+        log: Print modualtion data to files? (boolean)
     """
     
     def __init__(self,
diff --git a/gr-digital/python/digital/packet_utils.py 
b/gr-digital/python/digital/packet_utils.py
index 865f3ad..d7aa4e6 100644
--- a/gr-digital/python/digital/packet_utils.py
+++ b/gr-digital/python/digital/packet_utils.py
@@ -113,7 +113,9 @@ def make_packet(payload, samples_per_symbol, 
bits_per_symbol,
         bits_per_symbol: (needed for padding calculation) (int)
         preamble: string of ascii 0's and 1's
         access_code: string of ascii 0's and 1's
+        pad_for_usrp: If true, packets are padded such that they end up a 
multiple of 128 samples(512 bytes)
         whitener_offset: offset into whitener string to use [0-16)
+        whitening: Whether to turn on data whitening(scrambling) (boolean)
     
     Packet will have access code at the beginning, followed by length, payload
     and finally CRC-32.
diff --git a/grc/grc_gnuradio/blks2/packet.py b/grc/grc_gnuradio/blks2/packet.py
index 872f08c..dde3ec7 100644
--- a/grc/grc_gnuradio/blks2/packet.py
+++ b/grc/grc_gnuradio/blks2/packet.py
@@ -75,9 +75,9 @@ class packet_encoder(gr.hier_block2):
         Args:
             samples_per_symbol: number of samples per symbol
             bits_per_symbol: number of bits per symbol
+            preamble: string of ascii 0's and 1's
             access_code: AKA sync vector
             pad_for_usrp: If true, packets are padded such that they end up a 
multiple of 128 samples
-            payload_length: number of bytes in a data-stream slice
         """
         #setup parameters
         self._samples_per_symbol = samples_per_symbol