On Thu, Jan 16, 2020 at 01:04:07PM +0800, Qu Wenruo wrote: > Relocation is one of the most complex part of btrfs, while it's also the > foundation stone for online resizing, profile converting. > > For such a complex facility, we should at least have some introduction > to it. > > This patch will add an basic introduction at pretty a high level, > explaining: > - What relocation does > - How relocation is done > Only mentioning how data reloc tree and reloc tree are involved in the > operation. > No details like the backref cache, or the data reloc tree contents. > - Which function to refer. > > More detailed comments will be added for reloc tree creation, data reloc > tree creation and backref cache. > > For now the introduction should save reader some time before digging > into the rabbit hole. > > Signed-off-by: Qu Wenruo <wqu@xxxxxxxx> > --- > Changelog: > v2: > - New line after section title to improve readability > - Don't mention "to relocate some extents" part for the objective. > As that only happens for error case. > - Grammar fix. Added to misc-next, thanks. For documenation, please try to spell out all abbreviations or short forms. For example 'bg' is 'block group' and RO is 'read-only', etc.
