Unify the style of short command descriptions

diff --git a/commands/cmd.c b/commands/cmd.c
index a7874d34bf2727e48ee6d2199148549b40c505d7..1a043f86dbfff184bc7879bde6500404c9fcf9f8 100644 (file)
--- a/commands/cmd.c
+++ b/commands/cmd.c
@@ -80,7 +80,7 @@ cmd_des_t const **cmd_list;
 /** Command descriptor for sleep command */
 cmd_des_t const cmd_des_sleep={
     0, 0,
-    "sleep","Sleep the board.",
+    "sleep","Sleep the board",
     "=== Syntax ===\n"
     "\n"
     " sleep\n"
@@ -96,7 +96,7 @@ cmd_des_t const cmd_des_sleep={
 /** Command descriptor for show help command */
 cmd_des_t const cmd_des_help={
     0, 0,
-    "help","Prints help for commands",
+    "help","Print help for commands",
     "=== Syntax ===\n"
     "\n"
     " help [command]\n"

diff --git a/commands/cmd_adc.c b/commands/cmd_adc.c
index 7cabf17264e27f584b1a49173fc2c7635b48bab7..879ad70faaf08ac943536b654343ba27e767b7f2 100644 (file)
--- a/commands/cmd_adc.c
+++ b/commands/cmd_adc.c
@@ -60,7 +60,7 @@ int cmd_do_read_adc1_values(cmd_io_t *cmd_io, const struct cmd_des *des, char *p
 /** Descriptor of command for adc port reading */
 cmd_des_t const cmd_des_read_adc1={
     0, 0,
-    "readadc","Reads values from ADC1", /* FIXME: is ADC1 also a name of a pin? */
+    "adcread","Read values from ADC1", /* FIXME: is ADC1 also a name of a pin? */
     "=== Command syntax ===\n"
     "\n"
     "   readadc\n"

diff --git a/commands/cmd_dac.c b/commands/cmd_dac.c
index 94db9efdb0be4d232743e8866624633e32c3fd9c..1e9e23cee8fef7e6de90e03deafb24e8d7e5c648 100644 (file)
--- a/commands/cmd_dac.c
+++ b/commands/cmd_dac.c
@@ -156,7 +156,7 @@ int cmd_do_dac_pin_set_voltage(cmd_io_t *cmd_io, const struct cmd_des *des, char
 /** Descriptor of command for dac pin setup */
 cmd_des_t const cmd_des_dac_pin_setup = {
        0, CDESM_OPCHR|CDESM_WR,
-       "dacpinenable#","Enables or disables a DAC pin",
+       "dacpinenable#","Enable or disable a DAC pin",
        "=== Command syntax ===\n"
        "\n"
        "   dacpinenable<PIN>:<VALUE> \n"
@@ -182,7 +182,7 @@ cmd_des_t const cmd_des_dac_pin_setup = {
 /** Descriptor of command for dac pin value set */
 cmd_des_t const cmd_des_dac_pin_set_val = {
        0, CDESM_OPCHR|CDESM_WR,
-       "dacpinval#","Sets raw value to pin DAC.",
+       "dacpinval#","Set raw value of a DAC register",
        "=== Command syntax ===\n"
        "\n"
        "   dacpinval<PIN>:<VALUE>\n"
@@ -211,7 +211,7 @@ cmd_des_t const cmd_des_dac_pin_set_val = {
 /** Descriptor of command for dac pin voltage set */
 cmd_des_t const cmd_des_dac_pin_set_voltage = {
        0, CDESM_OPCHR|CDESM_WR,
-       "dacpinvoltage#","Sets voltage in mV to pin DAC.",
+       "dacpinvoltage#","Set voltage in mV of a DAC pin",
        "=== Command syntax ===\n"
        "\n"
        "   dacpinvoltage<PIN>:<VALUE>\n"

diff --git a/commands/cmd_din.c b/commands/cmd_din.c
index 889cbf7e9d327d11b316b02452f8a4f0a12afd5a..338e5f2d7d9a191897f1978dc6f7285e1e379c80 100644 (file)
--- a/commands/cmd_din.c
+++ b/commands/cmd_din.c
@@ -36,7 +36,7 @@
 #include "hal/hal.h"
 
 /**
- * @brief      Setup DIN pin parameters (Pull up/down, tristate/active, IRQ and wakeup disable/enable
+ * @brief      Setup DIN pin parameters (pull up/down, tristate/active, IRQ and wakeup disable/enable
  *
  * @param[in]  cmd_io  Pointer to IO stack
  * @param[in]  des             Pointer to command descriptor

diff --git a/commands/cmd_fray.c b/commands/cmd_fray.c
index 28e12291c1a5b0e8e1b50102c44079c15092911d..857a86df590c39f83d98e109e5548bdbe26fc203 100644 (file)
--- a/commands/cmd_fray.c
+++ b/commands/cmd_fray.c
@@ -422,7 +422,7 @@ int cmd_do_test_frayB(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[]
 /** Command descriptor for FlexRay status command */
 cmd_des_t const cmd_des_fray_stat={
        0, 0,
-       "frayxcvrstat#","Get status of a FlexRay transceiver in a human readable form",
+       "frayxcvrstat#","Get the status of a FlexRay transceiver in a human readable form",
        "=== Command syntax ===\n"
        "\n"
        "   frayxcvrstat<CHN>\n"
@@ -444,7 +444,7 @@ cmd_des_t const cmd_des_fray_stat={
 /** Command descriptor for FlexRay 1 test node A */
 cmd_des_t const cmd_des_test_fray_a={
            0, 0,
-           "fraytestA","Run the FlexRay test as A node.",
+           "fraytestA","Run the FlexRay test as A node",
            "=== Command syntax ===\n"
            "\n"
            "   fraytestA\n"
@@ -467,7 +467,7 @@ cmd_des_t const cmd_des_test_fray_a={
 /** Command descriptor for FlexRay 1 test node B */
 cmd_des_t const cmd_des_test_fray_b={
            0, 0,
-           "fraytestB","Run the FlexRay test as B node.",
+           "fraytestB","Run the FlexRay test as B node",
            "=== Command syntax ===\n"
            "\n"
            "   fraytestB\n"

diff --git a/commands/cmd_hbr.c b/commands/cmd_hbr.c
index 183592d68dfda1bd60d13909b72a91972e6dc21f..896797114aa9e4b4a6d399108f4c3587b612c375 100644 (file)
--- a/commands/cmd_hbr.c
+++ b/commands/cmd_hbr.c
@@ -117,7 +117,7 @@ int cmd_do_hbr_disable(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[
 /** Command descriptor for HBR enable command */
 cmd_des_t const cmd_des_hbr_enable = {
     0, CDESM_OPCHR|CDESM_WR,
-    "hbrenable","Enables H-bridge and sets its PWM period.",
+    "hbrenable","Enable the H-bridge and set its PWM period",
     "=== Command syntax ===\n"
     "\n"
     "   hbrenable:<PER>\n"
@@ -146,7 +146,7 @@ cmd_des_t const cmd_des_hbr_enable = {
 /** Command descriptor for HBR control command */
 cmd_des_t const cmd_des_hbr_control = {
     0, CDESM_OPCHR|CDESM_WR,
-    "hbrcontrol","Sets motor voltage direction and size in percent",
+    "hbrcontrol","Set the motor voltage direction and size in percent",
     "=== Command syntax ===\n"
     "\n"
     "   hbrcontrol:<SPEED>\n"
@@ -186,7 +186,7 @@ cmd_des_t const cmd_des_hbr_control = {
 /** Command descriptor for HBR disable command */
 cmd_des_t const cmd_des_hbr_disable = {
     0, 0,
-    "hbrdisable","Disables H-bridge",
+    "hbrdisable","Disable the H-bridge",
     "=== Command syntax ===\n"
     "\n"
     "   hbrdisable\n"

diff --git a/commands/cmd_hout.c b/commands/cmd_hout.c
index 428f9c0e8b11b75e517dede47e5695984a72f1b6..0707fa97ae515e5ddf1cd01730f9ce3effc61804 100644 (file)
--- a/commands/cmd_hout.c
+++ b/commands/cmd_hout.c
@@ -219,7 +219,7 @@ cmd_des_t const cmd_des_test_hout_fail = {
 /** Command descriptor for hout read IFBK command */
 cmd_des_t const cmd_des_read_hifbk={
     0, 0,
-    "houtifbk","Reads values from HOUT IFBK",
+    "houtifbk","Read values from HOUT current feedback",
     "=== Command syntax ===\n"
     "\n"
     "   houtifbk\n"
@@ -234,7 +234,7 @@ cmd_des_t const cmd_des_read_hifbk={
 /** Command descriptor for HOUT set PWM command */
 cmd_des_t const cmd_des_hout_pwm={
     0, CDESM_OPCHR|CDESM_RW,
-    "houtpwm*","Sets or gets actual PWM parameters", /* FIXME: Why is here * and other commands have #? */
+    "houtpwm*","Set or get actual PWM parameters", /* FIXME: Why is here * and other commands have #? */
     "=== Command syntax ===\n"
     "\n"
     "   houtpwm<PIN>:(<PER>,<DUTY>)\n"

diff --git a/commands/cmd_lout.c b/commands/cmd_lout.c
index 3183c6882c35921bb203bc4c12210e913dd69122..2e1dd18462c434b69737091c046ee5430b7802b4 100644 (file)
--- a/commands/cmd_lout.c
+++ b/commands/cmd_lout.c
@@ -138,7 +138,7 @@ cmd_des_t const cmd_des_lout_set={
 /** Command descriptor for lout get pin diag value */
 cmd_des_t const cmd_des_lout_diag={
        0, CDESM_OPCHR|CDESM_RD,
-       "loutdiag#","Reads a diagnostic value from an LOUT pin",
+       "loutdiag#","Read a diagnostic value from an LOUT pin",
        "=== Command syntax ===\n"
        "\n"
        "   loutdiag<PIN>?\n"

diff --git a/commands/cmd_motor_example.c b/commands/cmd_motor_example.c
index d2bc43c9619e51361f9faf11f77dccb7155f1b66..411d08cf80c3c5686e6967a77559018f589e4bcf 100644 (file)
--- a/commands/cmd_motor_example.c
+++ b/commands/cmd_motor_example.c
@@ -366,7 +366,7 @@ int cmd_do_motor(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[]) {
 /** Command descriptor for control */
 cmd_des_t const cmd_des_control={
                0, 0,
-               "demomotctrl","Run motor control demo - reads input and sends it ",
+               "demomotctrl","Run motor control demo - reads input and sends it",
                "=== Command syntax ===\n"
                "\n"
                "   demomotctrl\n"
@@ -386,7 +386,7 @@ cmd_des_t const cmd_des_control={
 /** Command descriptor for motor */
 cmd_des_t const cmd_des_motor={
                0, 0,
-               "demomotdrive","Run motor control demo - drives the DC motor.",
+               "demomotdrive","Run motor control demo - drives the DC motor",
                "=== Command syntax ===\n"
                "\n"
                "   demomotmotor\n"

diff --git a/commands/cmd_pin.c b/commands/cmd_pin.c
index f456c1573043f7952de31473c391533611e355d9..5d96f58016a0142bdd426282d50b1d967fdc91bd 100644 (file)
--- a/commands/cmd_pin.c
+++ b/commands/cmd_pin.c
@@ -138,7 +138,7 @@ int cmd_do_pin_dir(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[]) {
 /** Command descriptor for pin list */
 cmd_des_t const cmd_des_pin_list = {
     0, 0,
-    "pinlist","Prints a list of all defined pins.",
+    "pinlist","Print a list of all defined pins.",
     "=== Command syntax ===\n"
     "\n"
     "   pinlist\n"
@@ -153,7 +153,7 @@ cmd_des_t const cmd_des_pin_list = {
 /** Command descriptor for pin get/set value */
 cmd_des_t const cmd_des_pin_val={
        0, CDESM_OPCHR|CDESM_RW,
-       "pinval*","Sets or gets pin value.",
+       "pinval*","Set or get the pin value",
        "=== Command syntax ===\n"
        "\n"
        "   pinval<NAME>:<VAL>\n"
@@ -189,7 +189,7 @@ cmd_des_t const cmd_des_pin_val={
 /** Command descriptor for pin get/set direction */
 cmd_des_t const cmd_des_pin_dir={
        0, CDESM_OPCHR|CDESM_RW,
-       "pindir*","Sets pin direction",
+       "pindir*","Set the pin direction",
        "=== Command syntax ===\n"
        "\n"
        "   pindir<NAME>:<DIR>\n"

diff --git a/commands/cmd_port.c b/commands/cmd_port.c
index c4d08baf44f299f5c8763137b2a8c9f099ec19e4..a24adba6620e4de8b78394702e15addf4e76bd09 100644 (file)
--- a/commands/cmd_port.c
+++ b/commands/cmd_port.c
@@ -96,7 +96,7 @@ int cmd_do_port_val(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
 /** Command descriptor for read values from port command */
 cmd_des_t const cmd_des_port_val={
     0, CDESM_OPCHR|CDESM_RW,
-    "portval*","Reads or writes values from or to the port",
+    "portval*","Read or write values from or to the port",
     "=== Command syntax ===\n"
     "\n"
     "   portval<NAME>:(<VAL>)\n"
@@ -132,7 +132,7 @@ cmd_des_t const cmd_des_port_val={
 /** Command descriptor for port list printout */
 cmd_des_t const cmd_des_port_list={
     0, 0,
-    "portlist","Prints list of all port names",
+    "portlist","Print a list of all port names",
     "=== Command syntax ===\n"
     "\n"
     "   portlist\n"

diff --git a/commands/cmd_sdram.c b/commands/cmd_sdram.c
index b20d0ad9af30ec685a838b97c412a352a703c152..e2fdac3e6d431f20cc29e49a7380bc0a857a58d8 100644 (file)
--- a/commands/cmd_sdram.c
+++ b/commands/cmd_sdram.c
@@ -237,7 +237,7 @@ int cmd_do_test_ram(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
 /** Command descriptor for test SDRAM */
 cmd_des_t const cmd_des_test_sdram={
     0, 0,
-    "sdramtest","Tests if the SDRAM module is connected and if so, measures its capacity",
+    "sdramtest","Test if the SDRAM module is connected and if so, measures its capacity",
     "=== Command syntax ===\n"
     "\n"
     "   sdramtest\n"

diff --git a/commands/cmd_spi.c b/commands/cmd_spi.c
index b5997861f720a9487b7e763c4c5664276e898ece..7d08b84d18dc48632b37e08ecaebd4297bb5d820 100644 (file)
--- a/commands/cmd_spi.c
+++ b/commands/cmd_spi.c
@@ -223,7 +223,7 @@ cmd_des_t const cmd_des_spi_translate={
 /** Command descriptor for SPI trasfer */
 cmd_des_t const cmd_des_spimst = {
        0, CDESM_OPCHR,
-       "spimst#", "SPI master communication request",
+       "spimst#", "Request SPI master communication",
        "=== Command syntax ===\n"
        "\n"
        "   spimst<SPI>:<ADDR>(<DATA>)\n"