diff options
| -rw-r--r-- | HACKING | 48 | ||||
| -rw-r--r-- | src/rvs-core/commit.d.sh | 6 | ||||
| -rw-r--r-- | src/rvs-core/commit.f.sh | 12 | ||||
| -rw-r--r-- | src/rvs-core/commit.sh | 6 | ||||
| -rw-r--r-- | src/rvs-core/get.d.sh | 6 | ||||
| -rw-r--r-- | src/rvs-core/get.f.sh | 8 | ||||
| -rw-r--r-- | src/rvs-core/get.sh | 6 | ||||
| -rw-r--r-- | src/rvs-core/init.sh | 8 | ||||
| -rw-r--r-- | src/rvs-core/lib/rvsdb.sh | 4 | ||||
| -rw-r--r-- | src/rvs.sh | 2 |
10 files changed, 50 insertions, 56 deletions
@@ -5,7 +5,7 @@ in commit 2 before commit 1 ////////////////////////////////////////////////////////////////////// - I know this file is long* and boring. I try to keep it preened and + I know this file is long* and boring. I try to keep it preened and informative, but would rather spend my time actually hacking. If you think you can help this file, have at it! ~ Luke Shumaker @@ -13,9 +13,9 @@ hacking - There are two main parts to rvs, the wrapper, and the core. The + There are two main parts to rvs, the wrapper, and the core. The wrapper is a small executable, located in the PATH, and is the one - called when you type `rvs'. The core is a set of many small + called when you type `rvs'. The core is a set of many small executables that do all the real work. build system @@ -31,7 +31,7 @@ preprocessor - The preprocessor contains all configuration variables. When it + The preprocessor contains all configuration variables. When it processes a file every instance of `$$VAR_NAME$$' is replaced by that variable's value. Note that this replacement only happens for defined variables. @@ -51,11 +51,11 @@ The source for the core is in `source/rvs-core/' $$SHELL$$ is the shell all shell scripts that are part of rvs are - run in. As of rvs 0.6.3 all executables are shell scripts. + run in. As of rvs 0.6.3 all executables are shell scripts. Most of these can easily be changed _after_ compilation also: VER line 4 of the wrapper - SHELL line 1 each shell script + SHELL line 1 of each shell script prefix simply move the wrapper bindir simply move the wrapper libdir move the core, then update the line `RVSDIR=...' in @@ -71,8 +71,8 @@ The `rvs commit' command is also quite simple in design. It takes a single argument; the file to commit. If no target is specified, it - defaults to `./'. It checks which type of file the target is, and - runs `rvs commit.FILE_CODE TARGET'. The file codes are as follows: + defaults to `./'. It checks which type of file the target is, and + runs `rvs commit.FILE_CODE TARGET'. The file codes are as follows: block (buffered) special b character (unbuffered) special c @@ -88,9 +88,9 @@ implemented as of rvs 0.6.3. After `rvs commit' has done this, it creates a meta-file for that - commit. The meta file contains author, copyright owner, licence - data, file permissions, timestamps, etc. The id of the meta-file - is written to stdout, and used to later check out that commit + commit. The meta file contains author, copyright owner, licence + data, file permissions, timestamps, etc. The id of the meta-file is + written to stdout, and used to later check out that commit. get works in much the same way as commit, only it reads the file type from the meta-file, then runs `rvs get.FILE_CODE COMMIT_ID'. @@ -99,7 +99,7 @@ functions in the propper locations. Any commit function should take a filename as an argument and - output the according commit id to stdout. stderr should be used + output the according commit id to stdout. stderr should be used for all messages. Any get function should take the commit id as an argument and @@ -118,7 +118,7 @@ THIS WAS WRITTEN FOR rvs 0.6.2 THIS PORTION OF THE CODE IS BEING REVISED IN rvs 0.6.3 - I have created two 'libraries' for use by rvs components. They + I have created two 'libraries' for use by rvs components. They provide several functions that can be accessed by shell script by using the code: source "`rvs -d`/lib/stdio" @@ -147,17 +147,17 @@ 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 - commiting them. In 0.5.8-0.6.3 this is just the sha1sum of + the database. This is used to know where to put files when + commiting them. In 0.5.8-0.6.3 this is just the sha1sum of the file NOTE: the "log*" functions aren't very stable or developed loginit FILE - initialize an rvs log at FILE. These logs are used for + initialize an rvs log at FILE. These logs are used for metafiles, directory listings, and (probably) eventually checkout logs lograw LOG prepare LOG for reading, and write the output to stdout (to - pipe into another function). This is mostly for internal + pipe into another function). This is mostly for internal use by rvsdb logread LOG VAR read variable VAR from the logfile LOG @@ -170,11 +170,9 @@ the database (.rvs/*) So, what are all these files doing in in the database? The scheme - is fairly simple. In the `.rvs' directory there are 2 directories, - the `files' directory, and the `tmp' directory. `tmp' is what it - sounds like, a place for rvs compnents to keep temporary files. - The wrapper sets TMPDIR, so you can create a unique file in there - with: + 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` The `files' directory is where all the data is kept. @@ -192,9 +190,9 @@ $$libdir$$/commit calls $$libdir$$/commit.FILETYPE to generate the raw-file, but generates the meta-file itself (in `.rvs/tmp', then - calls commit.f to commit the meta-file). It then returns the ID - of the meta-file. Therefore, the user never deals with the IDs of - raw-files, and doesn't need to. The metafiles contain pointers to + calls commit.f to commit the meta-file). It then returns the ID of + the meta-file. Therefore, the user never deals with the IDs of + raw-files, and doesn't need to. The metafiles contain pointers to the corresponding raw-files. To keep things modular, commit.f is the ONLY thing that should diff --git a/src/rvs-core/commit.d.sh b/src/rvs-core/commit.d.sh index dcad82f..d8d366c 100644 --- a/src/rvs-core/commit.d.sh +++ b/src/rvs-core/commit.d.sh @@ -1,7 +1,7 @@ #!$$SHELL$$ # abomination module:rvs:commit:d name='rvs commit.d' -ver='0.6.0' +ver='0.6.3' usage='[OPTIONS] DIRECTORY' # Copyright (C) 2009 Luke Shumaker # This program is distributed in the hope that it will be useful, @@ -11,8 +11,8 @@ usage='[OPTIONS] DIRECTORY' # # Originally written by Luke Shumaker <lukeshu@sbcglobal.net>. -source "`rvs -d`/lib/stdio" -source "`rvs -d`/lib/rvsdb" +source "$RVSDIR/lib/stdio" +source "$RVSDIR/lib/rvsdb" # commit.d DIRNAME dir="$1" diff --git a/src/rvs-core/commit.f.sh b/src/rvs-core/commit.f.sh index ac645cd..a9be426 100644 --- a/src/rvs-core/commit.f.sh +++ b/src/rvs-core/commit.f.sh @@ -1,7 +1,7 @@ #!$$SHELL$$ # abomination module:rvs:commit:f name='rvs commit.f' -ver='0.6.0' +ver='0.6.3' usage='[OPTIONS] FILE' # Copyright (C) 2009 Luke Shumaker # This program is distributed in the hope that it will be useful, @@ -11,16 +11,16 @@ usage='[OPTIONS] FILE' # # Originally written by Luke Shumaker <lukeshu@sbcglobal.net>. -source "`rvs -d`/lib/stdio" -source "`rvs -d`/lib/rvsdb" +source "$RVSDIR/lib/stdio" +source "$RVSDIR/lib/rvsdb" # commit.f FILENAME file="$1" hash=`getid $file` -if [ ! -f "$repo/files/$hash" ]; then - #cp "$file" "$repo/files/$hash" - install -m 644 -o $USER -g $USER -T "$file" "$repo/files/$hash" +if [ ! -f "`rvs repo`/files/$hash" ]; then + #cp "$file" "`rvs repo`/files/$hash" + install -m 644 -o $USER -g $USER -T "$file" "`rvs repo`/files/$hash" fi echo "$hash" diff --git a/src/rvs-core/commit.sh b/src/rvs-core/commit.sh index 7fe1221..e54c9f4 100644 --- a/src/rvs-core/commit.sh +++ b/src/rvs-core/commit.sh @@ -1,7 +1,7 @@ #!$$SHELL$$ # abomination module:rvs:commit name='rvs commit' -ver='0.6.0' +ver='0.6.3' usage='[OPTIONS] [FILE]' # Copyright (C) 2009 Luke Shumaker # This program is distributed in the hope that it will be useful, @@ -11,8 +11,8 @@ usage='[OPTIONS] [FILE]' # # Originally written by Luke Shumaker <lukeshu@sbcglobal.net>. -source "`rvs -d`/lib/stdio" -source "`rvs -d`/lib/rvsdb" +source "$RVSDIR/lib/stdio" +source "$RVSDIR/lib/rvsdb" # commit FILE if [ $# -gt 0 ]; then diff --git a/src/rvs-core/get.d.sh b/src/rvs-core/get.d.sh index dcd78e8..a58a7c0 100644 --- a/src/rvs-core/get.d.sh +++ b/src/rvs-core/get.d.sh @@ -1,7 +1,7 @@ #!$$SHELL$$ # abomination module:rvs:get:d name='rvs get.d' -ver='0.6.0' +ver='0.6.3' usage='[OPTIONS] ID FILENAME' # Copyright (C) 2009 Luke Shumaker # This program is distributed in the hope that it will be useful, @@ -11,8 +11,8 @@ usage='[OPTIONS] ID FILENAME' # # Originally written by Luke Shumaker <lukeshu@sbcglobal.net>. -source "`rvs -d`/lib/stdio" -source "`rvs -d`/lib/rvsdb" +source "$RVSDIR/lib/stdio" +source "$RVSDIR/lib/rvsdb" # get.d ID DIRNAME id="$1" diff --git a/src/rvs-core/get.f.sh b/src/rvs-core/get.f.sh index 9e4cec7..3c17df5 100644 --- a/src/rvs-core/get.f.sh +++ b/src/rvs-core/get.f.sh @@ -1,7 +1,7 @@ #!$$SHELL$$ # abomination module:rvs:get:f name='rvs get.f' -ver='0.6.0' +ver='0.6.3' usage='[OPTIONS] ID FILENAME' # Copyright (C) 2009 Luke Shumaker # This program is distributed in the hope that it will be useful, @@ -11,12 +11,12 @@ usage='[OPTIONS] ID FILENAME' # # Originally written by Luke Shumaker <lukeshu@sbcglobal.net>. -source "`rvs -d`/lib/stdio" -source "`rvs -d`/lib/rvsdb" +source "$RVSDIR/lib/stdio" +source "$RVSDIR/lib/rvsdb" # get.f ID FILENAME id="$1" file="$2" -cp "$repo/files/$id" "$file" +cp "`rvs repo`/files/$id" "$file" diff --git a/src/rvs-core/get.sh b/src/rvs-core/get.sh index c1a2469..1d3eb76 100644 --- a/src/rvs-core/get.sh +++ b/src/rvs-core/get.sh @@ -1,7 +1,7 @@ #!$$SHELL$$ # abomination module:rvs:get name='rvs commit' -ver='0.6.0' +ver='0.6.3' usage='[OPTIONS] ID [FILENAME]' # Copyright (C) 2009 Luke Shumaker # This program is distributed in the hope that it will be useful, @@ -11,8 +11,8 @@ usage='[OPTIONS] ID [FILENAME]' # # Originally written by Luke Shumaker <lukeshu@sbcglobal.net>. -source "`rvs -d`/lib/stdio" -source "`rvs -d`/lib/rvsdb" +source "$RVSDIR/lib/stdio" +source "$RVSDIR/lib/rvsdb" # get ID [FILE] id="$1" diff --git a/src/rvs-core/init.sh b/src/rvs-core/init.sh index cb5866c..ff650a5 100644 --- a/src/rvs-core/init.sh +++ b/src/rvs-core/init.sh @@ -1,7 +1,7 @@ #!$$SHELL$$ # abomination rvs init name='rvs init' -ver='0.6.0' +ver='0.6.3' usage='[OPTIONS]' # Copyright (C) 2009 Luke Shumaker # This program is distributed in the hope that it will be useful, @@ -11,8 +11,8 @@ usage='[OPTIONS]' # # Originally written by Luke Shumaker <lukeshu@sbcglobal.net>. -source "`rvs -d`/lib/stdio" -source "`rvs -d`/lib/rvsdb" +source "$RVSDIR/lib/stdio" +source "$RVSDIR/lib/rvsdb" -mkdir -p $repo/{,files} +mkdir -p .rvs/{,files} diff --git a/src/rvs-core/lib/rvsdb.sh b/src/rvs-core/lib/rvsdb.sh index dcef0d6..41f0e03 100644 --- a/src/rvs-core/lib/rvsdb.sh +++ b/src/rvs-core/lib/rvsdb.sh @@ -1,7 +1,7 @@ #!$$SHELL$$ # abomination module:rvs:lib:rvsdb #name='rvs db' -#ver='0.6.2' +#ver='0.6.3' logver='0.6.0' # Copyright (C) 2009 Luke Shumaker # This program is distributed in the hope that it will be useful, @@ -13,8 +13,6 @@ logver='0.6.0' source "$RVSDIR/lib/stdio" -repo=`rvs repo` # this is left for back-compat, and should be gone by 0.6.3 - # getid file getid() { #md5sum $file | sed "s/ .*$//" @@ -19,8 +19,6 @@ source "$RVSDIR/lib/stdio" com=$1; # END OPTION HANDLING # case "$com" in - # -d is left for back-compat, should be removed by the end of 0.6.3 - -d) echo "$RVSDIR";; '') error 'no command specified';; *) if [ -f "$RVSDIR/$com" ]; then |