Skip to content

Commit d2f24d7

Browse files
committed
The usual tiny fixes.
1 parent 83ca11c commit d2f24d7

File tree

1 file changed

+78
-81
lines changed

1 file changed

+78
-81
lines changed

‎rev_news/drafts/edition-47.md‎

Lines changed: 78 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -22,100 +22,100 @@ This edition covers what happened during the month of December 2018.
2222

2323
*[Referring to commits in commit messages](https://public-inbox.org/git/[email protected]/)
2424

25-
Ævar Arnfjörð Bjarmason replied to a
26-
[patch](https://public-inbox.org/git/[email protected]/)
27-
that Jonathan Nieder had sent to the mailing list. He suggested using
28-
the [standard commit-reference format documented in SubmittingPatches](https://github.com/git/git/blob/16a465bc018d09e9d7bbbdc5f40a7fb99c21f8ef/Documentation/SubmittingPatches#L143-L158) in the commit message of the patch.
25+
Ævar Arnfjörð Bjarmason replied to a
26+
[patch](https://public-inbox.org/git/[email protected]/)
27+
that Jonathan Nieder had sent to the mailing list. He suggested using
28+
the [standard commit-reference format documented in SubmittingPatches](https://github.com/git/git/blob/16a465bc018d09e9d7bbbdc5f40a7fb99c21f8ef/Documentation/SubmittingPatches#L143-L158) in the commit message of the patch.
2929

30-
Using the standard format would have produced:
30+
Using the standard format would have produced:
3131

32-
```
33-
92068ae8bf ("stripspace: respect repository config", 2016-11-21)
34-
```
32+
```
33+
92068ae8bf ("stripspace: respect repository config", 2016-11-21)
34+
```
3535

36-
while Jonathan's patch contained:
36+
while Jonathan's patch contained:
3737

38-
```
39-
v2.11.0-rc3~3^2~1 (stripspace: respect repository config, 2016-11-21)
40-
```
38+
```
39+
v2.11.0-rc3~3^2~1 (stripspace: respect repository config, 2016-11-21)
40+
```
4141

42-
The main difference is that the former starts with an abbreviated
43-
object id, while the latter starts with an output from `git describe`.
42+
The main difference is that the former starts with an abbreviated
43+
object id, while the latter starts with an output from `git describe`.
4444

45-
Ævar gave an example of him previously looking for a commit using
46-
`git log --grep=0386dd37b1` and not finding it because Jonathan had
47-
not used the standard format.
45+
Ævar gave an example of him previously looking for a commit using
46+
`git log --grep=0386dd37b1` and not finding it because Jonathan had
47+
not used the standard format.
4848

49-
Ævar also wondered if "we should have some mode where
50-
`--grep=<commitish>` will be combined with some mode where we try to
51-
find various forms of `<commitish>` in commit messages, then normalize
52-
& match them..."
49+
Ævar also wondered if "we should have some mode where
50+
`--grep=<commitish>` will be combined with some mode where we try to
51+
find various forms of `<commitish>` in commit messages, then normalize
52+
& match them..."
5353

54-
Duy Nguyen replied to that by suggesting we use email style trailers
55-
like `In-Reply-To: ...` or even `Fixes: ...` to refer
56-
to related commits, which could make sense as we already use
57-
[`Signed-off-by: User <email>` trailers](https://github.com/git/git/blob/master/Documentation/SubmittingPatches#L306-L347)
58-
and some other similar trailers in commit messages.
54+
Duy Nguyen replied to that by suggesting we use email style trailers
55+
like `In-Reply-To: ...` or even `Fixes: ...` to refer
56+
to related commits, which could make sense as we already use
57+
[`Signed-off-by: User <email>` trailers](https://github.com/git/git/blob/master/Documentation/SubmittingPatches#L306-L347)
58+
and some other similar trailers in commit messages.
5959

60-
SZEDER Gábor also replied to Ævar saying that the `%h (%s, %ad)` is
61-
even better and more widely used than the standard `%h ("%s", %ad)` as
62-
the former avoids useless double quotes around the commit title.
60+
Gábor Szeder also replied to Ævar saying that the `%h (%s, %ad)` is
61+
even better and more widely used than the standard `%h ("%s", %ad)` as
62+
the former avoids useless double quotes around the commit title.
6363

64-
Jeff King, alias Peff, then commented to Ævar's suggestion about a new
65-
mode for `--grep=<commitish>`. He gave examples of other tools that
66-
work better with the standard format:
64+
Jeff King, alias Peff, then commented to Ævar's suggestion about a new
65+
mode for `--grep=<commitish>`. He gave examples of other tools that
66+
work better with the standard format:
6767

68-
- web interfaces like GitHub have learned to replace an abbreviated
69-
object id with a link to a page displaying the object,
68+
- web interfaces like GitHub have learned to replace an abbreviated
69+
object id with a link to a page displaying the object,
7070

71-
- terminals makes it easy to select object ids, but don't understand
72-
output from `git describe`.
71+
- terminals makes it easy to select object ids, but don't understand
72+
output from `git describe`.
7373

74-
Peff acknowledged that the format with an output from `git describe`
75-
has some benefits:
74+
Peff acknowledged that the format with an output from `git describe`
75+
has some benefits:
7676

77-
> As far as I can tell, the main advantage of using `v2.11.0-rc3~3^2~1`
78-
> over its hex id is that it gives a better sense in time of which Git
79-
> version we're talking about. The date in the parentheses does something
80-
> similar for wall-clock time, but it's left to the reader to map that to
81-
> a Git version if they choose.
77+
> As far as I can tell, the main advantage of using `v2.11.0-rc3~3^2~1`
78+
> over its hex id is that it gives a better sense in time of which Git
79+
> version we're talking about. The date in the parentheses does something
80+
> similar for wall-clock time, but it's left to the reader to map that to
81+
> a Git version if they choose.
8282
83-
But he thought that they were not worth the disadvantages "as in the
84-
rare instance that I care about the containing version, it's not a big
85-
deal to use `git tag --contains`".
83+
But he thought that they were not worth the disadvantages "as in the
84+
rare instance that I care about the containing version, it's not a big
85+
deal to use `git tag --contains`".
8686

87-
He suggested anyway using something like:
87+
He suggested anyway using something like:
8888

89-
```
90-
1234abcd (the subject line, 2016-01-01, v2.11.0)
91-
```
89+
```
90+
1234abcd (the subject line, 2016-01-01, v2.11.0)
91+
```
9292

93-
which adds a version after the date, "if we really want to convey that
94-
information". And he proposed some reasonable rules for this new
95-
format.
93+
which adds a version after the date, "if we really want to convey that
94+
information". And he proposed some reasonable rules for this new
95+
format.
9696

97-
Jonathan replied to Peff's suggestion by discussing the possible
98-
ambiguities in what the tag name is referring to. This led Jonathan to
99-
prefer using trailers like `Fixes: ...` as Duy had suggested,
100-
saying they have been working well for the Linux kernel project.
97+
Jonathan replied to Peff's suggestion by discussing the possible
98+
ambiguities in what the tag name is referring to. This led Jonathan to
99+
prefer using trailers like `Fixes: ...` as Duy had suggested,
100+
saying they have been working well for the Linux kernel project.
101101

102-
In a separate reply to Duy's email, Jonathan copied relevant
103-
[documentation from the Linux kernel project](https://github.com/torvalds/linux/blob/ae67ee6c5e1d5b6acdb0d51fddde651834096d75/Documentation/process/submitting-patches.rst)
104-
where they specify a trailer that looks like:
102+
In a separate reply to Duy's email, Jonathan copied relevant
103+
[documentation from the Linux kernel project](https://github.com/torvalds/linux/blob/ae67ee6c5e1d5b6acdb0d51fddde651834096d75/Documentation/process/submitting-patches.rst)
104+
where they specify a trailer that looks like:
105105

106-
```
107-
Fixes: e21d2170f366 ("video: remove unnecessary platform_set_drvdata()")
108-
```
106+
```
107+
Fixes: e21d2170f366 ("video: remove unnecessary platform_set_drvdata()")
108+
```
109109

110-
Jonathan then proposed a patch to the Git Documentation that would
111-
make the Git project adopt a similar policy.
110+
Jonathan then proposed a patch to the Git Documentation that would
111+
make the Git project adopt a similar policy.
112112

113-
Peff replied to Jonathan that using `Fixes: ...` trailers is a good
114-
idea but that "there are many other reasons to refer to another commit
115-
in prose (or even outside of a commit message entirely)".
113+
Peff replied to Jonathan that using `Fixes: ...` trailers is a good
114+
idea but that "there are many other reasons to refer to another commit
115+
in prose (or even outside of a commit message entirely)".
116116

117-
Jonathan, Peff and Ævar discussed a bit more, and Jacob Keller chimed
118-
in, but in the end it doesn't look like any change has been decided.
117+
Jonathan, Peff and Ævar discussed a bit more, and Jacob Keller chimed
118+
in, but in the end it doesn't look like any change has been decided.
119119

120120
<!---
121121
### Reviews
@@ -172,27 +172,24 @@ __Various__
172172
the object name. The issue was fixed in JGit versions 4.5.5, 4.7.7, 4.9.8, 4.11.6,
173173
5.1.5 and 5.2.1, which were included in Gerrit versions 2.9.5, 2.10.8, 2.11.12,
174174
2.12.9, 2.13.12, 2.14.18, 2.15.8 and 2.16.3.
175-
176175
*[Outreachy](https://www.outreachy.org/) interns working on Git have been blogging about their internship:
177176
-[Tanushree Tumane's blog](http://tanu1596.blogspot.com/)
178177
-[Slavica Đukić's blog](https://slavicadj.github.io/blog/)
179178
* AsciiDoc, the markup language used by [Git's manual and other documentation](https://git-scm.com/docs),
180179
will get [an official specification under the Eclipse Foundation](https://asciidoctor.org/news/2019/01/07/asciidoc-spec-proposal/).
181-
182-
* Google is [seeking open source projects for Google Summer of Code 2019](https://opensource.googleblog.com/2019/01/seeking-projects-for-gsoc-2019.html)
180+
* Google is [seeking open source projects for Google Summer of Code 2019](https://opensource.googleblog.com/2019/01/seeking-projects-for-gsoc-2019.html).
183181
The deadline to apply is February 6 at 20:00 UTC, chosen
184-
organizations will be annouced on February 26.
182+
organizations will be announced on February 26.
185183
Git Development Community [is interested](https://public-inbox.org/git/CAP8UFD3Kt3dreMnfAdLiP2yc47kBLoVYCk-2yDw67OkujVY=Ew@mail.gmail.com/T/#m5568b147f03c0b2e9dc96843dc13e85f5b2f187f).
186-
187-
*[GitLab Serverless launched Dec. 22](https://about.gitlab.com/2018/12/11/introducing-gitlab-serverless/)
188-
*[New year, new GitHub: Announcing unlimited free private repos and unified Enterprise offering](https://github.blog/2019-01-07-new-year-new-github/) (the former with up to three collaborators per repository)
184+
*[GitLab Serverless launched Dec. 22](https://about.gitlab.com/2018/12/11/introducing-gitlab-serverless/).
185+
*[New year, new GitHub: Announcing unlimited free private repos and unified Enterprise offering](https://github.blog/2019-01-07-new-year-new-github/) (the former with up to three collaborators per repository).
189186

190187
__Light reading__
191188
*[A tale of 132 e's](https://linuxwit.ch/blog/2018/12/e98e/) and [the [E]nd of eeeee](https://linuxwit.ch/blog/2018/12/everything-that-lives-is-designed-to-end/) by Iliana Weller, about [e30e/e98e](https://github.com/eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee/eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee) GitHub repository and its history
192189
*[How to teach Git](https://rachelcarmena.github.io/2018/12/12/how-to-teach-git.html) by Rachel M. Carmena
193190
*[How To Use Git: A Reference Guide](https://dev.to/digitalocean/how-to-use-git-a-reference-guide-6b6) by Lisa Tagliaferri from DigitalOcean
194191
*[8 Productivity Tips for GitHub](https://dev.to/_darrenburns/8-productivity-tips-for-github-44kn) by Darren Burns
195-
*[Something Someone Somewhere Uses... Sometimes](https://dev.to/benjaminadk/something-someone-somewhere-uses-sometimes-1kab) by benjaminadk, about [Gitmoji](https://gitmoji.carloscuesta.me/)
192+
*[Something Someone Somewhere Uses... Sometimes](https://dev.to/benjaminadk/something-someone-somewhere-uses-sometimes-1kab) by benjaminadk, about [gitmoji](https://gitmoji.carloscuesta.me/)
196193
*[A new free-software forge: sr.ht [LWN.net]](https://lwn.net/Articles/775963/) by Jake Edge; this service was covered in [previous edition of Git Rev News](https://git.github.io/rev_news/2018/12/19/edition-46/#other-news)
197194
*[Monorepos: Please don’t!](https://medium.com/@mattklein123/monorepos-please-dont-e9a279be011b) by Matt Klein
198195
-[Monorepo: please do!](https://medium.com/@adamhjk/monorepo-please-do-3657e08a4b70), response by Adam Jacob
@@ -205,14 +202,14 @@ __Light reading__
205202
[Lerna](https://lernajs.io/) ([Git Rev News: Edition #43](https://git.github.io/rev_news/2018/09/19/edition-43/)) tools for monorepos
206203
*[Writing Good Commit Messages](https://medium.com/compass-true-north/writing-good-commit-messages-fc33af9d6321) by Ben Hoyt (2018)
207204
*[Useful Tips for writing better Git commit messages](https://code.likeagirl.io/useful-tips-for-writing-better-git-commit-messages-808770609503) by Egwuenu Gift (2018)
208-
*[1296: Git Commit - explain xkcd](https://www.explainxkcd.com/wiki/index.php/1296:_Git_Commit) (2013)
205+
*[1296: Git Commit -- explain xkcd](https://www.explainxkcd.com/wiki/index.php/1296:_Git_Commit) (2013)
209206
*[How to manage binary blobs with Git](https://opensource.com/life/16/8/how-manage-binary-blobs-git-part-7) by Seth Kenlon (2016)
210-
*[Migrating Internet Archive to Kubernetes](https://archive.org/~tracey/slides/kubecon/#/) -- slides from presentation at KubeCon 2018; slides [#35](https://archive.org/~tracey/slides/kubecon/#/35) and later are about how Git is used at Archive.org
207+
*[Migrating Internet Archive to Kubernetes](https://archive.org/~tracey/slides/kubecon/#/) -- slides from presentation at KubeCon 2018; slides [#35](https://archive.org/~tracey/slides/kubecon/#/35) and later are about how Git is used at [archive.org](https://archive.org/)
211208

212209
__Git tools and sites__
213210

214211
*[OneDev](https://onedev.io) Open source git server with unique features such as language aware code search and navigation, source/diff annotation for code discussion and comprehension, customizable issue field and workflow, write protection for branches/tags/files, etc.
215-
*[gitmoji | An emoji guide for your commit messages](https://gitmoji.carloscuesta.me/)
212+
*[gitmoji -- An emoji guide for your commit messages](https://gitmoji.carloscuesta.me/)
216213

217214
## Credits
218215

0 commit comments

Comments
(0)