Skip to main content

## warn_symlink_checked_out_as_plain_text_file

# Function warn_symlink_checked_out_as_plain_text_file

Source

    fn warn_symlink_checked_out_as_plain_text_file(
        gctx: &GlobalContext,
        src_files: &[PathEntry],
        repo: &Repository,
    ) -> CargoResult<()>

Expand description

Warns if any symlinks were checked out as plain text files.

Git config `core.symlinks` defaults to true when unset. In git-for-windows (and git as well), the config should be set to false explicitly when the repo was created, if symlink support wasn’t detected 1.

We assume the config was always set at creation time and never changed. So, if it is true, we don’t bother users with any warning.

1. https://github.com/git-for-windows/git/blob/f1241afcc7956918d5da33ef74abd9cbba369247/setup.c#L2394-L2403 ↩