| Message ID | 20200301033344.808-2-marcos@mpdesouza.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | progs: fix testsuite | expand |
On 2020/3/1 上午11:33, Marcos Paulo de Souza wrote: > From: Marcos Paulo de Souza <mpdesouza@suse.com> > > btrfs-find-root and btrfs-select-super stopped to be shipped in 2014, so > remove all references to these manpages as well. Nope, my distro is still shipping it, and I find it kinda useful for certain recovery scenario. Thus it's better to keep their documents. Thanks, Qu > > Signed-off-by: Marcos Paulo de Souza <mpdesouza@suse.com> > --- > .gitignore | 2 - > Documentation/Makefile.in | 2 - > Documentation/btrfs-find-root.asciidoc | 35 ----------------- > Documentation/btrfs-select-super.asciidoc | 46 ----------------------- > Documentation/btrfs.asciidoc | 2 - > 5 files changed, 87 deletions(-) > delete mode 100644 Documentation/btrfs-find-root.asciidoc > delete mode 100644 Documentation/btrfs-select-super.asciidoc > > diff --git a/.gitignore b/.gitignore > index aadf9ae7..2b1c1aef 100644 > --- a/.gitignore > +++ b/.gitignore > @@ -73,7 +73,6 @@ > /Documentation/btrfs-convert.8 > /Documentation/btrfs-device.8 > /Documentation/btrfs-filesystem.8 > -/Documentation/btrfs-find-root.8 > /Documentation/btrfs-image.8 > /Documentation/btrfs-inspect-internal.8 > /Documentation/btrfs-ioctl.3 > @@ -87,7 +86,6 @@ > /Documentation/btrfs-rescue.8 > /Documentation/btrfs-restore.8 > /Documentation/btrfs-scrub.8 > -/Documentation/btrfs-select-super.8 > /Documentation/btrfs-send.8 > /Documentation/btrfs-subvolume.8 > /Documentation/btrfs.8 > diff --git a/Documentation/Makefile.in b/Documentation/Makefile.in > index d35cb858..ff0459c0 100644 > --- a/Documentation/Makefile.in > +++ b/Documentation/Makefile.in > @@ -4,10 +4,8 @@ MAN8_TXT = > # Top level commands > MAN8_TXT += btrfs.asciidoc > MAN8_TXT += btrfs-convert.asciidoc > -MAN8_TXT += btrfs-find-root.asciidoc > MAN8_TXT += btrfs-image.asciidoc > MAN8_TXT += btrfs-map-logical.asciidoc > -MAN8_TXT += btrfs-select-super.asciidoc > MAN8_TXT += btrfstune.asciidoc > MAN8_TXT += fsck.btrfs.asciidoc > MAN8_TXT += mkfs.btrfs.asciidoc > diff --git a/Documentation/btrfs-find-root.asciidoc b/Documentation/btrfs-find-root.asciidoc > deleted file mode 100644 > index 652796c8..00000000 > --- a/Documentation/btrfs-find-root.asciidoc > +++ /dev/null > @@ -1,35 +0,0 @@ > -btrfs-find-root(8) > -================== > - > -NAME > ----- > -btrfs-find-root - filter to find btrfs root > - > -SYNOPSIS > --------- > -*btrfs-find-root* [options] <device> > - > -DESCRIPTION > ------------ > -*btrfs-find-root* is used to find the satisfied root, you can filter by > -root tree's objectid, generation, level. > - > -OPTIONS > -------- > --a:: > -Search through all metadata extents, even the root has been already found. > --g <generation>:: > -Filter root tree by it's original transaction id, tree root's generation in default. > --o <objectid>:: > -Filter root tree by it's objectid,tree root's objectid in default. > --l <level>:: > -Filter root tree by B-+ tree's level, level 0 in default. > - > -EXIT STATUS > ------------ > -*btrfs-find-root* will return 0 if no error happened. > -If any problems happened, 1 will be returned. > - > -SEE ALSO > --------- > -`mkfs.btrfs`(8) > diff --git a/Documentation/btrfs-select-super.asciidoc b/Documentation/btrfs-select-super.asciidoc > deleted file mode 100644 > index e3bca98b..00000000 > --- a/Documentation/btrfs-select-super.asciidoc > +++ /dev/null > @@ -1,46 +0,0 @@ > -btrfs-select-super(8) > -===================== > - > -NAME > ----- > -btrfs-select-super - overwrite primary superblock with a backup copy > - > -SYNOPSIS > --------- > -*btrfs-select-super* -s number <device> > - > -DESCRIPTION > ------------ > -Destructively overwrite all copies of the superblock > -with a specified copy. This helps in certain cases, for example when write > -barriers were disabled during a power failure and not all superblocks were > -written, or if the primary superblock is damaged, eg. accidentally overwritten. > - > -The filesystem specified by 'device' must not be mounted. > - > -NOTE: *Prior to overwriting the primary superblock, please make sure that the backup > -copies are valid!* > - > -To dump a superblock use the *btrfs inspect-internal dump-super* command. > - > -Then run the check (in the non-repair mode) using the command *btrfs check -s* > -where '-s' specifies the superblock copy to use. > - > -Superblock copies exist in the following offsets on the device: > - > -- primary: '64KiB' (65536) > -- 1st copy: '64MiB' (67108864) > -- 2nd copy: '256GiB' (274877906944) > - > -A superblock size is '4KiB' (4096). > - > -OPTIONS > -------- > --s|--super <superblock>:: > -use 'superblock'th superblock copy, valid values are 0 1 or 2 if the > -respective superblock offset is within the device size > - > -SEE ALSO > --------- > -`btrfs-inspect-internal`(8), > -`btrfsck check`(8) > diff --git a/Documentation/btrfs.asciidoc b/Documentation/btrfs.asciidoc > index 1625f6d8..e3328942 100644 > --- a/Documentation/btrfs.asciidoc > +++ b/Documentation/btrfs.asciidoc > @@ -115,8 +115,6 @@ Tools that are still in active use without an equivalent in *btrfs*: > > *btrfs-convert*:: in-place conversion from ext2/3/4 filesystems to btrfs > *btrfstune*:: tweak some filesystem properties on a unmounted filesystem > -*btrfs-select-super*:: rescue tool to overwrite primary superblock from a spare copy > -*btrfs-find-root*:: rescue helper to find tree roots in a filesystem > > Deprecated and obsolete tools: > >
On Sun, 2020-03-01 at 16:26 +0800, Qu Wenruo wrote: > > On 2020/3/1 上午11:33, Marcos Paulo de Souza wrote: > > From: Marcos Paulo de Souza <mpdesouza@suse.com> > > > > btrfs-find-root and btrfs-select-super stopped to be shipped in > 2014, so > > remove all references to these manpages as well. > > Nope, my distro is still shipping it, and I find it kinda useful for > certain recovery scenario. > > Thus it's better to keep their documents. Thanks for checking this Qu. What do you think about the other two patches? David, do you think you can only patches 2 and 3? The first patch can be skipped, since only the later two solve the issue. Thanks, Marcos > > Thanks, > Qu > > > > > Signed-off-by: Marcos Paulo de Souza <mpdesouza@suse.com> > > --- > > .gitignore | 2 - > > Documentation/Makefile.in | 2 - > > Documentation/btrfs-find-root.asciidoc | 35 ----------------- > > Documentation/btrfs-select-super.asciidoc | 46 ----------------- > ------ > > Documentation/btrfs.asciidoc | 2 - > > 5 files changed, 87 deletions(-) > > delete mode 100644 Documentation/btrfs-find-root.asciidoc > > delete mode 100644 Documentation/btrfs-select-super.asciidoc > > > > diff --git a/.gitignore b/.gitignore > > index aadf9ae7..2b1c1aef 100644 > > --- a/.gitignore > > +++ b/.gitignore > > @@ -73,7 +73,6 @@ > > /Documentation/btrfs-convert.8 > > /Documentation/btrfs-device.8 > > /Documentation/btrfs-filesystem.8 > > -/Documentation/btrfs-find-root.8 > > /Documentation/btrfs-image.8 > > /Documentation/btrfs-inspect-internal.8 > > /Documentation/btrfs-ioctl.3 > > @@ -87,7 +86,6 @@ > > /Documentation/btrfs-rescue.8 > > /Documentation/btrfs-restore.8 > > /Documentation/btrfs-scrub.8 > > -/Documentation/btrfs-select-super.8 > > /Documentation/btrfs-send.8 > > /Documentation/btrfs-subvolume.8 > > /Documentation/btrfs.8 > > diff --git a/Documentation/Makefile.in b/Documentation/Makefile.in > > index d35cb858..ff0459c0 100644 > > --- a/Documentation/Makefile.in > > +++ b/Documentation/Makefile.in > > @@ -4,10 +4,8 @@ MAN8_TXT = > > # Top level commands > > MAN8_TXT += btrfs.asciidoc > > MAN8_TXT += btrfs-convert.asciidoc > > -MAN8_TXT += btrfs-find-root.asciidoc > > MAN8_TXT += btrfs-image.asciidoc > > MAN8_TXT += btrfs-map-logical.asciidoc > > -MAN8_TXT += btrfs-select-super.asciidoc > > MAN8_TXT += btrfstune.asciidoc > > MAN8_TXT += fsck.btrfs.asciidoc > > MAN8_TXT += mkfs.btrfs.asciidoc > > diff --git a/Documentation/btrfs-find-root.asciidoc > b/Documentation/btrfs-find-root.asciidoc > > deleted file mode 100644 > > index 652796c8..00000000 > > --- a/Documentation/btrfs-find-root.asciidoc > > +++ /dev/null > > @@ -1,35 +0,0 @@ > > -btrfs-find-root(8) > > -================== > > - > > -NAME > > ----- > > -btrfs-find-root - filter to find btrfs root > > - > > -SYNOPSIS > > --------- > > -*btrfs-find-root* [options] <device> > > - > > -DESCRIPTION > > ------------ > > -*btrfs-find-root* is used to find the satisfied root, you can > filter by > > -root tree's objectid, generation, level. > > - > > -OPTIONS > > -------- > > --a:: > > -Search through all metadata extents, even the root has been > already found. > > --g <generation>:: > > -Filter root tree by it's original transaction id, tree root's > generation in default. > > --o <objectid>:: > > -Filter root tree by it's objectid,tree root's objectid in default. > > --l <level>:: > > -Filter root tree by B-+ tree's level, level 0 in default. > > - > > -EXIT STATUS > > ------------ > > -*btrfs-find-root* will return 0 if no error happened. > > -If any problems happened, 1 will be returned. > > - > > -SEE ALSO > > --------- > > -`mkfs.btrfs`(8) > > diff --git a/Documentation/btrfs-select-super.asciidoc > b/Documentation/btrfs-select-super.asciidoc > > deleted file mode 100644 > > index e3bca98b..00000000 > > --- a/Documentation/btrfs-select-super.asciidoc > > +++ /dev/null > > @@ -1,46 +0,0 @@ > > -btrfs-select-super(8) > > -===================== > > - > > -NAME > > ----- > > -btrfs-select-super - overwrite primary superblock with a backup > copy > > - > > -SYNOPSIS > > --------- > > -*btrfs-select-super* -s number <device> > > - > > -DESCRIPTION > > ------------ > > -Destructively overwrite all copies of the superblock > > -with a specified copy. This helps in certain cases, for example > when write > > -barriers were disabled during a power failure and not all > superblocks were > > -written, or if the primary superblock is damaged, eg. accidentally > overwritten. > > - > > -The filesystem specified by 'device' must not be mounted. > > - > > -NOTE: *Prior to overwriting the primary superblock, please make > sure that the backup > > -copies are valid!* > > - > > -To dump a superblock use the *btrfs inspect-internal dump-super* > command. > > - > > -Then run the check (in the non-repair mode) using the command > *btrfs check -s* > > -where '-s' specifies the superblock copy to use. > > - > > -Superblock copies exist in the following offsets on the device: > > - > > -- primary: '64KiB' (65536) > > -- 1st copy: '64MiB' (67108864) > > -- 2nd copy: '256GiB' (274877906944) > > - > > -A superblock size is '4KiB' (4096). > > - > > -OPTIONS > > -------- > > --s|--super <superblock>:: > > -use 'superblock'th superblock copy, valid values are 0 1 or 2 if > the > > -respective superblock offset is within the device size > > - > > -SEE ALSO > > --------- > > -`btrfs-inspect-internal`(8), > > -`btrfsck check`(8) > > diff --git a/Documentation/btrfs.asciidoc > b/Documentation/btrfs.asciidoc > > index 1625f6d8..e3328942 100644 > > --- a/Documentation/btrfs.asciidoc > > +++ b/Documentation/btrfs.asciidoc > > @@ -115,8 +115,6 @@ Tools that are still in active use without an > equivalent in *btrfs*: > > > > *btrfs-convert*:: in-place conversion from ext2/3/4 filesystems to > btrfs > > *btrfstune*:: tweak some filesystem properties on a unmounted > filesystem > > -*btrfs-select-super*:: rescue tool to overwrite primary superblock > from a spare copy > > -*btrfs-find-root*:: rescue helper to find tree roots in a > filesystem > > > > Deprecated and obsolete tools: > > > > >
On Sun, Mar 01, 2020 at 11:28:55AM -0300, Marcos Paulo de Souza wrote: > On Sun, 2020-03-01 at 16:26 +0800, Qu Wenruo wrote: > > > > On 2020/3/1 上午11:33, Marcos Paulo de Souza wrote: > > > From: Marcos Paulo de Souza <mpdesouza@suse.com> > > > > > > btrfs-find-root and btrfs-select-super stopped to be shipped in > > 2014, so > > > remove all references to these manpages as well. > > > > Nope, my distro is still shipping it, and I find it kinda useful for > > certain recovery scenario. > > > > Thus it's better to keep their documents. > > Thanks for checking this Qu. What do you think about the other two > patches? > > David, do you think you can only patches 2 and 3? The first patch can > be skipped, since only the later two solve the issue. I was not expecing to see actual removal of the manual pages but rather removing manual pages installed by distro packages without the related binaries. In the long term we want to migrate the functionality of find-root and select-super to the 'rescue' subcommand and at that time the manual pages' text will be moved. Until then it should be kept but it's up to the distro package to either ship the binaries + manual pages or neither.
diff --git a/.gitignore b/.gitignore index aadf9ae7..2b1c1aef 100644 --- a/.gitignore +++ b/.gitignore @@ -73,7 +73,6 @@ /Documentation/btrfs-convert.8 /Documentation/btrfs-device.8 /Documentation/btrfs-filesystem.8 -/Documentation/btrfs-find-root.8 /Documentation/btrfs-image.8 /Documentation/btrfs-inspect-internal.8 /Documentation/btrfs-ioctl.3 @@ -87,7 +86,6 @@ /Documentation/btrfs-rescue.8 /Documentation/btrfs-restore.8 /Documentation/btrfs-scrub.8 -/Documentation/btrfs-select-super.8 /Documentation/btrfs-send.8 /Documentation/btrfs-subvolume.8 /Documentation/btrfs.8 diff --git a/Documentation/Makefile.in b/Documentation/Makefile.in index d35cb858..ff0459c0 100644 --- a/Documentation/Makefile.in +++ b/Documentation/Makefile.in @@ -4,10 +4,8 @@ MAN8_TXT = # Top level commands MAN8_TXT += btrfs.asciidoc MAN8_TXT += btrfs-convert.asciidoc -MAN8_TXT += btrfs-find-root.asciidoc MAN8_TXT += btrfs-image.asciidoc MAN8_TXT += btrfs-map-logical.asciidoc -MAN8_TXT += btrfs-select-super.asciidoc MAN8_TXT += btrfstune.asciidoc MAN8_TXT += fsck.btrfs.asciidoc MAN8_TXT += mkfs.btrfs.asciidoc diff --git a/Documentation/btrfs-find-root.asciidoc b/Documentation/btrfs-find-root.asciidoc deleted file mode 100644 index 652796c8..00000000 --- a/Documentation/btrfs-find-root.asciidoc +++ /dev/null @@ -1,35 +0,0 @@ -btrfs-find-root(8) -================== - -NAME ----- -btrfs-find-root - filter to find btrfs root - -SYNOPSIS --------- -*btrfs-find-root* [options] <device> - -DESCRIPTION ------------ -*btrfs-find-root* is used to find the satisfied root, you can filter by -root tree's objectid, generation, level. - -OPTIONS -------- --a:: -Search through all metadata extents, even the root has been already found. --g <generation>:: -Filter root tree by it's original transaction id, tree root's generation in default. --o <objectid>:: -Filter root tree by it's objectid,tree root's objectid in default. --l <level>:: -Filter root tree by B-+ tree's level, level 0 in default. - -EXIT STATUS ------------ -*btrfs-find-root* will return 0 if no error happened. -If any problems happened, 1 will be returned. - -SEE ALSO --------- -`mkfs.btrfs`(8) diff --git a/Documentation/btrfs-select-super.asciidoc b/Documentation/btrfs-select-super.asciidoc deleted file mode 100644 index e3bca98b..00000000 --- a/Documentation/btrfs-select-super.asciidoc +++ /dev/null @@ -1,46 +0,0 @@ -btrfs-select-super(8) -===================== - -NAME ----- -btrfs-select-super - overwrite primary superblock with a backup copy - -SYNOPSIS --------- -*btrfs-select-super* -s number <device> - -DESCRIPTION ------------ -Destructively overwrite all copies of the superblock -with a specified copy. This helps in certain cases, for example when write -barriers were disabled during a power failure and not all superblocks were -written, or if the primary superblock is damaged, eg. accidentally overwritten. - -The filesystem specified by 'device' must not be mounted. - -NOTE: *Prior to overwriting the primary superblock, please make sure that the backup -copies are valid!* - -To dump a superblock use the *btrfs inspect-internal dump-super* command. - -Then run the check (in the non-repair mode) using the command *btrfs check -s* -where '-s' specifies the superblock copy to use. - -Superblock copies exist in the following offsets on the device: - -- primary: '64KiB' (65536) -- 1st copy: '64MiB' (67108864) -- 2nd copy: '256GiB' (274877906944) - -A superblock size is '4KiB' (4096). - -OPTIONS -------- --s|--super <superblock>:: -use 'superblock'th superblock copy, valid values are 0 1 or 2 if the -respective superblock offset is within the device size - -SEE ALSO --------- -`btrfs-inspect-internal`(8), -`btrfsck check`(8) diff --git a/Documentation/btrfs.asciidoc b/Documentation/btrfs.asciidoc index 1625f6d8..e3328942 100644 --- a/Documentation/btrfs.asciidoc +++ b/Documentation/btrfs.asciidoc @@ -115,8 +115,6 @@ Tools that are still in active use without an equivalent in *btrfs*: *btrfs-convert*:: in-place conversion from ext2/3/4 filesystems to btrfs *btrfstune*:: tweak some filesystem properties on a unmounted filesystem -*btrfs-select-super*:: rescue tool to overwrite primary superblock from a spare copy -*btrfs-find-root*:: rescue helper to find tree roots in a filesystem Deprecated and obsolete tools: