diff mbox series

docs: clarified that --lost-found implies --no-reflogs

Message ID pull.970.git.git.1614610921331.gitgitgadget@gmail.com (mailing list archive)
State New
Headers show
Series docs: clarified that --lost-found implies --no-reflogs | expand

Commit Message

Marco Luzzara March 1, 2021, 3:02 p.m. UTC
From: Marco Luzzara <marco.luzzara@hotmail.it>

git fsck --lost-found does not look for references in the reflog. If not specified, it could create misunderstandings like this one: https://stackoverflow.com/questions/66401232/git-fsck-combining-lost-found-and-unreachable

Signed-off-by: Marco Luzzara <marco.luzzara@hotmail.it>
---
    docs: clarified that --lost-found implies --no-reflogs
    
    git fsck --lost-found does not look for references in the reflog. If not
    specified, it could create misunderstandings like this one: git fsck
    combining --lost-found and --unreachable
    [https://stackoverflow.com/questions/66401232/git-fsck-combining-lost-found-and-unreachable]

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-970%2Fmarco-luzzara%2Fmaster-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-970/marco-luzzara/master-v1
Pull-Request: https://github.com/git/git/pull/970

 Documentation/git-fsck.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


base-commit: 225365fb5195e804274ab569ac3cc4919451dc7f

Comments

Junio C Hamano March 1, 2021, 7:02 p.m. UTC | #1
"Marco Luzzara via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Marco Luzzara <marco.luzzara@hotmail.it>
>
> git fsck --lost-found does not look for references in the reflog. If not specified, it could create misunderstandings like this one: https://stackoverflow.com/questions/66401232/git-fsck-combining-lost-found-and-unreachable

Thanks for attempting to improve our documentation.

 - Please avoid an overly long line like the above.  Wrap your line
   at around 60-70 columns.

 - Please do not force readers to visit external site to understand
   why your change is useful.  You should be able to summarize the
   puzzlement described there in a few sentences, something like:

	The documentation does not say "git fsck --lost-found" uses
	"--no-reflogs" to make it easier to find objects that are
	not reachable from the tip of refs, which leads people to
	wonder why commits that are reachable only from reflogs are
	shown as dangling (see https://stackoverflow.com/questions/66401232
	for an example).

   perhaps.

> @@ -89,7 +89,7 @@ care about this output and want to speed it up further.
>  	Write dangling objects into .git/lost-found/commit/ or
>  	.git/lost-found/other/, depending on type.  If the object is
>  	a blob, the contents are written into the file, rather than
> -	its object name.
> +	its object name. This option implies `--no-reflogs`.

It also would be a good idea to explain why it implies that.

THanks.
diff mbox series

Patch

diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt
index bd596619c0d3..9f1db29042f0 100644
--- a/Documentation/git-fsck.txt
+++ b/Documentation/git-fsck.txt
@@ -89,7 +89,7 @@  care about this output and want to speed it up further.
 	Write dangling objects into .git/lost-found/commit/ or
 	.git/lost-found/other/, depending on type.  If the object is
 	a blob, the contents are written into the file, rather than
-	its object name.
+	its object name. This option implies `--no-reflogs`.
 
 --name-objects::
 	When displaying names of reachable objects, in addition to the