| Message ID | 20240517165654.427746-1-arnaud.pouliquen@foss.st.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | rpmsg: char: fix rpmsg_eptdev structure documentation | expand |
On 5/17/2024 10:26 PM, Arnaud Pouliquen wrote: > Add missing @ tags for some rpmsg_eptdev structure parameters. > > This fixes warning messages on build: > drivers/rpmsg/rpmsg_char.c:75: warning: Function parameter or struct member 'remote_flow_restricted' not described in 'rpmsg_eptdev' > drivers/rpmsg/rpmsg_char.c:75: warning: Function parameter or struct member 'remote_flow_updated' not described in 'rpmsg_eptdev' > > Fixes: 5550201c0fe2 ("rpmsg: char: Add RPMSG GET/SET FLOWCONTROL IOCTL support") > > Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com> Reviewed-by: Mukesh Ojha <quic_mojha@quicinc.com> -Mukesh
On Fri, May 17, 2024 at 06:56:54PM +0200, Arnaud Pouliquen wrote: > Add missing @ tags for some rpmsg_eptdev structure parameters. > > This fixes warning messages on build: > drivers/rpmsg/rpmsg_char.c:75: warning: Function parameter or struct member 'remote_flow_restricted' not described in 'rpmsg_eptdev' > drivers/rpmsg/rpmsg_char.c:75: warning: Function parameter or struct member 'remote_flow_updated' not described in 'rpmsg_eptdev' > > Fixes: 5550201c0fe2 ("rpmsg: char: Add RPMSG GET/SET FLOWCONTROL IOCTL support") > > Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com> > --- > drivers/rpmsg/rpmsg_char.c | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/drivers/rpmsg/rpmsg_char.c b/drivers/rpmsg/rpmsg_char.c > index 1cb8d7474428..98d95ce5b6fb 100644 > --- a/drivers/rpmsg/rpmsg_char.c > +++ b/drivers/rpmsg/rpmsg_char.c > @@ -52,8 +52,8 @@ static DEFINE_IDA(rpmsg_minor_ida); > * @readq: wait object for incoming queue > * @default_ept: set to channel default endpoint if the default endpoint should be re-used > * on device open to prevent endpoint address update. > - * remote_flow_restricted: to indicate if the remote has requested for flow to be limited > - * remote_flow_updated: to indicate if the flow control has been requested > + * @remote_flow_restricted: to indicate if the remote has requested for flow to be limited > + * @remote_flow_updated: to indicate if the flow control has been requested I will apply this patch next week when rc1 comes out. Thanks, Mathieu > */ > struct rpmsg_eptdev { > struct device dev; > -- > 2.25.1 >
diff --git a/drivers/rpmsg/rpmsg_char.c b/drivers/rpmsg/rpmsg_char.c index 1cb8d7474428..98d95ce5b6fb 100644 --- a/drivers/rpmsg/rpmsg_char.c +++ b/drivers/rpmsg/rpmsg_char.c @@ -52,8 +52,8 @@ static DEFINE_IDA(rpmsg_minor_ida); * @readq: wait object for incoming queue * @default_ept: set to channel default endpoint if the default endpoint should be re-used * on device open to prevent endpoint address update. - * remote_flow_restricted: to indicate if the remote has requested for flow to be limited - * remote_flow_updated: to indicate if the flow control has been requested + * @remote_flow_restricted: to indicate if the remote has requested for flow to be limited + * @remote_flow_updated: to indicate if the flow control has been requested */ struct rpmsg_eptdev { struct device dev;
Add missing @ tags for some rpmsg_eptdev structure parameters. This fixes warning messages on build: drivers/rpmsg/rpmsg_char.c:75: warning: Function parameter or struct member 'remote_flow_restricted' not described in 'rpmsg_eptdev' drivers/rpmsg/rpmsg_char.c:75: warning: Function parameter or struct member 'remote_flow_updated' not described in 'rpmsg_eptdev' Fixes: 5550201c0fe2 ("rpmsg: char: Add RPMSG GET/SET FLOWCONTROL IOCTL support") Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com> --- drivers/rpmsg/rpmsg_char.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)