aboutsummaryrefslogtreecommitdiff
path: root/object/tree/mode/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'object/tree/mode/doc.go')
-rw-r--r--object/tree/mode/doc.go6
1 files changed, 6 insertions, 0 deletions
diff --git a/object/tree/mode/doc.go b/object/tree/mode/doc.go
new file mode 100644
index 00000000..8e3f5984
--- /dev/null
+++ b/object/tree/mode/doc.go
@@ -0,0 +1,6 @@
+// Package mode provides canonical Git tree entry modes.
+//
+// A [Mode] is the octal file mode stored in a tree entry,
+// such as a regular file, executable, symlink, directory, or gitlink.
+// It rejects malformed, unsupported, and zero-padded encodings.
+package mode