From: David Sterba <dsterba@suse.cz>
To: Qu Wenruo <wqu@suse.com>
Cc: linux-btrfs@vger.kernel.org
Subject: Re: [PATCH] btrfs-progs: fix documentation build due to phony contents.rst
Date: Mon, 29 Apr 2024 19:24:05 +0200 [thread overview]
Message-ID: <20240429172405.GI2585@twin.jikos.cz> (raw)
In-Reply-To: <8018c8dd90b26bcf9bdf1d76d731022b85147be1.1714086020.git.wqu@suse.com>
On Fri, Apr 26, 2024 at 08:30:22AM +0930, Qu Wenruo wrote:
> [BUG]
> Since commit 8049446bb0ba ("btrfs-progs: docs: placeholder for
> contents.rst file on older sphinx version"), on systems with much newer
> sphinx-build, "make" would not work for Documentation directory:
>
> $ make clean-all && ./autogen.sh && ./configure --prefix=/usr/ && make -j12
> $ ls -alh Documentation/_build
> ls: cannot access 'Documentation/_build': No such file or directory
>
> The sphinx-build has a much newer version:
>
> $ sphinx-build --version
> sphinx-build 7.2.6
>
> [CAUSE]
> On systems which doesn't need the workaround, the phony target of
> contents.rst seems to cause a dependency loop:
>
> GNU Make 4.4.1
> Built for x86_64-pc-linux-gnu
> Copyright (C) 1988-2023 Free Software Foundation, Inc.
> License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
> This is free software: you are free to change and redistribute it.
> There is NO WARRANTY, to the extent permitted by law.
> Reading makefiles...
> Reading makefile 'Makefile'...
> Updating makefiles....
> Considering target file 'Makefile'.
> Looking for an implicit rule for 'Makefile'.
> Trying pattern rule '%:' with stem 'Makefile'.
> Found implicit rule '%:' for 'Makefile'.
> Finished prerequisites of target file 'Makefile'.
> No need to remake target 'Makefile'.
> Updating goal targets....
> Considering target file 'contents.rst'.
> File 'contents.rst' does not exist.
> Finished prerequisites of target file 'contents.rst'.
> Must remake target 'contents.rst'.
> Makefile:35: update target 'contents.rst' due to: target is .PHONY
> if [ "$(sphinx-build --version | cut -d' ' -f2)" \< "1.7.7" ]; then \
> touch contents.rst; \
> fi
> Putting child 0x64ee81960130 (contents.rst) PID 66833 on the chain.
> Live child 0x64ee81960130 (contents.rst) PID 66833
> Reaping winning child 0x64ee81960130 PID 66833
> Removing child 0x64ee81960130 PID 66833 from chain.
> Successfully remade target file 'contents.rst'.
>
> All the default make doing is just try to generate contents.rst, but
> since we have much newer version, we won't generate the file at all.
>
> [FIX]
> Instead of a phony target, just move the contents.rst generation into
> man page target so that we won't cause loop target on contents.rst.
>
> Fixes: 8049446bb0ba ("btrfs-progs: docs: placeholder for contents.rst file on older sphinx version")
> Signed-off-by: Qu Wenruo <wqu@suse.com>
Added to devel, thanks.
prev parent reply other threads:[~2024-04-29 17:31 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-25 23:00 [PATCH] btrfs-progs: fix documentation build due to phony contents.rst Qu Wenruo
2024-04-29 17:24 ` David Sterba [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240429172405.GI2585@twin.jikos.cz \
--to=dsterba@suse.cz \
--cc=linux-btrfs@vger.kernel.org \
--cc=wqu@suse.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).