[PATCH] STM32F4 GPIO: Remove old comments

Gedare Bloom gedare at rtems.org
Wed Jul 6 14:40:50 UTC 2022


Hi Duc,

Save incremental patches like this for a second round of review. We
consider each patch set sent as an "atomic unit" for reviewing, but
this patch doesn't make any sense unless the previous patches you
already sent have been applied.

When you do send your next round of patches, be sure to use the -v2 to
identify versioning of patch sets:
https://docs.rtems.org/branches/master/eng/vc-users.html#creating-a-patch

On Wed, Jul 6, 2022 at 5:14 AM Duc Doan <dtbpkmte at gmail.com> wrote:
>
> ---
>  bsps/arm/stm32f4/gpio/gpio.c | 14 --------------
>  1 file changed, 14 deletions(-)
>
> diff --git a/bsps/arm/stm32f4/gpio/gpio.c b/bsps/arm/stm32f4/gpio/gpio.c
> index b632236d8d..8e3f7c7131 100644
> --- a/bsps/arm/stm32f4/gpio/gpio.c
> +++ b/bsps/arm/stm32f4/gpio/gpio.c
> @@ -330,11 +330,6 @@ rtems_status_code stm32f4_gpio_deinit(rtems_gpio *base) {
>      return RTEMS_SUCCESSFUL;
>  }
>
> -/**
> -  * @note Warning: only one pin can be passed as argument
> -  * @note If using interrupt mode, use rtems_gpio_configure_interrupt().
> -  * @note If using alternate mode, use rtems_gpio_configure().
> -  */
You probably do want to have some kind of documentation though.
Hopefully you have Doxygen in the header file.

>  rtems_status_code stm32f4_gpio_set_pin_mode(
>      rtems_gpio *base,
>      rtems_gpio_pin_mode mode
> @@ -374,9 +369,6 @@ rtems_status_code stm32f4_gpio_set_pin_mode(
>      return RTEMS_SUCCESSFUL;
>  }
>
> -/**
> -  * @note Warning: only one pin can be passed as argument
> -  */
>  rtems_status_code stm32f4_gpio_set_pull(
>      rtems_gpio *base,
>      rtems_gpio_pull pull
> @@ -404,12 +396,6 @@ rtems_status_code stm32f4_gpio_set_pull(
>      return RTEMS_SUCCESSFUL;
>  }
>
> -/**
> -  * TODO
> -  *
> -  * @note This function defaults to not using pull resistor.
> -  *       Use rtems_gpio_set_pull() afterwards to change.
> -  */
>  rtems_status_code stm32f4_gpio_configure_interrupt(
>      rtems_gpio *base,
>      rtems_gpio_isr isr,
> --
> 2.36.1
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel


More information about the devel mailing list