summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Sterba <dsterba@suse.com>2016-11-10 18:31:53 +0100
committerDavid Sterba <dsterba@suse.com>2016-11-23 11:07:05 +0100
commitd8f93ce802c31dde2b936d0626b636dc070e118b (patch)
treeea9b151c434a5646c5487fbb4ad7e55e312acf09
parent776cd164b73092ec559a47080ff44aa22bad97a1 (diff)
btrfs-progs: Update README and other docs
Signed-off-by: David Sterba <dsterba@suse.com>
-rw-r--r--Documentation/ReleaseChecklist37
-rw-r--r--INSTALL27
-rw-r--r--README.md63
-rw-r--r--tests/README.md3
4 files changed, 107 insertions, 23 deletions
diff --git a/Documentation/ReleaseChecklist b/Documentation/ReleaseChecklist
new file mode 100644
index 0000000..d8bf50c
--- /dev/null
+++ b/Documentation/ReleaseChecklist
@@ -0,0 +1,37 @@
+Release checklist
+=================
+
+Last code touches:
+
+* make the code ready, collect patches queued for the release
+* look to mailinglist for any relevant last-minute fixes
+
+Pre-checks:
+
+* update package in OBS, (multi arch build checks)
+* submit sources to coverity
+* run all internal functional tests
+ * defaults
+ * D=asan
+ * D=ubsan
+* run all build tests
+* run with fstests
+
+Pre-release:
+
+* write CHANGES entry
+
+Release:
+
+* tag release, sign
+* make tar
+* build check of unpacked tar
+* upload tar to kernel.org
+* refresh git branches, push tags
+
+Post-release:
+
+* write and send announcement mail to mailinglist
+* update wiki://Main_page#News
+* update wiki://Changelog#btrfs-progs
+* update title on IRC
diff --git a/INSTALL b/INSTALL
index 85a839f..0465fb0 100644
--- a/INSTALL
+++ b/INSTALL
@@ -31,26 +31,27 @@ Building from sources
To build from git sources you need to generate the configure script using the
autotools:
- $ ./autogen.sh
+ $ ./autogen.sh
To build from the released tarballs:
- $ ./configure
- $ make
- $ make install
+ $ ./configure
+ $ make
+ $ make install
You may disable building some parts like documentation, btrfs-convert or
backtrace support. See ./configure --help for more.
Specific CFLAGS or LDFLAGS should be set like
- $ CFLAGS=... LDFLAGS=... ./configure --prefix=/usr
+ $ CFLAGS=... LDFLAGS=... ./configure --prefix=/usr
and not as arguments to make. You can specify additional flags to build via
variables EXTRA_CFLAGS and EXTRA_LDFLAGS that get appended to the predefined
-values of the respective variables.
+values of the respective variables. There are further build tuning options
+documented in the Makefile.
- $ make EXTRA_CFLAGS=-ggdb3
+ $ make EXTRA_CFLAGS=-ggdb3
The build utilizes autotools, dependencies for generating the configure
scripts are:
@@ -60,18 +61,18 @@ scripts are:
* pkg-config
-Staticly built binaries
------------------------
+Statically built binaries
+-------------------------
The makefiles are ready to let you build static binaries of the utilities. This
may be handy in rescue environments. Your system has to provide static version
of the libraries.
-$ make static
-$ make btrfs.static
-$ make btrfs-convert.static
+ $ make static
+ $ make btrfs.static
+ $ make btrfs-convert.static
-The resulting static binaries have the '.static' suffix, the intermediate object
+The resulting binaries have the '.static' suffix, the intermediate object
files do not conflict with the normal (dynamic) build.
diff --git a/README.md b/README.md
index 13a2c83..e5e3f29 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-Btrfs-progs [![build status](https://travis-ci.org/kdave/btrfs-progs.svg?branch=devel)](https://travis-ci.org/kdave/btrfs-progs)
+Btrfs-progs [![build status](https://travis-ci.org/kdave/btrfs-progs.svg?branch=devel)](https://travis-ci.org/kdave/btrfs-progs) [![coverity status](https://scan.coverity.com/projects/617/badge.svg)](https://scan.coverity.com/projects/btrfs-progs)
===========
Userspace utilities to manage btrfs filesystems.
@@ -14,28 +14,73 @@ This repository hosts following utilities:
* **btrfs** &mdash; the main administration tool ([manual page](https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs))
* **mkfs.btrfs** &mdash; utility to create the filesystem ([manual page](https://btrfs.wiki.kernel.org/index.php/Manpage/mkfs.btrfs))
-See INSTALL for build instructions.
+See INSTALL for build instructions and [tests/README.md](tests/README.md) for
+testing information.
Release cycle
-------------
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 queued bug fixes or minor useful
-improvements.
+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](https://www.kernel.org/pub/linux/kernel/people/kdave/btrfs-progs/).
+See file [CHANGES](CHANGES) or [changelogs on wiki](https://btrfs.wiki.kernel.org/index.php/Changelog#By_version_.28btrfs-progs.29).
+
+Reporting bugs
+--------------
+
+There are several ways, each has its own specifics and audience that can give
+feedback or work on a fix.
+
+* [bugzilla.kernel.org](https://bugzilla.kernel.org) -- (requires
+ registration), set the product to Filesystems and component Btrfs, please put
+ 'btrfs-progs' into the subject so it's clear that it's not a kernel bug
+ report
+* to the mailing list *linux-btrfs@vger.kernel.org* -- (not required to
+ subscribe), beware that the mail might get overlooked in other traffic
+* [github issue tracker](https://github.com/kdave/btrfs-sprogs/issues)
+* IRC (irc.freenode.net #btrfs) -- good for discussions eg. if a bug is already
+ known, but reports could miss developers' attention
+
Development
-----------
The patch submissions, development or general discussions take place at
-*linux-btrfs@vger.kernel.org* mailinglist, subsciption not required.
+*linux-btrfs@vger.kernel.org* mailinglist, subsciption is not required to post.
+
+The GitHub pull requests will not be accepted directly, the preferred way is to
+send patches to the mailinglist instead. You can link to a branch in any git
+repository if the mails do not make it to the mailinglist or just for
+convenience (makes it easier to test).
+
+The development model of btrfs-progs shares a lot with the kernel model. The
+github way is different in some ways. We, the upstream community, expect that
+the patches meet some criteria (often lacking in github contributions):
+
+* **one logical change per patch**: eg. not mixing bugfixes, cleanups, features
+ etc., sometimes it's not clear and will be usually pointed out during reviews
+* proper **subject line**: eg. prefix with _btrfs-progs: subpart, ..._ ,
+ descriptive yet not too long, see `git log --oneline` for some inspiration
+* proper **changelog**: the changelogs are often missing or lacking explanation _why_
+ the change was made, or _how_ is something broken, _what_ are user-visible
+ effects of the bug or the fix, _how_ does an improvement help or the intended
+ _usecase_
+* the **Signed-off-by** line: this documents who authored the change, you can read
+ more about the _The Developer's Certificate of Origin_ [here (chapter 11)](https://www.kernel.org/doc/Documentation/SubmittingPatches)
+
+**Exceptions**: documentation fixes or updates do not need much explanation so
+sticking to the above rules is not necessary. Github pull requests are OK.
References
----------
-* [Wiki with more information](https://btrfs.wiki.kernel.org)
-* [Btrfs-progs changelogs](https://btrfs.wiki.kernel.org/index.php/Changelog#By_version_.28btrfs-progs.29)
-* [wiki/FAQ](https://btrfs.wiki.kernel.org/index.php/FAQ)
+* [wiki/Developer's FAQ](https://btrfs.wiki.kernel.org/index.php/Developer's_FAQ)
* [wiki/Getting started](https://btrfs.wiki.kernel.org/index.php/Getting_started)
* [wiki/TODO](https://btrfs.wiki.kernel.org/index.php/Project_ideas#Userspace_tools_projects)
-* [wiki/Developer's FAQ](https://btrfs.wiki.kernel.org/index.php/Developer's_FAQ)
+* [Btrfs-progs changelogs](https://btrfs.wiki.kernel.org/index.php/Changelog#By_version_.28btrfs-progs.29)
+* [wiki/FAQ](https://btrfs.wiki.kernel.org/index.php/FAQ)
+* [Wiki with more information](https://btrfs.wiki.kernel.org)
diff --git a/tests/README.md b/tests/README.md
index f0d54d5..4866447 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -1,7 +1,8 @@
# Btrfs-progs tests
A testsuite covering functionality of btrfs-progs, ie. the checker, image, mkfs
-and similar tools. There are no special requirements on kernel features, the
+and similar tools. There are no additional requirements on kernel features
+(other than `CONFIG_BTRFS_FS` built-in or module), the
tests build on top of the core functionality like snapshots and device
management. In some cases optional features are turned on by mkfs and the
filesystem image could be mounted, such tests might fail if there's lack of