From 1d4b4f0ce27a44be132971ed690189e470af28ce Mon Sep 17 00:00:00 2001 From: Jim Mussared Date: Wed, 31 May 2023 16:37:23 +1000 Subject: [PATCH] ports: Standardise docs link in help text. Updates all `help()` output to use the phrase: `For online docs please visit http://docs.micropython.org/` Some ports previously used different wording, some pointed to the wrong link. Also make all ports use `help.c` for consistency. This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared --- ports/cc3200/misc/help.c | 2 +- ports/esp32/help.c | 2 +- ports/esp8266/help.c | 3 +- ports/mimxrt/Makefile | 1 + ports/mimxrt/help.c | 74 ++++++++++++++++++++++++++++++++++++++ ports/mimxrt/main.c | 47 ------------------------ ports/nrf/help.c | 2 +- ports/renesas-ra/help.c | 2 +- ports/rp2/CMakeLists.txt | 1 + ports/rp2/help.c | 64 +++++++++++++++++++++++++++++++++ ports/rp2/main.c | 37 ------------------- ports/samd/help.c | 2 +- ports/stm32/factoryreset.c | 2 +- ports/stm32/help.c | 2 +- ports/teensy/help.c | 2 +- ports/zephyr/help.c | 2 ++ 16 files changed, 152 insertions(+), 93 deletions(-) create mode 100644 ports/mimxrt/help.c create mode 100644 ports/rp2/help.c diff --git a/ports/cc3200/misc/help.c b/ports/cc3200/misc/help.c index ea0c9501db..213950c8ed 100644 --- a/ports/cc3200/misc/help.c +++ b/ports/cc3200/misc/help.c @@ -28,5 +28,5 @@ #include "py/builtin.h" const char cc3200_help_text[] = "Welcome to MicroPython!\n" - "For online help please visit http://micropython.org/help/.\n" + "For online docs please visit http://docs.micropython.org/\n" "For further help on a specific object, type help(obj)\n"; diff --git a/ports/esp32/help.c b/ports/esp32/help.c index 2336d97f84..2351d7dc73 100644 --- a/ports/esp32/help.c +++ b/ports/esp32/help.c @@ -31,7 +31,7 @@ const char esp32_help_text[] = "Welcome to MicroPython on the ESP32!\n" "\n" - "For generic online docs please visit http://docs.micropython.org/\n" + "For online docs please visit http://docs.micropython.org/\n" "\n" "For access to the hardware use the 'machine' module:\n" "\n" diff --git a/ports/esp8266/help.c b/ports/esp8266/help.c index a755a10a76..a9cb27bad5 100644 --- a/ports/esp8266/help.c +++ b/ports/esp8266/help.c @@ -29,7 +29,8 @@ const char esp_help_text[] = "Welcome to MicroPython!\n" "\n" - "For online docs please visit http://docs.micropython.org/en/latest/esp8266/ .\n" + "For online docs please visit http://docs.micropython.org/\n" + "\n" "For diagnostic information to include in bug reports execute 'import port_diag'.\n" "\n" "Basic WiFi configuration:\n" diff --git a/ports/mimxrt/Makefile b/ports/mimxrt/Makefile index cfef8ee0f9..63cba7d7a6 100644 --- a/ports/mimxrt/Makefile +++ b/ports/mimxrt/Makefile @@ -191,6 +191,7 @@ SRC_C += \ fatfs_port.c \ flash.c \ hal/pwm_backport.c \ + help.c \ led.c \ machine_adc.c \ machine_bitstream.c \ diff --git a/ports/mimxrt/help.c b/ports/mimxrt/help.c new file mode 100644 index 0000000000..10627aff7f --- /dev/null +++ b/ports/mimxrt/help.c @@ -0,0 +1,74 @@ +/* + * This file is part of the MicroPython project, http://micropython.org/ + * + * The MIT License (MIT) + * + * Copyright (c) 2023 Damien P. George + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +#include "py/builtin.h" + +const char mimxrt_help_text[] = + "Welcome to MicroPython!\n" + "\n" + "For online docs please visit http://docs.micropython.org/\n" + "\n" + "For access to the hardware use the 'machine' module. \n" + "\n" + "Quick overview of some objects:\n" + " machine.Pin(pin) -- get a pin, eg machine.Pin(0)\n" + " machine.Pin(pin, m, [p]) -- get a pin and configure it for IO mode m, pull mode p\n" + " methods: init(..), value([v]), high(), low())\n" + "\n" + " Pins are numbered board specific, either 0-n, or 'D0'-'Dn', or 'A0' - 'An',\n" + " according to the boards's pinout sheet.\n" + " Pin IO modes are: Pin.IN, Pin.OUT, Pin.OPEN_DRAIN\n" + " Pin pull modes are: Pin.PULL_UP, Pin.PULL_UP_47K, Pin.PULL_UP_22K, Pin.PULL_DOWN, Pin.PULL_HOLD\n" + " machine.ADC(pin) -- make an analog object from a pin\n" + " methods: read_u16()\n" + " machine.UART(id, baudrate=115200) -- create an UART object (id=1 - 8, board-specific)\n" + " methods: init(), write(buf), any()\n" + " buf=read(n), readinto(buf), buf=readline()\n" + " The RX and TX pins are fixed and board-specific.\n" + " machine.SoftI2C() -- create a Soft I2C object\n" + " machine.I2C(id) -- create a HW I2C object\n" + " methods: readfrom(addr, buf, stop=True), writeto(addr, buf, stop=True)\n" + " readfrom_mem(addr, memaddr, arg), writeto_mem(addr, memaddr, arg)\n" + " SoftI2C allows to use any pin for sda and scl, HW I2C id's and pins are fixed\n" + " machine.SoftSPI(baudrate=1000000) -- create a Soft SPI object\n" + " machine.SPI(id, baudrate=1000000) -- create a HW SPI object\n" + " methods: read(nbytes, write=0x00), write(buf), write_readinto(wr_buf, rd_buf)\n" + " SoftSPI allows to use any pin for SPI, HW SPI id's and pins are fixed\n" + " machine.Timer(id, freq, callback) -- create a hardware timer object (id=0,1,2)\n" + " eg: machine.Timer(freq=1, callback=lambda t:print(t))\n" + " machine.RTC() -- create a Real Time Clock object\n" + " methods: init(), datetime([dateime_tuple]), now()\n" + " machine.PWM(pin, freq, duty_u16[, kw_opts]) -- create a PWM object\n" + " methods: init(), duty_u16([value]), duty_ns([value]), freq([value])\n" + "\n" + "Useful control commands:\n" + " CTRL-C -- interrupt a running program\n" + " CTRL-D -- on a blank line, do a soft reset of the board\n" + " CTRL-E -- on a blank line, enter paste mode\n" + "\n" + "For further help on a specific object, type help(obj)\n" + "For a list of available modules, type help('modules')\n" +; diff --git a/ports/mimxrt/main.c b/ports/mimxrt/main.c index 8f8ecd91d4..9ac46e4814 100644 --- a/ports/mimxrt/main.c +++ b/ports/mimxrt/main.c @@ -151,50 +151,3 @@ void MP_WEAK __assert_func(const char *file, int line, const char *func, const c } } #endif - -const char mimxrt_help_text[] = - "Welcome to MicroPython!\n" - "\n" - "For online help please visit https://micropython.org/help/.\n" - "\n" - "For access to the hardware use the 'machine' module. \n" - "\n" - "Quick overview of some objects:\n" - " machine.Pin(pin) -- get a pin, eg machine.Pin(0)\n" - " machine.Pin(pin, m, [p]) -- get a pin and configure it for IO mode m, pull mode p\n" - " methods: init(..), value([v]), high(), low())\n" - "\n" - " Pins are numbered board specific, either 0-n, or 'D0'-'Dn', or 'A0' - 'An',\n" - " according to the boards's pinout sheet.\n" - " Pin IO modes are: Pin.IN, Pin.OUT, Pin.OPEN_DRAIN\n" - " Pin pull modes are: Pin.PULL_UP, Pin.PULL_UP_47K, Pin.PULL_UP_22K, Pin.PULL_DOWN, Pin.PULL_HOLD\n" - " machine.ADC(pin) -- make an analog object from a pin\n" - " methods: read_u16()\n" - " machine.UART(id, baudrate=115200) -- create an UART object (id=1 - 8, board-specific)\n" - " methods: init(), write(buf), any()\n" - " buf=read(n), readinto(buf), buf=readline()\n" - " The RX and TX pins are fixed and board-specific.\n" - " machine.SoftI2C() -- create a Soft I2C object\n" - " machine.I2C(id) -- create a HW I2C object\n" - " methods: readfrom(addr, buf, stop=True), writeto(addr, buf, stop=True)\n" - " readfrom_mem(addr, memaddr, arg), writeto_mem(addr, memaddr, arg)\n" - " SoftI2C allows to use any pin for sda and scl, HW I2C id's and pins are fixed\n" - " machine.SoftSPI(baudrate=1000000) -- create a Soft SPI object\n" - " machine.SPI(id, baudrate=1000000) -- create a HW SPI object\n" - " methods: read(nbytes, write=0x00), write(buf), write_readinto(wr_buf, rd_buf)\n" - " SoftSPI allows to use any pin for SPI, HW SPI id's and pins are fixed\n" - " machine.Timer(id, freq, callback) -- create a hardware timer object (id=0,1,2)\n" - " eg: machine.Timer(freq=1, callback=lambda t:print(t))\n" - " machine.RTC() -- create a Real Time Clock object\n" - " methods: init(), datetime([dateime_tuple]), now()\n" - " machine.PWM(pin, freq, duty_u16[, kw_opts]) -- create a PWM object\n" - " methods: init(), duty_u16([value]), duty_ns([value]), freq([value])\n" - "\n" - "Useful control commands:\n" - " CTRL-C -- interrupt a running program\n" - " CTRL-D -- on a blank line, do a soft reset of the board\n" - " CTRL-E -- on a blank line, enter paste mode\n" - "\n" - "For further help on a specific object, type help(obj)\n" - "For a list of available modules, type help('modules')\n" -; diff --git a/ports/nrf/help.c b/ports/nrf/help.c index afc979130f..b9ab16da62 100644 --- a/ports/nrf/help.c +++ b/ports/nrf/help.c @@ -34,7 +34,7 @@ const char nrf5_help_text[] = "Welcome to MicroPython!\n" "\n" - "For online help please visit http://micropython.org/help/.\n" + "For online docs please visit http://docs.micropython.org/\n" "\n" "Quick overview of commands for the board:\n" #if MICROPY_HW_HAS_LED diff --git a/ports/renesas-ra/help.c b/ports/renesas-ra/help.c index 3bce504d9c..48a06af348 100644 --- a/ports/renesas-ra/help.c +++ b/ports/renesas-ra/help.c @@ -30,7 +30,7 @@ const char ra_help_text[] = "Welcome to MicroPython for Renesas RA!\n" "\n" - "For online docs please visit http://docs.micropython.org/.\n" + "For online docs please visit http://docs.micropython.org/\n" "\n" "For access to hardware please use machine module.\n" "import machine\n" diff --git a/ports/rp2/CMakeLists.txt b/ports/rp2/CMakeLists.txt index 4d0de92182..3dff0d54c6 100644 --- a/ports/rp2/CMakeLists.txt +++ b/ports/rp2/CMakeLists.txt @@ -114,6 +114,7 @@ set(MICROPY_SOURCE_DRIVERS set(MICROPY_SOURCE_PORT fatfs_port.c + help.c machine_adc.c machine_bitstream.c machine_i2c.c diff --git a/ports/rp2/help.c b/ports/rp2/help.c new file mode 100644 index 0000000000..5546411e6d --- /dev/null +++ b/ports/rp2/help.c @@ -0,0 +1,64 @@ +/* + * This file is part of the MicroPython project, http://micropython.org/ + * + * The MIT License (MIT) + * + * Copyright (c) 2023 Damien P. George + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +#include "py/builtin.h" + +const char rp2_help_text[] = + "Welcome to MicroPython!\n" + "\n" + "For online docs please visit http://docs.micropython.org/\n" + "\n" + "For access to the hardware use the 'machine' module. RP2 specific commands\n" + "are in the 'rp2' module.\n" + "\n" + "Quick overview of some objects:\n" + " machine.Pin(pin) -- get a pin, eg machine.Pin(0)\n" + " machine.Pin(pin, m, [p]) -- get a pin and configure it for IO mode m, pull mode p\n" + " methods: init(..), value([v]), high(), low(), irq(handler)\n" + " machine.ADC(pin) -- make an analog object from a pin\n" + " methods: read_u16()\n" + " machine.PWM(pin) -- make a PWM object from a pin\n" + " methods: deinit(), freq([f]), duty_u16([d]), duty_ns([d])\n" + " machine.I2C(id) -- create an I2C object (id=0,1)\n" + " methods: readfrom(addr, buf, stop=True), writeto(addr, buf, stop=True)\n" + " readfrom_mem(addr, memaddr, arg), writeto_mem(addr, memaddr, arg)\n" + " machine.SPI(id, baudrate=1000000) -- create an SPI object (id=0,1)\n" + " methods: read(nbytes, write=0x00), write(buf), write_readinto(wr_buf, rd_buf)\n" + " machine.Timer(freq, callback) -- create a software timer object\n" + " eg: machine.Timer(freq=1, callback=lambda t:print(t))\n" + "\n" + "Pins are numbered 0-29, and 26-29 have ADC capabilities\n" + "Pin IO modes are: Pin.IN, Pin.OUT, Pin.ALT\n" + "Pin pull modes are: Pin.PULL_UP, Pin.PULL_DOWN\n" + "\n" + "Useful control commands:\n" + " CTRL-C -- interrupt a running program\n" + " CTRL-D -- on a blank line, do a soft reset of the board\n" + " CTRL-E -- on a blank line, enter paste mode\n" + "\n" + "For further help on a specific object, type help(obj)\n" + "For a list of available modules, type help('modules')\n" +; diff --git a/ports/rp2/main.c b/ports/rp2/main.c index 0ecc09b346..c5118857a4 100644 --- a/ports/rp2/main.c +++ b/ports/rp2/main.c @@ -260,40 +260,3 @@ uint32_t rosc_random_u32(void) { } return value; } - -const char rp2_help_text[] = - "Welcome to MicroPython!\n" - "\n" - "For online help please visit https://micropython.org/help/.\n" - "\n" - "For access to the hardware use the 'machine' module. RP2 specific commands\n" - "are in the 'rp2' module.\n" - "\n" - "Quick overview of some objects:\n" - " machine.Pin(pin) -- get a pin, eg machine.Pin(0)\n" - " machine.Pin(pin, m, [p]) -- get a pin and configure it for IO mode m, pull mode p\n" - " methods: init(..), value([v]), high(), low(), irq(handler)\n" - " machine.ADC(pin) -- make an analog object from a pin\n" - " methods: read_u16()\n" - " machine.PWM(pin) -- make a PWM object from a pin\n" - " methods: deinit(), freq([f]), duty_u16([d]), duty_ns([d])\n" - " machine.I2C(id) -- create an I2C object (id=0,1)\n" - " methods: readfrom(addr, buf, stop=True), writeto(addr, buf, stop=True)\n" - " readfrom_mem(addr, memaddr, arg), writeto_mem(addr, memaddr, arg)\n" - " machine.SPI(id, baudrate=1000000) -- create an SPI object (id=0,1)\n" - " methods: read(nbytes, write=0x00), write(buf), write_readinto(wr_buf, rd_buf)\n" - " machine.Timer(freq, callback) -- create a software timer object\n" - " eg: machine.Timer(freq=1, callback=lambda t:print(t))\n" - "\n" - "Pins are numbered 0-29, and 26-29 have ADC capabilities\n" - "Pin IO modes are: Pin.IN, Pin.OUT, Pin.ALT\n" - "Pin pull modes are: Pin.PULL_UP, Pin.PULL_DOWN\n" - "\n" - "Useful control commands:\n" - " CTRL-C -- interrupt a running program\n" - " CTRL-D -- on a blank line, do a soft reset of the board\n" - " CTRL-E -- on a blank line, enter paste mode\n" - "\n" - "For further help on a specific object, type help(obj)\n" - "For a list of available modules, type help('modules')\n" -; diff --git a/ports/samd/help.c b/ports/samd/help.c index 577d153b53..c7d96ad2d9 100644 --- a/ports/samd/help.c +++ b/ports/samd/help.c @@ -29,7 +29,7 @@ const char samd_help_text[] = "Welcome to MicroPython!\n" "\n" - "For online docs please visit http://docs.micropython.org/en/latest/samd/ .\n" + "For online docs please visit http://docs.micropython.org/\n" "\n" "Control commands:\n" " CTRL-A -- on a blank line, enter raw REPL mode\n" diff --git a/ports/stm32/factoryreset.c b/ports/stm32/factoryreset.c index 2ac656db59..50854a908b 100644 --- a/ports/stm32/factoryreset.c +++ b/ports/stm32/factoryreset.c @@ -75,7 +75,7 @@ static const char fresh_readme_txt[] = " - Mac OS X: use the command: screen /dev/tty.usbmodem*\r\n" " - Linux: use the command: screen /dev/ttyACM0\r\n" "\r\n" - "Please visit http://micropython.org/help/ for further help.\r\n" + "For online docs please visit http://docs.micropython.org/\r\n" ; #endif diff --git a/ports/stm32/help.c b/ports/stm32/help.c index fba0a6937f..0b824e7b37 100644 --- a/ports/stm32/help.c +++ b/ports/stm32/help.c @@ -29,7 +29,7 @@ const char stm32_help_text[] = "Welcome to MicroPython!\n" "\n" - "For online help please visit http://micropython.org/help/.\n" + "For online docs please visit http://docs.micropython.org/\n" "\n" "Quick overview of commands for the board:\n" " pyb.info() -- print some general information\n" diff --git a/ports/teensy/help.c b/ports/teensy/help.c index 11625afc5a..e2857aedfd 100644 --- a/ports/teensy/help.c +++ b/ports/teensy/help.c @@ -29,7 +29,7 @@ const char teensy_help_text[] = "Welcome to MicroPython!\n" "\n" - "For online help please visit http://micropython.org/help/.\n" + "For online docs please visit http://docs.micropython.org/\n" "\n" "Quick overview of commands for the board:\n" " pyb.info() -- print some general information\n" diff --git a/ports/zephyr/help.c b/ports/zephyr/help.c index 4ee674b9d2..0b977fa033 100644 --- a/ports/zephyr/help.c +++ b/ports/zephyr/help.c @@ -29,6 +29,8 @@ const char zephyr_help_text[] = "Welcome to MicroPython!\n" "\n" + "For online docs please visit http://docs.micropython.org/\n" + "\n" "Control commands:\n" " CTRL-A -- on a blank line, enter raw REPL mode\n" " CTRL-B -- on a blank line, enter normal REPL mode\n"