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: <20211026171804.2867369-1-robh@kernel.org> <8c6d5a97-14f7-9155-6f90-17e6e33d77c2@lucaceresoli.net>
In-Reply-To: <8c6d5a97-14f7-9155-6f90-17e6e33d77c2@lucaceresoli.net>
From:   Rob Herring <robh@kernel.org>
Date:   Wed, 27 Oct 2021 08:53:23 -0500
Message-ID: <CAL_JsqLij-yhUJ1+rKODzs2rSKepUDgWUxBwvEu8f_mvKqm5xQ@mail.gmail.com>
Subject: Re: [PATCH] dt-bindings: Add a help message when dtschema tools are missing
To:     Luca Ceresoli <luca@lucaceresoli.net>
Cc:     devicetree@vger.kernel.org,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        Masahiro Yamada <masahiroy@kernel.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Wed, Oct 27, 2021 at 2:30 AM Luca Ceresoli <luca@lucaceresoli.net> wrote:
>
> Hi Rob,
>
> thanks for this patch!
>
> On 26/10/21 19:18, Rob Herring wrote:
> > The dtschema version check works, but is not that clear when dtschema is
> > neither installed nor in the PATH. Add a separate check and message if
>
> Nit: I think it should say "either not installed or not in the PATH".

Right.

>
> > dt-doc-validate is not found.
> >
> > Cc: Luca Ceresoli <luca@lucaceresoli.net>
> > Cc: Masahiro Yamada <masahiroy@kernel.org>
> > Signed-off-by: Rob Herring <robh@kernel.org>
> > ---
> >  Documentation/devicetree/bindings/Makefile | 4 ++++
> >  1 file changed, 4 insertions(+)
> >
> > diff --git a/Documentation/devicetree/bindings/Makefile b/Documentation/devicetree/bindings/Makefile
> > index 8d6d912c6a6a..001b4f62b741 100644
> > --- a/Documentation/devicetree/bindings/Makefile
> > +++ b/Documentation/devicetree/bindings/Makefile
> > @@ -9,6 +9,10 @@ DT_SCHEMA_MIN_VERSION = 2021.2.1
> >
> >  PHONY += check_dtschema_version
> >  check_dtschema_version:
> > +     @which $(DT_DOC_CHECKER) >/dev/null || \
> > +             { echo "Error: '$(DT_DOC_CHECKER)' not found!" \
> > +             "\nEnsure dtschema python package is installed and in your PATH." \
> > +             "\nCurrent PATH is:\n$$PATH\n" >&2; false; }
>
> You need 'echo -e' for the '\n'.

Except dash will just print '-e' and interpret the newlines...

I changed it like this:

@which $(DT_DOC_CHECKER) >/dev/null || \
{ echo "Error: '$(DT_DOC_CHECKER)' not found!" >&2; \
  echo "Ensure dtschema python package is installed and in your PATH." >&2; \
  echo "Current PATH is:" >&2; \
  echo "$$PATH" >&2; false; }

Rob