From ccf0a346b6d28f03afb4d87ac6da554347a75e37 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Thu, 6 Feb 2020 09:42:20 -0700 Subject: improvements & tweaks to docs Signed-off-by: Sean Whitton --- README | 4 ++-- bin/annex-review-unused | 8 ++++---- bin/annex-to-annex | 8 ++++---- bin/annex-to-annex-dropunused | 4 ++-- bin/annex-to-annex-reinject | 8 +++++--- lib/Git/Annex.pm | 7 ++----- lib/Git/Annex/BatchCommand.pm | 7 ++----- 7 files changed, 21 insertions(+), 25 deletions(-) diff --git a/README b/README index 9a42826..d550c62 100644 --- a/README +++ b/README @@ -6,10 +6,10 @@ use of this interface. Requires git-annex installed to be useful. Git::Annex -- class representing a git-annex repository -annex-review-unused -- interactively process `git annex unused` output - annex-to-annex -- use hardlinks to migrate files between git annex repos +annex-review-unused -- interactively process `git annex unused` output + INSTALLATION To install this module, run the following commands: diff --git a/bin/annex-review-unused b/bin/annex-review-unused index 4c06307..082f058 100755 --- a/bin/annex-review-unused +++ b/bin/annex-review-unused @@ -1,7 +1,7 @@ #!/usr/bin/perl # PODNAME: annex-review-unused # ABSTRACT: interactively process `git annex unused` output - +# # Copyright (C) 2019-2020 Sean Whitton # # This program is free software: you can redistribute it and/or modify @@ -24,9 +24,9 @@ B [B<--just-print>] [B<--from=>I] [B<--used-refspec =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, by running -git-log(1). +repository, choosing which you'd like to drop. By running git-log(1), +it provides more information about unused files than does B. =head1 OPTIONS diff --git a/bin/annex-to-annex b/bin/annex-to-annex index 517bdcd..ee16f05 100755 --- a/bin/annex-to-annex +++ b/bin/annex-to-annex @@ -1,7 +1,7 @@ #!/usr/bin/perl # PODNAME: annex-to-annex # ABSTRACT: use hardlinks to migrate files between git annex repos - +# # Copyright (C) 2019-2020 Sean Whitton # # This program is free software: you can redistribute it and/or modify @@ -24,8 +24,8 @@ B [B<--commit>] I ... I =head1 DESCRIPTION This script moves files and directories from one or more git annexes -into a destination git annex, using hardlinks rather than copying -files where possible. +into a destination git annex, where possible using hardlinks instead +of copying files. It is useful for splitting and consolidating git annexes. For example, at the end of the semester I use this script to move files @@ -48,7 +48,7 @@ changes are merely added to the index. =head1 SEE ALSO -git-annex(1) +git-annex(1), annex-to-annex-dropunused(1), annex-to-annex-reinject(1) =cut diff --git a/bin/annex-to-annex-dropunused b/bin/annex-to-annex-dropunused index a90b45f..9abb25f 100755 --- a/bin/annex-to-annex-dropunused +++ b/bin/annex-to-annex-dropunused @@ -1,7 +1,7 @@ #!/usr/bin/perl # PODNAME: annex-to-annex-dropunused # ABSTRACT: drop old hardlinks migrated by annex-to-annex - +# # Copyright (C) 2019-2020 Sean Whitton # # This program is free software: you can redistribute it and/or modify @@ -36,7 +36,7 @@ None. =head1 SEE ALSO -annex-to-annex(1) +git-annex-dropunused(1), annex-to-annex(1), annex-to-annex-reinject(1) =cut diff --git a/bin/annex-to-annex-reinject b/bin/annex-to-annex-reinject index 66b39ca..897c007 100755 --- a/bin/annex-to-annex-reinject +++ b/bin/annex-to-annex-reinject @@ -1,7 +1,7 @@ #!/usr/bin/perl # PODNAME: annex-to-annex-reinject # ABSTRACT: use 'git annex reinject' to redo annex-to-annex - +# # Copyright (C) 2019-2020 Sean Whitton # # This program is free software: you can redistribute it and/or modify @@ -25,7 +25,9 @@ B I I Wrapper around B, invoked in I, on the files in the git-annex objects dir of the I -(usually I/.git/annex/objects). +(usually I/.git/annex/objects). After reinjecting files, +the git-annex branch of I is updated so that it does not +think the content is present there anymore. 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. @@ -44,7 +46,7 @@ None. =head1 SEE ALSO -annex-to-annex(1), annex-to-annex-dropunused(1) +git-annex-reinject(1), annex-to-annex(1), annex-to-annex-dropunused(1) =cut diff --git a/lib/Git/Annex.pm b/lib/Git/Annex.pm index cd274f7..031148c 100644 --- a/lib/Git/Annex.pm +++ b/lib/Git/Annex.pm @@ -1,5 +1,5 @@ -# Git::Annex -# Perl interface to git-annex repositories +package Git::Annex; +# ABSTRACT: Perl interface to git-annex repositories # # Copyright (C) 2019-2020 Sean Whitton # @@ -48,9 +48,6 @@ git-annex. =cut -package Git::Annex; -# ABSTRACT: Perl interface to git-annex repositories - use 5.028; use strict; use warnings; diff --git a/lib/Git/Annex/BatchCommand.pm b/lib/Git/Annex/BatchCommand.pm index 249b53d..1629bb1 100644 --- a/lib/Git/Annex/BatchCommand.pm +++ b/lib/Git/Annex/BatchCommand.pm @@ -1,5 +1,5 @@ -# Git::Annex -# Perl interface to git-annex repositories +package Git::Annex::BatchCommand; +# ABSTRACT: Perl interface to git-annex --batch commands # # Copyright (C) 2020 Sean Whitton # @@ -38,9 +38,6 @@ processes to perform queries or request changes. =cut -package Git::Annex::BatchCommand; -# ABSTRACT: Perl interface to git-annex --batch commands - use 5.028; use strict; use warnings; -- cgit v1.2.3