commit | 40588d4aa94769680cfc9c40bfdce7ad4f4989bf | [log] [tgz] |
---|---|---|
author | Qu Wenruo <wqu@suse.com> | Fri Apr 26 08:30:22 2024 +0930 |
committer | David Sterba <dsterba@suse.com> | Tue Apr 30 21:49:15 2024 +0200 |
tree | 7ac59d7253f40796278033dbc3ee8d2f17ba8327 | |
parent | 152c70894417121d43406270bb9f4815e7089b74 [diff] |
btrfs-progs: docs: fix build due to phony contents.rst [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 don'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> Signed-off-by: David Sterba <dsterba@suse.com>
Userspace utilities to manage btrfs filesystems. License: GPLv2.
Btrfs is a copy on write (COW) filesystem for Linux aimed at implementing advanced features while focusing on fault tolerance, repair and easy administration.
This repository hosts following utilities and also documentation:
See INSTALL for build instructions, tests/README.md for testing information and ci/README.md for CI information.
The major version releases are time-based and follow the cycle of the linux kernel releases. The cycle usually takes 2 months. A minor version releases may happen in the meantime if there are bug fixes or minor useful improvements queued.
The release tags are signed with a GPG key ID F2B4 1200 C54E FB30 380C 1756 C565 D5F9 D76D 583B
, release tarballs are hosted at kernel.org. See file CHANGES or changelogs on RTD.
Releases with changelog are also published at Github release page.
For each release there are static binaries of btrfs
and btrfs.box
provided. These can be used in rescue environments and are built for x86_64
architecture (with maximum backward compatibility), inside the Github Actions workflow. The btrfs.box
is an all-in-one tool in the busybox style, the functionality is determined by the binary names (either symlink, hradlink or a file copy).
The btrfs-progs of version X.Y declare support of kernel features of the same version. New progs on old kernel are expected to work, limited only by features provided by the kernel.
Build is supported on the GNU C library as the primary target, and on the musl libc.
The supported compilers are gcc (minimal version 4.8) and clang (minimal version 3.4).
Build tests are done on several distributions, see Github actions workflow.
There are several ways, each has its own specifics and audience that can give feedback or work on a fix. The following list is sorted in the order of preference:
The development takes place in the mailing list (linux-btrfs@vger.kernel.org) or at Github (issues, pull requests). Changes should be split to logical parts if possible, documentation may be included in the same patch as to code or separately.
The development model of btrfs-progs shares a lot with the kernel model. The
git log --oneline
for some inspirationThe pull requests on Github may be used for code or documentation contributions. There are basic build checks enabled in the Github actions CI for pull requests. The status can be checked at the workflow page.
[skip ci]
to the changelogSource code coding style and preferences follow the kernel coding style. You can find the editor settings in .editorconfig
and use the EditorConfig plugin to let your editor use that, or update your editor settings manually.
The documentation for writing and running tests can be found in tests/ and continuous integration/container images in ci/.
Development branches are tested by Github Action workflows.
Code coverage provided by codecov.io can be found here.
Documentation fixes or updates do not need much explanation so sticking to the code rules in the previous section is not necessary. GitHub pull requests are OK, patches could be sent to me directly and not required to be also in the mailing list. Pointing out typos via IRC also works, although might get accidentally lost in the noise.
Documentation sources are written in RST and built by sphinx.
Build dependencies are listed in INSTALL. Implementation of checksum/hash functions is provided by copies of the respective sources to avoid adding dependencies that would make deployments in rescue or limited environments harder. The implementations are portable and there are optimized versions for some architectures. Optionally it's possible to use libgcrypt, libsodium, libkcapi, Botan or OpenSSL implementations.
The builtin implemtations uses the following sources: CRC32C, XXHASH, SHA256, BLAKE2.
Some other code is borrowed from kernel, eg. the raid5 tables or data structure implementation (list, rb-tree).