git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Marco Luzzara via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Marco Luzzara <marco.luzzara@hotmail.it>
Subject: Re: [PATCH] docs: clarified that --lost-found implies --no-reflogs
Date: Mon, 01 Mar 2021 11:02:26 -0800	[thread overview]
Message-ID: <xmqq4khur931.fsf@gitster.c.googlers.com> (raw)
In-Reply-To: <pull.970.git.git.1614610921331.gitgitgadget@gmail.com> (Marco Luzzara via GitGitGadget's message of "Mon, 01 Mar 2021 15:02:00 +0000")

"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.

      reply	other threads:[~2021-03-01 19:07 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-01 15:02 [PATCH] docs: clarified that --lost-found implies --no-reflogs Marco Luzzara via GitGitGadget
2021-03-01 19:02 ` Junio C Hamano [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqq4khur931.fsf@gitster.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=marco.luzzara@hotmail.it \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).