diff options
author | Sean Whitton <spwhitton@spwhitton.name> | 2020-02-05 20:48:42 -0700 |
---|---|---|
committer | Sean Whitton <spwhitton@spwhitton.name> | 2020-02-05 20:50:51 -0700 |
commit | 940358e1257953c983e4f50ece1ef90045cf2dba (patch) | |
tree | 931183a8a0dc71d6786fe845a653222315a5dbfa | |
parent | 71f9b1b7d52e3b1d9c3ab20ed3fa6bc0076aba0e (diff) | |
download | p5-Git-Annex-940358e1257953c983e4f50ece1ef90045cf2dba.tar.gz |
fill out PODs
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
-rwxr-xr-x | bin/annex-review-unused | 32 | ||||
-rwxr-xr-x | bin/annex-to-annex | 20 | ||||
-rwxr-xr-x | bin/annex-to-annex-dropunused | 15 | ||||
-rwxr-xr-x | bin/annex-to-annex-reinject | 23 |
4 files changed, 86 insertions, 4 deletions
diff --git a/bin/annex-review-unused b/bin/annex-review-unused index 1d4ae11..ce43641 100755 --- a/bin/annex-review-unused +++ b/bin/annex-review-unused @@ -19,11 +19,41 @@ =head1 SYNOPSIS - +B<annex-review-unused> [B<--just-print>] [B<--from=>I<REMOTE>] [B<--used-refspec=>I<USEDREFSPEC>] =head1 DESCRIPTION +This program lets you interactively review unused files in a git annex +repository, choosing which you'd like to drop. It provides more +information about unused files that B<git annex unused>, by running +git-log(1). + +=head1 OPTIONS + +=over 4 + +=item B<--just-print> + +Run non-interactively: gather and print information about unused +files, and then exit. + +=item B<--from=>I<REMOTE> + +Passed on to B<git annex unused>. + +=item B<--used-refspec=>I<USEDREFSPEC> + +Passed on to B<git annex unused>. + +=back + +=head1 EXIT STATUS + +0 if there are no unused files left at time of program exit, 1 if there are. + +=head1 SEE ALSO +git-annex-unused(1), git-annex-dropunused(1) =cut diff --git a/bin/annex-to-annex b/bin/annex-to-annex index 8d94ba0..517bdcd 100755 --- a/bin/annex-to-annex +++ b/bin/annex-to-annex @@ -19,7 +19,7 @@ =head1 SYNOPSIS - +B<annex-to-annex> [B<--commit>] I<source> ... I<destination> =head1 DESCRIPTION @@ -32,6 +32,24 @@ example, at the end of the semester I use this script to move files from my work annex, which gets synced to a lot of places, into an archival annex, which doesn't. +Each I<source> should be a file or directory in a git annex. +I<destination> should be a subdirectory of a git annex. + +=head1 OPTIONS + +=over 4 + +=item B<--commit> + +Commit changes in the source and destination annexes. Otherwise +changes are merely added to the index. + +=back + +=head1 SEE ALSO + +git-annex(1) + =cut use 5.028; diff --git a/bin/annex-to-annex-dropunused b/bin/annex-to-annex-dropunused index 508b79a..a90b45f 100755 --- a/bin/annex-to-annex-dropunused +++ b/bin/annex-to-annex-dropunused @@ -19,11 +19,24 @@ =head1 SYNOPSIS - +B<annex-to-annex-dropunused> =head1 DESCRIPTION +This program drops files which have been migrated by +annex-to-annex(1). You can run it in the source annex(es) to get rid +of the old unused files which are known to have been migrated. + +Only files which have been hardlinked into the destination annex will +be removed, i.e., no data will be irrevocably removed by this command. + +=head1 OPTIONS + +None. + +=head1 SEE ALSO +annex-to-annex(1) =cut diff --git a/bin/annex-to-annex-reinject b/bin/annex-to-annex-reinject index 023ebe3..66b39ca 100755 --- a/bin/annex-to-annex-reinject +++ b/bin/annex-to-annex-reinject @@ -19,11 +19,32 @@ =head1 SYNOPSIS - +B<annex-to-annex-reinject> I<SOURCEANNEX> I<DESTANNEX> =head1 DESCRIPTION +Wrapper around B<git annex reinject --known>, invoked in I<DESTANNEX>, +on the files in the git-annex objects dir of the I<SOURCEANNEX> +(usually I<SOURCEANNEX>/.git/annex/objects). + +Suppose that you use annex-to-annex(1) to migrate files from ~/work to +~/old on your laptop, where each of ~/work and ~/old are git annexes. +Then on your USB backup drive, you can use this script to move the +contents of migrated files from your clone of ~/work to your clone of ~/old: + +=over 4 + + % annex-to-annex-reinject /media/spwhitton/usb/work /media/spwhitton/usb/old + +=back + +=head1 OPTIONS + +None. + +=head1 SEE ALSO +annex-to-annex(1), annex-to-annex-dropunused(1) =cut |