btrfs: add comments for btrfs_reserve_flush_enum
authorQu Wenruo <wqu@suse.com>
Mon, 13 Jul 2020 01:03:22 +0000 (09:03 +0800)
committerDavid Sterba <dsterba@suse.com>
Mon, 27 Jul 2020 10:55:45 +0000 (12:55 +0200)
commitfd7fb634d69a7d8c91aa3166b77351b96954aae4
treee6dc66d37a98573aa2733e94cd7f79e887a612df
parent44d354abf33e92a5e73b965c84caf5a5d5e58a0b
btrfs: add comments for btrfs_reserve_flush_enum

This enum is the interface exposed to developers.

Although we have a detailed comment explaining the whole idea of space
flushing at the beginning of space-info.c, the exposed enum interface
doesn't have any comment.

Some corner cases, like BTRFS_RESERVE_FLUSH_ALL and
BTRFS_RESERVE_FLUSH_ALL_STEAL can be interrupted by fatal signals, are
not explained at all.

So add some simple comments for these enums as a quick reference.

Signed-off-by: Qu Wenruo <wqu@suse.com>
Reviewed-by: David Sterba <dsterba@suse.com>
Signed-off-by: David Sterba <dsterba@suse.com>
fs/btrfs/ctree.h