btrfs-progs: doc: link btrfsck to btrfs-check
diff mbox

Message ID 1397668577-846-1-git-send-email-dsterba@suse.cz
State Accepted
Headers show

Commit Message

David Sterba April 16, 2014, 5:16 p.m. UTC
The 'btrfsck' command has been deprecated in favor of 'btrfs check'. For
compatibility install a symlink to the btrfs-check.8 manpage.

CC: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
---
 Documentation/Makefile        | 2 ++
 Documentation/btrfs-check.txt | 3 ++-
 2 files changed, 4 insertions(+), 1 deletion(-)

Comments

Qu Wenruo April 17, 2014, 12:47 a.m. UTC | #1
-------- Original Message --------
Subject: [PATCH] btrfs-progs: doc: link btrfsck to btrfs-check
From: David Sterba <dsterba@suse.cz>
To: linux-btrfs@vger.kernel.org
Date: 2014?04?17? 01:16
> The 'btrfsck' command has been deprecated in favor of 'btrfs check'. For
> compatibility install a symlink to the btrfs-check.8 manpage.
>
> CC: Qu Wenruo <quwenruo@cn.fujitsu.com>
> Signed-off-by: David Sterba <dsterba@suse.cz>
> ---
>   Documentation/Makefile        | 2 ++
>   Documentation/btrfs-check.txt | 3 ++-
>   2 files changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index ec8598bb57d3..1eef9fd57da3 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -48,6 +48,7 @@ XMLTO_EXTRA = -m manpage-bold-literal.xsl
>   GZIP = gzip
>   INSTALL ?= install
>   RM ?= rm -f
> +LNS ?= ln -sf
>   BTRFS_VERSION = $(shell sed -n 's/.*BTRFS_BUILD_VERSION "Btrfs \(.*\)"/\1/p'\
>   		  ../version.h)
>   
> @@ -73,6 +74,7 @@ install: install-man
>   install-man: man
>   	$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
>   	$(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
> +	$(LNS) btrfs-check.txt $(DESTDIR)$(man8dir)
Shouldn't the source of soft link be btrfs-check.8.gz. ?
>   
>   clean:
>   	$(RM) *.xml *.xml+ *.8 *.8.gz
> diff --git a/Documentation/btrfs-check.txt b/Documentation/btrfs-check.txt
> index ddd7fe77eca2..485a49cbc3ec 100644
> --- a/Documentation/btrfs-check.txt
> +++ b/Documentation/btrfs-check.txt
> @@ -18,6 +18,8 @@ command, it is *highly* recommended to read the following btrfs wiki before
>   executing 'btrfs check' with '--repair' option: +
>   https://btrfs.wiki.kernel.org/index.php/Btrfsck
>   
> +'btrfsck' is an alias of 'btrfs check' command and is now deprecated.
> +
>   OPTIONS
>   -------
>   -s|--support <superblock>::
> @@ -47,4 +49,3 @@ SEE ALSO
>   `mkfs.btrfs`(8),
>   `btrfs-scrub`(8),
>   `btrfs-rescue`(8)
> -`btrfsck`(8)
Sorry to bother you but 'btrfs-scrub'/'btrfs-rescue' and 'btrfs-restore' 
seems also metioning 'btrfsck' and may also needs to remove 'btrfsck'.

Thanks,
Qu
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
David Sterba April 18, 2014, 2:48 p.m. UTC | #2
On Thu, Apr 17, 2014 at 08:47:28AM +0800, Qu Wenruo wrote:
> >@@ -73,6 +74,7 @@ install: install-man
> >  install-man: man
> >  	$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
> >  	$(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
> >+	$(LNS) btrfs-check.txt $(DESTDIR)$(man8dir)
> Shouldn't the source of soft link be btrfs-check.8.gz. ?

> >@@ -47,4 +49,3 @@ SEE ALSO
> >  `mkfs.btrfs`(8),
> >  `btrfs-scrub`(8),
> >  `btrfs-rescue`(8)
> >-`btrfsck`(8)
> Sorry to bother you but 'btrfs-scrub'/'btrfs-rescue' and 'btrfs-restore'
> seems also metioning 'btrfsck' and may also needs to remove 'btrfsck'.

Thanks for catching them, I'll fix it up.
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
WorMzy Tykashi April 30, 2014, 12:14 p.m. UTC | #3
Hi,

While trying to view the btrfs-check manpage today (using
integration-20140429), I noticed that the current symlink overwrites
the actual btrfs-check manpage, making an unusable, cyclic link:

    $ man btrfs-check
    man: can't resolve /usr/share/man/man8/btrfs-check.8.gz: Too many
levels of symbolic links
    No manual entry for btrfs-check

I believe you forgot to add the file name of the symlink at the end of
the line, e.g.

    $(LNS) btrfs-check.8.gz $(DESTDIR)$(man8dir)

should be

    $(LNS) btrfs-check.8.gz $(DESTDIR)$(man8dir)/btrfsck.8.gz

Cheers,


WorMzy
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
David Sterba May 5, 2014, 2:57 p.m. UTC | #4
On Wed, Apr 30, 2014 at 01:14:59PM +0100, WorMzy Tykashi wrote:
>     $(LNS) btrfs-check.8.gz $(DESTDIR)$(man8dir)
> 
> should be
> 
>     $(LNS) btrfs-check.8.gz $(DESTDIR)$(man8dir)/btrfsck.8.gz

Thank you, fix sent.
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Qu Wenruo May 8, 2014, 1:40 a.m. UTC | #5
-------- Original Message --------
Subject: Re: [PATCH] btrfs-progs: doc: link btrfsck to btrfs-check
From: David Sterba <dsterba@suse.cz>
To: Qu Wenruo <quwenruo@cn.fujitsu.com>
Date: 2014?04?18? 22:48
> On Thu, Apr 17, 2014 at 08:47:28AM +0800, Qu Wenruo wrote:
>>> @@ -73,6 +74,7 @@ install: install-man
>>>   install-man: man
>>>   	$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
>>>   	$(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
>>> +	$(LNS) btrfs-check.txt $(DESTDIR)$(man8dir)
>> Shouldn't the source of soft link be btrfs-check.8.gz. ?
Forgot to mention that the dest is also wrong. This will make 
$(DESTDIR)$(man8dir)/btrfs-check.8.gz to be a
infinite loop(pointing to it self).
The correct one should be like the following:
+       $(LNS) btrfs-check.8.gz $(DESTDIR)$(man8dir)/btrfsck.8.gz

Thanks,
Qu

>>> @@ -47,4 +49,3 @@ SEE ALSO
>>>   `mkfs.btrfs`(8),
>>>   `btrfs-scrub`(8),
>>>   `btrfs-rescue`(8)
>>> -`btrfsck`(8)
>> Sorry to bother you but 'btrfs-scrub'/'btrfs-rescue' and 'btrfs-restore'
>> seems also metioning 'btrfsck' and may also needs to remove 'btrfsck'.
> Thanks for catching them, I'll fix it up.
> --
> To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
David Sterba May 12, 2014, 2:09 p.m. UTC | #6
On Thu, May 08, 2014 at 09:40:03AM +0800, Qu Wenruo wrote:
> -------- Original Message --------
> Subject: Re: [PATCH] btrfs-progs: doc: link btrfsck to btrfs-check
> From: David Sterba <dsterba@suse.cz>
> To: Qu Wenruo <quwenruo@cn.fujitsu.com>
> Date: 2014?04?18? 22:48
> >On Thu, Apr 17, 2014 at 08:47:28AM +0800, Qu Wenruo wrote:
> >>>@@ -73,6 +74,7 @@ install: install-man
> >>>  install-man: man
> >>>  	$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
> >>>  	$(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
> >>>+	$(LNS) btrfs-check.txt $(DESTDIR)$(man8dir)
> >>Shouldn't the source of soft link be btrfs-check.8.gz. ?
> Forgot to mention that the dest is also wrong. This will make
> $(DESTDIR)$(man8dir)/btrfs-check.8.gz to be a
> infinite loop(pointing to it self).
> The correct one should be like the following:
> +       $(LNS) btrfs-check.8.gz $(DESTDIR)$(man8dir)/btrfsck.8.gz

Thanks, it was reported & fixed a few days ago, though it's not in the
integration branch, lag is on my side.

https://patchwork.kernel.org/patch/4115501/
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
WorMzy Tykashi June 3, 2014, 9:38 a.m. UTC | #7
On 12 May 2014 15:09, David Sterba <dsterba@suse.cz> wrote:
>
> Thanks, it was reported & fixed a few days ago, though it's not in the
> integration branch, lag is on my side.
>
> https://patchwork.kernel.org/patch/4115501/

Hi David,

I noticed this in another thread:

On 3 June 2014 10:14, David Sterba <dsterba@suse.cz> wrote:
> I've assembled a branch containing doc-only fixes, including this one,
> and asked Chris do do a 3.14.3 release.

Does this branch include this fix for this bug? According to
patchwork, it's status is still "under review", but it's been a month
and the bug slipped into the 3.14.2 release. I just want to make sure
it hasn't fallen out of the pile. :)

Cheers,


WorMzy
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
David Sterba June 3, 2014, 12:19 p.m. UTC | #8
On Tue, Jun 03, 2014 at 10:38:16AM +0100, WorMzy Tykashi wrote:
> I noticed this in another thread:
> 
> On 3 June 2014 10:14, David Sterba <dsterba@suse.cz> wrote:
> > I've assembled a branch containing doc-only fixes, including this one,
> > and asked Chris do do a 3.14.3 release.
> 
> Does this branch include this fix for this bug? According to
> patchwork, it's status is still "under review", but it's been a month
> and the bug slipped into the 3.14.2 release. I just want to make sure
> it hasn't fallen out of the pile. :)

Yes the branch contains this fix as well,

http://repo.or.cz/w/btrfs-progs-unstable/devel.git/shortlog/refs/heads/v3.14.x

and it almost fell off, I had forgotten to tag it in my mailbox and a
filter did not pick it.

About patchwork, I'm still using mailbox and git for tracking patches
and sync the patchwork status manually on occasion. This is not ideal
and patchwork status is not accurate. I'm aiming for a semi-automated
sync from git/mbox -> patchwork when the patches change their status
regarding stability and upstream readiness.
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch
diff mbox

diff --git a/Documentation/Makefile b/Documentation/Makefile
index ec8598bb57d3..1eef9fd57da3 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -48,6 +48,7 @@  XMLTO_EXTRA = -m manpage-bold-literal.xsl
 GZIP = gzip
 INSTALL ?= install
 RM ?= rm -f
+LNS ?= ln -sf
 BTRFS_VERSION = $(shell sed -n 's/.*BTRFS_BUILD_VERSION "Btrfs \(.*\)"/\1/p'\
 		  ../version.h)
 
@@ -73,6 +74,7 @@  install: install-man
 install-man: man
 	$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
 	$(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
+	$(LNS) btrfs-check.txt $(DESTDIR)$(man8dir)
 
 clean:
 	$(RM) *.xml *.xml+ *.8 *.8.gz
diff --git a/Documentation/btrfs-check.txt b/Documentation/btrfs-check.txt
index ddd7fe77eca2..485a49cbc3ec 100644
--- a/Documentation/btrfs-check.txt
+++ b/Documentation/btrfs-check.txt
@@ -18,6 +18,8 @@  command, it is *highly* recommended to read the following btrfs wiki before
 executing 'btrfs check' with '--repair' option: +
 https://btrfs.wiki.kernel.org/index.php/Btrfsck
 
+'btrfsck' is an alias of 'btrfs check' command and is now deprecated.
+
 OPTIONS
 -------
 -s|--support <superblock>::
@@ -47,4 +49,3 @@  SEE ALSO
 `mkfs.btrfs`(8),
 `btrfs-scrub`(8),
 `btrfs-rescue`(8)
-`btrfsck`(8)