Skip to content

Docs around filter + sparse checkout are misleading #2247

@heikomat

Description

@heikomat

The docs for the filter option say the following:

Partially clone against a given filter. Overrides sparse-checkout if set.

This is misleading. It led me to believe, that i cannot use filter and sparse-checkout together. But from what i can see, that is absolutely possible.

When looking at the Pull Request that added these docs:

you can see here that adding a filter does not disable sparse-checkout. It just overrides the filter that is automatically applied when sparse-checkout is set

If i've interpreted the situation incorrectly, please let me know. otherwise i suggest to improve the wording in the docs regarding the filter option.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions