Skip to content

Commit d25c801

Browse files
purringuntitaker
authored andcommitted
add 'caution' section to docs, workaround for zero-padded file modes (pallets#2057)
Fix pallets#2029
1 parent cdbd63d commit d25c801

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.rst

+25
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,28 @@ Generate a HTML report can be done using this command::
8787

8888
Full docs on ``coverage.py`` are here: https://coverage.readthedocs.io
8989

90+
Caution
91+
=======
92+
pushing
93+
-------
94+
This repository contains several zero-padded file modes that may cause issues when pushing this repository to git hosts other than github. Fixing this is destructive to the commit history, so we suggest ignoring these warnings. If it fails to push and you're using a self-hosted git service like Gitlab, you can turn off repository checks in the admin panel.
95+
96+
97+
cloning
98+
-------
99+
The zero-padded file modes files above can cause issues while cloning, too. If you have
100+
101+
::
102+
103+
[fetch]
104+
fsckobjects = true
105+
106+
or
107+
108+
::
109+
110+
[receive]
111+
fsckObjects = true
112+
113+
114+
set in your git configuration file, cloning this repository will fail. The only solution is to set both of the above settings to false while cloning, and then setting them back to true after the cloning is finished.

0 commit comments

Comments
 (0)