Skip to content

git-lfs help contradicts the documentation #5041

@rpgoldman

Description

@rpgoldman

Describe the bug

When I type git lfs help to the shell, I see (among other things) the following:

Examples
--------

To get started with Git LFS, the following commands can be used.

 1. Setup Git LFS on your system. You only have to do this once per
    repository per machine:

        git lfs install

However, when I look at the documentation page, I see this:

Download and install the Git command line extension. Once downloaded and installed, set up Git LFS for your user account by running:

git lfs install

You only need to run this once per user account. [italics mine]

So one of these two must be wrong: either you need to install in each working copy, or you only need to install once for your user account on whatever machine you are working on.

To Reproduce

git lfs help

Expected behavior

Help string agrees with documentation (or documentation is revised)

System environment

MacOS Monterey

git-lfs from Homebrew

$ git-lfs --version
git-lfs/3.2.0 (GitHub; darwin arm64; go 1.18.2)

Comments

This is related to #4032, which seems to have partially fixed the problem, but it seems like the out-of-date wording persists in at least one location

When I search for "per repository" I find it here in the source code for the man page, in "Examples".

I don't know what the relationship is between the man page and the help text.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions