summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2010-11-15 18:04:19 -0400
committerGravatar Joey Hess <joey@kitenet.net>2010-11-15 18:04:19 -0400
commit748a7475bb99e1127dc12bb2cc9d5653e4648200 (patch)
tree1f8a191a561715b4ff22949e420b452380ab1f6e /doc
parent9dc43d25995b085745c16cc31ad11106a74a9973 (diff)
dropunused
Diffstat (limited to 'doc')
-rw-r--r--doc/git-annex.mdwn61
-rw-r--r--doc/walkthrough.mdwn10
2 files changed, 40 insertions, 31 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index a522534da..618ddf203 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -112,6 +112,32 @@ Many git-annex subcommands will stage changes for later `git commit` by you.
Use this to undo an unlock command if you don't want to modify
the files, or have made modifications you want to discard.
+* fsck [path ...]
+
+ With no parameters, this subcommand checks the whole annex for consistency,
+ and warns about any problems found.
+
+ With parameters, only the specified files are checked.
+
+* unused
+
+ Checks the annex for data that is not used by any files currently
+ in the annex, and prints a numbered list of the data.
+
+ (This is run as part of `git annex fsck`.)
+
+* dropunused [number ...]
+
+ Drops the data corresponding to the numbers, as listed by the last
+ `git annex unused` or `git annex fsck`
+
+* find [path ...]
+
+ Outputs a list of annexed files whose content is currently present.
+
+ With no parameters, defaults to finding all files in the current directory
+ and its subdirectories.
+
* unannex [path ...]
Use this to undo an accidental add command. This is not the command you
@@ -159,25 +185,6 @@ Many git-annex subcommands will stage changes for later `git commit` by you.
git annex setkey --key=1287765018:3 /tmp/file
-* fsck [path ...]
-
- With no parameters, this subcommand checks the whole annex for consistency,
- and warns about any problems found.
-
- With parameters, only the specified files are checked.
-
-* unused
-
- Checks the annex for data that is not used by any files currently
- in the annex, and prints a report.
-
-* find [path ...]
-
- Outputs a list of annexed files whose content is currently present.
-
- With no parameters, defaults to finding all files in the current directory
- and its subdirectories.
-
# OPTIONS
* --force
@@ -194,14 +201,6 @@ Many git-annex subcommands will stage changes for later `git commit` by you.
Enable verbose logging.
-* --backend=name
-
- Specifies the key-value backend to use when adding a file.
-
-* --key=name
-
- Specifies a key to operate on, for use with the addkey subcommand.
-
* --from=repository
Specifies a repository that content will be retrieved from.
@@ -212,6 +211,14 @@ Many git-annex subcommands will stage changes for later `git commit` by you.
Specifies a git repository that content will be sent to.
It should be specified using the name of a configured git remote.
+* --backend=name
+
+ Specifies which key-value backend to use.
+
+* --key=name
+
+ Specifies a key to operate on.
+
# CONFIGURATION
Like other git commands, git-annex is configured via `git-config`.
diff --git a/doc/walkthrough.mdwn b/doc/walkthrough.mdwn
index 9a6ee220c..1e07053ae 100644
--- a/doc/walkthrough.mdwn
+++ b/doc/walkthrough.mdwn
@@ -287,7 +287,7 @@ setting is satisfied for all files, and it warns about any dangling values
in `.git/annex/objects/`.
# git annex fsck
- fsck (checking for unused data...) ok
+ unused (checking for unused data...) ok
fsck my_cool_big_file (checksum...) ok
......
@@ -304,10 +304,12 @@ Fsck never deletes possibly bad data; instead it will be moved to
might say about a badly messed up annex:
# git annex fsck
- fsck (checking for unused data...)
+ unused (checking for unused data...)
Some annexed data is no longer pointed to by any files in the repository.
- If this data is no longer needed, it can be removed using git-annex dropkey:
- WORM:1289672605:3:file
+ NUMBER KEY
+ 1 WORM:1289672605:3:file
+ (To see where data was previously used, try: git log --stat -S'KEY')
+ (To remove unwanted data: git-annex dropunused NUMBER)
failed
fsck my_cool_big_file (checksum...)
Bad file content; moved to .git/annex/bad/SHA1:7da006579dd64330eb2456001fd01948430572f2