|
1 | | -This file is for tracking features that are less well implemented or less powerful than their `git` counterparts for one reason or another. |
| 1 | +# Shortcomings |
2 | 2 |
|
3 | | -#### `gix` |
| 3 | +This file is for tracking features that are less well implemented or less powerful than their Git counterparts for one reason or another. |
4 | 4 |
|
5 | 5 | ### gix-index |
6 | 6 |
|
7 | | -* The `link` extension can be read, but won't be written. This effectively disables the use of a split index once a mutating operation is run on it with `gitixode`. |
| 7 | +* The `link` extension can be read, but won't be written. This effectively disables the use of a split index once a mutating operation is run on it with `gitoxide`. |
8 | 8 |
|
9 | 9 | ### gix-protocol |
10 | | -* **fetches using protocol V1 and stateful connections, i.e. ssh, git, file, may hang** |
| 10 | + |
| 11 | +* **Fetches using protocol V1 and stateful connections, i.e. ssh, git, file, may hang** |
11 | 12 | * This can be fixed by making response parsing. |
12 | 13 | * Note that this does not affect cloning, which works fine. |
13 | 14 |
|
14 | | -### `gix-pack` |
| 15 | +### gix-pack |
| 16 | + |
15 | 17 | * **Packfiles use memory maps** |
16 | 18 | * Even though they are comfortable to use and fast, they squelch IO errors. |
17 | | - * _potential remedy_: We could generalize the Pack to make it possible to work on in-memory buffers directly. That way, one |
18 | | - would initialize a Pack by reading the whole file into memory, thus not squelching IO errors at the expense of latency as well |
| 19 | + * _Potential remedy_: We could generalize the `Pack` to make it possible to work on in-memory buffers directly. That way, one |
| 20 | + would initialize a `Pack` by reading the whole file into memory, thus not squelching IO errors at the expense of latency as well |
19 | 21 | as memory efficiency. |
20 | | -* **Packfiles cannot load files bigger than 2^31 or 2^32 on 32 bit systems** |
| 22 | +* **Packfiles cannot load files bigger than 2^31 or 2^32 on 32-bit systems** |
21 | 23 | * As these systems cannot address more memory than that. |
22 | | - * _potential remedy_: implement a sliding window to map and unmap portions of the file as needed. |
23 | | - * However, those who need to access big packs on these systems would rather resort to `git` itself, allowing |
| 24 | + * _Potential remedy_: implement a sliding window to map and unmap portions of the file as needed. |
| 25 | + * However, those who need to access big packs on these systems would rather resort to Git itself, allowing |
24 | 26 | our implementation to be simpler and potentially more performant. |
25 | | -* **Objects larger than 32 bits cannot be loaded on 32 bit systems** |
26 | | - * in-memory representations objects cannot handle objects greater than the amount of addressable memory. |
27 | | - * This will not affect git LFS though. |
| 27 | +* **Objects larger than 32 bits cannot be loaded on 32-bit systems** |
| 28 | + * In-memory representations objects cannot handle objects greater than the amount of addressable memory. |
| 29 | + * This will not affect Git LFS though. |
28 | 30 |
|
29 | | -### `gix` |
| 31 | +### gix |
30 | 32 |
|
31 | | -* object replacements are read once upon opening the repository from their refs and changes to these won't be picked up. |
| 33 | +* Object replacements are read once upon opening the repository from their refs and changes to these won't be picked up. |
32 | 34 |
|
33 | | -### `gix-url` |
| 35 | +### gix-url |
34 | 36 |
|
35 | | -* **gix-url** _might_ be more restrictive than what git allows as for the most part, it uses a browser grade URL parser. |
36 | | - * Thus far there is no proof for this, and as _potential remedy_ we could certainly re-implement exactly what git does |
| 37 | +* **gix-url** _might_ be more restrictive than what Git allows as for the most part, it uses a browser grade URL parser. |
| 38 | + * Thus far there is no proof for this, and as _potential remedy_ we could certainly re-implement exactly what Git does |
37 | 39 | to handle its URLs. |
0 commit comments