Skip to content

Commit

Permalink
doc: Remove a couple obsolete planned items
Browse files Browse the repository at this point in the history
This removes two items that are obsolete or effectively completed
due to subsequent design changes, and whose links were broken, in
`crate-status.md` and `general-tasks.md`. It also adds a note to
`general-tasks.md` that it may be outdated.

These changes are based on the discussion in #1627 and specifically
#1627 (comment).
  • Loading branch information
EliahKagan committed Oct 16, 2024
1 parent 155b5e1 commit b1685a0
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 7 deletions.
1 change: 0 additions & 1 deletion crate-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,6 @@ The top-level crate that acts as hub to all functionality provided by the `gix-*
* [x] decode (zero copy)
* [x] verify checksum
* [x] simple and fast pack traversal
* [ ] [fast pack traversal works with ref-deltas](https://github.com/GitoxideLabs/gitoxide/blob/8f9a55bb31af32b266d7c53426bc925361a627b2/gix-pack/src/cache/delta/from_offsets.rs#L101-L105)
* [x] decode
* [x] full objects
* [x] deltified objects
Expand Down
8 changes: 2 additions & 6 deletions general-tasks.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## General

*Note: Some of these items may be out of date.*

### Get rid of unsafe pointer magic [WithSidebands] _(cost: high)_

What needs to be done is to transform the &mut StreamingPeekableIter into a child future, and when exhausted, it must be transformed back
Expand All @@ -12,12 +14,6 @@ That would be quite some work though.

## Potential for improving performance

### gix-odb

* Finding an object in a loose object store [costs an extra disk IO operation][extra-iop] to pacify the borrow checker. This wouldn't be an issue with polonius.

[extra-iop]: https://github.com/GitoxideLabs/gitoxide/blob/2958145a0ae1ef582bbf88352f5567d5c2b5eaf0/gix-odb/src/store/linked/find.rs#L33

### gix-object

* **tree-parsing performance**
Expand Down

0 comments on commit b1685a0

Please sign in to comment.