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.

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

Update references to default branch in docs #1126

Merged
merged 1 commit into from
Jul 20, 2020

Conversation

emkll
Copy link
Contributor

@emkll emkll commented Jul 15, 2020

Description

Fixes #1122

Test Plan

Docs changes only

  • URLs that were changed point to the correct files on the correct branch

Copy link
Contributor

@sssoleileraaa sssoleileraaa left a comment

Choose a reason for hiding this comment

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

lgtm

notes about using HEAD instead of the branch name (thanks @maeve-fpf for the pro-tip):

  • HEAD of a remote is defined as the "default branch" of the remote: https://git-scm.com/docs/git-remote#Documentation/git-remote.txt-emset-headem, so if you were doing self-hosted git somewhere, you would run git remote set-head origin main instead of going to the github UI, which as the docs say will set the symbolic-ref refs/remotes/origin/HEAD to refs/remotes/origin/master. This will only work if refs/remotes/origin/master already exists; if not it must be fetched first.

@sssoleileraaa sssoleileraaa merged commit 91752be into main Jul 20, 2020
@sssoleileraaa sssoleileraaa deleted the update-default-branch branch July 20, 2020 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

What should our primary branch name be?
2 participants