Small Corrections to 'The Smart Protocol/Downloading Data/SSH' Section

Open
#1,921 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
55/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
git
Domain
documentation

Research direction

Open book/10-git-internals/sections/transfer-protocols.asc and locate the “The Smart Protocol/Downloading Data/SSH” section. Compare the refs/heads/master SHA-1 shown there with the expected value in the issue, then update the incorrect value and verify the rendered book content.

Written by the indexing model from the issue text.

Description

bug
There's no existing/similar bug report.
  • I have searched the existing issues
This report is about a single actionable bug.
  • I'm reporting a single actionable bug
This report is about the ProGit book, version 2, English language.
  • This bug is not about a translation or old version
Bug covers book website/pdf
  • I confirm the bug is about the book as found on the website/pdf
Problem is present in the Pro Git book on the website?
  • This bug also affects the Pro Git book as published on the website.
Which version of the book is affected?

Source files

Describe the bug:

In Git Internals/Transfer Protocols/The Smart Protocol/Downloading Data/SSH section, ProGit2 claims the first response from server side looks something like this:

00dfca82a6dff817ec66f44342007202690a93763949 HEAD□multi_ack thin-pack \
	side-band side-band-64k ofs-delta shallow no-progress include-tag \
	multi_ack_detailed symref=HEAD:refs/heads/master \
	agent=git/2:2.1.1+github-607-gfba4028
003fe2409a098dc3e53539a9028a94b6224db9d6a6b6 refs/heads/master
0000

For me, the refs/heads/master's SHA-1 value looks strange, since HEAD now symbolically links to refs/heads/master, the listed SHA-1 should be same. To confirm this, I manually cloned the simplegit-progit repository and tried following commands:

$ git cat-file -p e2409a098dc3e53539a9028a94b6224db9d6a6b6
fatal: Not a valid object name e2409a098dc3e53539a9028a94b6224db9d6a6b6

The object that corresponds to this SHA-1 value doesn't even exist. Therefore, I think the SHA-1 value of refs/heads/master should be corrected.

Steps to reproduce:
  1. Please refer to book/10-git-internals/sections/transfer-protocols.asc
Expected behavior:

The SHA-1 value of refs/heads/master should be ca82a6dff817ec66f44342007202690a93763949.

Screenshots:

No response

Additional context:

No response

Device

No response

Operating system

No response

Browser/application + version

No response

Dominant language
CSS
Stars
6.6k
Forks
2.1k
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from progit/progit2

All issues in progit/progit2

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.