Skip to content

Commit 83b45fa

Browse files
committed
chapter 5: minor rewording for clarity
Also change output of "git shortlog" so that number of log entries matched what is actually printed. Signed-off-by: Robert P. J. Day <[email protected]>
1 parent 73a294f commit 83b45fa

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

book/05-distributed-git/sections/maintaining.asc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
=== Maintaining a Project
22

33
(((maintaining a project)))
4-
In addition to knowing how to effectively contribute to a project, you'll likely need to know how to maintain one.
4+
In addition to knowing how to contribute effectively to a project, you'll likely need to know how to maintain one.
55
This can consist of accepting and applying patches generated via `format-patch` and emailed to you, or integrating changes in remote branches for repositories you've added as remotes to your project.
66
Whether you maintain a canonical repository or want to help by verifying or approving patches, you need to know how to accept work in a way that is clearest for other contributors and sustainable by you over the long run.
77

@@ -485,7 +485,7 @@ Also, if you include instructions in the tag message, running `git show <tag>` w
485485
486486
(((build numbers)))(((git commands, describe)))
487487
Because Git doesn't have monotonically increasing numbers like 'v123' or the equivalent to go with each commit, if you want to have a human-readable name to go with a commit, you can run `git describe` on that commit.
488-
Git gives you the name of the nearest tag with the number of commits on top of that tag and a partial SHA-1 value of the commit you're describing:
488+
In response, Git generates a string consisting of the name of the most recent tag earlier than that commit, followed by the number of commits since that tag, followed finally by a partial SHA-1 value of the commit being described (prefixed with the letter "g" meaning Git):
489489
490490
[source,console]
491491
----
@@ -495,10 +495,10 @@ v1.6.2-rc1-20-g8c5b85c
495495
496496
This way, you can export a snapshot or build and name it something understandable to people.
497497
In fact, if you build Git from source code cloned from the Git repository, `git --version` gives you something that looks like this.
498-
If you're describing a commit that you have directly tagged, it gives you the tag name.
498+
If you're describing a commit that you have directly tagged, it gives you simply the tag name.
499499
500500
The `git describe` command favors annotated tags (tags created with the `-a` or `-s` flag), so release tags should be created this way if you're using `git describe`, to ensure the commit is named properly when described.
501-
You can also use this string as the target of a checkout or show command, although it relies on the abbreviated SHA-1 value at the end, so it may not be valid forever.
501+
You can also use this string as the target of a `git checkout` or `git show` command, although it relies on the abbreviated SHA-1 value at the end, so it may not be valid forever.
502502
For instance, the Linux kernel recently jumped from 8 to 10 characters to ensure SHA-1 object uniqueness, so older `git describe` output names were invalidated.
503503
504504
[[_preparing_release]]
@@ -537,7 +537,7 @@ It summarizes all the commits in the range you give it; for example, the followi
537537
[source,console]
538538
----
539539
$ git shortlog --no-merges master --not v1.0.1
540-
Chris Wanstrath (8):
540+
Chris Wanstrath (6):
541541
Add support for annotated tags to Grit::Tag
542542
Add packed-refs annotated tag support.
543543
Add Grit::Commit#to_patch

0 commit comments

Comments
 (0)