Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20210601183002.26176586@canb.auug.org.au> <CACK8Z6Fp-_oRkC-dQ4U5y6ZUrr7Q3U084PiP+Q9daYstpps+aA@mail.gmail.com>
 <YLosn8r6pg4AUC14@kroah.com>
In-Reply-To: <YLosn8r6pg4AUC14@kroah.com>
From:   Rajat Jain <rajatja@google.com>
Date:   Tue, 13 Jul 2021 14:03:23 -0700
Message-ID: <CACK8Z6GGXXv3G6po5Adfsw7=vHMij7Cpxu2mwjRmCDT70mkGhw@mail.gmail.com>
Subject: Re: linux-next: build warning after merge of the usb tree
To:     Greg KH <greg@kroah.com>, Jonathan Corbet <corbet@lwn.net>,
        linux-doc@vger.kernel.org
Cc:     Stephen Rothwell <sfr@canb.auug.org.au>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
        Linux Next Mailing List <linux-next@vger.kernel.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

+linux-doc@vger.kernel.org
+Jonathan Corbet

Hi Jonathan / kernel-docs people,

On Fri, Jun 4, 2021 at 6:37 AM Greg KH <greg@kroah.com> wrote:
>
> On Tue, Jun 01, 2021 at 10:39:42AM -0700, Rajat Jain wrote:
> > Hello,
> >
> >
> > On Tue, Jun 1, 2021 at 1:30 AM Stephen Rothwell <sfr@canb.auug.org.au> wrote:
> > >
> > > Hi all,
> > >
> > > After merging the usb tree, today's linux-next build (htmldocs) produced
> > > this warning:
> > >
> > > Documentation/ABI/testing/sysfs-devices-removable:2: WARNING: Unexpected indentation.
> > > Documentation/ABI/testing/sysfs-devices-removable:2: WARNING: Block quote ends without a blank line; unexpected unindent.
> >
> > I'd be happy to send a patch to fix this, but I didn't really
> > understand what needs to be done.
> >
> > Here is the relevant documentation update in the patch:
> >
> > +What:          /sys/devices/.../removable
> > +Date:          May 2021
> > +Contact:       Rajat Jain <rajatxjain@gmail.com>
> > +Description:
> > +               Information about whether a given device can be removed from the
> > +               platform by the user. This is determined by its subsystem in a
> > +               bus / platform-specific way. This attribute is only present for
> > +               devices that can support determining such information:
> > +
> > +               "removable": device can be removed from the platform by the user
> > +               "fixed":     device is fixed to the platform / cannot be removed
> > +                            by the user.
> > +               "unknown":   The information is unavailable / cannot be deduced.
> > +
> > +               Currently this is only supported by USB (which infers the
> > +               information from a combination of hub descriptor bits and
> > +               platform-specific data such as ACPI).
> >
> > I'd be happy to send a patch if you can point me what needs to be done
> > (or let Stephen / Greg / some one else do it if it is easier to just
> > do it instead of guiding me).
>
> I do not know what the "right" thing to do here is, sorry.  Maybe one of
> the kerneldoc people know?

Can someone familiar with the documentation and html docs let me know
what is wrong with Documentation/ABI/testing/sysfs-devices-removable
that is resulting in this warning when doing "make htmldocs":

> > > Documentation/ABI/testing/sysfs-devices-removable:2: WARNING: Unexpected indentation.
> > > Documentation/ABI/testing/sysfs-devices-removable:2: WARNING: Block quote ends without a blank line; unexpected unindent.

I looked at the file line number 2 and it just seems inline with other
similar files in that documentation folder.

Thanks,

Rajat

> >
>
> greg k-h