[PATCH] platform/surface: aggregator: Fix kernel-doc references

[PATCH] platform/surface: aggregator: Fix kernel-doc references

[Maximilian Luz]

Both, ssh_rtl_rx_start() and ssh_rtl_tx_start() functions, do not exist
and have been consolidated into ssh_rtl_start(). Nevertheless,
kernel-doc references the former functions. Replace those references
with references to ssh_rtl_start().

Signed-off-by: Maximilian Luz <luzmaximilian@gmail.com>
---

Note: This patch does not change the kernel doc at the ssh_rtl_start()
itself, as there is already another patch for it:

  "platform/surface: aggregator: fix a kernel-doc markup"
  https://lore.kernel.org/patchwork/patch/1364953/

---
 drivers/platform/surface/aggregator/ssh_request_layer.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/drivers/platform/surface/aggregator/ssh_request_layer.c b/drivers/platform/surface/aggregator/ssh_request_layer.c
index bb1c862411a2..4fbe58265e31 100644
--- a/drivers/platform/surface/aggregator/ssh_request_layer.c
+++ b/drivers/platform/surface/aggregator/ssh_request_layer.c
@@ -1004,9 +1004,8 @@ int ssh_request_init(struct ssh_request *rqst, enum ssam_request_flags flags,
  *
  * Initializes the given request transport layer and associated packet
  * transport layer. Transmitter and receiver threads must be started
- * separately via ssh_rtl_tx_start() and ssh_rtl_rx_start(), after the
- * request-layer has been initialized and the lower-level serial device layer
- * has been set up.
+ * separately via ssh_rtl_start(), after the request-layer has been
+ * initialized and the lower-level serial device layer has been set up.
  *
  * Return: Returns zero on success and a nonzero error code on failure.
  */
-- 
2.30.0

Re: [PATCH] platform/surface: aggregator: Fix kernel-doc references

[Hans de Goede]

Hi,

On 1/14/21 4:08 PM, Maximilian Luz wrote:
> Both, ssh_rtl_rx_start() and ssh_rtl_tx_start() functions, do not exist
> and have been consolidated into ssh_rtl_start(). Nevertheless,
> kernel-doc references the former functions. Replace those references
> with references to ssh_rtl_start().
> 
> Signed-off-by: Maximilian Luz <luzmaximilian@gmail.com>

Thank you for your patch, I've applied this patch to my review-hans 
branch:
https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans

Note it will show up in my review-hans branch once I've pushed my
local branch there, which might take a while.

Once I've run some tests on this branch the patches there will be
added to the platform-drivers-x86/for-next branch and eventually
will be included in the pdx86 pull-request to Linus for the next
merge-window.

Regards,

Hans

> ---
> 
> Note: This patch does not change the kernel doc at the ssh_rtl_start()
> itself, as there is already another patch for it:
> 
>   "platform/surface: aggregator: fix a kernel-doc markup"
>   https://lore.kernel.org/patchwork/patch/1364953/
> 
> ---
>  drivers/platform/surface/aggregator/ssh_request_layer.c | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/platform/surface/aggregator/ssh_request_layer.c b/drivers/platform/surface/aggregator/ssh_request_layer.c
> index bb1c862411a2..4fbe58265e31 100644
> --- a/drivers/platform/surface/aggregator/ssh_request_layer.c
> +++ b/drivers/platform/surface/aggregator/ssh_request_layer.c
> @@ -1004,9 +1004,8 @@ int ssh_request_init(struct ssh_request *rqst, enum ssam_request_flags flags,
>   *
>   * Initializes the given request transport layer and associated packet
>   * transport layer. Transmitter and receiver threads must be started
> - * separately via ssh_rtl_tx_start() and ssh_rtl_rx_start(), after the
> - * request-layer has been initialized and the lower-level serial device layer
> - * has been set up.
> + * separately via ssh_rtl_start(), after the request-layer has been
> + * initialized and the lower-level serial device layer has been set up.
>   *
>   * Return: Returns zero on success and a nonzero error code on failure.
>   */
>