Browse Source

Add note about on-disk filenames.

Jelmer Vernooij 5 years ago
parent
commit
a8c7a6e317
1 changed files with 2 additions and 1 deletions
  1. 2 1
      CONTRIBUTING.rst

+ 2 - 1
CONTRIBUTING.rst

@@ -37,8 +37,9 @@ raw byte strings are supported.
 For this reason, the lower levels in Dulwich treat git-based filenames as
 For this reason, the lower levels in Dulwich treat git-based filenames as
 bytestrings. It is up to the Dulwich API user to encode and decode them if
 bytestrings. It is up to the Dulwich API user to encode and decode them if
 necessary. The porcelain may accept unicode strings and convert them to
 necessary. The porcelain may accept unicode strings and convert them to
-bytestrings as necessary on the fly (using sys.getfilesystemencoding()).
+bytestrings as necessary on the fly (using 'utf-8').
 
 
+* on-disk filenames: regular strings
 * git-repository related filenames: bytes
 * git-repository related filenames: bytes
 * object sha1 digests (20 bytes long): bytes
 * object sha1 digests (20 bytes long): bytes
 * object sha1 hexdigests (40 bytes long): str (bytestrings on python2, strings
 * object sha1 hexdigests (40 bytes long): str (bytestrings on python2, strings