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

Jump to bottom

Missing documentation upstream? (Document how $HOME is set on Windows) #5282

Open
1 task done
alejandro5042 opened this issue Nov 26, 2024 · 2 comments · May be fixed by gitgitgadget/git#1834
Open
1 task done

Missing documentation upstream? (Document how $HOME is set on Windows) #5282

alejandro5042 opened this issue Nov 26, 2024 · 2 comments · May be fixed by gitgitgadget/git#1834

Comments

@alejandro5042
Copy link

  • I was not able to find an open or closed issue matching what I'm seeing

Migrating the discussion in a commit comment to an issue.

Here's what @hickford said in 4931518#commitcomment-149554802:

image
@alejandro5042 @dscho Any idea why this paragraph doesn't appear at https://git-scm.com/docs/git ? Does the change have to be upstreamed to https://github.com/git/git/blob/master/Documentation/git.txt ?

I'll be honest, I'm not sure. Maybe it's cause this is the Windows version of Git, and perhaps this functionality wasn't upstream?

Here's what I'm finding:

  • My original commit was back in March 2018 in 6e494ad
  • However, the Windows functionality was upstreamed July 2019 in git@e12a955

Seems like that July 2019 commit should have included my documentation change.
alejandro5042 referenced this issue Nov 26, 2024
@alejandro5042 @dscho
Document how $HOME is set on Windows
4931518 
Git documentation refers to $HOME and $XDG_CONFIG_HOME often, but does not specify how or where these values come from on Windows where neither is set by default. The new documentation reflects the behavior of setup_windows_environment() in compat/mingw.c.

Signed-off-by: Alejandro Barreto <[email protected]>
@dscho
Copy link
Member

dscho commented Nov 26, 2024

Any idea why this paragraph doesn't appear at https://git-scm.com/docs/git ? Does the change have to be upstreamed to https://github.com/git/git/blob/master/Documentation/git.txt ?

Yes, and yes ;-)

Here's what I'm finding:

  • My original commit was back in March 2018 in 6e494ad
  • However, the Windows functionality was upstreamed July 2019 in git@e12a955

Seems like that July 2019 commit should have included my documentation change.

Too true.

A lot of Git for Windows' patches have to be upstreamed, and I'll be honest with you: The reason why I don't spend more time on upstreaming these patches is the process that requires sending patches to a mailing list where reviewers' priorities seem to diverge from mine...

If you want to take some of that burden from my shoulders, I would be delighted.

@hickford
Copy link

hickford commented Dec 8, 2024

Upstream PR at gitgitgadget#1834 ready to send

@hickford hickford linked a pull request Dec 9, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document how $HOME is set on Windows hickford/git
3 participants
@hickford @dscho @alejandro5042