Received-SPF: pass (google.com: domain of linux-kernel+bounces-59162-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Date: Fri, 9 Feb 2024 01:38:44 -0800
From: Breno Leitao <leitao@debian.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Thorsten Blum <thorsten.blum@toblux.com>, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Vegard Nossum <vegard.nossum@oracle.com>
Subject: Re: [PATCH] docs: Makefile: Fix make cleandocs by deleting generated
 .rst files
Message-ID: <ZcXypIwlSZnH/kTf@gmail.com>
References: <20240208145001.61769-1-thorsten.blum@toblux.com>
 <87a5oafu1z.fsf@meer.lwn.net>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <87a5oafu1z.fsf@meer.lwn.net>

On Thu, Feb 08, 2024 at 03:52:08PM -0700, Jonathan Corbet wrote:
> Thorsten Blum <thorsten.blum@toblux.com> writes:
> 
> > The script tools/net/ynl/ynl-gen-rst.py (YNL_TOOL) generates several .rst
> > files (YNL_INDEX, YNL_RST_FILES) in Documentation/networking/netlink_spec
> > (YNL_RST_DIR) which are not deleted by make cleandocs.
> >
> > Fix make cleandocs by deleting the generated .rst files.
> >
> > Signed-off-by: Thorsten Blum <thorsten.blum@toblux.com>
> > ---
> >  Documentation/Makefile | 1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/Documentation/Makefile b/Documentation/Makefile
> > index 3885bbe260eb..4479910166fc 100644
> > --- a/Documentation/Makefile
> > +++ b/Documentation/Makefile
> > @@ -176,6 +176,7 @@ refcheckdocs:
> >  	$(Q)cd $(srctree);scripts/documentation-file-ref-check
> >  
> >  cleandocs:
> > +	$(Q)rm -f $(YNL_INDEX) $(YNL_RST_FILES)

I haven't check but I _think_ that just deleting $(YNL_INDEX) is enough
here, since $(YNL_INDEX) depends on $(YNL_RST_FILES).

> >  	$(Q)rm -rf $(BUILDDIR)
> >  	$(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean
> 
> So this seems worth doing ... except that there has been talk about not
> depositing those files into the source tree in the first place.  Adding
> Vegard and Breno to see if they have any thoughts on the matter...

Agree. This is definitely worth doing.