aboutsummaryrefslogtreecommitdiff
path: root/doc/internals.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2011-06-22 17:26:34 -0400
committerGravatar Joey Hess <joey@kitenet.net>2011-06-22 17:26:34 -0400
commitb1acf41036a1eddea29cc69c6b2a595582378465 (patch)
tree33025d13ac8c7d8cd0c7ccdf1eda5773e0829fc5 /doc/internals.mdwn
parentd70e9a945b4ac44ff42872b08dcf09051759eb9c (diff)
update documentation that mentioned .git-annex/
Diffstat (limited to 'doc/internals.mdwn')
-rw-r--r--doc/internals.mdwn16
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/internals.mdwn b/doc/internals.mdwn
index b362e68e1..419096744 100644
--- a/doc/internals.mdwn
+++ b/doc/internals.mdwn
@@ -17,7 +17,15 @@ This two-level structure is used because it allows the write bit to be removed
from the subdirectories as well as from the files. That prevents accidentially
deleting or changing the file contents.
-## `.git-annex/uuid.log`
+## The git-annex branch
+
+This branch is managed by git-annex, with the contents listed below.
+
+Note that it assumes only it will modify the branch. If you go in and make
+changes, be sure to remove `.git/index.git-annex` before running git-annex,
+otherwise it will probably revert your changes in its next commit to the branch.
+
+### `uuid.log`
Records the UUIDs of known repositories, and associates them with a
description of the repository. This allows git-annex to display something
@@ -30,7 +38,7 @@ space and then the description through to the end of the line. Example:
e605dca6-446a-11e0-8b2a-002170d25c55 laptop
26339d22-446b-11e0-9101-002170d25c55 usb disk
-## `git-annex/remotes.log`
+## `remotes.log`
Holds persistent configuration settings for [[special_remotes]] such as
Amazon S3.
@@ -39,7 +47,7 @@ The file format is one line per remote, starting with the uuid of the
remote, followed by a space, and then a series of key=value pairs,
each separated by whitespace.
-## `.git-annex/trust.log`
+## `trust.log`
Records the [[trust]] information for repositories. Does not exist unless
[[trust]] values are configured.
@@ -53,7 +61,7 @@ Example:
e605dca6-446a-11e0-8b2a-002170d25c55 1
26339d22-446b-11e0-9101-002170d25c55 ?
-## `.git-annex/aaa/bbb/*.log`
+## `aaa/bbb/*.log`
The remainder of the log files record [[location_tracking]] information
for file contents. Again these are placed in two levels of subdirectories