From 34c2d13dce10d7cad215ae3650356aab9ad205de Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Fri, 23 Apr 2021 14:53:38 -0400 Subject: [PATCH] add note to git-annex-log man page about when information is not available --- doc/git-annex-log.mdwn | 14 +++++++++++--- doc/todo/hiding_a_repository.mdwn | 13 ------------- 2 files changed, 11 insertions(+), 16 deletions(-) diff --git a/doc/git-annex-log.mdwn b/doc/git-annex-log.mdwn index 486b9853fa..a5169727e8 100644 --- a/doc/git-annex-log.mdwn +++ b/doc/git-annex-log.mdwn @@ -8,11 +8,19 @@ git annex log `[path ...]` # DESCRIPTION -Displays the location log for the specified file or files, -showing each repository they were added to ("+") and removed from ("-"). -Note that the location log is for the particular file contents currently at these paths, +Displays the location log for the specified file or files, showing each +repository they were added to ("+") and removed from ("-"). Note that the +location log is for the particular file contents currently at these paths, not for any different content that was there in earlier commits. +This displays information from the history of the git-annex branch. Several +things can prevent that information being available to display. When +[[git-annex-dead]] and [[git-annex-forget]] are used, old historical +data gets cleared from the branch. When annex.private or +remote.name.annex-private is configured, git-annex does not write +information to the branch at all. And when annex.alwayscommit is set to +false, information may not have been committed to the branch yet. + # OPTIONS * `--since=date`, `--after=date`, `--until=date`, `--before=date`, `--max-count=N` diff --git a/doc/todo/hiding_a_repository.mdwn b/doc/todo/hiding_a_repository.mdwn index 2e96364a6a..55815104c2 100644 --- a/doc/todo/hiding_a_repository.mdwn +++ b/doc/todo/hiding_a_repository.mdwn @@ -145,19 +145,6 @@ all reads followed by writes do go via Annex.Branch.change, so Annex.Branch.get can just concacenate the two without worrying about it leaking back out in a later write. -> Implementing this is in progress, in the `hiddenannex` branch. -> -> Got the separate journal mostly working. No separate index yet. -> No way to configure what repo is hidden yet. --[[Joey]] -> -> Implementation notes: -> -> * [[bugs/git-annex_branch_caching_bug]] was a problem, now fixed. -> * Any other similar direct accesses of the branch, not going through -> Annex.Branch, also need to be fixed (and may be missing journal files -> already?) Most fixed now. Command.Log behavior needs to be -> investigated still. - ## networks of hidden repos There are a lot of complications involving using hidden repos as remotes.