Re: [PATCH v14 6/7] core doc: modernize core.bigFileThreshold documentation
Han Xin <chiyutianyi@gmail.com> writes:
> core.bigFileThreshold::
Show 11 quoted lines
> + The size of files considered "big", which as discussed below
> + changes the behavior of numerous git commands, as well as how
> + such files are stored within the repository. The default is
> + 512 MiB. Common unit suffixes of 'k', 'm', or 'g' are
> + supported.
> +
> +Files above the configured limit will be:
> +
> +* Stored deflated in packfiles, without attempting delta compression.
> ++
> +The default limit is primarily set with this use-case in mind. With it
Show 5 quoted lines
> +most projects will have their source code and other text files delta
> +compressed, but not larger binary media files.
> +
> +Storing large files without delta compression avoids excessive memory
> +usage, at the slight expense of increased disk usage.
> +* Will be treated as if though they were labeled "binary" (see
"as if though" -> "as if"
> + linkgit:gitattributes[5]). e.g. linkgit:git-log[1] and
> + linkgit:git-diff[1] will not diffs for files above this limit.
"will not diffs" -ECANNOTPARSE. "will not compute diffs", probably?
> ++
> +* Will be generally be streamed when written, which avoids excessive
"be generally be" -> "generally be"
Show 7 quoted lines
> +memory usage, at the cost of some fixed overhead. Commands that make
> +use of this include linkgit:git-archive[1],
> +linkgit:git-fast-import[1], linkgit:git-index-pack[1] and
> +linkgit:git-fsck[1].
>
> core.excludesFile::
> Specifies the pathname to the file that contains patterns to
Junio C Hamano <gitster@pobox.com>