Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include information about GIT_PAGER in manual #991

Merged
merged 1 commit into from
Feb 26, 2022
Merged

Include information about GIT_PAGER in manual #991

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions manual/src/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ The most convenient way to configure delta is with a `[delta]` section in `~/.gi

</sub>

If you have the `GIT_PAGER` environment variable set, you'll need to unset it.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @katylava, good call! This is definitely worth mentioning. Shall we maybe tweak that to say that they can set GIT_PAGER=delta, or unset it?

Copy link
Contributor Author

@katylava katylava Feb 26, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think saying more would require more explanation as well, and since the documentation on this page is just to get people started, it should probably be kept short. Like I think if you say they can set it, you'll also have to explain that it overrides what is in .gitconfig under core.pager. And then explain why they might want it in one place over the other.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you're right. OK, thanks a lot -- I'll merge this now and maybe explain more later.

(It might be nice at some point to make a delta doctor command that, among other things, would check for relevant environment variables and warn if they look like not what the user wanted.)


Use `delta --help` to see all the available options.

Note that delta style argument values in ~/.gitconfig should be in double quotes, like `--minus-style="syntax #340001"`. For theme names and other values, do not use quotes as they will be passed on to delta, like `theme = Monokai Extended`.
Expand Down