mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
git-annex/doc/git-annex-log.mdwn

148 lines
4.1 KiB
Text
Raw Normal View History

separated man pages for all the maintenance commands
2015-03-24 19:23:59 +00:00
# NAME
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
git-annex log - shows location log information
separated man pages for all the maintenance commands
2015-03-24 19:23:59 +00:00
# SYNOPSIS
git annex log `[path ...]`
# DESCRIPTION
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
This command displays information from the history of the git-annex branch.
separated man pages for all the maintenance commands
2015-03-24 19:23:59 +00:00
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
Several things can prevent that information being available to display.
git-annex log --sizes CSV format so it can be fed into a program to graph it. Note that dead repositories are not yet handled so their sizes show as nonzero after they are marked dead. Sponsored-By: k0ld on Patreon
2023-11-13 17:07:22 +00:00
When [[git-annex-forget]] is used, old historical
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
data gets cleared from the branch. When annex.private or
add note to git-annex-log man page about when information is not available
2021-04-23 18:53:38 +00:00
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.
separated man pages for all the maintenance commands
2015-03-24 19:23:59 +00:00
# OPTIONS
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
* `[path ...]`
Displays the location log for the specified file or files, showing each
repository they were added to ("+") and removed from ("-"). Note that
it displays information about the file content currently at these paths,
not for any different content that was there in earlier commits.
* matching options
The [[git-annex-matching-options]](1)
can be used to control what to act on when displaying the location log
for specified files.
* `--all` `-A`
Shows location log changes to all content, with the most recent changes first.
In this mode, the names of files are not available and keys are displayed
instead.
* `--sizesof=repository`
git-annex log --sizes CSV format so it can be fed into a program to graph it. Note that dead repositories are not yet handled so their sizes show as nonzero after they are marked dead. Sponsored-By: k0ld on Patreon
2023-11-13 17:07:22 +00:00
Displays a history of the total size of the annexed files in a repository
git-annex log --received modifier option Only counting received and not dropped makes this show the bandwidth of data coming into the repository, although only in a sense. Since git-annex branch updates only happen at the end of a command, and we don't know when a command started, it's only an approximation of the actual bandwidth. (A previous git-annex branch update made have happened in a different repository.) It would be possible to also add a --dropped option, but I don't know how useful that would be? Sponsored-by: Nicholas Golder-Manning on Patreon
2023-11-14 18:00:06 +00:00
over time from the creation of the repository to the present.
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
The repository can be "here" for the current repository, or the name of a
remote, or a repository description or uuid.
git-annex log --sizes CSV format so it can be fed into a program to graph it. Note that dead repositories are not yet handled so their sizes show as nonzero after they are marked dead. Sponsored-By: k0ld on Patreon
2023-11-13 17:07:22 +00:00
Note that keys that do not have a known size are not included in the
total.
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
* `--sizes`
This is like --sizesof, but rather than display the size of a single
git-annex log --sizes CSV format so it can be fed into a program to graph it. Note that dead repositories are not yet handled so their sizes show as nonzero after they are marked dead. Sponsored-By: k0ld on Patreon
2023-11-13 17:07:22 +00:00
repository, it displays the sizes of all known repositories.
The output is a CSV formatted table.
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
* `--totalsizes`
This is like `--sizesof`, but it displays the total size of all
known repositories.
rename --when to --interval More accurately describes its behavior.
2023-11-14 15:45:16 +00:00
* `--interval=time`
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
When using `--sizesof`, `--sizes`, and `--totalsizes`, this
rename --when to --interval More accurately describes its behavior.
2023-11-14 15:45:16 +00:00
controls the minimum interval between displays of the size.
git-annex log --received modifier option Only counting received and not dropped makes this show the bandwidth of data coming into the repository, although only in a sense. Since git-annex branch updates only happen at the end of a command, and we don't know when a command started, it's only an approximation of the actual bandwidth. (A previous git-annex branch update made have happened in a different repository.) It would be possible to also add a --dropped option, but I don't know how useful that would be? Sponsored-by: Nicholas Golder-Manning on Patreon
2023-11-14 18:00:06 +00:00
The default is to display each new recorded size.
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
The time is of the form "30d" or "1y".
git-annex log --received modifier option Only counting received and not dropped makes this show the bandwidth of data coming into the repository, although only in a sense. Since git-annex branch updates only happen at the end of a command, and we don't know when a command started, it's only an approximation of the actual bandwidth. (A previous git-annex branch update made have happened in a different repository.) It would be possible to also add a --dropped option, but I don't know how useful that would be? Sponsored-by: Nicholas Golder-Manning on Patreon
2023-11-14 18:00:06 +00:00
* `--received`
separated man pages for all the maintenance commands
2015-03-24 19:23:59 +00:00
git-annex log --received modifier option Only counting received and not dropped makes this show the bandwidth of data coming into the repository, although only in a sense. Since git-annex branch updates only happen at the end of a command, and we don't know when a command started, it's only an approximation of the actual bandwidth. (A previous git-annex branch update made have happened in a different repository.) It would be possible to also add a --dropped option, but I don't know how useful that would be? Sponsored-by: Nicholas Golder-Manning on Patreon
2023-11-14 18:00:06 +00:00
Combine this option with `--sizesof` or `--sizes` to display
the amount of data received into repositories since the last
line was output.
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
git-annex log --gnuplot The gnuplot output is pretty good, but could still be improved with: * more colors (repeating colors is confusing with a lot of repos) * better positioning of the legend, making the plot wider and moving it from over top of the graph Sponsored-by: Kevin Mueller on Patreon
2023-11-14 18:56:58 +00:00
* `--gnuplot`
Combine this option with `--sizesof` or `--sizes` or `--totalsizes`
to use gnuplot(1) to graph the data. The gnuplot file will be left on
disk for you to reuse.
For example, to graph the sizes of all repositories:
git-annex log --sizes --interval=1d --gnuplot
To graph the amount of new data received into each repository every 30
days:
git-annex log --sizes --interval=30d --gnuplot --recieved
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
* `--bytes`
Show sizes in bytes, disabling the default nicer units.
log --raw-date: Use to display seconds from unix epoch.
2016-03-29 18:39:16 +00:00
* `--raw-date`
Rather than the normal display of a date in the local time zone,
displays seconds since the unix epoch.
git-annex log --received modifier option Only counting received and not dropped makes this show the bandwidth of data coming into the repository, although only in a sense. Since git-annex branch updates only happen at the end of a command, and we don't know when a command started, it's only an approximation of the actual bandwidth. (A previous git-annex branch update made have happened in a different repository.) It would be possible to also add a --dropped option, but I don't know how useful that would be? Sponsored-by: Nicholas Golder-Manning on Patreon
2023-11-14 18:00:06 +00:00
* `--since=date`, `--after=date`, `--until=date`, `--before=date`, `--max-count=N`
These options are passed through to `git log`, and can be used to limit
how far back to search for location log changes.
For example: `--since "1 month ago"`
These options do not have an affect when using `--sizesof`, `--sizes`,
and `--totalsizes`.
separated man pages for all the maintenance commands
2015-03-24 19:23:59 +00:00
* `--gource`
Generates output suitable for the `gource` visualization program.
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
This option does not have an affect when using `--sizesof`, `--sizes`,
and `--totalsizes`.
separated man pages for all the maintenance commands
2015-03-24 19:23:59 +00:00
log: Support --json and --json-error-messages Also in passing the --all display was fixed up to not quote keys like filenames. Note that the check added to compareChanges was needed to avoid logging when nothing changed. Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project
2023-05-04 16:36:31 +00:00
* `--json`
Enable JSON output. This is intended to be parsed by programs that use
git-annex. Each line of output is a JSON object.
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
This option does not have an affect when using `--sizesof`, `--sizes`,
and `--totalsizes`.
log: Support --json and --json-error-messages Also in passing the --all display was fixed up to not quote keys like filenames. Note that the check added to compareChanges was needed to avoid logging when nothing changed. Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project
2023-05-04 16:36:31 +00:00
* `--json-error-messages`
Messages that would normally be output to standard error are included in
the JSON instead.
separated man pages for all the maintenance commands
2015-03-24 19:23:59 +00:00
git-annex log --sizesof This can take a lot of memory. I decided to violate the usual rule in git-annex that it operate in constant memory no matter how many annexed objects. In this case, it would be hard to be fast without using a big map of the location logs. The main difficulty here is that there can be many git-annex branches and it needs to display a consistent view at a point in time, which means merging information from multiple git-annex branches. I have not checked if there are any laziness leaks in this code. It takes 1 gb to run in my big repo, which is around what I estimated before writing it. 2 options that are documented are not yet implemented. Small bug: With eg --when=1h, it will display at 12:00 then 1:10 if the next change after 12:59 is then. Then it waits until after 2:10 to display the next change. It ought to wait until after 2:00. Sponsored-by: Brock Spratlen on Patreon
2023-11-10 20:17:15 +00:00
This option does not have an affect when using `--sizesof`, `--sizes`,
and `--totalsizes`.
log: Added --all option.
2016-07-17 19:15:08 +00:00
split out common options to its own page and mention it on each subcommand page Sometimes users would get confused because an option they were looking for was not mentioned on a subcommand's man page, and they had not noticed that the main git-annex man page had a list of common options. This change lets each subcommand mention the common options, similarly to how the matching options are handled. This commit was sponsored by Svenne Krap on Patreon.
2021-05-10 19:00:13 +00:00
* Also the [[git-annex-common-options]](1) can be used.
separated man pages for all the maintenance commands
2015-03-24 19:23:59 +00:00
# SEE ALSO
[[git-annex]](1)
remove redundant options header
2015-07-06 22:22:27 +00:00
[[git-annex-forget]](1)
separated man pages for all the maintenance commands
2015-03-24 19:23:59 +00:00
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
Reference in a new issue Copy permalink