On Wed, Apr 13, 2022 at 11:32:23AM +0530, Vinod Koul wrote:
> On 07-04-22, 12:21, Jules Maselbas wrote:
> > Update the syntax used by the documentation of phy operation functions.
> > This is to unify the syntax with the newly added documentation.
>
> Is there any reason for using this sytax, is it documented somewhere..?
> How does this syntax help?
I don't have any particular reason for this syntax, this syntax have been
suggested by Randy Dunlap.
>
> >
> > Signed-off-by: Jules Maselbas <jmaselbas@xxxxxxxxx>
> > ---
> > v2: new patch
> > v3: no change
> >
> > drivers/phy/phy-core.c | 6 +++---
> > 1 file changed, 3 insertions(+), 3 deletions(-)
> >
> > diff --git a/drivers/phy/phy-core.c b/drivers/phy/phy-core.c
> > index d1817a0f2d09..d11b517e283a 100644
> > --- a/drivers/phy/phy-core.c
> > +++ b/drivers/phy/phy-core.c
> > @@ -467,7 +467,7 @@ EXPORT_SYMBOL_GPL(phy_reset);
> > * runtime, which are otherwise lost after host controller reset and cannot
> > * be applied in phy_init() or phy_power_on().
> > *
> > - * Returns: 0 if successful, an negative error code otherwise
> > + * Return: %0 if successful, a negative error code otherwise
> > */
> > int phy_calibrate(struct phy *phy)
> > {
> > @@ -493,7 +493,7 @@ EXPORT_SYMBOL_GPL(phy_calibrate);
> > * on the phy. The configuration will be applied on the current phy
> > * mode, that can be changed using phy_set_mode().
> > *
> > - * Returns: 0 if successful, an negative error code otherwise
> > + * Return: %0 if successful, a negative error code otherwise
> > */
> > int phy_configure(struct phy *phy, union phy_configure_opts *opts)
> > {
> > @@ -527,7 +527,7 @@ EXPORT_SYMBOL_GPL(phy_configure);
> > * PHY, so calling it as many times as deemed fit will have no side
> > * effect.
> > *
> > - * Returns: 0 if successful, an negative error code otherwise
> > + * Return: %0 if successful, a negative error code otherwise
> > */
> > int phy_validate(struct phy *phy, enum phy_mode mode, int submode,
> > union phy_configure_opts *opts)
> > --
> > 2.17.1
> >
> >
> > --
> > linux-phy mailing list
> > linux-phy@xxxxxxxxxxxxxxxxxxx
> > https://lists.infradead.org/mailman/listinfo/linux-phy
>
> --
> ~Vinod
