summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING19
1 files changed, 14 insertions, 5 deletions
diff --git a/HACKING b/HACKING
index ed08289..f7caf04 100644
--- a/HACKING
+++ b/HACKING
@@ -143,8 +143,6 @@
rvsdb provides several functions and variables for dealing with the
rvs database:
- $repo
- the directory of the database (./.rvs)
getid FILE
returns what the id of a given file would be if it were in
the database. This is used to know where to put files when
@@ -168,9 +166,9 @@
the value VAL
the database (.rvs/*)
-
- So, what are all these files doing in in the database? The scheme
- is fairly simple. In the `.rvs' directory there is 1 directory, the
+
+ So, what are all these files doing in this database? The scheme is
+ fairly simple. In the `.rvs' directory there is 1 directory, the
`files' directory. There used to be a folder for tempfiles (0.5.8-
0.6.2), but no more (0.6.3+). If you need a tempfile, just run:
FILENAME=`tempfile`
@@ -198,6 +196,17 @@
To keep things modular, commit.f is the ONLY thing that should
actually put files in `.rvs/files', and get.f the only thing that
should get them. Everything else should call them.
+
+ The repo and init are the ONLY things that should have `.rvs'
+ hardcoded into them. If the repository directory is needed, then
+ use `rvs repo'. Again, in the core, these should only be the .f
+ functions, however, it will be useful to plugins.
+
+ Why do we have the `files' directory, why don't we just put
+ everything in `.rvs'? This way:
+ * There is a spot to put user data, when we get around to writing
+ it
+
final thoughts