Skip to content

Commit 53a8329

Browse files
committed
Merge branch 'bc/misconception-doc'
Doc updates. * bc/misconception-doc: docs: mention when increasing http.postBuffer is valuable doc: dissuade users from trying to ignore tracked files
2 parents c9ccf9d + 7a2dc95 commit 53a8329

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

Documentation/config/http.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,14 @@ http.postBuffer::
199199
Transfer-Encoding: chunked is used to avoid creating a
200200
massive pack file locally. Default is 1 MiB, which is
201201
sufficient for most requests.
202+
+
203+
Note that raising this limit is only effective for disabling chunked
204+
transfer encoding and therefore should be used only where the remote
205+
server or a proxy only supports HTTP/1.0 or is noncompliant with the
206+
HTTP standard. Raising this is not, in general, an effective solution
207+
for most push problems, but can increase memory consumption
208+
significantly since the entire buffer is allocated even for small
209+
pushes.
202210

203211
http.lowSpeedLimit, http.lowSpeedTime::
204212
If the HTTP transfer speed is less than 'http.lowSpeedLimit'

Documentation/git-update-index.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -549,6 +549,22 @@ The untracked cache extension can be enabled by the
549549
`core.untrackedCache` configuration variable (see
550550
linkgit:git-config[1]).
551551

552+
NOTES
553+
-----
554+
555+
Users often try to use the assume-unchanged and skip-worktree bits
556+
to tell Git to ignore changes to files that are tracked. This does not
557+
work as expected, since Git may still check working tree files against
558+
the index when performing certain operations. In general, Git does not
559+
provide a way to ignore changes to tracked files, so alternate solutions
560+
are recommended.
561+
562+
For example, if the file you want to change is some sort of config file,
563+
the repository can include a sample config file that can then be copied
564+
into the ignored name and modified. The repository can even include a
565+
script to treat the sample file as a template, modifying and copying it
566+
automatically.
567+
552568
SEE ALSO
553569
--------
554570
linkgit:git-config[1],

0 commit comments

Comments
 (0)