Skip to contentSkip to conversation

doc: detail LMAP binary format specification

PATCH New irsalshydiq 1 participant 1 message Jun 18

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: detail LMAP binary format specification

The experimental Rust implementation in 'loose.rs' introduces a new binary format called 'LMAP' for mapping between different object ID formats (e.g., SHA-1 and SHA-256).

However, the technical documentation for this format was missing from the 'Documentation/technical/' directory, making it difficult for C developers to understand the format's layout and logic.

Add 'Documentation/technical/loose-object-map.adoc' to provide a bit-by-bit specification of the 'LMAP' format and register it in the build systems.

---
 Documentation/Makefile                        |  1 +
 Documentation/technical/loose-object-map.adoc | 72 +++++++++++++++++++
 Documentation/technical/meson.build           |  1 +
 3 files changed, 74 insertions(+)
 create mode 100644 Documentation/technical/loose-object-map.adoc
Documentation/Makefile +1 -0
index 2699f0b24a..8ad908d62c 100644
@@ -126,6 +126,7 @@ TECH_DOCS += technical/directory-rename-detection
 TECH_DOCS += technical/hash-function-transition
 TECH_DOCS += technical/large-object-promisors
 TECH_DOCS += technical/long-running-process-protocol
+TECH_DOCS += technical/loose-object-map
 TECH_DOCS += technical/multi-pack-index
 TECH_DOCS += technical/packfile-uri
 TECH_DOCS += technical/pack-heuristics
Documentation/technical/loose-object-map.adoc new file +72 -0

72 lines not on this page · raw message

Documentation/technical/meson.build +1 -0
index ec07088c57..dc1249f9aa 100644
@@ -16,6 +16,7 @@ articles = [
   'large-object-promisors.adoc',
   'long-running-process-protocol.adoc',
   'multi-pack-index.adoc',
+  'loose-object-map.adoc',
   'packfile-uri.adoc',
   'pack-heuristics.adoc',
   'parallel-checkout.adoc',
Signature · 1 line
2.50.1 (Apple Git-155)