git-annex/doc/git-annex-fix.mdwn

# NAME

git-annex fix - fix up links to annexed content

# SYNOPSIS

git annex fix `[path ...]`

# DESCRIPTION

Fixes up symlinks that have become broken to again point to annexed
content.

This is useful to run manually when you have been moving the symlinks
around, but is done automatically when committing a change with git too.

Also, adjusts unlocked files to be copies or hard links as
configured by annex.thin.

# OPTIONS

* file matching options
  
  The [[git-annex-matching-options]](1)
  can be used to specify files to fix.

* `--json`

  Enable JSON output. This is intended to be parsed by programs that use
  git-annex. Each line of output is a JSON object.

* `--json-error-messages`

  Messages that would normally be output to standard error are included in
  the JSON instead.

* Also the [[git-annex-common-options]](1) can be used.

# SEE ALSO

[[git-annex]](1)

[[git-annex-fsck]](1)

# AUTHOR

Joey Hess <id@joeyh.name>

Warning: Automatically converted into a man page by mdwn2man. Edit with care.
separated man pages for all the maintenance commands 2015-03-24 19:23:59 +00:00			`# NAME`

annex.thin Decided it's too scary to make v6 unlocked files have 1 copy by default, but that should be available to those who need it. This is consistent with git-annex not dropping unused content without --force, etc. * Added annex.thin setting, which makes unlocked files in v6 repositories be hard linked to their content, instead of a copy. This saves disk space but means any modification of an unlocked file will lose the local (and possibly only) copy of the old version. * Enable annex.thin by default on upgrade from direct mode to v6, since direct mode made the same tradeoff. * fix: Adjusts unlocked files as configured by annex.thin. 2015-12-27 19:59:59 +00:00			`git-annex fix - fix up links to annexed content`
separated man pages for all the maintenance commands 2015-03-24 19:23:59 +00:00
			`# SYNOPSIS`

			git annex fix `[path ...]`

			`# DESCRIPTION`

			`Fixes up symlinks that have become broken to again point to annexed`
			`content.`

annex.thin Decided it's too scary to make v6 unlocked files have 1 copy by default, but that should be available to those who need it. This is consistent with git-annex not dropping unused content without --force, etc. * Added annex.thin setting, which makes unlocked files in v6 repositories be hard linked to their content, instead of a copy. This saves disk space but means any modification of an unlocked file will lose the local (and possibly only) copy of the old version. * Enable annex.thin by default on upgrade from direct mode to v6, since direct mode made the same tradeoff. * fix: Adjusts unlocked files as configured by annex.thin. 2015-12-27 19:59:59 +00:00			`This is useful to run manually when you have been moving the symlinks`
			`around, but is done automatically when committing a change with git too.`

			`Also, adjusts unlocked files to be copies or hard links as`
			`configured by annex.thin.`
separated man pages for all the maintenance commands 2015-03-24 19:23:59 +00:00
			`# OPTIONS`

			`* file matching options`

			`The [[git-annex-matching-options]](1)`
			`can be used to specify files to fix.`

fix: Support --json and --json-error-messages And triaged out some commands that don't need to support these options. Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project 2023-05-04 18:28:21 +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.`

			* `--json-error-messages`

			`Messages that would normally be output to standard error are included in`
			`the JSON instead.`

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)`

expand manpages cross-references significantly i found that most man pages only had references to the main git-annex manpage, which i stillfind pretty huge and hard to navigate through. i tried to sift through all the man pages and add cross-references between relevant pages. my general rule of thumb is that links should be both ways unless one of the pages is a more general page that would become ridiculously huge if all backlinks would be added (git-annex-preferred-content comes to mind). i have also make the links one per line as this is how it was done in the metadata pages so far. i did everything but the plumbing, utility and test commands, although some of those are linked from the other commands so cross-links were added there as well. 2015-05-29 16:12:55 +00:00			`[[git-annex-fsck]](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.`