codekingpro commited on
Commit
e2a081e
·
verified ·
1 Parent(s): 6bd0abf

Add files using upload-large-folder tool

Browse files
This view is limited to 50 files because it contains too many changes.   See raw diff
Files changed (50) hide show
  1. git/mingw64/share/doc/git-doc/MyFirstContribution.adoc +1427 -0
  2. git/mingw64/share/doc/git-doc/MyFirstContribution.html +0 -0
  3. git/mingw64/share/doc/git-doc/MyFirstObjectWalk.adoc +913 -0
  4. git/mingw64/share/doc/git-doc/MyFirstObjectWalk.html +1708 -0
  5. git/mingw64/share/doc/git-doc/RelNotes/1.5.0.1.adoc +42 -0
  6. git/mingw64/share/doc/git-doc/RelNotes/1.5.0.2.adoc +65 -0
  7. git/mingw64/share/doc/git-doc/RelNotes/1.5.0.3.adoc +58 -0
  8. git/mingw64/share/doc/git-doc/RelNotes/1.5.0.4.adoc +22 -0
  9. git/mingw64/share/doc/git-doc/RelNotes/1.5.0.5.adoc +26 -0
  10. git/mingw64/share/doc/git-doc/RelNotes/1.5.0.6.adoc +21 -0
  11. git/mingw64/share/doc/git-doc/RelNotes/1.5.0.7.adoc +18 -0
  12. git/mingw64/share/doc/git-doc/RelNotes/1.5.0.adoc +469 -0
  13. git/mingw64/share/doc/git-doc/RelNotes/1.5.1.1.adoc +65 -0
  14. git/mingw64/share/doc/git-doc/RelNotes/1.5.1.2.adoc +50 -0
  15. git/mingw64/share/doc/git-doc/RelNotes/1.5.1.3.adoc +45 -0
  16. git/mingw64/share/doc/git-doc/RelNotes/1.5.1.4.adoc +30 -0
  17. git/mingw64/share/doc/git-doc/RelNotes/1.5.1.5.adoc +42 -0
  18. git/mingw64/share/doc/git-doc/RelNotes/1.5.1.6.adoc +45 -0
  19. git/mingw64/share/doc/git-doc/RelNotes/1.5.1.adoc +371 -0
  20. git/mingw64/share/doc/git-doc/RelNotes/1.5.2.1.adoc +47 -0
  21. git/mingw64/share/doc/git-doc/RelNotes/1.5.2.2.adoc +61 -0
  22. git/mingw64/share/doc/git-doc/RelNotes/1.5.2.3.adoc +27 -0
  23. git/mingw64/share/doc/git-doc/RelNotes/1.5.2.4.adoc +28 -0
  24. git/mingw64/share/doc/git-doc/RelNotes/1.5.2.5.adoc +30 -0
  25. git/mingw64/share/doc/git-doc/RelNotes/1.5.2.adoc +197 -0
  26. git/mingw64/share/doc/git-doc/RelNotes/1.5.3.1.adoc +10 -0
  27. git/mingw64/share/doc/git-doc/RelNotes/1.5.3.2.adoc +58 -0
  28. git/mingw64/share/doc/git-doc/RelNotes/1.5.3.3.adoc +31 -0
  29. git/mingw64/share/doc/git-doc/RelNotes/1.5.3.4.adoc +35 -0
  30. git/mingw64/share/doc/git-doc/RelNotes/1.5.3.5.adoc +94 -0
  31. git/mingw64/share/doc/git-doc/RelNotes/1.5.3.6.adoc +48 -0
  32. git/mingw64/share/doc/git-doc/RelNotes/1.5.3.7.adoc +45 -0
  33. git/mingw64/share/doc/git-doc/RelNotes/1.5.3.8.adoc +25 -0
  34. git/mingw64/share/doc/git-doc/RelNotes/1.5.3.adoc +366 -0
  35. git/mingw64/share/doc/git-doc/RelNotes/1.5.4.1.adoc +17 -0
  36. git/mingw64/share/doc/git-doc/RelNotes/1.5.4.2.adoc +43 -0
  37. git/mingw64/share/doc/git-doc/RelNotes/1.5.4.3.adoc +27 -0
  38. git/mingw64/share/doc/git-doc/RelNotes/1.5.4.4.adoc +66 -0
  39. git/mingw64/share/doc/git-doc/RelNotes/1.5.4.5.adoc +56 -0
  40. git/mingw64/share/doc/git-doc/RelNotes/1.5.4.6.adoc +43 -0
  41. git/mingw64/share/doc/git-doc/RelNotes/1.5.4.7.adoc +10 -0
  42. git/mingw64/share/doc/git-doc/RelNotes/1.5.4.adoc +377 -0
  43. git/mingw64/share/doc/git-doc/RelNotes/1.5.5.1.adoc +44 -0
  44. git/mingw64/share/doc/git-doc/RelNotes/1.5.5.2.adoc +27 -0
  45. git/mingw64/share/doc/git-doc/RelNotes/1.5.5.3.adoc +12 -0
  46. git/mingw64/share/doc/git-doc/RelNotes/1.5.5.4.adoc +7 -0
  47. git/mingw64/share/doc/git-doc/RelNotes/1.5.5.5.adoc +11 -0
  48. git/mingw64/share/doc/git-doc/RelNotes/1.5.5.6.adoc +10 -0
  49. git/mingw64/share/doc/git-doc/RelNotes/1.5.5.adoc +207 -0
  50. git/mingw64/share/doc/git-doc/RelNotes/1.5.6.1.adoc +28 -0
git/mingw64/share/doc/git-doc/MyFirstContribution.adoc ADDED
@@ -0,0 +1,1427 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ My First Contribution to the Git Project
2
+ ========================================
3
+ :sectanchors:
4
+
5
+ [[summary]]
6
+ == Summary
7
+
8
+ This is a tutorial demonstrating the end-to-end workflow of creating a change to
9
+ the Git tree, sending it for review, and making changes based on comments.
10
+
11
+ [[prerequisites]]
12
+ === Prerequisites
13
+
14
+ This tutorial assumes you're already fairly familiar with using Git to manage
15
+ source code. The Git workflow steps will largely remain unexplained.
16
+
17
+ [[related-reading]]
18
+ === Related Reading
19
+
20
+ This tutorial aims to summarize the following documents, but the reader may find
21
+ useful additional context:
22
+
23
+ - `Documentation/SubmittingPatches`
24
+ - `Documentation/howto/new-command.adoc`
25
+
26
+ [[getting-help]]
27
+ === Getting Help
28
+
29
+ If you get stuck, you can seek help in the following places.
30
+
31
+ ==== git@vger.kernel.org
32
+
33
+ This is the main Git project mailing list where code reviews, version
34
+ announcements, design discussions, and more take place. Those interested in
35
+ contributing are welcome to post questions here. The Git list requires
36
+ plain-text-only emails and prefers inline and bottom-posting when replying to
37
+ mail; you will be CC'd in all replies to you. Optionally, you can subscribe to
38
+ the list by sending an email to <git+subscribe@vger.kernel.org>
39
+ (see https://subspace.kernel.org/subscribing.html for details).
40
+ The https://lore.kernel.org/git[archive] of this mailing list is
41
+ available to view in a browser.
42
+
43
+ ==== https://web.libera.chat/#git-devel[#git-devel] on Libera Chat
44
+
45
+ This IRC channel is for conversations between Git contributors. If someone is
46
+ currently online and knows the answer to your question, you can receive help
47
+ in real time. Otherwise, you can read the
48
+ https://colabti.org/irclogger/irclogger_logs/git-devel[scrollback] to see
49
+ whether someone answered you. IRC does not allow offline private messaging, so
50
+ if you try to private message someone and then log out of IRC, they cannot
51
+ respond to you. It's better to ask your questions in the channel so that you
52
+ can be answered if you disconnect and so that others can learn from the
53
+ conversation.
54
+
55
+ ==== https://discord.gg/GRFVkzgxRd[#discord] on Discord
56
+ This is an unofficial Git Discord server for everyone, from people just
57
+ starting out with Git to those who develop it. It's a great place to ask
58
+ questions, share tips, and connect with the broader Git community in real time.
59
+
60
+ The server has channels for general discussions and specific channels for those
61
+ who use Git and those who develop it. The server's search functionality also
62
+ allows you to find previous conversations and answers to common questions.
63
+
64
+ [[getting-started]]
65
+ == Getting Started
66
+
67
+ [[cloning]]
68
+ === Clone the Git Repository
69
+
70
+ Git is mirrored in a number of locations. Clone the repository from one of them;
71
+ https://git-scm.com/downloads suggests one of the best places to clone from is
72
+ the mirror on GitHub.
73
+
74
+ ----
75
+ $ git clone https://github.com/git/git git
76
+ $ cd git
77
+ ----
78
+
79
+ [[dependencies]]
80
+ === Installing Dependencies
81
+
82
+ To build Git from source, you need to have a handful of dependencies installed
83
+ on your system. For a hint of what's needed, you can take a look at
84
+ `INSTALL`, paying close attention to the section about Git's dependencies on
85
+ external programs and libraries. That document mentions a way to "test-drive"
86
+ our freshly built Git without installing; that's the method we'll be using in
87
+ this tutorial.
88
+
89
+ Make sure that your environment has everything you need by building your brand
90
+ new clone of Git from the above step:
91
+
92
+ ----
93
+ $ make
94
+ ----
95
+
96
+ NOTE: The Git build is parallelizable. `-j#` is not included above but you can
97
+ use it as you prefer, here and elsewhere.
98
+
99
+ [[identify-problem]]
100
+ === Identify Problem to Solve
101
+
102
+ ////
103
+ Use + to indicate fixed-width here; couldn't get ` to work nicely with the
104
+ quotes around "Pony Saying 'Um, Hello'".
105
+ ////
106
+ In this tutorial, we will add a new command, +git psuh+, short for ``Pony Saying
107
+ `Um, Hello''' - a feature which has gone unimplemented despite a high frequency
108
+ of invocation during users' typical daily workflow.
109
+
110
+ (We've seen some other effort in this space with the implementation of popular
111
+ commands such as `sl`.)
112
+
113
+ [[setup-workspace]]
114
+ === Set Up Your Workspace
115
+
116
+ Let's start by making a development branch to work on our changes. Per
117
+ `Documentation/SubmittingPatches`, since a brand new command is a new feature,
118
+ it's fine to base your work on `master`. However, in the future for bugfixes,
119
+ etc., you should check that document and base it on the appropriate branch.
120
+
121
+ For the purposes of this document, we will base all our work on the `master`
122
+ branch of the upstream project. Create the `psuh` branch you will use for
123
+ development like so:
124
+
125
+ ----
126
+ $ git checkout -b psuh origin/master
127
+ ----
128
+
129
+ We'll make a number of commits here in order to demonstrate how to send a topic
130
+ with multiple patches up for review simultaneously.
131
+
132
+ [[code-it-up]]
133
+ == Code It Up!
134
+
135
+ NOTE: A reference implementation can be found at
136
+ https://github.com/nasamuffin/git/tree/psuh.
137
+
138
+ [[add-new-command]]
139
+ === Adding a New Command
140
+
141
+ Lots of the subcommands are written as builtins, which means they are
142
+ implemented in C and compiled into the main `git` executable. Implementing the
143
+ very simple `psuh` command as a built-in will demonstrate the structure of the
144
+ codebase, the internal API, and the process of working together as a contributor
145
+ with the reviewers and maintainer to integrate this change into the system.
146
+
147
+ Built-in subcommands are typically implemented in a function named "cmd_"
148
+ followed by the name of the subcommand, in a source file named after the
149
+ subcommand and contained within `builtin/`. So it makes sense to implement your
150
+ command in `builtin/psuh.c`. Create that file, and within it, write the entry
151
+ point for your command in a function matching the style and signature:
152
+
153
+ ----
154
+ int cmd_psuh(int argc UNUSED, const char **argv UNUSED,
155
+ const char *prefix UNUSED, struct repository *repo UNUSED)
156
+ ----
157
+
158
+ A few things to note:
159
+
160
+ * A subcommand implementation takes its command line arguments
161
+ in `int argc` + `const char **argv`, like `main()` would.
162
+
163
+ * It also takes two extra parameters, `prefix` and `repo`. What
164
+ they mean will not be discussed until much later.
165
+
166
+ * Because this first example will not use any of the parameters,
167
+ your compiler will give warnings on unused parameters. As the
168
+ list of these four parameters is mandated by the API to add
169
+ new built-in commands, you cannot omit them. Instead, you add
170
+ `UNUSED` to each of them to tell the compiler that you *know*
171
+ you are not (yet) using it.
172
+
173
+ We'll also need to add the declaration of psuh; open up `builtin.h`, find the
174
+ declaration for `cmd_pull`, and add a new line for `psuh` immediately before it,
175
+ in order to keep the declarations alphabetically sorted:
176
+
177
+ ----
178
+ int cmd_psuh(int argc, const char **argv, const char *prefix, struct repository *repo);
179
+ ----
180
+
181
+ Be sure to `#include "builtin.h"` in your `psuh.c`. You'll also need to
182
+ `#include "gettext.h"` to use functions related to printing output text.
183
+
184
+ Go ahead and add some throwaway printf to the `cmd_psuh` function. This is a
185
+ decent starting point as we can now add build rules and register the command.
186
+
187
+ NOTE: Your throwaway text, as well as much of the text you will be adding over
188
+ the course of this tutorial, is user-facing. That means it needs to be
189
+ localizable. Take a look at `po/README` under "Marking strings for translation".
190
+ Throughout the tutorial, we will mark strings for translation as necessary; you
191
+ should also do so when writing your user-facing commands in the future.
192
+
193
+ ----
194
+ int cmd_psuh(int argc UNUSED, const char **argv UNUSED,
195
+ const char *prefix UNUSED, struct repository *repo UNUSED)
196
+ {
197
+ printf(_("Pony saying hello goes here.\n"));
198
+ return 0;
199
+ }
200
+ ----
201
+
202
+ Let's try to build it. Open `Makefile`, find where `builtin/pull.o` is added
203
+ to `BUILTIN_OBJS`, and add `builtin/psuh.o` in the same way next to it in
204
+ alphabetical order. Once you've done so, move to the top-level directory and
205
+ build simply with `make`. Also add the `DEVELOPER=1` variable to turn on
206
+ some additional warnings:
207
+
208
+ ----
209
+ $ echo DEVELOPER=1 >config.mak
210
+ $ make
211
+ ----
212
+
213
+ NOTE: When you are developing the Git project, it's preferred that you use the
214
+ `DEVELOPER` flag; if there's some reason it doesn't work for you, you can turn
215
+ it off, but it's a good idea to mention the problem to the mailing list.
216
+
217
+ Great, now your new command builds happily on its own. But nobody invokes it.
218
+ Let's change that.
219
+
220
+ The list of commands lives in `git.c`. We can register a new command by adding
221
+ a `cmd_struct` to the `commands[]` array. `struct cmd_struct` takes a string
222
+ with the command name, a function pointer to the command implementation, and a
223
+ setup option flag. For now, let's keep mimicking `push`. Find the line where
224
+ `cmd_push` is registered, copy it, and modify it for `cmd_psuh`, placing the new
225
+ line in alphabetical order (immediately before `cmd_pull`).
226
+
227
+ The options are documented in `builtin.h` under "Adding a new built-in." Since
228
+ we hope to print some data about the user's current workspace context later,
229
+ we need a Git directory, so choose `RUN_SETUP` as your only option.
230
+
231
+ Go ahead and build again. You should see a clean build, so let's kick the tires
232
+ and see if it works. There's a binary you can use to test with in the
233
+ `bin-wrappers` directory.
234
+
235
+ ----
236
+ $ ./bin-wrappers/git psuh
237
+ ----
238
+
239
+ Check it out! You've got a command! Nice work! Let's commit this.
240
+
241
+ `git status` reveals modified `Makefile`, `builtin.h`, and `git.c` as well as
242
+ untracked `builtin/psuh.c` and `git-psuh`. First, let's take care of the binary,
243
+ which should be ignored. Open `.gitignore` in your editor, find `/git-pull`, and
244
+ add an entry for your new command in alphabetical order:
245
+
246
+ ----
247
+ ...
248
+ /git-prune-packed
249
+ /git-psuh
250
+ /git-pull
251
+ /git-push
252
+ /git-quiltimport
253
+ /git-range-diff
254
+ ...
255
+ ----
256
+
257
+ Checking `git status` again should show that `git-psuh` has been removed from
258
+ the untracked list and `.gitignore` has been added to the modified list. Now we
259
+ can stage and commit:
260
+
261
+ ----
262
+ $ git add Makefile builtin.h builtin/psuh.c git.c .gitignore
263
+ $ git commit -s
264
+ ----
265
+
266
+ You will be presented with your editor in order to write a commit message. Start
267
+ the commit with a 50-column or less subject line, including the name of the
268
+ component you're working on, followed by a blank line (always required) and then
269
+ the body of your commit message, which should provide the bulk of the context.
270
+ Remember to be explicit and provide the "Why" of your change, especially if it
271
+ couldn't easily be understood from your diff. When editing your commit message,
272
+ don't remove the `Signed-off-by` trailer which was added by `-s` above.
273
+
274
+ ----
275
+ psuh: add a built-in by popular demand
276
+
277
+ Internal metrics indicate this is a command many users expect to be
278
+ present. So here's an implementation to help drive customer
279
+ satisfaction and engagement: a pony which doubtfully greets the user,
280
+ or, a Pony Saying "Um, Hello" (PSUH).
281
+
282
+ This commit message is intentionally formatted to 72 columns per line,
283
+ starts with a single line as "commit message subject" that is written as
284
+ if to command the codebase to do something (add this, teach a command
285
+ that). The body of the message is designed to add information about the
286
+ commit that is not readily deduced from reading the associated diff,
287
+ such as answering the question "why?".
288
+
289
+ Signed-off-by: A U Thor <author@example.com>
290
+ ----
291
+
292
+ Go ahead and inspect your new commit with `git show`. "psuh:" indicates you
293
+ have modified mainly the `psuh` command. The subject line gives readers an idea
294
+ of what you've changed. The sign-off line (`-s`) indicates that you agree to
295
+ the Developer's Certificate of Origin 1.1 (see the
296
+ `Documentation/SubmittingPatches` +++[[dco]]+++ header).
297
+
298
+ For the remainder of the tutorial, the subject line only will be listed for the
299
+ sake of brevity. However, fully-fleshed example commit messages are available
300
+ on the reference implementation linked at the top of this document.
301
+
302
+ [[implementation]]
303
+ === Implementation
304
+
305
+ It's probably useful to do at least something besides printing out a string.
306
+ Let's start by having a look at everything we get.
307
+
308
+ Modify your `cmd_psuh` implementation to dump the args you're passed,
309
+ keeping existing `printf()` calls in place; because the args are now
310
+ used, remove the `UNUSED` macro from them:
311
+
312
+ ----
313
+ int i;
314
+
315
+ ...
316
+
317
+ printf(Q_("Your args (there is %d):\n",
318
+ "Your args (there are %d):\n",
319
+ argc),
320
+ argc);
321
+ for (i = 0; i < argc; i++)
322
+ printf("%d: %s\n", i, argv[i]);
323
+
324
+ printf(_("Your current working directory:\n<top-level>%s%s\n"),
325
+ prefix ? "/" : "", prefix ? prefix : "");
326
+
327
+ ----
328
+
329
+ Build and try it. As you may expect, there's pretty much just whatever we give
330
+ on the command line, including the name of our command. (If `prefix` is empty
331
+ for you, try `cd Documentation/ && ../bin-wrappers/git psuh`). That's not so
332
+ helpful. So what other context can we get?
333
+
334
+ Add a line to `#include "config.h"`, `#include "repository.h"` and
335
+ `#include "environment.h"`.
336
+ Then, add the following bits to the function body:
337
+ function body:
338
+
339
+ ----
340
+ const char *cfg_name;
341
+
342
+ ...
343
+
344
+ repo_config(repo, git_default_config, NULL);
345
+ if (repo_config_get_string_tmp(repo, "user.name", &cfg_name))
346
+ printf(_("No name is found in config\n"));
347
+ else
348
+ printf(_("Your name: %s\n"), cfg_name);
349
+ ----
350
+
351
+ `repo_config()` will grab the configuration from config files known to Git and
352
+ apply standard precedence rules. `repo_config_get_string_tmp()` will look up
353
+ a specific key ("user.name") and give you the value. There are a number of
354
+ single-key lookup functions like this one; you can see them all (and more info
355
+ about how to use `repo_config()`) in `config.h`.
356
+
357
+ You should see that the name printed matches the one you see when you run:
358
+
359
+ ----
360
+ $ git config --get user.name
361
+ ----
362
+
363
+ Great! Now we know how to check for values in the Git config. Let's commit this
364
+ too, so we don't lose our progress.
365
+
366
+ ----
367
+ $ git add builtin/psuh.c
368
+ $ git commit -sm "psuh: show parameters & config opts"
369
+ ----
370
+
371
+ NOTE: Again, the above is for sake of brevity in this tutorial. In a real change
372
+ you should not use `-m` but instead use the editor to write a meaningful
373
+ message.
374
+
375
+ Still, it'd be nice to know what the user's working context is like. Let's see
376
+ if we can print the name of the user's current branch. We can mimic the
377
+ `git status` implementation; the printer is located in `wt-status.c` and we can
378
+ see that the branch is held in a `struct wt_status`.
379
+
380
+ `wt_status_print()` gets invoked by `cmd_status()` in `builtin/commit.c`.
381
+ Looking at that implementation we see the status config being populated like so:
382
+
383
+ ----
384
+ status_init_config(&s, git_status_config);
385
+ ----
386
+
387
+ But as we drill down, we can find that `status_init_config()` wraps a call
388
+ to `repo_config()`. Let's modify the code we wrote in the previous commit.
389
+
390
+ Be sure to include the header to allow you to use `struct wt_status`:
391
+
392
+ ----
393
+ #include "wt-status.h"
394
+ ----
395
+
396
+ Then modify your `cmd_psuh` implementation to declare your `struct wt_status`,
397
+ prepare it, and print its contents:
398
+
399
+ ----
400
+ struct wt_status status;
401
+
402
+ ...
403
+
404
+ wt_status_prepare(repo, &status);
405
+ repo_config(repo, git_default_config, &status);
406
+
407
+ ...
408
+
409
+ printf(_("Your current branch: %s\n"), status.branch);
410
+ ----
411
+
412
+ Run it again. Check it out - here's the (verbose) name of your current branch!
413
+
414
+ Let's commit this as well.
415
+
416
+ ----
417
+ $ git add builtin/psuh.c
418
+ $ git commit -sm "psuh: print the current branch"
419
+ ----
420
+
421
+ Now let's see if we can get some info about a specific commit.
422
+
423
+ Luckily, there are some helpers for us here. `commit.h` has a function called
424
+ `lookup_commit_reference_by_name` to which we can simply provide a hardcoded
425
+ string; `pretty.h` has an extremely handy `pp_commit_easy()` call which doesn't
426
+ require a full format object to be passed.
427
+
428
+ Add the following includes:
429
+
430
+ ----
431
+ #include "commit.h"
432
+ #include "pretty.h"
433
+ #include "strbuf.h"
434
+ ----
435
+
436
+ Then, add the following lines within your implementation of `cmd_psuh()` near
437
+ the declarations and the logic, respectively.
438
+
439
+ ----
440
+ struct commit *c = NULL;
441
+ struct strbuf commitline = STRBUF_INIT;
442
+
443
+ ...
444
+
445
+ c = lookup_commit_reference_by_name("origin/master");
446
+
447
+ if (c != NULL) {
448
+ pp_commit_easy(CMIT_FMT_ONELINE, c, &commitline);
449
+ printf(_("Current commit: %s\n"), commitline.buf);
450
+ }
451
+ ----
452
+
453
+ The `struct strbuf` provides some safety belts to your basic `char*`, one of
454
+ which is a length member to prevent buffer overruns. It needs to be initialized
455
+ nicely with `STRBUF_INIT`. Keep it in mind when you need to pass around `char*`.
456
+
457
+ `lookup_commit_reference_by_name` resolves the name you pass it, so you can play
458
+ with the value there and see what kind of things you can come up with.
459
+
460
+ `pp_commit_easy` is a convenience wrapper in `pretty.h` that takes a single
461
+ format enum shorthand, rather than an entire format struct. It then
462
+ pretty-prints the commit according to that shorthand. These are similar to the
463
+ formats available with `--pretty=FOO` in many Git commands.
464
+
465
+ Build it and run, and if you're using the same name in the example, you should
466
+ see the subject line of the most recent commit in `origin/master` that you know
467
+ about. Neat! Let's commit that as well.
468
+
469
+ ----
470
+ $ git add builtin/psuh.c
471
+ $ git commit -sm "psuh: display the top of origin/master"
472
+ ----
473
+
474
+ [[add-documentation]]
475
+ === Adding Documentation
476
+
477
+ Awesome! You've got a fantastic new command that you're ready to share with the
478
+ community. But hang on just a minute - this isn't very user-friendly. Run the
479
+ following:
480
+
481
+ ----
482
+ $ ./bin-wrappers/git help psuh
483
+ ----
484
+
485
+ Your new command is undocumented! Let's fix that.
486
+
487
+ Take a look at `Documentation/git-*.adoc`. These are the manpages for the
488
+ subcommands that Git knows about. You can open these up and take a look to get
489
+ acquainted with the format, but then go ahead and make a new file
490
+ `Documentation/git-psuh.adoc`. Like with most of the documentation in the Git
491
+ project, help pages are written with AsciiDoc (see CodingGuidelines, "Writing
492
+ Documentation" section). Use the following template to fill out your own
493
+ manpage:
494
+
495
+ // Surprisingly difficult to embed AsciiDoc source within AsciiDoc.
496
+ [listing]
497
+ ....
498
+ git-psuh(1)
499
+ ===========
500
+
501
+ NAME
502
+ ----
503
+ git-psuh - Delight users' typo with a shy horse
504
+
505
+
506
+ SYNOPSIS
507
+ --------
508
+ [synopsis]
509
+ git psuh [<arg>...]
510
+
511
+ DESCRIPTION
512
+ -----------
513
+ ...
514
+
515
+ OPTIONS[[OPTIONS]]
516
+ ------------------
517
+ ...
518
+
519
+ OUTPUT
520
+ ------
521
+ ...
522
+
523
+ GIT
524
+ ---
525
+ Part of the linkgit:git[1] suite
526
+ ....
527
+
528
+ The most important pieces of this to note are the file header, underlined by =,
529
+ the NAME section, and the SYNOPSIS, which would normally contain the grammar if
530
+ your command took arguments. Try to use well-established manpage headers so your
531
+ documentation is consistent with other Git and UNIX manpages; this makes life
532
+ easier for your user, who can skip to the section they know contains the
533
+ information they need.
534
+
535
+ NOTE: Before trying to build the docs, make sure you have the package `asciidoc`
536
+ installed.
537
+
538
+ Now that you've written your manpage, you'll need to build it explicitly. We
539
+ convert your AsciiDoc to troff which is man-readable like so:
540
+
541
+ ----
542
+ $ make all doc
543
+ $ man Documentation/git-psuh.1
544
+ ----
545
+
546
+ or
547
+
548
+ ----
549
+ $ make -C Documentation/ git-psuh.1
550
+ $ man Documentation/git-psuh.1
551
+ ----
552
+
553
+ While this isn't as satisfying as running through `git help`, you can at least
554
+ check that your help page looks right.
555
+
556
+ You can also check that the documentation coverage is good (that is, the project
557
+ sees that your command has been implemented as well as documented) by running
558
+ `make check-docs` from the top-level.
559
+
560
+ Go ahead and commit your new documentation change.
561
+
562
+ [[add-usage]]
563
+ === Adding Usage Text
564
+
565
+ Try and run `./bin-wrappers/git psuh -h`. Your command should crash at the end.
566
+ That's because `-h` is a special case which your command should handle by
567
+ printing usage.
568
+
569
+ Take a look at `Documentation/technical/api-parse-options.adoc`. This is a handy
570
+ tool for pulling out options you need to be able to handle, and it takes a
571
+ usage string.
572
+
573
+ In order to use it, we'll need to prepare a NULL-terminated array of usage
574
+ strings and a `builtin_psuh_options` array.
575
+
576
+ Add a line to `#include "parse-options.h"`.
577
+
578
+ At global scope, add your array of usage strings:
579
+
580
+ ----
581
+ static const char * const psuh_usage[] = {
582
+ N_("git psuh [<arg>...]"),
583
+ NULL,
584
+ };
585
+ ----
586
+
587
+ Then, within your `cmd_psuh()` implementation, we can declare and populate our
588
+ `option` struct. Ours is pretty boring but you can add more to it if you want to
589
+ explore `parse_options()` in more detail:
590
+
591
+ ----
592
+ struct option options[] = {
593
+ OPT_END()
594
+ };
595
+ ----
596
+
597
+ Finally, before you print your args and prefix, add the call to
598
+ `parse-options()`:
599
+
600
+ ----
601
+ argc = parse_options(argc, argv, prefix, options, psuh_usage, 0);
602
+ ----
603
+
604
+ This call will modify your `argv` parameter. It will strip the options you
605
+ specified in `options` from `argv` and the locations pointed to from `options`
606
+ entries will be updated. Be sure to replace your `argc` with the result from
607
+ `parse_options()`, or you will be confused if you try to parse `argv` later.
608
+
609
+ It's worth noting the special argument `--`. As you may be aware, many Unix
610
+ commands use `--` to indicate "end of named parameters" - all parameters after
611
+ the `--` are interpreted merely as positional arguments. (This can be handy if
612
+ you want to pass as a parameter something which would usually be interpreted as
613
+ a flag.) `parse_options()` will terminate parsing when it reaches `--` and give
614
+ you the rest of the options afterwards, untouched.
615
+
616
+ Now that you have a usage hint, you can teach Git how to show it in the general
617
+ command list shown by `git help git` or `git help -a`, which is generated from
618
+ `command-list.txt`. Find the line for 'git-pull' so you can add your 'git-psuh'
619
+ line above it in alphabetical order. Now, we can add some attributes about the
620
+ command which impacts where it shows up in the aforementioned help commands. The
621
+ top of `command-list.txt` shares some information about what each attribute
622
+ means; in those help pages, the commands are sorted according to these
623
+ attributes. `git psuh` is user-facing, or porcelain - so we will mark it as
624
+ "mainporcelain". For "mainporcelain" commands, the comments at the top of
625
+ `command-list.txt` indicate we can also optionally add an attribute from another
626
+ list; since `git psuh` shows some information about the user's workspace but
627
+ doesn't modify anything, let's mark it as "info". Make sure to keep your
628
+ attributes in the same style as the rest of `command-list.txt` using spaces to
629
+ align and delineate them:
630
+
631
+ ----
632
+ git-prune-packed plumbingmanipulators
633
+ git-psuh mainporcelain info
634
+ git-pull mainporcelain remote
635
+ git-push mainporcelain remote
636
+ ----
637
+
638
+ Build again. Now, when you run with `-h`, you should see your usage printed and
639
+ your command terminated before anything else interesting happens. Great!
640
+
641
+ Go ahead and commit this one, too.
642
+
643
+ [[testing]]
644
+ == Testing
645
+
646
+ It's important to test your code - even for a little toy command like this one.
647
+ Moreover, your patch won't be accepted into the Git tree without tests. Your
648
+ tests should:
649
+
650
+ * Illustrate the current behavior of the feature
651
+ * Prove the current behavior matches the expected behavior
652
+ * Ensure the externally-visible behavior isn't broken in later changes
653
+
654
+ So let's write some tests.
655
+
656
+ Related reading: `t/README`
657
+
658
+ [[overview-test-structure]]
659
+ === Overview of Testing Structure
660
+
661
+ The tests in Git live in `t/` and are named with a 4-digit decimal number using
662
+ the schema shown in the Naming Tests section of `t/README`.
663
+
664
+ [[write-new-test]]
665
+ === Writing Your Test
666
+
667
+ Since this a toy command, let's go ahead and name the test with t9999. However,
668
+ as many of the family/subcmd combinations are full, best practice seems to be
669
+ to find a command close enough to the one you've added and share its naming
670
+ space.
671
+
672
+ Create a new file `t/t9999-psuh-tutorial.sh`. Begin with the header as so (see
673
+ "Writing Tests" and "Source 'test-lib.sh'" in `t/README`):
674
+
675
+ ----
676
+ #!/bin/sh
677
+
678
+ test_description='git-psuh test
679
+
680
+ This test runs git-psuh and makes sure it does not crash.'
681
+
682
+ . ./test-lib.sh
683
+ ----
684
+
685
+ Tests are framed inside of a `test_expect_success` in order to output TAP
686
+ formatted results. Let's make sure that `git psuh` doesn't exit poorly and does
687
+ mention the right animal somewhere:
688
+
689
+ ----
690
+ test_expect_success 'runs correctly with no args and good output' '
691
+ git psuh >actual &&
692
+ grep Pony actual
693
+ '
694
+ ----
695
+
696
+ Indicate that you've run everything you wanted by adding the following at the
697
+ bottom of your script:
698
+
699
+ ----
700
+ test_done
701
+ ----
702
+
703
+ Make sure you mark your test script executable:
704
+
705
+ ----
706
+ $ chmod +x t/t9999-psuh-tutorial.sh
707
+ ----
708
+
709
+ You can get an idea of whether you created your new test script successfully
710
+ by running `make -C t test-lint`, which will check for things like test number
711
+ uniqueness, executable bit, and so on.
712
+
713
+ [[local-test]]
714
+ === Running Locally
715
+
716
+ Let's try and run locally:
717
+
718
+ ----
719
+ $ make
720
+ $ cd t/ && prove t9999-psuh-tutorial.sh
721
+ ----
722
+
723
+ You can run the full test suite and ensure `git-psuh` didn't break anything:
724
+
725
+ ----
726
+ $ cd t/
727
+ $ prove -j$(nproc) --shuffle t[0-9]*.sh
728
+ ----
729
+
730
+ NOTE: You can also do this with `make test` or use any testing harness which can
731
+ speak TAP. `prove` can run concurrently. `-j$(nproc)` runs tests using all
732
+ available CPUs in parallel, but the job count can be adjusted as needed.
733
+ `shuffle` randomizes the order the tests are run in, which makes them resilient
734
+ against unwanted inter-test dependencies. `prove` also makes the output nicer.
735
+
736
+ Go ahead and commit this change, as well.
737
+
738
+ [[ready-to-share]]
739
+ == Getting Ready to Share: Anatomy of a Patch Series
740
+
741
+ You may have noticed already that the Git project performs its code reviews via
742
+ emailed patches, which are then applied by the maintainer when they are ready
743
+ and approved by the community. The Git project does not accept contributions from
744
+ pull requests, and the patches emailed for review need to be formatted a
745
+ specific way.
746
+
747
+ :patch-series: https://lore.kernel.org/git/pull.1218.git.git.1645209647.gitgitgadget@gmail.com/
748
+ :lore: https://lore.kernel.org/git/
749
+
750
+ Before taking a look at how to convert your commits into emailed patches,
751
+ let's analyze what the end result, a "patch series", looks like. Here is an
752
+ {patch-series}[example] of the summary view for a patch series on the web interface of
753
+ the {lore}[Git mailing list archive]:
754
+
755
+ ----
756
+ 2022-02-18 18:40 [PATCH 0/3] libify reflog John Cai via GitGitGadget
757
+ 2022-02-18 18:40 ` [PATCH 1/3] reflog: libify delete reflog function and helpers John Cai via GitGitGadget
758
+ 2022-02-18 19:10 ` Ævar Arnfjörð Bjarmason [this message]
759
+ 2022-02-18 19:39 ` Taylor Blau
760
+ 2022-02-18 19:48 ` Ævar Arnfjörð Bjarmason
761
+ 2022-02-18 19:35 ` Taylor Blau
762
+ 2022-02-21 1:43 ` John Cai
763
+ 2022-02-21 1:50 ` Taylor Blau
764
+ 2022-02-23 19:50 ` John Cai
765
+ 2022-02-18 20:00 ` // other replies elided
766
+ 2022-02-18 18:40 ` [PATCH 2/3] reflog: call reflog_delete from reflog.c John Cai via GitGitGadget
767
+ 2022-02-18 19:15 ` Ævar Arnfjörð Bjarmason
768
+ 2022-02-18 20:26 ` Junio C Hamano
769
+ 2022-02-18 18:40 ` [PATCH 3/3] stash: call reflog_delete from reflog.c John Cai via GitGitGadget
770
+ 2022-02-18 19:20 ` Ævar Arnfjörð Bjarmason
771
+ 2022-02-19 0:21 ` Taylor Blau
772
+ 2022-02-22 2:36 ` John Cai
773
+ 2022-02-22 10:51 ` Ævar Arnfjörð Bjarmason
774
+ 2022-02-18 19:29 ` [PATCH 0/3] libify reflog Ævar Arnfjörð Bjarmason
775
+ 2022-02-22 18:30 ` [PATCH v2 0/3] libify reflog John Cai via GitGitGadget
776
+ 2022-02-22 18:30 ` [PATCH v2 1/3] stash: add test to ensure reflog --rewrite --updatref behavior John Cai via GitGitGadget
777
+ 2022-02-23 8:54 ` Ævar Arnfjörð Bjarmason
778
+ 2022-02-23 21:27 ` Junio C Hamano
779
+ // continued
780
+ ----
781
+
782
+ We can note a few things:
783
+
784
+ - Each commit is sent as a separate email, with the commit message title as
785
+ subject, prefixed with "[PATCH _i_/_n_]" for the _i_-th commit of an
786
+ _n_-commit series.
787
+ - Each patch is sent as a reply to an introductory email called the _cover
788
+ letter_ of the series, prefixed "[PATCH 0/_n_]".
789
+ - Subsequent iterations of the patch series are labelled "PATCH v2", "PATCH
790
+ v3", etc. in place of "PATCH". For example, "[PATCH v2 1/3]" would be the first of
791
+ three patches in the second iteration. Each iteration is sent with a new cover
792
+ letter (like "[PATCH v2 0/3]" above), itself a reply to the cover letter of the
793
+ previous iteration (more on that below).
794
+
795
+ NOTE: A single-patch topic is sent with "[PATCH]", "[PATCH v2]", etc. without
796
+ _i_/_n_ numbering (in the above thread overview, no single-patch topic appears,
797
+ though).
798
+
799
+ [[cover-letter]]
800
+ === The cover letter
801
+
802
+ In addition to an email per patch, the Git community also expects your patches
803
+ to come with a cover letter. This is an important component of change
804
+ submission as it explains to the community from a high level what you're trying
805
+ to do, and why, in a way that's more apparent than just looking at your
806
+ patches.
807
+
808
+ The title of your cover letter should be something which succinctly covers the
809
+ purpose of your entire topic branch. It's often in the imperative mood, just
810
+ like our commit message titles. Here is how we'll title our series:
811
+
812
+ ---
813
+ Add the 'psuh' command
814
+ ---
815
+
816
+ The body of the cover letter is used to give additional context to reviewers.
817
+ Be sure to explain anything your patches don't make clear on their own, but
818
+ remember that since the cover letter is not recorded in the commit history,
819
+ anything that might be useful to future readers of the repository's history
820
+ should also be in your commit messages.
821
+
822
+ Here's an example body for `psuh`:
823
+
824
+ ----
825
+ Our internal metrics indicate widespread interest in the command
826
+ git-psuh - that is, many users are trying to use it, but finding it is
827
+ unavailable, using some unknown workaround instead.
828
+
829
+ The following handful of patches add the psuh command and implement some
830
+ handy features on top of it.
831
+
832
+ This patchset is part of the MyFirstContribution tutorial and should not
833
+ be merged.
834
+ ----
835
+
836
+ At this point the tutorial diverges, in order to demonstrate two
837
+ different methods of formatting your patchset and getting it reviewed.
838
+
839
+ The first method to be covered is GitGitGadget, which is useful for those
840
+ already familiar with GitHub's common pull request workflow. This method
841
+ requires a GitHub account.
842
+
843
+ The second method to be covered is `git send-email`, which can give slightly
844
+ more fine-grained control over the emails to be sent. This method requires some
845
+ setup which can change depending on your system and will not be covered in this
846
+ tutorial.
847
+
848
+ Regardless of which method you choose, your engagement with reviewers will be
849
+ the same; the review process will be covered after the sections on GitGitGadget
850
+ and `git send-email`.
851
+
852
+ [[howto-ggg]]
853
+ == Sending Patches via GitGitGadget
854
+
855
+ One option for sending patches is to follow a typical pull request workflow and
856
+ send your patches out via GitGitGadget. GitGitGadget is a tool created by
857
+ Johannes Schindelin to make life as a Git contributor easier for those used to
858
+ the GitHub PR workflow. It allows contributors to open pull requests against its
859
+ mirror of the Git project, and does some magic to turn the PR into a set of
860
+ emails and send them out for you. It also runs the Git continuous integration
861
+ suite for you. It's documented at https://gitgitgadget.github.io/.
862
+
863
+ [[create-fork]]
864
+ === Forking `git/git` on GitHub
865
+
866
+ Before you can send your patch off to be reviewed using GitGitGadget, you will
867
+ need to fork the Git project and upload your changes. First thing - make sure
868
+ you have a GitHub account.
869
+
870
+ Head to the https://github.com/git/git[GitHub mirror] and look for the Fork
871
+ button. Place your fork wherever you deem appropriate and create it.
872
+
873
+ [[upload-to-fork]]
874
+ === Uploading to Your Own Fork
875
+
876
+ To upload your branch to your own fork, you'll need to add the new fork as a
877
+ remote. You can use `git remote -v` to show the remotes you have added already.
878
+ From your new fork's page on GitHub, you can press "Clone or download" to get
879
+ the URL; then you need to run the following to add, replacing your own URL and
880
+ remote name for the examples provided:
881
+
882
+ ----
883
+ $ git remote add remotename git@github.com:remotename/git.git
884
+ ----
885
+
886
+ or to use the HTTPS URL:
887
+
888
+ ----
889
+ $ git remote add remotename https://github.com/remotename/git/.git
890
+ ----
891
+
892
+ Run `git remote -v` again and you should see the new remote showing up.
893
+ `git fetch remotename` (with the real name of your remote replaced) in order to
894
+ get ready to push.
895
+
896
+ Next, double-check that you've been doing all your development in a new branch
897
+ by running `git branch`. If you didn't, now is a good time to move your new
898
+ commits to their own branch.
899
+
900
+ As mentioned briefly at the beginning of this document, we are basing our work
901
+ on `master`, so go ahead and update as shown below, or using your preferred
902
+ workflow.
903
+
904
+ ----
905
+ $ git checkout master
906
+ $ git pull -r
907
+ $ git rebase master psuh
908
+ ----
909
+
910
+ Finally, you're ready to push your new topic branch! (Due to our branch and
911
+ command name choices, be careful when you type the command below.)
912
+
913
+ ----
914
+ $ git push remotename psuh
915
+ ----
916
+
917
+ Now you should be able to go and check out your newly created branch on GitHub.
918
+
919
+ [[send-pr-ggg]]
920
+ === Sending a PR to GitGitGadget
921
+
922
+ In order to have your code tested and formatted for review, you need to start by
923
+ opening a Pull Request against either `gitgitgadget/git` or `git/git`. Head to
924
+ https://github.com/gitgitgadget/git or https://github.com/git/git and open a PR
925
+ either with the "New pull request" button or the convenient "Compare & pull
926
+ request" button that may appear with the name of your newly pushed branch.
927
+
928
+ The differences between using `gitgitgadget/git` and `git/git` as your base can
929
+ be found [here](https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror)
930
+
931
+ Review the PR's title and description, as they're used by GitGitGadget
932
+ respectively as the subject and body of the cover letter for your change. Refer
933
+ to <<cover-letter,"The cover letter">> above for advice on how to title your
934
+ submission and what content to include in the description.
935
+
936
+ NOTE: For single-patch contributions, your commit message should already be
937
+ meaningful and explain at a high level the purpose (what is happening and why)
938
+ of your patch, so you usually do not need any additional context. In that case,
939
+ remove the PR description that GitHub automatically generates from your commit
940
+ message (your PR description should be empty). If you do need to supply even
941
+ more context, you can do so in that space and it will be appended to the email
942
+ that GitGitGadget will send, between the three-dash line and the diffstat
943
+ (see <<single-patch,Bonus Chapter: One-Patch Changes>> for how this looks once
944
+ submitted).
945
+
946
+ When you're happy, submit your pull request.
947
+
948
+ [[run-ci-ggg]]
949
+ === Running CI and Getting Ready to Send
950
+
951
+ If it's your first time using GitGitGadget (which is likely, as you're using
952
+ this tutorial) then someone will need to give you permission to use the tool.
953
+ As mentioned in the GitGitGadget documentation, you just need someone who
954
+ already uses it to comment on your PR with `/allow <username>`. GitGitGadget
955
+ will automatically run your PRs through the CI even without the permission given
956
+ but you will not be able to `/submit` your changes until someone allows you to
957
+ use the tool.
958
+
959
+ NOTE: You can typically find someone who can `/allow` you on GitGitGadget by
960
+ either examining recent pull requests where someone has been granted `/allow`
961
+ (https://github.com/gitgitgadget/git/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+%22%2Fallow%22[Search:
962
+ is:pr is:open "/allow"]), in which case both the author and the person who
963
+ granted the `/allow` can now `/allow` you, or by inquiring on the
964
+ https://web.libera.chat/#git-devel[#git-devel] IRC channel on Libera Chat
965
+ linking your pull request and asking for someone to `/allow` you.
966
+
967
+ If the CI fails, you can update your changes with `git rebase -i` and push your
968
+ branch again:
969
+
970
+ ----
971
+ $ git push -f remotename psuh
972
+ ----
973
+
974
+ In fact, you should continue to make changes this way up until the point when
975
+ your patch is accepted into `next`.
976
+
977
+ ////
978
+ TODO https://github.com/gitgitgadget/gitgitgadget/issues/83
979
+ It'd be nice to be able to verify that the patch looks good before sending it
980
+ to everyone on Git mailing list.
981
+ [[check-work-ggg]]
982
+ === Check Your Work
983
+ ////
984
+
985
+ [[send-mail-ggg]]
986
+ === Sending Your Patches
987
+
988
+ Now that your CI is passing and someone has granted you permission to use
989
+ GitGitGadget with the `/allow` command, sending out for review is as simple as
990
+ commenting on your PR with `/submit`.
991
+
992
+ [[responding-ggg]]
993
+ === Updating With Comments
994
+
995
+ Skip ahead to <<reviewing,Responding to Reviews>> for information on how to
996
+ reply to review comments you will receive on the mailing list.
997
+
998
+ Once you have your branch again in the shape you want following all review
999
+ comments, you can submit again:
1000
+
1001
+ ----
1002
+ $ git push -f remotename psuh
1003
+ ----
1004
+
1005
+ Next, go look at your pull request against GitGitGadget; you should see the CI
1006
+ has been kicked off again. Now while the CI is running is a good time for you
1007
+ to modify your description at the top of the pull request thread; it will be
1008
+ used again as the cover letter. You should use this space to describe what
1009
+ has changed since your previous version, so that your reviewers have some idea
1010
+ of what they're looking at. When the CI is done running, you can comment once
1011
+ more with `/submit` - GitGitGadget will automatically add a v2 mark to your
1012
+ changes.
1013
+
1014
+ [[howto-git-send-email]]
1015
+ == Sending Patches with `git send-email`
1016
+
1017
+ If you don't want to use GitGitGadget, you can also use Git itself to mail your
1018
+ patches. Some benefits of using Git this way include finer grained control of
1019
+ subject line (for example, being able to use the tag [RFC PATCH] in the subject)
1020
+ and being able to send a ``dry run'' mail to yourself to ensure it all looks
1021
+ good before going out to the list.
1022
+
1023
+ [[setup-git-send-email]]
1024
+ === Prerequisite: Setting Up `git send-email`
1025
+
1026
+ Configuration for `send-email` can vary based on your operating system and email
1027
+ provider, and so will not be covered in this tutorial, beyond stating that in
1028
+ many distributions of Linux, `git-send-email` is not packaged alongside the
1029
+ typical `git` install. You may need to install this additional package; there
1030
+ are a number of resources online to help you do so. You will also need to
1031
+ determine the right way to configure it to use your SMTP server; again, as this
1032
+ configuration can change significantly based on your system and email setup, it
1033
+ is out of scope for the context of this tutorial.
1034
+
1035
+ [[format-patch]]
1036
+ === Preparing Initial Patchset
1037
+
1038
+ Sending emails with Git is a two-part process; before you can prepare the emails
1039
+ themselves, you'll need to prepare the patches. Luckily, this is pretty simple:
1040
+
1041
+ ----
1042
+ $ git format-patch --cover-letter -o psuh/ --base=auto psuh@{u}..psuh
1043
+ ----
1044
+
1045
+ . The `--cover-letter` option tells `format-patch` to create a
1046
+ cover letter template for you. You will need to fill in the
1047
+ template before you're ready to send - but for now, the template
1048
+ will be next to your other patches.
1049
+
1050
+ . The `-o psuh/` option tells `format-patch` to place the patch
1051
+ files into a directory. This is useful because `git send-email`
1052
+ can take a directory and send out all the patches from there.
1053
+
1054
+ . The `--base=auto` option tells the command to record the "base
1055
+ commit", on which the recipient is expected to apply the patch
1056
+ series. The `auto` value will cause `format-patch` to compute
1057
+ the base commit automatically, which is the merge base of tip
1058
+ commit of the remote-tracking branch and the specified revision
1059
+ range.
1060
+
1061
+ . The `psuh@{u}..psuh` option tells `format-patch` to generate
1062
+ patches for the commits you created on the `psuh` branch since it
1063
+ forked from its upstream (which is `origin/master` if you
1064
+ followed the example in the "Set up your workspace" section). If
1065
+ you are already on the `psuh` branch, you can just say `@{u}`,
1066
+ which means "commits on the current branch since it forked from
1067
+ its upstream", which is the same thing.
1068
+
1069
+ The command will make one patch file per commit. After you
1070
+ run, you can go have a look at each of the patches with your favorite text
1071
+ editor and make sure everything looks alright; however, it's not recommended to
1072
+ make code fixups via the patch file. It's a better idea to make the change the
1073
+ normal way using `git rebase -i` or by adding a new commit than by modifying a
1074
+ patch.
1075
+
1076
+ NOTE: Optionally, you can also use the `--rfc` flag to prefix your patch subject
1077
+ with ``[RFC PATCH]'' instead of ``[PATCH]''. RFC stands for ``request for
1078
+ comments'' and indicates that while your code isn't quite ready for submission,
1079
+ you'd like to begin the code review process. This can also be used when your
1080
+ patch is a proposal, but you aren't sure whether the community wants to solve
1081
+ the problem with that approach or not - to conduct a sort of design review. You
1082
+ may also see on the list patches marked ``WIP'' - this means they are incomplete
1083
+ but want reviewers to look at what they have so far. You can add this flag with
1084
+ `--subject-prefix=WIP`.
1085
+
1086
+ Check and make sure that your patches and cover letter template exist in the
1087
+ directory you specified - you're nearly ready to send out your review!
1088
+
1089
+ [[preparing-cover-letter]]
1090
+ === Preparing Email
1091
+
1092
+ Since you invoked `format-patch` with `--cover-letter`, you've already got a
1093
+ cover letter template ready. Open it up in your favorite editor.
1094
+
1095
+ You should see a number of headers present already. Check that your `From:`
1096
+ header is correct. Then modify your `Subject:` (see <<cover-letter,above>> for
1097
+ how to choose good title for your patch series):
1098
+
1099
+ ----
1100
+ Subject: [PATCH 0/7] Add the 'psuh' command
1101
+ ----
1102
+
1103
+ Make sure you retain the ``[PATCH 0/X]'' part; that's what indicates to the Git
1104
+ community that this email is the beginning of a patch series, and many
1105
+ reviewers filter their email for this type of flag.
1106
+
1107
+ You'll need to add some extra parameters when you invoke `git send-email` to add
1108
+ the cover letter.
1109
+
1110
+ Next you'll have to fill out the body of your cover letter. Again, see
1111
+ <<cover-letter,above>> for what content to include.
1112
+
1113
+ The template created by `git format-patch --cover-letter` includes a diffstat.
1114
+ This gives reviewers a summary of what they're in for when reviewing your topic.
1115
+ The one generated for `psuh` from the sample implementation looks like this:
1116
+
1117
+ ----
1118
+ Documentation/git-psuh.adoc | 40 +++++++++++++++++++++
1119
+ Makefile | 1 +
1120
+ builtin.h | 1 +
1121
+ builtin/psuh.c | 73 ++++++++++++++++++++++++++++++++++++++
1122
+ git.c | 1 +
1123
+ t/t9999-psuh-tutorial.sh | 12 +++++++
1124
+ 6 files changed, 128 insertions(+)
1125
+ create mode 100644 Documentation/git-psuh.adoc
1126
+ create mode 100644 builtin/psuh.c
1127
+ create mode 100755 t/t9999-psuh-tutorial.sh
1128
+ ----
1129
+
1130
+ Finally, the letter will include the version of Git used to generate the
1131
+ patches. You can leave that string alone.
1132
+
1133
+ [[sending-git-send-email]]
1134
+ === Sending Email
1135
+
1136
+ At this point you should have a directory `psuh/` which is filled with your
1137
+ patches and a cover letter. Time to mail it out! You can send it like this:
1138
+
1139
+ ----
1140
+ $ git send-email --to=target@example.com psuh/*.patch
1141
+ ----
1142
+
1143
+ NOTE: Check `git help send-email` for some other options which you may find
1144
+ valuable, such as changing the Reply-to address or adding more CC and BCC lines.
1145
+
1146
+ :contrib-scripts: footnoteref:[contrib-scripts,Scripts under `contrib/` are +
1147
+ not part of the core `git` binary and must be called directly. Clone the Git +
1148
+ codebase and run `perl contrib/contacts/git-contacts`.]
1149
+
1150
+ NOTE: If you're not sure whom to CC, running `contrib/contacts/git-contacts` can
1151
+ list potential reviewers. In addition, you can do `git send-email
1152
+ --cc-cmd='perl contrib/contacts/git-contacts' feature/*.patch`{contrib-scripts} to
1153
+ automatically pass this list of emails to `send-email`.
1154
+
1155
+ NOTE: When you are sending a real patch, it will go to git@vger.kernel.org - but
1156
+ please don't send your patchset from the tutorial to the real mailing list! For
1157
+ now, you can send it to yourself, to make sure you understand how it will look.
1158
+
1159
+ NOTE: After sending your patches, you can confirm that they reached the mailing
1160
+ list by visiting https://lore.kernel.org/git/. Use the search bar to find your
1161
+ name or the subject of your patch. If it appears, your email was successfully
1162
+ delivered.
1163
+
1164
+ After you run the command above, you will be presented with an interactive
1165
+ prompt for each patch that's about to go out. This gives you one last chance to
1166
+ edit or quit sending something (but again, don't edit code this way). Once you
1167
+ press `y` or `a` at these prompts your emails will be sent! Congratulations!
1168
+
1169
+ Awesome, now the community will drop everything and review your changes. (Just
1170
+ kidding - be patient!)
1171
+
1172
+ [[v2-git-send-email]]
1173
+ === Sending v2
1174
+
1175
+ This section will focus on how to send a v2 of your patchset. To learn what
1176
+ should go into v2, skip ahead to <<reviewing,Responding to Reviews>> for
1177
+ information on how to handle comments from reviewers.
1178
+
1179
+ We'll reuse our `psuh` topic branch for v2. Before we make any changes, we'll
1180
+ mark the tip of our v1 branch for easy reference:
1181
+
1182
+ ----
1183
+ $ git checkout psuh
1184
+ $ git branch psuh-v1
1185
+ ----
1186
+
1187
+ Refine your patch series by using `git rebase -i` to adjust commits based upon
1188
+ reviewer comments. Once the patch series is ready for submission, generate your
1189
+ patches again, but with some new flags:
1190
+
1191
+ ----
1192
+ $ git format-patch -v2 --cover-letter -o psuh/ --range-diff master..psuh-v1 master..
1193
+ ----
1194
+
1195
+ The `--range-diff master..psuh-v1` parameter tells `format-patch` to include a
1196
+ range-diff between `psuh-v1` and `psuh` in the cover letter (see
1197
+ linkgit:git-range-diff[1]). This helps tell reviewers about the differences
1198
+ between your v1 and v2 patches.
1199
+
1200
+ The `-v2` parameter tells `format-patch` to output your patches
1201
+ as version "2". For instance, you may notice that your v2 patches are
1202
+ all named like `v2-000n-my-commit-subject.patch`. `-v2` will also format
1203
+ your patches by prefixing them with "[PATCH v2]" instead of "[PATCH]",
1204
+ and your range-diff will be prefaced with "Range-diff against v1".
1205
+
1206
+ After you run this command, `format-patch` will output the patches to the `psuh/`
1207
+ directory, alongside the v1 patches. Using a single directory makes it easy to
1208
+ refer to the old v1 patches while proofreading the v2 patches, but you will need
1209
+ to be careful to send out only the v2 patches. We will use a pattern like
1210
+ `psuh/v2-*.patch` (not `psuh/*.patch`, which would match v1 and v2 patches).
1211
+
1212
+ Edit your cover letter again. Now is a good time to mention what's different
1213
+ between your last version and now, if it's something significant. You do not
1214
+ need the exact same body in your second cover letter; focus on explaining to
1215
+ reviewers the changes you've made that may not be as visible.
1216
+
1217
+ You will also need to go and find the Message-ID of your previous cover letter.
1218
+ You can either note it when you send the first series, from the output of `git
1219
+ send-email`, or you can look it up on the
1220
+ https://lore.kernel.org/git[mailing list]. Find your cover letter in the
1221
+ archives, click on it, then click "permalink" or "raw" to reveal the Message-ID
1222
+ header. It should match:
1223
+
1224
+ ----
1225
+ Message-ID: <foo.12345.author@example.com>
1226
+ ----
1227
+
1228
+ Your Message-ID is `<foo.12345.author@example.com>`. This example will be used
1229
+ below as well; make sure to replace it with the correct Message-ID for your
1230
+ **previous cover letter** - that is, if you're sending v2, use the Message-ID
1231
+ from v1; if you're sending v3, use the Message-ID from v2.
1232
+
1233
+ While you're looking at the email, you should also note who is CC'd, as it's
1234
+ common practice in the mailing list to keep all CCs on a thread. You can add
1235
+ these CC lines directly to your cover letter with a line like so in the header
1236
+ (before the Subject line):
1237
+
1238
+ ----
1239
+ CC: author@example.com, Othe R <other@example.com>
1240
+ ----
1241
+
1242
+ Now send the emails again, paying close attention to which messages you pass in
1243
+ to the command:
1244
+
1245
+ ----
1246
+ $ git send-email --to=target@example.com
1247
+ --in-reply-to="<foo.12345.author@example.com>"
1248
+ psuh/v2-*.patch
1249
+ ----
1250
+
1251
+ [[single-patch]]
1252
+ === Bonus Chapter: One-Patch Changes
1253
+
1254
+ In some cases, your very small change may consist of only one patch. When that
1255
+ happens, you only need to send one email. Your commit message should already be
1256
+ meaningful and explain at a high level the purpose (what is happening and why)
1257
+ of your patch, but if you need to supply even more context, you can do so below
1258
+ the `---` in your patch. Take the example below, which was generated with `git
1259
+ format-patch` on a single commit, and then edited to add the content between
1260
+ the `---` and the diffstat.
1261
+
1262
+ ----
1263
+ From 1345bbb3f7ac74abde040c12e737204689a72723 Mon Sep 17 00:00:00 2001
1264
+ From: A U Thor <author@example.com>
1265
+ Date: Thu, 18 Apr 2019 15:11:02 -0700
1266
+ Subject: [PATCH] README: change the grammar
1267
+
1268
+ I think it looks better this way. This part of the commit message will
1269
+ end up in the commit-log.
1270
+
1271
+ Signed-off-by: A U Thor <author@example.com>
1272
+ ---
1273
+ Let's have a wild discussion about grammar on the mailing list. This
1274
+ part of my email will never end up in the commit log. Here is where I
1275
+ can add additional context to the mailing list about my intent, outside
1276
+ of the context of the commit log. This section was added after `git
1277
+ format-patch` was run, by editing the patch file in a text editor.
1278
+
1279
+ README.md | 2 +-
1280
+ 1 file changed, 1 insertion(+), 1 deletion(-)
1281
+
1282
+ diff --git a/README.md b/README.md
1283
+ index 88f126184c..38da593a60 100644
1284
+ --- a/README.md
1285
+ +++ b/README.md
1286
+ @@ -3,7 +3,7 @@
1287
+ Git - fast, scalable, distributed revision control system
1288
+ =========================================================
1289
+
1290
+ -Git is a fast, scalable, distributed revision control system with an
1291
+ +Git is a fast, scalable, and distributed revision control system with an
1292
+ unusually rich command set that provides both high-level operations
1293
+ and full access to internals.
1294
+
1295
+ --
1296
+ 2.21.0.392.gf8f6787159e-goog
1297
+ ----
1298
+
1299
+ [[now-what]]
1300
+ == My Patch Got Emailed - Now What?
1301
+
1302
+ Please give reviewers enough time to process your initial patch before
1303
+ sending an updated version. That is, resist the temptation to send a new
1304
+ version immediately, because others may have already started reviewing
1305
+ your initial version.
1306
+
1307
+ While waiting for review comments, you may find mistakes in your initial
1308
+ patch, or perhaps realize a different and better way to achieve the goal
1309
+ of the patch. In this case you may communicate your findings to other
1310
+ reviewers as follows:
1311
+
1312
+ - If the mistakes you found are minor, send a reply to your patch as if
1313
+ you were a reviewer and mention that you will fix them in an
1314
+ updated version.
1315
+
1316
+ - On the other hand, if you think you want to change the course so
1317
+ drastically that reviews on the initial patch would be a waste of
1318
+ time (for everyone involved), retract the patch immediately with
1319
+ a reply like "I am working on a much better approach, so please
1320
+ ignore this patch and wait for the updated version."
1321
+
1322
+ Now, the above is a good practice if you sent your initial patch
1323
+ prematurely without polish. But a better approach of course is to avoid
1324
+ sending your patch prematurely in the first place.
1325
+
1326
+ Please be considerate of the time needed by reviewers to examine each
1327
+ new version of your patch. Rather than seeing the initial version right
1328
+ now (followed by several "oops, I like this version better than the
1329
+ previous one" patches over 2 days), reviewers would strongly prefer if a
1330
+ single polished version came 2 days later instead, and that version with
1331
+ fewer mistakes were the only one they would need to review.
1332
+
1333
+
1334
+ [[reviewing]]
1335
+ === Responding to Reviews
1336
+
1337
+ After a few days, you will hopefully receive a reply to your patchset with some
1338
+ comments. Woohoo! Now you can get back to work.
1339
+
1340
+ It's good manners to reply to each comment, notifying the reviewer that you have
1341
+ made the change suggested, feel the original is better, or that the comment
1342
+ inspired you to do something a new way which is superior to both the original
1343
+ and the suggested change. This way reviewers don't need to inspect your v2 to
1344
+ figure out whether you implemented their comment or not.
1345
+
1346
+ Reviewers may ask you about what you wrote in the patchset, either in
1347
+ the proposed commit log message or in the changes themselves. You
1348
+ should answer these questions in your response messages, but often the
1349
+ reason why reviewers asked these questions to understand what you meant
1350
+ to write is because your patchset needed clarification to be understood.
1351
+
1352
+ Do not be satisfied by just answering their questions in your response
1353
+ and hear them say that they now understand what you wanted to say.
1354
+ Update your patches to clarify the points reviewers had trouble with,
1355
+ and prepare your v2; the words you used to explain your v1 to answer
1356
+ reviewers' questions may be useful thing to use. Your goal is to make
1357
+ your v2 clear enough so that it becomes unnecessary for you to give the
1358
+ same explanation to the next person who reads it.
1359
+
1360
+ If you are going to push back on a comment, be polite and explain why you feel
1361
+ your original is better; be prepared that the reviewer may still disagree with
1362
+ you, and the rest of the community may weigh in on one side or the other. As
1363
+ with all code reviews, it's important to keep an open mind to doing something a
1364
+ different way than you originally planned; other reviewers have a different
1365
+ perspective on the project than you do, and may be thinking of a valid side
1366
+ effect which had not occurred to you. It is always okay to ask for clarification
1367
+ if you aren't sure why a change was suggested, or what the reviewer is asking
1368
+ you to do.
1369
+
1370
+ Make sure your email client has a plaintext email mode and it is turned on; the
1371
+ Git list rejects HTML email. Please also follow the mailing list etiquette
1372
+ outlined in the
1373
+ https://kernel.googlesource.com/pub/scm/git/git/+/todo/MaintNotes[Maintainer's
1374
+ Note], which are similar to etiquette rules in most open source communities
1375
+ surrounding bottom-posting and inline replies.
1376
+
1377
+ When you're making changes to your code, it is cleanest - that is, the resulting
1378
+ commits are easiest to look at - if you use `git rebase -i` (interactive
1379
+ rebase). Take a look at this
1380
+ https://www.oreilly.com/library/view/git-pocket-guide/9781449327507/ch10.html[overview]
1381
+ from O'Reilly. The general idea is to modify each commit which requires changes;
1382
+ this way, instead of having a patch A with a mistake, a patch B which was fine
1383
+ and required no upstream reviews in v1, and a patch C which fixes patch A for
1384
+ v2, you can just ship a v2 with a correct patch A and correct patch B. This is
1385
+ changing history, but since it's local history which you haven't shared with
1386
+ anyone, that is okay for now! (Later, it may not make sense to do this; take a
1387
+ look at the section below this one for some context.)
1388
+
1389
+ [[after-approval]]
1390
+ === After Review Approval
1391
+
1392
+ The Git project has four integration branches: `seen`, `next`, `master`, and
1393
+ `maint`. Your change will be placed into `seen` fairly early on by the maintainer
1394
+ while it is still in the review process; from there, when it is ready for wider
1395
+ testing, it will be merged into `next`. Plenty of early testers use `next` and
1396
+ may report issues. Eventually, changes in `next` will make it to `master`,
1397
+ which is typically considered stable. Finally, when a new release is cut,
1398
+ `maint` is used to base bugfixes onto. As mentioned at the beginning of this
1399
+ document, you can read `Documents/SubmittingPatches` for some more info about
1400
+ the use of the various integration branches.
1401
+
1402
+ Back to now: your code has been lauded by the upstream reviewers. It is perfect.
1403
+ It is ready to be accepted. You don't need to do anything else; the maintainer
1404
+ will merge your topic branch to `next` and life is good.
1405
+
1406
+ However, if you discover it isn't so perfect after this point, you may need to
1407
+ take some special steps depending on where you are in the process.
1408
+
1409
+ If the maintainer has announced in the "What's cooking in git.git" email that
1410
+ your topic is marked for `next` - that is, that they plan to merge it to `next`
1411
+ but have not yet done so - you should send an email asking the maintainer to
1412
+ wait a little longer: "I've sent v4 of my series and you marked it for `next`,
1413
+ but I need to change this and that - please wait for v5 before you merge it."
1414
+
1415
+ If the topic has already been merged to `next`, rather than modifying your
1416
+ patches with `git rebase -i`, you should make further changes incrementally -
1417
+ that is, with another commit, based on top of the maintainer's topic branch as
1418
+ detailed in https://github.com/gitster/git. Your work is still in the same topic
1419
+ but is now incremental, rather than a wholesale rewrite of the topic branch.
1420
+
1421
+ The topic branches in the maintainer's GitHub are mirrored in GitGitGadget, so
1422
+ if you're sending your reviews out that way, you should be sure to open your PR
1423
+ against the appropriate GitGitGadget/Git branch.
1424
+
1425
+ If you're using `git send-email`, you can use it the same way as before, but you
1426
+ should generate your diffs from `<topic>..<mybranch>` and base your work on
1427
+ `<topic>` instead of `master`.
git/mingw64/share/doc/git-doc/MyFirstContribution.html ADDED
The diff for this file is too large to render. See raw diff
 
git/mingw64/share/doc/git-doc/MyFirstObjectWalk.adoc ADDED
@@ -0,0 +1,913 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ = My First Object Walk
2
+
3
+ == What's an Object Walk?
4
+
5
+ The object walk is a key concept in Git - this is the process that underpins
6
+ operations like object transfer and fsck. Beginning from a given commit, the
7
+ list of objects is found by walking parent relationships between commits (commit
8
+ X based on commit W) and containment relationships between objects (tree Y is
9
+ contained within commit X, and blob Z is located within tree Y, giving our
10
+ working tree for commit X something like `y/z.txt`).
11
+
12
+ A related concept is the revision walk, which is focused on commit objects and
13
+ their parent relationships and does not delve into other object types. The
14
+ revision walk is used for operations like `git log`.
15
+
16
+ === Related Reading
17
+
18
+ - `Documentation/user-manual.adoc` under "Hacking Git" contains some coverage of
19
+ the revision walker in its various incarnations.
20
+ - `revision.h`
21
+ - https://eagain.net/articles/git-for-computer-scientists/[Git for Computer Scientists]
22
+ gives a good overview of the types of objects in Git and what your object
23
+ walk is really describing.
24
+
25
+ == Setting Up
26
+
27
+ Create a new branch from `master`.
28
+
29
+ ----
30
+ git checkout -b revwalk origin/master
31
+ ----
32
+
33
+ We'll put our fiddling into a new command. For fun, let's name it `git walken`.
34
+ Open up a new file `builtin/walken.c` and set up the command handler:
35
+
36
+ ----
37
+ /*
38
+ * "git walken"
39
+ *
40
+ * Part of the "My First Object Walk" tutorial.
41
+ */
42
+
43
+ #include "builtin.h"
44
+ #include "trace.h"
45
+
46
+ int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo)
47
+ {
48
+ trace_printf(_("cmd_walken incoming...\n"));
49
+ return 0;
50
+ }
51
+ ----
52
+
53
+ NOTE: `trace_printf()`, defined in `trace.h`, differs from `printf()` in
54
+ that it can be turned on or off at runtime. For the purposes of this
55
+ tutorial, we will write `walken` as though it is intended for use as
56
+ a "plumbing" command: that is, a command which is used primarily in
57
+ scripts, rather than interactively by humans (a "porcelain" command).
58
+ So we will send our debug output to `trace_printf()` instead.
59
+ When running, enable trace output by setting the environment variable `GIT_TRACE`.
60
+
61
+ Add usage text and `-h` handling, like all subcommands should consistently do
62
+ (our test suite will notice and complain if you fail to do so).
63
+ We'll need to include the `parse-options.h` header.
64
+
65
+ ----
66
+ #include "parse-options.h"
67
+
68
+ ...
69
+
70
+ int cmd_walken(int argc, const char **argv, const char *prefix)
71
+ {
72
+ const char * const walken_usage[] = {
73
+ N_("git walken"),
74
+ NULL,
75
+ };
76
+ struct option options[] = {
77
+ OPT_END()
78
+ };
79
+
80
+ argc = parse_options(argc, argv, prefix, options, walken_usage, 0);
81
+
82
+ ...
83
+ }
84
+ ----
85
+
86
+ Also add the relevant line in `builtin.h` near `cmd_version()`:
87
+
88
+ ----
89
+ int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo);
90
+ ----
91
+
92
+ Include the command in `git.c` in `commands[]` near the entry for `version`,
93
+ maintaining alphabetical ordering:
94
+
95
+ ----
96
+ { "walken", cmd_walken, RUN_SETUP },
97
+ ----
98
+
99
+ Add an entry for the new command in the both the Make and Meson build system,
100
+ before the entry for `worktree`:
101
+
102
+ - In the `Makefile`:
103
+ ----
104
+ ...
105
+ BUILTIN_OBJS += builtin/walken.o
106
+ ...
107
+ ----
108
+
109
+ - In the `meson.build` file:
110
+ ----
111
+ builtin_sources = [
112
+ ...
113
+ 'builtin/walken.c',
114
+ ...
115
+ ]
116
+ ----
117
+
118
+ Build and test out your command, without forgetting to ensure the `DEVELOPER`
119
+ flag is set, and with `GIT_TRACE` enabled so the debug output can be seen:
120
+
121
+ ----
122
+ $ echo DEVELOPER=1 >>config.mak
123
+ $ make
124
+ $ GIT_TRACE=1 ./bin-wrappers/git walken
125
+ ----
126
+
127
+ NOTE: For a more exhaustive overview of the new command process, take a look at
128
+ `Documentation/MyFirstContribution.adoc`.
129
+
130
+ NOTE: A reference implementation can be found at
131
+ https://github.com/nasamuffin/git/tree/revwalk.
132
+
133
+ === `struct rev_cmdline_info`
134
+
135
+ The definition of `struct rev_cmdline_info` can be found in `revision.h`.
136
+
137
+ This struct is contained within the `rev_info` struct and is used to reflect
138
+ parameters provided by the user over the CLI.
139
+
140
+ `nr` represents the number of `rev_cmdline_entry` present in the array.
141
+
142
+ `alloc` is used by the `ALLOC_GROW` macro. Check `alloc.h` - this variable is
143
+ used to track the allocated size of the list.
144
+
145
+ Per entry, we find:
146
+
147
+ `item` is the object provided upon which to base the object walk. Items in Git
148
+ can be blobs, trees, commits, or tags. (See `Documentation/gittutorial-2.adoc`.)
149
+
150
+ `name` is the object ID (OID) of the object - a hex string you may be familiar
151
+ with from using Git to organize your source in the past. Check the tutorial
152
+ mentioned above towards the top for a discussion of where the OID can come
153
+ from.
154
+
155
+ `whence` indicates some information about what to do with the parents of the
156
+ specified object. We'll explore this flag more later on; take a look at
157
+ `Documentation/revisions.adoc` to get an idea of what could set the `whence`
158
+ value.
159
+
160
+ `flags` are used to hint the beginning of the revision walk and are the first
161
+ block under the `#include`s in `revision.h`. The most likely ones to be set in
162
+ the `rev_cmdline_info` are `UNINTERESTING` and `BOTTOM`, but these same flags
163
+ can be used during the walk, as well.
164
+
165
+ === `struct rev_info`
166
+
167
+ This one is quite a bit longer, and many fields are only used during the walk
168
+ by `revision.c` - not configuration options. Most of the configurable flags in
169
+ `struct rev_info` have a mirror in `Documentation/rev-list-options.adoc`. It's a
170
+ good idea to take some time and read through that document.
171
+
172
+ == Basic Commit Walk
173
+
174
+ First, let's see if we can replicate the output of `git log --oneline`. We'll
175
+ refer back to the implementation frequently to discover norms when performing
176
+ an object walk of our own.
177
+
178
+ To do so, we'll first find all the commits, in order, which preceded the current
179
+ commit. We'll extract the name and subject of the commit from each.
180
+
181
+ Ideally, we will also be able to find out which ones are currently at the tip of
182
+ various branches.
183
+
184
+ === Setting Up
185
+
186
+ Preparing for your object walk has some distinct stages.
187
+
188
+ 1. Perform default setup for this mode, and others which may be invoked.
189
+ 2. Check configuration files for relevant settings.
190
+ 3. Set up the `rev_info` struct.
191
+ 4. Tweak the initialized `rev_info` to suit the current walk.
192
+ 5. Prepare the `rev_info` for the walk.
193
+ 6. Iterate over the objects, processing each one.
194
+
195
+ ==== Default Setups
196
+
197
+ Before examining configuration files which may modify command behavior, set up
198
+ default state for switches or options your command may have. If your command
199
+ utilizes other Git components, ask them to set up their default states as well.
200
+ For instance, `git log` takes advantage of `grep` and `diff` functionality, so
201
+ its `init_log_defaults()` sets its own state (`decoration_style`) and asks
202
+ `grep` and `diff` to initialize themselves by calling each of their
203
+ initialization functions.
204
+
205
+ ==== Configuring From `.gitconfig`
206
+
207
+ Next, we should have a look at any relevant configuration settings (i.e.,
208
+ settings readable and settable from `git config`). This is done by providing a
209
+ callback to `repo_config()`; within that callback, you can also invoke methods
210
+ from other components you may need that need to intercept these options. Your
211
+ callback will be invoked once per each configuration value which Git knows about
212
+ (global, local, worktree, etc.).
213
+
214
+ Similarly to the default values, we don't have anything to do here yet
215
+ ourselves; however, we should call `git_default_config()` if we aren't calling
216
+ any other existing config callbacks.
217
+
218
+ Add a new function to `builtin/walken.c`.
219
+ We'll also need to include the `config.h` header:
220
+
221
+ ----
222
+ #include "config.h"
223
+
224
+ ...
225
+
226
+ static int git_walken_config(const char *var, const char *value,
227
+ const struct config_context *ctx, void *cb)
228
+ {
229
+ /*
230
+ * For now, we don't have any custom configuration, so fall back to
231
+ * the default config.
232
+ */
233
+ return git_default_config(var, value, ctx, cb);
234
+ }
235
+ ----
236
+
237
+ Make sure to invoke `repo_config()` with it in your `cmd_walken()`:
238
+
239
+ ----
240
+ int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo)
241
+ {
242
+ ...
243
+
244
+ repo_config(repo, git_walken_config, NULL);
245
+
246
+ ...
247
+ }
248
+ ----
249
+
250
+ ==== Setting Up `rev_info`
251
+
252
+ Now that we've gathered external configuration and options, it's time to
253
+ initialize the `rev_info` object which we will use to perform the walk. This is
254
+ typically done by calling `repo_init_revisions()` with the repository you intend
255
+ to target, as well as the `prefix` argument of `cmd_walken` and your `rev_info`
256
+ struct.
257
+
258
+ Add the `struct rev_info` and the `repo_init_revisions()` call.
259
+ We'll also need to include the `revision.h` header:
260
+
261
+ ----
262
+ #include "revision.h"
263
+
264
+ ...
265
+
266
+ int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo)
267
+ {
268
+ /* This can go wherever you like in your declarations.*/
269
+ struct rev_info rev;
270
+ ...
271
+
272
+ /* This should go after the repo_config() call. */
273
+ repo_init_revisions(repo, &rev, prefix);
274
+
275
+ ...
276
+ }
277
+ ----
278
+
279
+ ==== Tweaking `rev_info` For the Walk
280
+
281
+ We're getting close, but we're still not quite ready to go. Now that `rev` is
282
+ initialized, we can modify it to fit our needs. This is usually done within a
283
+ helper for clarity, so let's add one:
284
+
285
+ ----
286
+ static void final_rev_info_setup(struct rev_info *rev)
287
+ {
288
+ /*
289
+ * We want to mimic the appearance of `git log --oneline`, so let's
290
+ * force oneline format.
291
+ */
292
+ get_commit_format("oneline", rev);
293
+
294
+ /* Start our object walk at HEAD. */
295
+ add_head_to_pending(rev);
296
+ }
297
+ ----
298
+
299
+ [NOTE]
300
+ ====
301
+ Instead of using the shorthand `add_head_to_pending()`, you could do
302
+ something like this:
303
+
304
+ ----
305
+ struct setup_revision_opt opt;
306
+
307
+ memset(&opt, 0, sizeof(opt));
308
+ opt.def = "HEAD";
309
+ opt.revarg_opt = REVARG_COMMITTISH;
310
+ setup_revisions(argc, argv, rev, &opt);
311
+ ----
312
+
313
+ Using a `setup_revision_opt` gives you finer control over your walk's starting
314
+ point.
315
+ ====
316
+
317
+ Then let's invoke `final_rev_info_setup()` after the call to
318
+ `repo_init_revisions()`:
319
+
320
+ ----
321
+ int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo)
322
+ {
323
+ ...
324
+
325
+ final_rev_info_setup(&rev);
326
+
327
+ ...
328
+ }
329
+ ----
330
+
331
+ Later, we may wish to add more arguments to `final_rev_info_setup()`. But for
332
+ now, this is all we need.
333
+
334
+ ==== Preparing `rev_info` For the Walk
335
+
336
+ Now that `rev` is all initialized and configured, we've got one more setup step
337
+ before we get rolling. We can do this in a helper, which will both prepare the
338
+ `rev_info` for the walk, and perform the walk itself. Let's start the helper
339
+ with the call to `prepare_revision_walk()`, which can return an error without
340
+ dying on its own:
341
+
342
+ ----
343
+ static void walken_commit_walk(struct rev_info *rev)
344
+ {
345
+ if (prepare_revision_walk(rev))
346
+ die(_("revision walk setup failed"));
347
+ }
348
+ ----
349
+
350
+ NOTE: `die()` prints to `stderr` and exits the program. Since it will print to
351
+ `stderr` it's likely to be seen by a human, so we will localize it.
352
+
353
+ ==== Performing the Walk!
354
+
355
+ Finally! We are ready to begin the walk itself. Now we can see that `rev_info`
356
+ can also be used as an iterator; we move to the next item in the walk by using
357
+ `get_revision()` repeatedly. Add the listed variable declarations at the top and
358
+ the walk loop below the `prepare_revision_walk()` call within your
359
+ `walken_commit_walk()`:
360
+
361
+ ----
362
+ #include "pretty.h"
363
+
364
+ ...
365
+
366
+ static void walken_commit_walk(struct rev_info *rev)
367
+ {
368
+ struct commit *commit;
369
+ struct strbuf prettybuf = STRBUF_INIT;
370
+
371
+ ...
372
+
373
+ while ((commit = get_revision(rev))) {
374
+ strbuf_reset(&prettybuf);
375
+ pp_commit_easy(CMIT_FMT_ONELINE, commit, &prettybuf);
376
+ puts(prettybuf.buf);
377
+ }
378
+ strbuf_release(&prettybuf);
379
+ }
380
+ ----
381
+
382
+ NOTE: `puts()` prints a `char*` to `stdout`. Since this is the part of the
383
+ command we expect to be machine-parsed, we're sending it directly to stdout.
384
+
385
+ Give it a shot.
386
+
387
+ ----
388
+ $ make
389
+ $ ./bin-wrappers/git walken
390
+ ----
391
+
392
+ You should see all of the subject lines of all the commits in
393
+ your tree's history, in order, ending with the initial commit, "Initial revision
394
+ of "git", the information manager from hell". Congratulations! You've written
395
+ your first revision walk. You can play with printing some additional fields
396
+ from each commit if you're curious; have a look at the functions available in
397
+ `commit.h`.
398
+
399
+ === Adding a Filter
400
+
401
+ Next, let's try to filter the commits we see based on their author. This is
402
+ equivalent to running `git log --author=<pattern>`. We can add a filter by
403
+ modifying `rev_info.grep_filter`, which is a `struct grep_opt`.
404
+
405
+ First some setup. Add `grep_config()` to `git_walken_config()`:
406
+
407
+ ----
408
+ static int git_walken_config(const char *var, const char *value,
409
+ const struct config_context *ctx, void *cb)
410
+ {
411
+ grep_config(var, value, ctx, cb);
412
+ return git_default_config(var, value, ctx, cb);
413
+ }
414
+ ----
415
+
416
+ Next, we can modify the `grep_filter`. This is done with convenience functions
417
+ found in `grep.h`. For fun, we're filtering to only commits from folks using a
418
+ `gmail.com` email address - a not-very-precise guess at who may be working on
419
+ Git as a hobby. Since we're checking the author, which is a specific line in the
420
+ header, we'll use the `append_header_grep_pattern()` helper. We can use
421
+ the `enum grep_header_field` to indicate which part of the commit header we want
422
+ to search.
423
+
424
+ In `final_rev_info_setup()`, add your filter line:
425
+
426
+ ----
427
+ static void final_rev_info_setup(int argc, const char **argv,
428
+ const char *prefix, struct rev_info *rev)
429
+ {
430
+ ...
431
+
432
+ append_header_grep_pattern(&rev->grep_filter, GREP_HEADER_AUTHOR,
433
+ "gmail");
434
+ compile_grep_patterns(&rev->grep_filter);
435
+
436
+ ...
437
+ }
438
+ ----
439
+
440
+ `append_header_grep_pattern()` adds your new "gmail" pattern to `rev_info`, but
441
+ it won't work unless we compile it with `compile_grep_patterns()`.
442
+
443
+ NOTE: If you are using `setup_revisions()` (for example, if you are passing a
444
+ `setup_revision_opt` instead of using `add_head_to_pending()`), you don't need
445
+ to call `compile_grep_patterns()` because `setup_revisions()` calls it for you.
446
+
447
+ NOTE: We could add the same filter via the `append_grep_pattern()` helper if we
448
+ wanted to, but `append_header_grep_pattern()` adds the `enum grep_context` and
449
+ `enum grep_pat_token` for us.
450
+
451
+ === Changing the Order
452
+
453
+ There are a few ways that we can change the order of the commits during a
454
+ revision walk. Firstly, we can use the `enum rev_sort_order` to choose from some
455
+ typical orderings.
456
+
457
+ `topo_order` is the same as `git log --topo-order`: we avoid showing a parent
458
+ before all of its children have been shown, and we avoid mixing commits which
459
+ are in different lines of history. (`git help log`'s section on `--topo-order`
460
+ has a very nice diagram to illustrate this.)
461
+
462
+ Let's see what happens when we run with `REV_SORT_BY_COMMIT_DATE` as opposed to
463
+ `REV_SORT_BY_AUTHOR_DATE`. Add the following:
464
+
465
+ ----
466
+ static void final_rev_info_setup(int argc, const char **argv,
467
+ const char *prefix, struct rev_info *rev)
468
+ {
469
+ ...
470
+
471
+ rev->topo_order = 1;
472
+ rev->sort_order = REV_SORT_BY_COMMIT_DATE;
473
+
474
+ ...
475
+ }
476
+ ----
477
+
478
+ Let's output this into a file so we can easily diff it with the walk sorted by
479
+ author date.
480
+
481
+ ----
482
+ $ make
483
+ $ ./bin-wrappers/git walken > commit-date.txt
484
+ ----
485
+
486
+ Then, let's sort by author date and run it again.
487
+
488
+ ----
489
+ static void final_rev_info_setup(int argc, const char **argv,
490
+ const char *prefix, struct rev_info *rev)
491
+ {
492
+ ...
493
+
494
+ rev->topo_order = 1;
495
+ rev->sort_order = REV_SORT_BY_AUTHOR_DATE;
496
+
497
+ ...
498
+ }
499
+ ----
500
+
501
+ ----
502
+ $ make
503
+ $ ./bin-wrappers/git walken > author-date.txt
504
+ ----
505
+
506
+ Finally, compare the two. This is a little less helpful without object names or
507
+ dates, but hopefully we get the idea.
508
+
509
+ ----
510
+ $ diff -u commit-date.txt author-date.txt
511
+ ----
512
+
513
+ This display indicates that commits can be reordered after they're written, for
514
+ example with `git rebase`.
515
+
516
+ Let's try one more reordering of commits. `rev_info` exposes a `reverse` flag.
517
+ Set that flag somewhere inside of `final_rev_info_setup()`:
518
+
519
+ ----
520
+ static void final_rev_info_setup(int argc, const char **argv, const char *prefix,
521
+ struct rev_info *rev)
522
+ {
523
+ ...
524
+
525
+ rev->reverse = 1;
526
+
527
+ ...
528
+ }
529
+ ----
530
+
531
+ Run your walk again and note the difference in order. (If you remove the grep
532
+ pattern, you should see the last commit this call gives you as your current
533
+ HEAD.)
534
+
535
+ == Basic Object Walk
536
+
537
+ So far we've been walking only commits. But Git has more types of objects than
538
+ that! Let's see if we can walk _all_ objects, and find out some information
539
+ about each one.
540
+
541
+ We can base our work on an example. `git pack-objects` prepares all kinds of
542
+ objects for packing into a bitmap or packfile. The work we are interested in
543
+ resides in `builtin/pack-objects.c:get_object_list()`; examination of that
544
+ function shows that the all-object walk is being performed by
545
+ `traverse_commit_list()` or `traverse_commit_list_filtered()`. Those two
546
+ functions reside in `list-objects.c`; examining the source shows that, despite
547
+ the name, these functions traverse all kinds of objects. Let's have a look at
548
+ the arguments to `traverse_commit_list()`.
549
+
550
+ - `struct rev_info *revs`: This is the `rev_info` used for the walk. If
551
+ its `filter` member is not `NULL`, then `filter` contains information for
552
+ how to filter the object list.
553
+ - `show_commit_fn show_commit`: A callback which will be used to handle each
554
+ individual commit object.
555
+ - `show_object_fn show_object`: A callback which will be used to handle each
556
+ non-commit object (so each blob, tree, or tag).
557
+ - `void *show_data`: A context buffer which is passed in turn to `show_commit`
558
+ and `show_object`.
559
+
560
+ In addition, `traverse_commit_list_filtered()` has an additional parameter:
561
+
562
+ - `struct oidset *omitted`: A linked-list of object IDs which the provided
563
+ filter caused to be omitted.
564
+
565
+ It looks like these methods use callbacks we provide instead of needing us
566
+ to call it repeatedly ourselves. Cool! Let's add the callbacks first.
567
+
568
+ For the sake of this tutorial, we'll simply keep track of how many of each kind
569
+ of object we find. At file scope in `builtin/walken.c` add the following
570
+ tracking variables:
571
+
572
+ ----
573
+ static int commit_count;
574
+ static int tag_count;
575
+ static int blob_count;
576
+ static int tree_count;
577
+ ----
578
+
579
+ Commits are handled by a different callback than other objects; let's do that
580
+ one first:
581
+
582
+ ----
583
+ static void walken_show_commit(struct commit *cmt, void *buf)
584
+ {
585
+ commit_count++;
586
+ }
587
+ ----
588
+
589
+ The `cmt` argument is fairly self-explanatory. But it's worth mentioning that
590
+ the `buf` argument is actually the context buffer that we can provide to the
591
+ traversal calls - `show_data`, which we mentioned a moment ago.
592
+
593
+ Since we have the `struct commit` object, we can look at all the same parts that
594
+ we looked at in our earlier commit-only walk. For the sake of this tutorial,
595
+ though, we'll just increment the commit counter and move on.
596
+
597
+ The callback for non-commits is a little different, as we'll need to check
598
+ which kind of object we're dealing with:
599
+
600
+ ----
601
+ static void walken_show_object(struct object *obj, const char *str, void *buf)
602
+ {
603
+ switch (obj->type) {
604
+ case OBJ_TREE:
605
+ tree_count++;
606
+ break;
607
+ case OBJ_BLOB:
608
+ blob_count++;
609
+ break;
610
+ case OBJ_TAG:
611
+ tag_count++;
612
+ break;
613
+ case OBJ_COMMIT:
614
+ BUG("unexpected commit object in walken_show_object\n");
615
+ default:
616
+ BUG("unexpected object type %s in walken_show_object\n",
617
+ type_name(obj->type));
618
+ }
619
+ }
620
+ ----
621
+
622
+ Again, `obj` is fairly self-explanatory, and we can guess that `buf` is the same
623
+ context pointer that `walken_show_commit()` receives: the `show_data` argument
624
+ to `traverse_commit_list()` and `traverse_commit_list_filtered()`. Finally,
625
+ `str` contains the name of the object, which ends up being something like
626
+ `foo.txt` (blob), `bar/baz` (tree), or `v1.2.3` (tag).
627
+
628
+ To help assure us that we aren't double-counting commits, we'll include some
629
+ complaining if a commit object is routed through our non-commit callback; we'll
630
+ also complain if we see an invalid object type. Since those two cases should be
631
+ unreachable, and would only change in the event of a semantic change to the Git
632
+ codebase, we complain by using `BUG()` - which is a signal to a developer that
633
+ the change they made caused unintended consequences, and the rest of the
634
+ codebase needs to be updated to understand that change. `BUG()` is not intended
635
+ to be seen by the public, so it is not localized.
636
+
637
+ Our main object walk implementation is substantially different from our commit
638
+ walk implementation, so let's make a new function to perform the object walk. We
639
+ can perform setup which is applicable to all objects here, too, to keep separate
640
+ from setup which is applicable to commit-only walks.
641
+
642
+ We'll start by enabling all types of objects in the `struct rev_info`. We'll
643
+ also turn on `tree_blobs_in_commit_order`, which means that we will walk a
644
+ commit's tree and everything it points to immediately after we find each commit,
645
+ as opposed to waiting for the end and walking through all trees after the commit
646
+ history has been discovered. With the appropriate settings configured, we are
647
+ ready to call `prepare_revision_walk()`.
648
+
649
+ ----
650
+ static void walken_object_walk(struct rev_info *rev)
651
+ {
652
+ rev->tree_objects = 1;
653
+ rev->blob_objects = 1;
654
+ rev->tag_objects = 1;
655
+ rev->tree_blobs_in_commit_order = 1;
656
+
657
+ if (prepare_revision_walk(rev))
658
+ die(_("revision walk setup failed"));
659
+
660
+ commit_count = 0;
661
+ tag_count = 0;
662
+ blob_count = 0;
663
+ tree_count = 0;
664
+ ----
665
+
666
+ Let's start by calling just the unfiltered walk and reporting our counts.
667
+ Complete your implementation of `walken_object_walk()`.
668
+ We'll also need to include the `list-objects.h` header.
669
+
670
+ ----
671
+ #include "list-objects.h"
672
+
673
+ ...
674
+
675
+ traverse_commit_list(rev, walken_show_commit, walken_show_object, NULL);
676
+
677
+ printf("commits %d\nblobs %d\ntags %d\ntrees %d\n", commit_count,
678
+ blob_count, tag_count, tree_count);
679
+ }
680
+ ----
681
+
682
+ NOTE: This output is intended to be machine-parsed. Therefore, we are not
683
+ sending it to `trace_printf()`, and we are not localizing it - we need scripts
684
+ to be able to count on the formatting to be exactly the way it is shown here.
685
+ If we were intending this output to be read by humans, we would need to localize
686
+ it with `_()`.
687
+
688
+ Finally, we'll ask `cmd_walken()` to use the object walk instead. Discussing
689
+ command line options is out of scope for this tutorial, so we'll just hardcode
690
+ a branch we can change at compile time. Where you call `final_rev_info_setup()`
691
+ and `walken_commit_walk()`, instead branch like so:
692
+
693
+ ----
694
+ if (1) {
695
+ add_head_to_pending(&rev);
696
+ walken_object_walk(&rev);
697
+ } else {
698
+ final_rev_info_setup(argc, argv, prefix, &rev);
699
+ walken_commit_walk(&rev);
700
+ }
701
+ ----
702
+
703
+ NOTE: For simplicity, we've avoided all the filters and sorts we applied in
704
+ `final_rev_info_setup()` and simply added `HEAD` to our pending queue. If you
705
+ want, you can certainly use the filters we added before by moving
706
+ `final_rev_info_setup()` out of the conditional and removing the call to
707
+ `add_head_to_pending()`.
708
+
709
+ Now we can try to run our command! It should take noticeably longer than the
710
+ commit walk, but an examination of the output will give you an idea why. Your
711
+ output should look similar to this example, but with different counts:
712
+
713
+ ----
714
+ Object walk completed. Found 55733 commits, 100274 blobs, 0 tags, and 104210 trees.
715
+ ----
716
+
717
+ This makes sense. We have more trees than commits because the Git project has
718
+ lots of subdirectories which can change, plus at least one tree per commit. We
719
+ have no tags because we started on a commit (`HEAD`) and while tags can point to
720
+ commits, commits can't point to tags.
721
+
722
+ NOTE: You will have different counts when you run this yourself! The number of
723
+ objects grows along with the Git project.
724
+
725
+ === Adding a Filter
726
+
727
+ There are a handful of filters that we can apply to the object walk laid out in
728
+ `Documentation/rev-list-options.adoc`. These filters are typically useful for
729
+ operations such as creating packfiles or performing a partial clone. They are
730
+ defined in `list-objects-filter-options.h`. For the purposes of this tutorial we
731
+ will use the "tree:1" filter, which causes the walk to omit all trees and blobs
732
+ which are not directly referenced by commits reachable from the commit in
733
+ `pending` when the walk begins. (`pending` is the list of objects which need to
734
+ be traversed during a walk; you can imagine a breadth-first tree traversal to
735
+ help understand. In our case, that means we omit trees and blobs not directly
736
+ referenced by `HEAD` or `HEAD`'s history, because we begin the walk with only
737
+ `HEAD` in the `pending` list.)
738
+
739
+ For now, we are not going to track the omitted objects, so we'll replace those
740
+ parameters with `NULL`. For the sake of simplicity, we'll add a simple
741
+ build-time branch to use our filter or not. Preface the line calling
742
+ `traverse_commit_list()` with the following, which will remind us which kind of
743
+ walk we've just performed:
744
+
745
+ ----
746
+ if (0) {
747
+ /* Unfiltered: */
748
+ trace_printf(_("Unfiltered object walk.\n"));
749
+ } else {
750
+ trace_printf(
751
+ _("Filtered object walk with filterspec 'tree:1'.\n"));
752
+
753
+ parse_list_objects_filter(&rev->filter, "tree:1");
754
+ }
755
+ traverse_commit_list(rev, walken_show_commit,
756
+ walken_show_object, NULL);
757
+ ----
758
+
759
+ The `rev->filter` member is usually built directly from a command
760
+ line argument, so the module provides an easy way to build one from a string.
761
+ Even though we aren't taking user input right now, we can still build one with
762
+ a hardcoded string using `parse_list_objects_filter()`.
763
+
764
+ With the filter spec "tree:1", we are expecting to see _only_ the root tree for
765
+ each commit; therefore, the tree object count should be less than or equal to
766
+ the number of commits. (For an example of why that's true: `git commit --revert`
767
+ points to the same tree object as its grandparent.)
768
+
769
+ === Counting Omitted Objects
770
+
771
+ We also have the capability to enumerate all objects which were omitted by a
772
+ filter, like with `git log --filter=<spec> --filter-print-omitted`. To do this,
773
+ change `traverse_commit_list()` to `traverse_commit_list_filtered()`, which is
774
+ able to populate an `omitted` list. Asking for this list of filtered objects
775
+ may cause performance degradations, however, because in this case, despite
776
+ filtering objects, the possibly much larger set of all reachable objects must
777
+ be processed in order to populate that list.
778
+
779
+ First, add the `struct oidset` and related items we will use to iterate it:
780
+
781
+ ----
782
+ #include "oidset.h"
783
+
784
+ ...
785
+
786
+ static void walken_object_walk(
787
+ ...
788
+
789
+ struct oidset omitted;
790
+ struct oidset_iter oit;
791
+ struct object_id *oid = NULL;
792
+ int omitted_count = 0;
793
+ oidset_init(&omitted, 0);
794
+
795
+ ...
796
+ ----
797
+
798
+ Replace the call to `traverse_commit_list()` with
799
+ `traverse_commit_list_filtered()` and pass a pointer to the `omitted` oidset
800
+ defined and initialized above:
801
+
802
+ ----
803
+ ...
804
+
805
+ traverse_commit_list_filtered(rev,
806
+ walken_show_commit, walken_show_object, NULL, &omitted);
807
+
808
+ ...
809
+ ----
810
+
811
+ Then, after your traversal, the `oidset` traversal is pretty straightforward.
812
+ Count all the objects within and modify the print statement:
813
+
814
+ ----
815
+ /* Count the omitted objects. */
816
+ oidset_iter_init(&omitted, &oit);
817
+
818
+ while ((oid = oidset_iter_next(&oit)))
819
+ omitted_count++;
820
+
821
+ printf("commits %d\nblobs %d\ntags %d\ntrees %d\nomitted %d\n",
822
+ commit_count, blob_count, tag_count, tree_count, omitted_count);
823
+ ----
824
+
825
+ By running your walk with and without the filter, you should find that the total
826
+ object count in each case is identical. You can also time each invocation of
827
+ the `walken` subcommand, with and without `omitted` being passed in, to confirm
828
+ to yourself the runtime impact of tracking all omitted objects.
829
+
830
+ === Changing the Order
831
+
832
+ Finally, let's demonstrate that you can also reorder walks of all objects, not
833
+ just walks of commits. First, we'll make our handlers chattier - modify
834
+ `walken_show_commit()` and `walken_show_object()` to print the object as they
835
+ go:
836
+
837
+ ----
838
+ #include "hex.h"
839
+
840
+ ...
841
+
842
+ static void walken_show_commit(struct commit *cmt, void *buf)
843
+ {
844
+ trace_printf("commit: %s\n", oid_to_hex(&cmt->object.oid));
845
+ commit_count++;
846
+ }
847
+
848
+ static void walken_show_object(struct object *obj, const char *str, void *buf)
849
+ {
850
+ trace_printf("%s: %s\n", type_name(obj->type), oid_to_hex(&obj->oid));
851
+
852
+ ...
853
+ }
854
+ ----
855
+
856
+ NOTE: Since we will be examining this output directly as humans, we'll use
857
+ `trace_printf()` here. Additionally, since this change introduces a significant
858
+ number of printed lines, using `trace_printf()` will allow us to easily silence
859
+ those lines without having to recompile.
860
+
861
+ (Leave the counter increment logic in place.)
862
+
863
+ With only that change, run again (but save yourself some scrollback):
864
+
865
+ ----
866
+ $ GIT_TRACE=1 ./bin-wrappers/git walken 2>&1 | head -n 10
867
+ ----
868
+
869
+ Take a look at the top commit with `git show` and the object ID you printed; it
870
+ should be the same as the output of `git show HEAD`.
871
+
872
+ Next, let's change a setting on our `struct rev_info` within
873
+ `walken_object_walk()`. Find where you're changing the other settings on `rev`,
874
+ such as `rev->tree_objects` and `rev->tree_blobs_in_commit_order`, and add the
875
+ `reverse` setting at the bottom:
876
+
877
+ ----
878
+ ...
879
+
880
+ rev->tree_objects = 1;
881
+ rev->blob_objects = 1;
882
+ rev->tag_objects = 1;
883
+ rev->tree_blobs_in_commit_order = 1;
884
+ rev->reverse = 1;
885
+
886
+ ...
887
+ ----
888
+
889
+ Now, run again, but this time, let's grab the last handful of objects instead
890
+ of the first handful:
891
+
892
+ ----
893
+ $ make
894
+ $ GIT_TRACE=1 ./bin-wrappers/git walken 2>&1 | tail -n 10
895
+ ----
896
+
897
+ The last commit object given should have the same OID as the one we saw at the
898
+ top before, and running `git show <oid>` with that OID should give you again
899
+ the same results as `git show HEAD`. Furthermore, if you run and examine the
900
+ first ten lines again (with `head` instead of `tail` like we did before applying
901
+ the `reverse` setting), you should see that now the first commit printed is the
902
+ initial commit, `e83c5163`.
903
+
904
+ == Wrapping Up
905
+
906
+ Let's review. In this tutorial, we:
907
+
908
+ - Built a commit walk from the ground up
909
+ - Enabled a grep filter for that commit walk
910
+ - Changed the sort order of that filtered commit walk
911
+ - Built an object walk (tags, commits, trees, and blobs) from the ground up
912
+ - Learned how to add a filter-spec to an object walk
913
+ - Changed the display order of the filtered object walk
git/mingw64/share/doc/git-doc/MyFirstObjectWalk.html ADDED
@@ -0,0 +1,1708 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html>
2
+ <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
3
+ <head>
4
+ <meta charset="UTF-8"/>
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
6
+ <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
7
+ <meta name="generator" content="Asciidoctor 2.0.23"/>
8
+ <title>My First Object Walk</title>
9
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
10
+ <style>
11
+ /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
12
+ /* Uncomment the following line when using as a custom stylesheet */
13
+ /* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
14
+ html{font-family:sans-serif;-webkit-text-size-adjust:100%}
15
+ a{background:none}
16
+ a:focus{outline:thin dotted}
17
+ a:active,a:hover{outline:0}
18
+ h1{font-size:2em;margin:.67em 0}
19
+ b,strong{font-weight:bold}
20
+ abbr{font-size:.9em}
21
+ abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
22
+ dfn{font-style:italic}
23
+ hr{height:0}
24
+ mark{background:#ff0;color:#000}
25
+ code,kbd,pre,samp{font-family:monospace;font-size:1em}
26
+ pre{white-space:pre-wrap}
27
+ q{quotes:"\201C" "\201D" "\2018" "\2019"}
28
+ small{font-size:80%}
29
+ sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
30
+ sup{top:-.5em}
31
+ sub{bottom:-.25em}
32
+ img{border:0}
33
+ svg:not(:root){overflow:hidden}
34
+ figure{margin:0}
35
+ audio,video{display:inline-block}
36
+ audio:not([controls]){display:none;height:0}
37
+ fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
38
+ legend{border:0;padding:0}
39
+ button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
40
+ button,input{line-height:normal}
41
+ button,select{text-transform:none}
42
+ button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
43
+ button[disabled],html input[disabled]{cursor:default}
44
+ input[type=checkbox],input[type=radio]{padding:0}
45
+ button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
46
+ textarea{overflow:auto;vertical-align:top}
47
+ table{border-collapse:collapse;border-spacing:0}
48
+ *,::before,::after{box-sizing:border-box}
49
+ html,body{font-size:100%}
50
+ body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
51
+ a:hover{cursor:pointer}
52
+ img,object,embed{max-width:100%;height:auto}
53
+ object,embed{height:100%}
54
+ img{-ms-interpolation-mode:bicubic}
55
+ .left{float:left!important}
56
+ .right{float:right!important}
57
+ .text-left{text-align:left!important}
58
+ .text-right{text-align:right!important}
59
+ .text-center{text-align:center!important}
60
+ .text-justify{text-align:justify!important}
61
+ .hide{display:none}
62
+ img,object,svg{display:inline-block;vertical-align:middle}
63
+ textarea{height:auto;min-height:50px}
64
+ select{width:100%}
65
+ .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
66
+ div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
67
+ a{color:#2156a5;text-decoration:underline;line-height:inherit}
68
+ a:hover,a:focus{color:#1d4b8f}
69
+ a img{border:0}
70
+ p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
71
+ p aside{font-size:.875em;line-height:1.35;font-style:italic}
72
+ h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
73
+ h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
74
+ h1{font-size:2.125em}
75
+ h2{font-size:1.6875em}
76
+ h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
77
+ h4,h5{font-size:1.125em}
78
+ h6{font-size:1em}
79
+ hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
80
+ em,i{font-style:italic;line-height:inherit}
81
+ strong,b{font-weight:bold;line-height:inherit}
82
+ small{font-size:60%;line-height:inherit}
83
+ code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
84
+ ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
85
+ ul,ol{margin-left:1.5em}
86
+ ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
87
+ ul.circle{list-style-type:circle}
88
+ ul.disc{list-style-type:disc}
89
+ ul.square{list-style-type:square}
90
+ ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
91
+ ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
92
+ dl dt{margin-bottom:.3125em;font-weight:bold}
93
+ dl dd{margin-bottom:1.25em}
94
+ blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
95
+ blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
96
+ @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
97
+ h1{font-size:2.75em}
98
+ h2{font-size:2.3125em}
99
+ h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
100
+ h4{font-size:1.4375em}}
101
+ table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
102
+ table thead,table tfoot{background:#f7f8f7}
103
+ table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
104
+ table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
105
+ table tr.even,table tr.alt{background:#f8f8f7}
106
+ table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
107
+ h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
108
+ h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
109
+ .center{margin-left:auto;margin-right:auto}
110
+ .stretch{width:100%}
111
+ .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
112
+ .clearfix::after,.float-group::after{clear:both}
113
+ :not(pre).nobreak{word-wrap:normal}
114
+ :not(pre).nowrap{white-space:nowrap}
115
+ :not(pre).pre-wrap{white-space:pre-wrap}
116
+ :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
117
+ pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
118
+ pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
119
+ pre>code{display:block}
120
+ pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
121
+ em em{font-style:normal}
122
+ strong strong{font-weight:400}
123
+ .keyseq{color:rgba(51,51,51,.8)}
124
+ kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
125
+ .keyseq kbd:first-child{margin-left:0}
126
+ .keyseq kbd:last-child{margin-right:0}
127
+ .menuseq,.menuref{color:#000}
128
+ .menuseq b:not(.caret),.menuref{font-weight:inherit}
129
+ .menuseq{word-spacing:-.02em}
130
+ .menuseq b.caret{font-size:1.25em;line-height:.8}
131
+ .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
132
+ b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
133
+ b.button::before{content:"[";padding:0 3px 0 2px}
134
+ b.button::after{content:"]";padding:0 2px 0 3px}
135
+ p a>code:hover{color:rgba(0,0,0,.9)}
136
+ #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
137
+ #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
138
+ #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
139
+ #content{margin-top:1.25em}
140
+ #content::before{content:none}
141
+ #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
142
+ #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
143
+ #header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
144
+ #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
145
+ #header .details span:first-child{margin-left:-.125em}
146
+ #header .details span.email a{color:rgba(0,0,0,.85)}
147
+ #header .details br{display:none}
148
+ #header .details br+span::before{content:"\00a0\2013\00a0"}
149
+ #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
150
+ #header .details br+span#revremark::before{content:"\00a0|\00a0"}
151
+ #header #revnumber{text-transform:capitalize}
152
+ #header #revnumber::after{content:"\00a0"}
153
+ #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
154
+ #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
155
+ #toc>ul{margin-left:.125em}
156
+ #toc ul.sectlevel0>li>a{font-style:italic}
157
+ #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
158
+ #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
159
+ #toc li{line-height:1.3334;margin-top:.3334em}
160
+ #toc a{text-decoration:none}
161
+ #toc a:active{text-decoration:underline}
162
+ #toctitle{color:#7a2518;font-size:1.2em}
163
+ @media screen and (min-width:768px){#toctitle{font-size:1.375em}
164
+ body.toc2{padding-left:15em;padding-right:0}
165
+ body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
166
+ #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
167
+ #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
168
+ #toc.toc2>ul{font-size:.9em;margin-bottom:0}
169
+ #toc.toc2 ul ul{margin-left:0;padding-left:1em}
170
+ #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
171
+ body.toc2.toc-right{padding-left:0;padding-right:15em}
172
+ body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
173
+ @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
174
+ #toc.toc2{width:20em}
175
+ #toc.toc2 #toctitle{font-size:1.375em}
176
+ #toc.toc2>ul{font-size:.95em}
177
+ #toc.toc2 ul ul{padding-left:1.25em}
178
+ body.toc2.toc-right{padding-left:0;padding-right:20em}}
179
+ #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
180
+ #content #toc>:first-child{margin-top:0}
181
+ #content #toc>:last-child{margin-bottom:0}
182
+ #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
183
+ #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
184
+ #content{margin-bottom:.625em}
185
+ .sect1{padding-bottom:.625em}
186
+ @media screen and (min-width:768px){#content{margin-bottom:1.25em}
187
+ .sect1{padding-bottom:1.25em}}
188
+ .sect1:last-child{padding-bottom:0}
189
+ .sect1+.sect1{border-top:1px solid #e7e7e9}
190
+ #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
191
+ #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
192
+ #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
193
+ #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
194
+ #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
195
+ details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
196
+ details{margin-left:1.25rem}
197
+ details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
198
+ details>summary::-webkit-details-marker{display:none}
199
+ details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
200
+ details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
201
+ details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
202
+ .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
203
+ table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
204
+ .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
205
+ .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
206
+ .admonitionblock>table td.icon{text-align:center;width:80px}
207
+ .admonitionblock>table td.icon img{max-width:none}
208
+ .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
209
+ .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
210
+ .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
211
+ .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
212
+ .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
213
+ .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
214
+ .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
215
+ .exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
216
+ .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
217
+ @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
218
+ @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
219
+ .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
220
+ .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
221
+ .listingblock>.content{position:relative}
222
+ .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
223
+ .listingblock:hover code[data-lang]::before{display:block}
224
+ .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
225
+ .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
226
+ .listingblock pre.highlightjs{padding:0}
227
+ .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
228
+ .listingblock pre.prettyprint{border-width:0}
229
+ .prettyprint{background:#f7f7f8}
230
+ pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
231
+ pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
232
+ pre.prettyprint li code[data-lang]::before{opacity:1}
233
+ pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
234
+ table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
235
+ table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
236
+ table.linenotable td.code{padding-left:.75em}
237
+ table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
238
+ pre.pygments span.linenos{display:inline-block;margin-right:.75em}
239
+ .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
240
+ .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
241
+ .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
242
+ .quoteblock blockquote{margin:0;padding:0;border:0}
243
+ .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
244
+ .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
245
+ .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
246
+ .verseblock{margin:0 1em 1.25em}
247
+ .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
248
+ .verseblock pre strong{font-weight:400}
249
+ .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
250
+ .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
251
+ .quoteblock .attribution br,.verseblock .attribution br{display:none}
252
+ .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
253
+ .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
254
+ .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
255
+ .quoteblock.abstract{margin:0 1em 1.25em;display:block}
256
+ .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
257
+ .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
258
+ .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
259
+ .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
260
+ .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
261
+ p.tableblock:last-child{margin-bottom:0}
262
+ td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
263
+ td.tableblock>.content>:last-child{margin-bottom:-1.25em}
264
+ table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
265
+ table.grid-all>*>tr>*{border-width:1px}
266
+ table.grid-cols>*>tr>*{border-width:0 1px}
267
+ table.grid-rows>*>tr>*{border-width:1px 0}
268
+ table.frame-all{border-width:1px}
269
+ table.frame-ends{border-width:1px 0}
270
+ table.frame-sides{border-width:0 1px}
271
+ table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
272
+ table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
273
+ table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
274
+ table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
275
+ table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
276
+ th.halign-left,td.halign-left{text-align:left}
277
+ th.halign-right,td.halign-right{text-align:right}
278
+ th.halign-center,td.halign-center{text-align:center}
279
+ th.valign-top,td.valign-top{vertical-align:top}
280
+ th.valign-bottom,td.valign-bottom{vertical-align:bottom}
281
+ th.valign-middle,td.valign-middle{vertical-align:middle}
282
+ table thead th,table tfoot th{font-weight:bold}
283
+ tbody tr th{background:#f7f8f7}
284
+ tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
285
+ p.tableblock>code:only-child{background:none;padding:0}
286
+ p.tableblock{font-size:1em}
287
+ ol{margin-left:1.75em}
288
+ ul li ol{margin-left:1.5em}
289
+ dl dd{margin-left:1.125em}
290
+ dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
291
+ li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
292
+ ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
293
+ ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
294
+ ul.unstyled,ol.unstyled{margin-left:0}
295
+ li>p:empty:only-child::before{content:"";display:inline-block}
296
+ ul.checklist>li>p:first-child{margin-left:-1em}
297
+ ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
298
+ ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
299
+ ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
300
+ ul.inline>li{margin-left:1.25em}
301
+ .unstyled dl dt{font-weight:400;font-style:normal}
302
+ ol.arabic{list-style-type:decimal}
303
+ ol.decimal{list-style-type:decimal-leading-zero}
304
+ ol.loweralpha{list-style-type:lower-alpha}
305
+ ol.upperalpha{list-style-type:upper-alpha}
306
+ ol.lowerroman{list-style-type:lower-roman}
307
+ ol.upperroman{list-style-type:upper-roman}
308
+ ol.lowergreek{list-style-type:lower-greek}
309
+ .hdlist>table,.colist>table{border:0;background:none}
310
+ .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
311
+ td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
312
+ td.hdlist1{font-weight:bold;padding-bottom:1.25em}
313
+ td.hdlist2{word-wrap:anywhere}
314
+ .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
315
+ .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
316
+ .colist td:not([class]):first-child img{max-width:none}
317
+ .colist td:not([class]):last-child{padding:.25em 0}
318
+ .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
319
+ .imageblock.left{margin:.25em .625em 1.25em 0}
320
+ .imageblock.right{margin:.25em 0 1.25em .625em}
321
+ .imageblock>.title{margin-bottom:0}
322
+ .imageblock.thumb,.imageblock.th{border-width:6px}
323
+ .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
324
+ .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
325
+ .image.left{margin-right:.625em}
326
+ .image.right{margin-left:.625em}
327
+ a.image{text-decoration:none;display:inline-block}
328
+ a.image object{pointer-events:none}
329
+ sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
330
+ sup.footnote a,sup.footnoteref a{text-decoration:none}
331
+ sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
332
+ #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
333
+ #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
334
+ #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
335
+ #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
336
+ #footnotes .footnote:last-of-type{margin-bottom:0}
337
+ #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
338
+ div.unbreakable{page-break-inside:avoid}
339
+ .big{font-size:larger}
340
+ .small{font-size:smaller}
341
+ .underline{text-decoration:underline}
342
+ .overline{text-decoration:overline}
343
+ .line-through{text-decoration:line-through}
344
+ .aqua{color:#00bfbf}
345
+ .aqua-background{background:#00fafa}
346
+ .black{color:#000}
347
+ .black-background{background:#000}
348
+ .blue{color:#0000bf}
349
+ .blue-background{background:#0000fa}
350
+ .fuchsia{color:#bf00bf}
351
+ .fuchsia-background{background:#fa00fa}
352
+ .gray{color:#606060}
353
+ .gray-background{background:#7d7d7d}
354
+ .green{color:#006000}
355
+ .green-background{background:#007d00}
356
+ .lime{color:#00bf00}
357
+ .lime-background{background:#00fa00}
358
+ .maroon{color:#600000}
359
+ .maroon-background{background:#7d0000}
360
+ .navy{color:#000060}
361
+ .navy-background{background:#00007d}
362
+ .olive{color:#606000}
363
+ .olive-background{background:#7d7d00}
364
+ .purple{color:#600060}
365
+ .purple-background{background:#7d007d}
366
+ .red{color:#bf0000}
367
+ .red-background{background:#fa0000}
368
+ .silver{color:#909090}
369
+ .silver-background{background:#bcbcbc}
370
+ .teal{color:#006060}
371
+ .teal-background{background:#007d7d}
372
+ .white{color:#bfbfbf}
373
+ .white-background{background:#fafafa}
374
+ .yellow{color:#bfbf00}
375
+ .yellow-background{background:#fafa00}
376
+ span.icon>.fa{cursor:default}
377
+ a span.icon>.fa{cursor:inherit}
378
+ .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
379
+ .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
380
+ .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
381
+ .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
382
+ .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
383
+ .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
384
+ .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
385
+ .conum[data-value] *{color:#fff!important}
386
+ .conum[data-value]+b{display:none}
387
+ .conum[data-value]::after{content:attr(data-value)}
388
+ pre .conum[data-value]{position:relative;top:-.125em}
389
+ b.conum *{color:inherit!important}
390
+ .conum:not([data-value]):empty{display:none}
391
+ dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
392
+ h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
393
+ p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
394
+ p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
395
+ p{margin-bottom:1.25rem}
396
+ .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
397
+ .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
398
+ .print-only{display:none!important}
399
+ @page{margin:1.25cm .75cm}
400
+ @media print{*{box-shadow:none!important;text-shadow:none!important}
401
+ html{font-size:80%}
402
+ a{color:inherit!important;text-decoration:underline!important}
403
+ a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
404
+ a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
405
+ abbr[title]{border-bottom:1px dotted}
406
+ abbr[title]::after{content:" (" attr(title) ")"}
407
+ pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
408
+ thead{display:table-header-group}
409
+ svg{max-width:100%}
410
+ p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
411
+ h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
412
+ #header,#content,#footnotes,#footer{max-width:none}
413
+ #toc,.sidebarblock,.exampleblock>.content{background:none!important}
414
+ #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
415
+ body.book #header{text-align:center}
416
+ body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
417
+ body.book #header .details{border:0!important;display:block;padding:0!important}
418
+ body.book #header .details span:first-child{margin-left:0!important}
419
+ body.book #header .details br{display:block}
420
+ body.book #header .details br+span::before{content:none!important}
421
+ body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
422
+ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
423
+ .listingblock code[data-lang]::before{display:block}
424
+ #footer{padding:0 .9375em}
425
+ .hide-on-print{display:none!important}
426
+ .print-only{display:block!important}
427
+ .hide-for-print{display:none!important}
428
+ .show-for-print{display:inherit!important}}
429
+ @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
430
+ .sect1{padding:0!important}
431
+ .sect1+.sect1{border:0}
432
+ #footer{background:none}
433
+ #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
434
+ @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
435
+ </style>
436
+ <style>
437
+ pre>code {
438
+ display: inline;
439
+ }
440
+ </style>
441
+ </head>
442
+ <body class="article">
443
+ <div id="header">
444
+ <h1>My First Object Walk</h1>
445
+ </div>
446
+ <div id="content">
447
+ <div class="sect1">
448
+ <h2 id="_whats_an_object_walk">What&#8217;s an Object Walk?</h2>
449
+ <div class="sectionbody">
450
+ <div class="paragraph">
451
+ <p>The object walk is a key concept in Git - this is the process that underpins
452
+ operations like object transfer and fsck. Beginning from a given commit, the
453
+ list of objects is found by walking parent relationships between commits (commit
454
+ X based on commit W) and containment relationships between objects (tree Y is
455
+ contained within commit X, and blob Z is located within tree Y, giving our
456
+ working tree for commit X something like <code>y/z.txt</code>).</p>
457
+ </div>
458
+ <div class="paragraph">
459
+ <p>A related concept is the revision walk, which is focused on commit objects and
460
+ their parent relationships and does not delve into other object types. The
461
+ revision walk is used for operations like <code>git</code> <code>log</code>.</p>
462
+ </div>
463
+ <div class="sect2">
464
+ <h3 id="_related_reading">Related Reading</h3>
465
+ <div class="ulist">
466
+ <ul>
467
+ <li>
468
+ <p><code>Documentation/user-manual.adoc</code> under "Hacking Git" contains some coverage of
469
+ the revision walker in its various incarnations.</p>
470
+ </li>
471
+ <li>
472
+ <p><code>revision.h</code></p>
473
+ </li>
474
+ <li>
475
+ <p><a href="https://eagain.net/articles/git-for-computer-scientists/">Git for Computer Scientists</a>
476
+ gives a good overview of the types of objects in Git and what your object
477
+ walk is really describing.</p>
478
+ </li>
479
+ </ul>
480
+ </div>
481
+ </div>
482
+ </div>
483
+ </div>
484
+ <div class="sect1">
485
+ <h2 id="_setting_up">Setting Up</h2>
486
+ <div class="sectionbody">
487
+ <div class="paragraph">
488
+ <p>Create a new branch from <code>master</code>.</p>
489
+ </div>
490
+ <div class="listingblock">
491
+ <div class="content">
492
+ <pre>git checkout -b revwalk origin/master</pre>
493
+ </div>
494
+ </div>
495
+ <div class="paragraph">
496
+ <p>We&#8217;ll put our fiddling into a new command. For fun, let&#8217;s name it <code>git</code> <code>walken</code>.
497
+ Open up a new file <code>builtin/walken.c</code> and set up the command handler:</p>
498
+ </div>
499
+ <div class="listingblock">
500
+ <div class="content">
501
+ <pre>/*
502
+ * "git walken"
503
+ *
504
+ * Part of the "My First Object Walk" tutorial.
505
+ */
506
+
507
+ #include "builtin.h"
508
+ #include "trace.h"
509
+
510
+ int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo)
511
+ {
512
+ trace_printf(_("cmd_walken incoming...\n"));
513
+ return 0;
514
+ }</pre>
515
+ </div>
516
+ </div>
517
+ <div class="admonitionblock note">
518
+ <table>
519
+ <tr>
520
+ <td class="icon">
521
+ <div class="title">Note</div>
522
+ </td>
523
+ <td class="content">
524
+ <code>trace_printf</code>(), defined in <code>trace.h</code>, differs from <code>printf</code>() in
525
+ that it can be turned on or off at runtime. For the purposes of this
526
+ tutorial, we will write <code>walken</code> as though it is intended for use as
527
+ a "plumbing" command: that is, a command which is used primarily in
528
+ scripts, rather than interactively by humans (a "porcelain" command).
529
+ So we will send our debug output to <code>trace_printf</code>() instead.
530
+ When running, enable trace output by setting the environment variable <code>GIT_TRACE</code>.
531
+ </td>
532
+ </tr>
533
+ </table>
534
+ </div>
535
+ <div class="paragraph">
536
+ <p>Add usage text and <code>-h</code> handling, like all subcommands should consistently do
537
+ (our test suite will notice and complain if you fail to do so).
538
+ We&#8217;ll need to include the <code>parse-options.h</code> header.</p>
539
+ </div>
540
+ <div class="listingblock">
541
+ <div class="content">
542
+ <pre>#include "parse-options.h"
543
+
544
+ ...
545
+
546
+ int cmd_walken(int argc, const char **argv, const char *prefix)
547
+ {
548
+ const char * const walken_usage[] = {
549
+ N_("git walken"),
550
+ NULL,
551
+ };
552
+ struct option options[] = {
553
+ OPT_END()
554
+ };
555
+
556
+ argc = parse_options(argc, argv, prefix, options, walken_usage, 0);
557
+
558
+ ...
559
+ }</pre>
560
+ </div>
561
+ </div>
562
+ <div class="paragraph">
563
+ <p>Also add the relevant line in <code>builtin.h</code> near <code>cmd_version</code>():</p>
564
+ </div>
565
+ <div class="listingblock">
566
+ <div class="content">
567
+ <pre>int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo);</pre>
568
+ </div>
569
+ </div>
570
+ <div class="paragraph">
571
+ <p>Include the command in <code>git.c</code> in <code>commands</code>[] near the entry for <code>version</code>,
572
+ maintaining alphabetical ordering:</p>
573
+ </div>
574
+ <div class="listingblock">
575
+ <div class="content">
576
+ <pre>{ "walken", cmd_walken, RUN_SETUP },</pre>
577
+ </div>
578
+ </div>
579
+ <div class="paragraph">
580
+ <p>Add an entry for the new command in the both the Make and Meson build system,
581
+ before the entry for <code>worktree</code>:</p>
582
+ </div>
583
+ <div class="ulist">
584
+ <ul>
585
+ <li>
586
+ <p>In the <code>Makefile</code>:</p>
587
+ </li>
588
+ </ul>
589
+ </div>
590
+ <div class="listingblock">
591
+ <div class="content">
592
+ <pre>...
593
+ BUILTIN_OBJS += builtin/walken.o
594
+ ...</pre>
595
+ </div>
596
+ </div>
597
+ <div class="ulist">
598
+ <ul>
599
+ <li>
600
+ <p>In the <code>meson.build</code> file:</p>
601
+ </li>
602
+ </ul>
603
+ </div>
604
+ <div class="listingblock">
605
+ <div class="content">
606
+ <pre>builtin_sources = [
607
+ ...
608
+ 'builtin/walken.c',
609
+ ...
610
+ ]</pre>
611
+ </div>
612
+ </div>
613
+ <div class="paragraph">
614
+ <p>Build and test out your command, without forgetting to ensure the <code>DEVELOPER</code>
615
+ flag is set, and with <code>GIT_TRACE</code> enabled so the debug output can be seen:</p>
616
+ </div>
617
+ <div class="listingblock">
618
+ <div class="content">
619
+ <pre>$ echo DEVELOPER=1 &gt;&gt;config.mak
620
+ $ make
621
+ $ GIT_TRACE=1 ./bin-wrappers/git walken</pre>
622
+ </div>
623
+ </div>
624
+ <div class="admonitionblock note">
625
+ <table>
626
+ <tr>
627
+ <td class="icon">
628
+ <div class="title">Note</div>
629
+ </td>
630
+ <td class="content">
631
+ For a more exhaustive overview of the new command process, take a look at
632
+ <code>Documentation/MyFirstContribution.adoc</code>.
633
+ </td>
634
+ </tr>
635
+ </table>
636
+ </div>
637
+ <div class="admonitionblock note">
638
+ <table>
639
+ <tr>
640
+ <td class="icon">
641
+ <div class="title">Note</div>
642
+ </td>
643
+ <td class="content">
644
+ A reference implementation can be found at
645
+ <a href="https://github.com/nasamuffin/git/tree/revwalk" class="bare">https://github.com/nasamuffin/git/tree/revwalk</a>.
646
+ </td>
647
+ </tr>
648
+ </table>
649
+ </div>
650
+ <div class="sect2">
651
+ <h3 id="_struct_rev_cmdline_info"><code>struct</code> <code>rev_cmdline_info</code></h3>
652
+ <div class="paragraph">
653
+ <p>The definition of <code>struct</code> <code>rev_cmdline_info</code> can be found in <code>revision.h</code>.</p>
654
+ </div>
655
+ <div class="paragraph">
656
+ <p>This struct is contained within the <code>rev_info</code> struct and is used to reflect
657
+ parameters provided by the user over the CLI.</p>
658
+ </div>
659
+ <div class="paragraph">
660
+ <p><code>nr</code> represents the number of <code>rev_cmdline_entry</code> present in the array.</p>
661
+ </div>
662
+ <div class="paragraph">
663
+ <p><code>alloc</code> is used by the <code>ALLOC_GROW</code> macro. Check <code>alloc.h</code> - this variable is
664
+ used to track the allocated size of the list.</p>
665
+ </div>
666
+ <div class="paragraph">
667
+ <p>Per entry, we find:</p>
668
+ </div>
669
+ <div class="paragraph">
670
+ <p><code>item</code> is the object provided upon which to base the object walk. Items in Git
671
+ can be blobs, trees, commits, or tags. (See <code>Documentation/gittutorial-2.adoc</code>.)</p>
672
+ </div>
673
+ <div class="paragraph">
674
+ <p><code>name</code> is the object ID (OID) of the object - a hex string you may be familiar
675
+ with from using Git to organize your source in the past. Check the tutorial
676
+ mentioned above towards the top for a discussion of where the OID can come
677
+ from.</p>
678
+ </div>
679
+ <div class="paragraph">
680
+ <p><code>whence</code> indicates some information about what to do with the parents of the
681
+ specified object. We&#8217;ll explore this flag more later on; take a look at
682
+ <code>Documentation/revisions.adoc</code> to get an idea of what could set the <code>whence</code>
683
+ value.</p>
684
+ </div>
685
+ <div class="paragraph">
686
+ <p><code>flags</code> are used to hint the beginning of the revision walk and are the first
687
+ block under the #include`s <code>in</code> `revision.<code>h</code>. The most likely ones to be set in
688
+ the <code>rev_cmdline_info</code> are <code>UNINTERESTING</code> and <code>BOTTOM</code>, but these same flags
689
+ can be used during the walk, as well.</p>
690
+ </div>
691
+ </div>
692
+ <div class="sect2">
693
+ <h3 id="_struct_rev_info"><code>struct</code> <code>rev_info</code></h3>
694
+ <div class="paragraph">
695
+ <p>This one is quite a bit longer, and many fields are only used during the walk
696
+ by <code>revision.c</code> - not configuration options. Most of the configurable flags in
697
+ <code>struct</code> <code>rev_info</code> have a mirror in <code>Documentation/rev-list-options.adoc</code>. It&#8217;s a
698
+ good idea to take some time and read through that document.</p>
699
+ </div>
700
+ </div>
701
+ </div>
702
+ </div>
703
+ <div class="sect1">
704
+ <h2 id="_basic_commit_walk">Basic Commit Walk</h2>
705
+ <div class="sectionbody">
706
+ <div class="paragraph">
707
+ <p>First, let&#8217;s see if we can replicate the output of <code>git</code> <code>log</code> <code>--oneline</code>. We&#8217;ll
708
+ refer back to the implementation frequently to discover norms when performing
709
+ an object walk of our own.</p>
710
+ </div>
711
+ <div class="paragraph">
712
+ <p>To do so, we&#8217;ll first find all the commits, in order, which preceded the current
713
+ commit. We&#8217;ll extract the name and subject of the commit from each.</p>
714
+ </div>
715
+ <div class="paragraph">
716
+ <p>Ideally, we will also be able to find out which ones are currently at the tip of
717
+ various branches.</p>
718
+ </div>
719
+ <div class="sect2">
720
+ <h3 id="_setting_up_2">Setting Up</h3>
721
+ <div class="paragraph">
722
+ <p>Preparing for your object walk has some distinct stages.</p>
723
+ </div>
724
+ <div class="olist arabic">
725
+ <ol class="arabic">
726
+ <li>
727
+ <p>Perform default setup for this mode, and others which may be invoked.</p>
728
+ </li>
729
+ <li>
730
+ <p>Check configuration files for relevant settings.</p>
731
+ </li>
732
+ <li>
733
+ <p>Set up the <code>rev_info</code> struct.</p>
734
+ </li>
735
+ <li>
736
+ <p>Tweak the initialized <code>rev_info</code> to suit the current walk.</p>
737
+ </li>
738
+ <li>
739
+ <p>Prepare the <code>rev_info</code> for the walk.</p>
740
+ </li>
741
+ <li>
742
+ <p>Iterate over the objects, processing each one.</p>
743
+ </li>
744
+ </ol>
745
+ </div>
746
+ <div class="sect3">
747
+ <h4 id="_default_setups">Default Setups</h4>
748
+ <div class="paragraph">
749
+ <p>Before examining configuration files which may modify command behavior, set up
750
+ default state for switches or options your command may have. If your command
751
+ utilizes other Git components, ask them to set up their default states as well.
752
+ For instance, <code>git</code> <code>log</code> takes advantage of <code>grep</code> and <code>diff</code> functionality, so
753
+ its <code>init_log_defaults</code>() sets its own state (<code>decoration_style</code>) and asks
754
+ <code>grep</code> and <code>diff</code> to initialize themselves by calling each of their
755
+ initialization functions.</p>
756
+ </div>
757
+ </div>
758
+ <div class="sect3">
759
+ <h4 id="_configuring_from_gitconfig">Configuring From .<code>gitconfig</code></h4>
760
+ <div class="paragraph">
761
+ <p>Next, we should have a look at any relevant configuration settings (i.e.,
762
+ settings readable and settable from <code>git</code> <code>config</code>). This is done by providing a
763
+ callback to <code>repo_config</code>(); within that callback, you can also invoke methods
764
+ from other components you may need that need to intercept these options. Your
765
+ callback will be invoked once per each configuration value which Git knows about
766
+ (global, local, worktree, etc.).</p>
767
+ </div>
768
+ <div class="paragraph">
769
+ <p>Similarly to the default values, we don&#8217;t have anything to do here yet
770
+ ourselves; however, we should call <code>git_default_config</code>() if we aren&#8217;t calling
771
+ any other existing config callbacks.</p>
772
+ </div>
773
+ <div class="paragraph">
774
+ <p>Add a new function to <code>builtin/walken.c</code>.
775
+ We&#8217;ll also need to include the <code>config.h</code> header:</p>
776
+ </div>
777
+ <div class="listingblock">
778
+ <div class="content">
779
+ <pre>#include "config.h"
780
+
781
+ ...
782
+
783
+ static int git_walken_config(const char *var, const char *value,
784
+ const struct config_context *ctx, void *cb)
785
+ {
786
+ /*
787
+ * For now, we don't have any custom configuration, so fall back to
788
+ * the default config.
789
+ */
790
+ return git_default_config(var, value, ctx, cb);
791
+ }</pre>
792
+ </div>
793
+ </div>
794
+ <div class="paragraph">
795
+ <p>Make sure to invoke <code>repo_config</code>() with it in your <code>cmd_walken</code>():</p>
796
+ </div>
797
+ <div class="listingblock">
798
+ <div class="content">
799
+ <pre>int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo)
800
+ {
801
+ ...
802
+
803
+ repo_config(repo, git_walken_config, NULL);
804
+
805
+ ...
806
+ }</pre>
807
+ </div>
808
+ </div>
809
+ </div>
810
+ <div class="sect3">
811
+ <h4 id="_setting_up_rev_info">Setting Up <code>rev_info</code></h4>
812
+ <div class="paragraph">
813
+ <p>Now that we&#8217;ve gathered external configuration and options, it&#8217;s time to
814
+ initialize the <code>rev_info</code> object which we will use to perform the walk. This is
815
+ typically done by calling <code>repo_init_revisions</code>() with the repository you intend
816
+ to target, as well as the <code>prefix</code> argument of <code>cmd_walken</code> and your <code>rev_info</code>
817
+ struct.</p>
818
+ </div>
819
+ <div class="paragraph">
820
+ <p>Add the <code>struct</code> <code>rev_info</code> and the <code>repo_init_revisions</code>() call.
821
+ We&#8217;ll also need to include the <code>revision.h</code> header:</p>
822
+ </div>
823
+ <div class="listingblock">
824
+ <div class="content">
825
+ <pre>#include "revision.h"
826
+
827
+ ...
828
+
829
+ int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo)
830
+ {
831
+ /* This can go wherever you like in your declarations.*/
832
+ struct rev_info rev;
833
+ ...
834
+
835
+ /* This should go after the repo_config() call. */
836
+ repo_init_revisions(repo, &amp;rev, prefix);
837
+
838
+ ...
839
+ }</pre>
840
+ </div>
841
+ </div>
842
+ </div>
843
+ <div class="sect3">
844
+ <h4 id="_tweaking_rev_info_for_the_walk">Tweaking <code>rev_info</code> For the Walk</h4>
845
+ <div class="paragraph">
846
+ <p>We&#8217;re getting close, but we&#8217;re still not quite ready to go. Now that <code>rev</code> is
847
+ initialized, we can modify it to fit our needs. This is usually done within a
848
+ helper for clarity, so let&#8217;s add one:</p>
849
+ </div>
850
+ <div class="listingblock">
851
+ <div class="content">
852
+ <pre>static void final_rev_info_setup(struct rev_info *rev)
853
+ {
854
+ /*
855
+ * We want to mimic the appearance of `git log --oneline`, so let's
856
+ * force oneline format.
857
+ */
858
+ get_commit_format("oneline", rev);
859
+
860
+ /* Start our object walk at HEAD. */
861
+ add_head_to_pending(rev);
862
+ }</pre>
863
+ </div>
864
+ </div>
865
+ <div class="admonitionblock note">
866
+ <table>
867
+ <tr>
868
+ <td class="icon">
869
+ <div class="title">Note</div>
870
+ </td>
871
+ <td class="content">
872
+ <div class="paragraph">
873
+ <p>Instead of using the shorthand <code>add_head_to_pending</code>(), you could do
874
+ something like this:</p>
875
+ </div>
876
+ <div class="listingblock">
877
+ <div class="content">
878
+ <pre> struct setup_revision_opt opt;
879
+
880
+ memset(&amp;opt, 0, sizeof(opt));
881
+ opt.def = "HEAD";
882
+ opt.revarg_opt = REVARG_COMMITTISH;
883
+ setup_revisions(argc, argv, rev, &amp;opt);</pre>
884
+ </div>
885
+ </div>
886
+ <div class="paragraph">
887
+ <p>Using a <code>setup_revision_opt</code> gives you finer control over your walk&#8217;s starting
888
+ point.</p>
889
+ </div>
890
+ </td>
891
+ </tr>
892
+ </table>
893
+ </div>
894
+ <div class="paragraph">
895
+ <p>Then let&#8217;s invoke <code>final_rev_info_setup</code>() after the call to
896
+ <code>repo_init_revisions</code>():</p>
897
+ </div>
898
+ <div class="listingblock">
899
+ <div class="content">
900
+ <pre>int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo)
901
+ {
902
+ ...
903
+
904
+ final_rev_info_setup(&amp;rev);
905
+
906
+ ...
907
+ }</pre>
908
+ </div>
909
+ </div>
910
+ <div class="paragraph">
911
+ <p>Later, we may wish to add more arguments to <code>final_rev_info_setup</code>(). But for
912
+ now, this is all we need.</p>
913
+ </div>
914
+ </div>
915
+ <div class="sect3">
916
+ <h4 id="_preparing_rev_info_for_the_walk">Preparing <code>rev_info</code> For the Walk</h4>
917
+ <div class="paragraph">
918
+ <p>Now that <code>rev</code> is all initialized and configured, we&#8217;ve got one more setup step
919
+ before we get rolling. We can do this in a helper, which will both prepare the
920
+ <code>rev_info</code> for the walk, and perform the walk itself. Let&#8217;s start the helper
921
+ with the call to <code>prepare_revision_walk</code>(), which can return an error without
922
+ dying on its own:</p>
923
+ </div>
924
+ <div class="listingblock">
925
+ <div class="content">
926
+ <pre>static void walken_commit_walk(struct rev_info *rev)
927
+ {
928
+ if (prepare_revision_walk(rev))
929
+ die(_("revision walk setup failed"));
930
+ }</pre>
931
+ </div>
932
+ </div>
933
+ <div class="admonitionblock note">
934
+ <table>
935
+ <tr>
936
+ <td class="icon">
937
+ <div class="title">Note</div>
938
+ </td>
939
+ <td class="content">
940
+ <code>die</code>() prints to <code>stderr</code> and exits the program. Since it will print to
941
+ <code>stderr</code> it&#8217;s likely to be seen by a human, so we will localize it.
942
+ </td>
943
+ </tr>
944
+ </table>
945
+ </div>
946
+ </div>
947
+ <div class="sect3">
948
+ <h4 id="_performing_the_walk">Performing the Walk!</h4>
949
+ <div class="paragraph">
950
+ <p>Finally! We are ready to begin the walk itself. Now we can see that <code>rev_info</code>
951
+ can also be used as an iterator; we move to the next item in the walk by using
952
+ <code>get_revision</code>() repeatedly. Add the listed variable declarations at the top and
953
+ the walk loop below the <code>prepare_revision_walk</code>() call within your
954
+ <code>walken_commit_walk</code>():</p>
955
+ </div>
956
+ <div class="listingblock">
957
+ <div class="content">
958
+ <pre>#include "pretty.h"
959
+
960
+ ...
961
+
962
+ static void walken_commit_walk(struct rev_info *rev)
963
+ {
964
+ struct commit *commit;
965
+ struct strbuf prettybuf = STRBUF_INIT;
966
+
967
+ ...
968
+
969
+ while ((commit = get_revision(rev))) {
970
+ strbuf_reset(&amp;prettybuf);
971
+ pp_commit_easy(CMIT_FMT_ONELINE, commit, &amp;prettybuf);
972
+ puts(prettybuf.buf);
973
+ }
974
+ strbuf_release(&amp;prettybuf);
975
+ }</pre>
976
+ </div>
977
+ </div>
978
+ <div class="admonitionblock note">
979
+ <table>
980
+ <tr>
981
+ <td class="icon">
982
+ <div class="title">Note</div>
983
+ </td>
984
+ <td class="content">
985
+ <code>puts</code>() prints a <code>char*</code> to <code>stdout</code>. Since this is the part of the
986
+ command we expect to be machine-parsed, we&#8217;re sending it directly to stdout.
987
+ </td>
988
+ </tr>
989
+ </table>
990
+ </div>
991
+ <div class="paragraph">
992
+ <p>Give it a shot.</p>
993
+ </div>
994
+ <div class="listingblock">
995
+ <div class="content">
996
+ <pre>$ make
997
+ $ ./bin-wrappers/git walken</pre>
998
+ </div>
999
+ </div>
1000
+ <div class="paragraph">
1001
+ <p>You should see all of the subject lines of all the commits in
1002
+ your tree&#8217;s history, in order, ending with the initial commit, "Initial revision
1003
+ of "git", the information manager from hell". Congratulations! You&#8217;ve written
1004
+ your first revision walk. You can play with printing some additional fields
1005
+ from each commit if you&#8217;re curious; have a look at the functions available in
1006
+ <code>commit.h</code>.</p>
1007
+ </div>
1008
+ </div>
1009
+ </div>
1010
+ <div class="sect2">
1011
+ <h3 id="_adding_a_filter">Adding a Filter</h3>
1012
+ <div class="paragraph">
1013
+ <p>Next, let&#8217;s try to filter the commits we see based on their author. This is
1014
+ equivalent to running <code>git</code> <code>log</code> <code>--author=</code><em>&lt;pattern&gt;</em>. We can add a filter by
1015
+ modifying <code>rev_info.grep_filter</code>, which is a <code>struct</code> <code>grep_opt</code>.</p>
1016
+ </div>
1017
+ <div class="paragraph">
1018
+ <p>First some setup. Add <code>grep_config</code>() to <code>git_walken_config</code>():</p>
1019
+ </div>
1020
+ <div class="listingblock">
1021
+ <div class="content">
1022
+ <pre>static int git_walken_config(const char *var, const char *value,
1023
+ const struct config_context *ctx, void *cb)
1024
+ {
1025
+ grep_config(var, value, ctx, cb);
1026
+ return git_default_config(var, value, ctx, cb);
1027
+ }</pre>
1028
+ </div>
1029
+ </div>
1030
+ <div class="paragraph">
1031
+ <p>Next, we can modify the <code>grep_filter</code>. This is done with convenience functions
1032
+ found in <code>grep.h</code>. For fun, we&#8217;re filtering to only commits from folks using a
1033
+ <code>gmail.com</code> email address - a not-very-precise guess at who may be working on
1034
+ Git as a hobby. Since we&#8217;re checking the author, which is a specific line in the
1035
+ header, we&#8217;ll use the <code>append_header_grep_pattern</code>() helper. We can use
1036
+ the <code>enum</code> <code>grep_header_field</code> to indicate which part of the commit header we want
1037
+ to search.</p>
1038
+ </div>
1039
+ <div class="paragraph">
1040
+ <p>In <code>final_rev_info_setup</code>(), add your filter line:</p>
1041
+ </div>
1042
+ <div class="listingblock">
1043
+ <div class="content">
1044
+ <pre>static void final_rev_info_setup(int argc, const char **argv,
1045
+ const char *prefix, struct rev_info *rev)
1046
+ {
1047
+ ...
1048
+
1049
+ append_header_grep_pattern(&amp;rev-&gt;grep_filter, GREP_HEADER_AUTHOR,
1050
+ "gmail");
1051
+ compile_grep_patterns(&amp;rev-&gt;grep_filter);
1052
+
1053
+ ...
1054
+ }</pre>
1055
+ </div>
1056
+ </div>
1057
+ <div class="paragraph">
1058
+ <p><code>append_header_grep_pattern</code>() adds your new "gmail" pattern to <code>rev_info</code>, but
1059
+ it won&#8217;t work unless we compile it with <code>compile_grep_patterns</code>().</p>
1060
+ </div>
1061
+ <div class="admonitionblock note">
1062
+ <table>
1063
+ <tr>
1064
+ <td class="icon">
1065
+ <div class="title">Note</div>
1066
+ </td>
1067
+ <td class="content">
1068
+ If you are using <code>setup_revisions</code>() (for example, if you are passing a
1069
+ <code>setup_revision_opt</code> instead of using <code>add_head_to_pending</code>()), you don&#8217;t need
1070
+ to call <code>compile_grep_patterns</code>() because <code>setup_revisions</code>() calls it for you.
1071
+ </td>
1072
+ </tr>
1073
+ </table>
1074
+ </div>
1075
+ <div class="admonitionblock note">
1076
+ <table>
1077
+ <tr>
1078
+ <td class="icon">
1079
+ <div class="title">Note</div>
1080
+ </td>
1081
+ <td class="content">
1082
+ We could add the same filter via the <code>append_grep_pattern</code>() helper if we
1083
+ wanted to, but <code>append_header_grep_pattern</code>() adds the <code>enum</code> <code>grep_context</code> and
1084
+ <code>enum</code> <code>grep_pat_token</code> for us.
1085
+ </td>
1086
+ </tr>
1087
+ </table>
1088
+ </div>
1089
+ </div>
1090
+ <div class="sect2">
1091
+ <h3 id="_changing_the_order">Changing the Order</h3>
1092
+ <div class="paragraph">
1093
+ <p>There are a few ways that we can change the order of the commits during a
1094
+ revision walk. Firstly, we can use the <code>enum</code> <code>rev_sort_order</code> to choose from some
1095
+ typical orderings.</p>
1096
+ </div>
1097
+ <div class="paragraph">
1098
+ <p><code>topo_order</code> is the same as <code>git</code> <code>log</code> <code>--topo-order</code>: we avoid showing a parent
1099
+ before all of its children have been shown, and we avoid mixing commits which
1100
+ are in different lines of history. (<code>git</code> <code>help</code> <code>log</code>'s section on <code>--topo-order</code>
1101
+ has a very nice diagram to illustrate this.)</p>
1102
+ </div>
1103
+ <div class="paragraph">
1104
+ <p>Let&#8217;s see what happens when we run with <code>REV_SORT_BY_COMMIT_DATE</code> as opposed to
1105
+ <code>REV_SORT_BY_AUTHOR_DATE</code>. Add the following:</p>
1106
+ </div>
1107
+ <div class="listingblock">
1108
+ <div class="content">
1109
+ <pre>static void final_rev_info_setup(int argc, const char **argv,
1110
+ const char *prefix, struct rev_info *rev)
1111
+ {
1112
+ ...
1113
+
1114
+ rev-&gt;topo_order = 1;
1115
+ rev-&gt;sort_order = REV_SORT_BY_COMMIT_DATE;
1116
+
1117
+ ...
1118
+ }</pre>
1119
+ </div>
1120
+ </div>
1121
+ <div class="paragraph">
1122
+ <p>Let&#8217;s output this into a file so we can easily diff it with the walk sorted by
1123
+ author date.</p>
1124
+ </div>
1125
+ <div class="listingblock">
1126
+ <div class="content">
1127
+ <pre>$ make
1128
+ $ ./bin-wrappers/git walken &gt; commit-date.txt</pre>
1129
+ </div>
1130
+ </div>
1131
+ <div class="paragraph">
1132
+ <p>Then, let&#8217;s sort by author date and run it again.</p>
1133
+ </div>
1134
+ <div class="listingblock">
1135
+ <div class="content">
1136
+ <pre>static void final_rev_info_setup(int argc, const char **argv,
1137
+ const char *prefix, struct rev_info *rev)
1138
+ {
1139
+ ...
1140
+
1141
+ rev-&gt;topo_order = 1;
1142
+ rev-&gt;sort_order = REV_SORT_BY_AUTHOR_DATE;
1143
+
1144
+ ...
1145
+ }</pre>
1146
+ </div>
1147
+ </div>
1148
+ <div class="listingblock">
1149
+ <div class="content">
1150
+ <pre>$ make
1151
+ $ ./bin-wrappers/git walken &gt; author-date.txt</pre>
1152
+ </div>
1153
+ </div>
1154
+ <div class="paragraph">
1155
+ <p>Finally, compare the two. This is a little less helpful without object names or
1156
+ dates, but hopefully we get the idea.</p>
1157
+ </div>
1158
+ <div class="listingblock">
1159
+ <div class="content">
1160
+ <pre>$ diff -u commit-date.txt author-date.txt</pre>
1161
+ </div>
1162
+ </div>
1163
+ <div class="paragraph">
1164
+ <p>This display indicates that commits can be reordered after they&#8217;re written, for
1165
+ example with <code>git</code> <code>rebase</code>.</p>
1166
+ </div>
1167
+ <div class="paragraph">
1168
+ <p>Let&#8217;s try one more reordering of commits. <code>rev_info</code> exposes a <code>reverse</code> flag.
1169
+ Set that flag somewhere inside of <code>final_rev_info_setup</code>():</p>
1170
+ </div>
1171
+ <div class="listingblock">
1172
+ <div class="content">
1173
+ <pre>static void final_rev_info_setup(int argc, const char **argv, const char *prefix,
1174
+ struct rev_info *rev)
1175
+ {
1176
+ ...
1177
+
1178
+ rev-&gt;reverse = 1;
1179
+
1180
+ ...
1181
+ }</pre>
1182
+ </div>
1183
+ </div>
1184
+ <div class="paragraph">
1185
+ <p>Run your walk again and note the difference in order. (If you remove the grep
1186
+ pattern, you should see the last commit this call gives you as your current
1187
+ HEAD.)</p>
1188
+ </div>
1189
+ </div>
1190
+ </div>
1191
+ </div>
1192
+ <div class="sect1">
1193
+ <h2 id="_basic_object_walk">Basic Object Walk</h2>
1194
+ <div class="sectionbody">
1195
+ <div class="paragraph">
1196
+ <p>So far we&#8217;ve been walking only commits. But Git has more types of objects than
1197
+ that! Let&#8217;s see if we can walk <em>all</em> objects, and find out some information
1198
+ about each one.</p>
1199
+ </div>
1200
+ <div class="paragraph">
1201
+ <p>We can base our work on an example. <code>git</code> <code>pack-objects</code> prepares all kinds of
1202
+ objects for packing into a bitmap or packfile. The work we are interested in
1203
+ resides in <code>builtin/pack-objects.c:get_object_list</code>(); examination of that
1204
+ function shows that the all-object walk is being performed by
1205
+ <code>traverse_commit_list</code>() or <code>traverse_commit_list_filtered</code>(). Those two
1206
+ functions reside in <code>list-objects.c</code>; examining the source shows that, despite
1207
+ the name, these functions traverse all kinds of objects. Let&#8217;s have a look at
1208
+ the arguments to <code>traverse_commit_list</code>().</p>
1209
+ </div>
1210
+ <div class="ulist">
1211
+ <ul>
1212
+ <li>
1213
+ <p><code>struct</code> <code>rev_info</code> <code>*revs</code>: This is the <code>rev_info</code> used for the walk. If
1214
+ its <code>filter</code> member is not <code>NULL</code>, then <code>filter</code> contains information for
1215
+ how to filter the object list.</p>
1216
+ </li>
1217
+ <li>
1218
+ <p><code>show_commit_fn</code> <code>show_commit</code>: A callback which will be used to handle each
1219
+ individual commit object.</p>
1220
+ </li>
1221
+ <li>
1222
+ <p><code>show_object_fn</code> <code>show_object</code>: A callback which will be used to handle each
1223
+ non-commit object (so each blob, tree, or tag).</p>
1224
+ </li>
1225
+ <li>
1226
+ <p><code>void</code> <code>*show_data</code>: A context buffer which is passed in turn to <code>show_commit</code>
1227
+ and <code>show_object</code>.</p>
1228
+ </li>
1229
+ </ul>
1230
+ </div>
1231
+ <div class="paragraph">
1232
+ <p>In addition, <code>traverse_commit_list_filtered</code>() has an additional parameter:</p>
1233
+ </div>
1234
+ <div class="ulist">
1235
+ <ul>
1236
+ <li>
1237
+ <p><code>struct</code> <code>oidset</code> <code>*omitted</code>: A linked-list of object IDs which the provided
1238
+ filter caused to be omitted.</p>
1239
+ </li>
1240
+ </ul>
1241
+ </div>
1242
+ <div class="paragraph">
1243
+ <p>It looks like these methods use callbacks we provide instead of needing us
1244
+ to call it repeatedly ourselves. Cool! Let&#8217;s add the callbacks first.</p>
1245
+ </div>
1246
+ <div class="paragraph">
1247
+ <p>For the sake of this tutorial, we&#8217;ll simply keep track of how many of each kind
1248
+ of object we find. At file scope in <code>builtin/walken.c</code> add the following
1249
+ tracking variables:</p>
1250
+ </div>
1251
+ <div class="listingblock">
1252
+ <div class="content">
1253
+ <pre>static int commit_count;
1254
+ static int tag_count;
1255
+ static int blob_count;
1256
+ static int tree_count;</pre>
1257
+ </div>
1258
+ </div>
1259
+ <div class="paragraph">
1260
+ <p>Commits are handled by a different callback than other objects; let&#8217;s do that
1261
+ one first:</p>
1262
+ </div>
1263
+ <div class="listingblock">
1264
+ <div class="content">
1265
+ <pre>static void walken_show_commit(struct commit *cmt, void *buf)
1266
+ {
1267
+ commit_count++;
1268
+ }</pre>
1269
+ </div>
1270
+ </div>
1271
+ <div class="paragraph">
1272
+ <p>The <code>cmt</code> argument is fairly self-explanatory. But it&#8217;s worth mentioning that
1273
+ the <code>buf</code> argument is actually the context buffer that we can provide to the
1274
+ traversal calls - <code>show_data</code>, which we mentioned a moment ago.</p>
1275
+ </div>
1276
+ <div class="paragraph">
1277
+ <p>Since we have the <code>struct</code> <code>commit</code> object, we can look at all the same parts that
1278
+ we looked at in our earlier commit-only walk. For the sake of this tutorial,
1279
+ though, we&#8217;ll just increment the commit counter and move on.</p>
1280
+ </div>
1281
+ <div class="paragraph">
1282
+ <p>The callback for non-commits is a little different, as we&#8217;ll need to check
1283
+ which kind of object we&#8217;re dealing with:</p>
1284
+ </div>
1285
+ <div class="listingblock">
1286
+ <div class="content">
1287
+ <pre>static void walken_show_object(struct object *obj, const char *str, void *buf)
1288
+ {
1289
+ switch (obj-&gt;type) {
1290
+ case OBJ_TREE:
1291
+ tree_count++;
1292
+ break;
1293
+ case OBJ_BLOB:
1294
+ blob_count++;
1295
+ break;
1296
+ case OBJ_TAG:
1297
+ tag_count++;
1298
+ break;
1299
+ case OBJ_COMMIT:
1300
+ BUG("unexpected commit object in walken_show_object\n");
1301
+ default:
1302
+ BUG("unexpected object type %s in walken_show_object\n",
1303
+ type_name(obj-&gt;type));
1304
+ }
1305
+ }</pre>
1306
+ </div>
1307
+ </div>
1308
+ <div class="paragraph">
1309
+ <p>Again, <code>obj</code> is fairly self-explanatory, and we can guess that <code>buf</code> is the same
1310
+ context pointer that <code>walken_show_commit</code>() receives: the <code>show_data</code> argument
1311
+ to <code>traverse_commit_list</code>() and <code>traverse_commit_list_filtered</code>(). Finally,
1312
+ <code>str</code> contains the name of the object, which ends up being something like
1313
+ <code>foo.txt</code> (blob), <code>bar/baz</code> (tree), or <code>v1.2.3</code> (tag).</p>
1314
+ </div>
1315
+ <div class="paragraph">
1316
+ <p>To help assure us that we aren&#8217;t double-counting commits, we&#8217;ll include some
1317
+ complaining if a commit object is routed through our non-commit callback; we&#8217;ll
1318
+ also complain if we see an invalid object type. Since those two cases should be
1319
+ unreachable, and would only change in the event of a semantic change to the Git
1320
+ codebase, we complain by using <code>BUG</code>() - which is a signal to a developer that
1321
+ the change they made caused unintended consequences, and the rest of the
1322
+ codebase needs to be updated to understand that change. <code>BUG</code>() is not intended
1323
+ to be seen by the public, so it is not localized.</p>
1324
+ </div>
1325
+ <div class="paragraph">
1326
+ <p>Our main object walk implementation is substantially different from our commit
1327
+ walk implementation, so let&#8217;s make a new function to perform the object walk. We
1328
+ can perform setup which is applicable to all objects here, too, to keep separate
1329
+ from setup which is applicable to commit-only walks.</p>
1330
+ </div>
1331
+ <div class="paragraph">
1332
+ <p>We&#8217;ll start by enabling all types of objects in the <code>struct</code> <code>rev_info</code>. We&#8217;ll
1333
+ also turn on <code>tree_blobs_in_commit_order</code>, which means that we will walk a
1334
+ commit&#8217;s tree and everything it points to immediately after we find each commit,
1335
+ as opposed to waiting for the end and walking through all trees after the commit
1336
+ history has been discovered. With the appropriate settings configured, we are
1337
+ ready to call <code>prepare_revision_walk</code>().</p>
1338
+ </div>
1339
+ <div class="listingblock">
1340
+ <div class="content">
1341
+ <pre>static void walken_object_walk(struct rev_info *rev)
1342
+ {
1343
+ rev-&gt;tree_objects = 1;
1344
+ rev-&gt;blob_objects = 1;
1345
+ rev-&gt;tag_objects = 1;
1346
+ rev-&gt;tree_blobs_in_commit_order = 1;
1347
+
1348
+ if (prepare_revision_walk(rev))
1349
+ die(_("revision walk setup failed"));
1350
+
1351
+ commit_count = 0;
1352
+ tag_count = 0;
1353
+ blob_count = 0;
1354
+ tree_count = 0;</pre>
1355
+ </div>
1356
+ </div>
1357
+ <div class="paragraph">
1358
+ <p>Let&#8217;s start by calling just the unfiltered walk and reporting our counts.
1359
+ Complete your implementation of <code>walken_object_walk</code>().
1360
+ We&#8217;ll also need to include the <code>list-objects.h</code> header.</p>
1361
+ </div>
1362
+ <div class="listingblock">
1363
+ <div class="content">
1364
+ <pre>#include "list-objects.h"
1365
+
1366
+ ...
1367
+
1368
+ traverse_commit_list(rev, walken_show_commit, walken_show_object, NULL);
1369
+
1370
+ printf("commits %d\nblobs %d\ntags %d\ntrees %d\n", commit_count,
1371
+ blob_count, tag_count, tree_count);
1372
+ }</pre>
1373
+ </div>
1374
+ </div>
1375
+ <div class="admonitionblock note">
1376
+ <table>
1377
+ <tr>
1378
+ <td class="icon">
1379
+ <div class="title">Note</div>
1380
+ </td>
1381
+ <td class="content">
1382
+ This output is intended to be machine-parsed. Therefore, we are not
1383
+ sending it to <code>trace_printf</code>(), and we are not localizing it - we need scripts
1384
+ to be able to count on the formatting to be exactly the way it is shown here.
1385
+ If we were intending this output to be read by humans, we would need to localize
1386
+ it with <code>_</code>().
1387
+ </td>
1388
+ </tr>
1389
+ </table>
1390
+ </div>
1391
+ <div class="paragraph">
1392
+ <p>Finally, we&#8217;ll ask <code>cmd_walken</code>() to use the object walk instead. Discussing
1393
+ command line options is out of scope for this tutorial, so we&#8217;ll just hardcode
1394
+ a branch we can change at compile time. Where you call <code>final_rev_info_setup</code>()
1395
+ and <code>walken_commit_walk</code>(), instead branch like so:</p>
1396
+ </div>
1397
+ <div class="listingblock">
1398
+ <div class="content">
1399
+ <pre> if (1) {
1400
+ add_head_to_pending(&amp;rev);
1401
+ walken_object_walk(&amp;rev);
1402
+ } else {
1403
+ final_rev_info_setup(argc, argv, prefix, &amp;rev);
1404
+ walken_commit_walk(&amp;rev);
1405
+ }</pre>
1406
+ </div>
1407
+ </div>
1408
+ <div class="admonitionblock note">
1409
+ <table>
1410
+ <tr>
1411
+ <td class="icon">
1412
+ <div class="title">Note</div>
1413
+ </td>
1414
+ <td class="content">
1415
+ For simplicity, we&#8217;ve avoided all the filters and sorts we applied in
1416
+ <code>final_rev_info_setup</code>() and simply added <code>HEAD</code> to our pending queue. If you
1417
+ want, you can certainly use the filters we added before by moving
1418
+ <code>final_rev_info_setup</code>() out of the conditional and removing the call to
1419
+ <code>add_head_to_pending</code>().
1420
+ </td>
1421
+ </tr>
1422
+ </table>
1423
+ </div>
1424
+ <div class="paragraph">
1425
+ <p>Now we can try to run our command! It should take noticeably longer than the
1426
+ commit walk, but an examination of the output will give you an idea why. Your
1427
+ output should look similar to this example, but with different counts:</p>
1428
+ </div>
1429
+ <div class="listingblock">
1430
+ <div class="content">
1431
+ <pre>Object walk completed. Found 55733 commits, 100274 blobs, 0 tags, and 104210 trees.</pre>
1432
+ </div>
1433
+ </div>
1434
+ <div class="paragraph">
1435
+ <p>This makes sense. We have more trees than commits because the Git project has
1436
+ lots of subdirectories which can change, plus at least one tree per commit. We
1437
+ have no tags because we started on a commit (<code>HEAD</code>) and while tags can point to
1438
+ commits, commits can&#8217;t point to tags.</p>
1439
+ </div>
1440
+ <div class="admonitionblock note">
1441
+ <table>
1442
+ <tr>
1443
+ <td class="icon">
1444
+ <div class="title">Note</div>
1445
+ </td>
1446
+ <td class="content">
1447
+ You will have different counts when you run this yourself! The number of
1448
+ objects grows along with the Git project.
1449
+ </td>
1450
+ </tr>
1451
+ </table>
1452
+ </div>
1453
+ <div class="sect2">
1454
+ <h3 id="_adding_a_filter_2">Adding a Filter</h3>
1455
+ <div class="paragraph">
1456
+ <p>There are a handful of filters that we can apply to the object walk laid out in
1457
+ <code>Documentation/rev-list-options.adoc</code>. These filters are typically useful for
1458
+ operations such as creating packfiles or performing a partial clone. They are
1459
+ defined in <code>list-objects-filter-options.h</code>. For the purposes of this tutorial we
1460
+ will use the "tree:1" filter, which causes the walk to omit all trees and blobs
1461
+ which are not directly referenced by commits reachable from the commit in
1462
+ <code>pending</code> when the walk begins. (<code>pending</code> is the list of objects which need to
1463
+ be traversed during a walk; you can imagine a breadth-first tree traversal to
1464
+ help understand. In our case, that means we omit trees and blobs not directly
1465
+ referenced by <code>HEAD</code> or <code>HEAD</code>'s history, because we begin the walk with only
1466
+ <code>HEAD</code> in the <code>pending</code> list.)</p>
1467
+ </div>
1468
+ <div class="paragraph">
1469
+ <p>For now, we are not going to track the omitted objects, so we&#8217;ll replace those
1470
+ parameters with <code>NULL</code>. For the sake of simplicity, we&#8217;ll add a simple
1471
+ build-time branch to use our filter or not. Preface the line calling
1472
+ <code>traverse_commit_list</code>() with the following, which will remind us which kind of
1473
+ walk we&#8217;ve just performed:</p>
1474
+ </div>
1475
+ <div class="listingblock">
1476
+ <div class="content">
1477
+ <pre> if (0) {
1478
+ /* Unfiltered: */
1479
+ trace_printf(_("Unfiltered object walk.\n"));
1480
+ } else {
1481
+ trace_printf(
1482
+ _("Filtered object walk with filterspec 'tree:1'.\n"));
1483
+
1484
+ parse_list_objects_filter(&amp;rev-&gt;filter, "tree:1");
1485
+ }
1486
+ traverse_commit_list(rev, walken_show_commit,
1487
+ walken_show_object, NULL);</pre>
1488
+ </div>
1489
+ </div>
1490
+ <div class="paragraph">
1491
+ <p>The <code>rev-</code>&gt;<code>filter</code> member is usually built directly from a command
1492
+ line argument, so the module provides an easy way to build one from a string.
1493
+ Even though we aren&#8217;t taking user input right now, we can still build one with
1494
+ a hardcoded string using <code>parse_list_objects_filter</code>().</p>
1495
+ </div>
1496
+ <div class="paragraph">
1497
+ <p>With the filter spec "tree:1", we are expecting to see <em>only</em> the root tree for
1498
+ each commit; therefore, the tree object count should be less than or equal to
1499
+ the number of commits. (For an example of why that&#8217;s true: <code>git</code> <code>commit</code> <code>--revert</code>
1500
+ points to the same tree object as its grandparent.)</p>
1501
+ </div>
1502
+ </div>
1503
+ <div class="sect2">
1504
+ <h3 id="_counting_omitted_objects">Counting Omitted Objects</h3>
1505
+ <div class="paragraph">
1506
+ <p>We also have the capability to enumerate all objects which were omitted by a
1507
+ filter, like with <code>git</code> <code>log</code> <code>--filter=</code><em>&lt;spec&gt;</em> <code>--filter-print-omitted</code>. To do this,
1508
+ change <code>traverse_commit_list</code>() to <code>traverse_commit_list_filtered</code>(), which is
1509
+ able to populate an <code>omitted</code> list. Asking for this list of filtered objects
1510
+ may cause performance degradations, however, because in this case, despite
1511
+ filtering objects, the possibly much larger set of all reachable objects must
1512
+ be processed in order to populate that list.</p>
1513
+ </div>
1514
+ <div class="paragraph">
1515
+ <p>First, add the <code>struct</code> <code>oidset</code> and related items we will use to iterate it:</p>
1516
+ </div>
1517
+ <div class="listingblock">
1518
+ <div class="content">
1519
+ <pre>#include "oidset.h"
1520
+
1521
+ ...
1522
+
1523
+ static void walken_object_walk(
1524
+ ...
1525
+
1526
+ struct oidset omitted;
1527
+ struct oidset_iter oit;
1528
+ struct object_id *oid = NULL;
1529
+ int omitted_count = 0;
1530
+ oidset_init(&amp;omitted, 0);
1531
+
1532
+ ...</pre>
1533
+ </div>
1534
+ </div>
1535
+ <div class="paragraph">
1536
+ <p>Replace the call to <code>traverse_commit_list</code>() with
1537
+ <code>traverse_commit_list_filtered</code>() and pass a pointer to the <code>omitted</code> oidset
1538
+ defined and initialized above:</p>
1539
+ </div>
1540
+ <div class="listingblock">
1541
+ <div class="content">
1542
+ <pre> ...
1543
+
1544
+ traverse_commit_list_filtered(rev,
1545
+ walken_show_commit, walken_show_object, NULL, &amp;omitted);
1546
+
1547
+ ...</pre>
1548
+ </div>
1549
+ </div>
1550
+ <div class="paragraph">
1551
+ <p>Then, after your traversal, the <code>oidset</code> traversal is pretty straightforward.
1552
+ Count all the objects within and modify the print statement:</p>
1553
+ </div>
1554
+ <div class="listingblock">
1555
+ <div class="content">
1556
+ <pre> /* Count the omitted objects. */
1557
+ oidset_iter_init(&amp;omitted, &amp;oit);
1558
+
1559
+ while ((oid = oidset_iter_next(&amp;oit)))
1560
+ omitted_count++;
1561
+
1562
+ printf("commits %d\nblobs %d\ntags %d\ntrees %d\nomitted %d\n",
1563
+ commit_count, blob_count, tag_count, tree_count, omitted_count);</pre>
1564
+ </div>
1565
+ </div>
1566
+ <div class="paragraph">
1567
+ <p>By running your walk with and without the filter, you should find that the total
1568
+ object count in each case is identical. You can also time each invocation of
1569
+ the <code>walken</code> subcommand, with and without <code>omitted</code> being passed in, to confirm
1570
+ to yourself the runtime impact of tracking all omitted objects.</p>
1571
+ </div>
1572
+ </div>
1573
+ <div class="sect2">
1574
+ <h3 id="_changing_the_order_2">Changing the Order</h3>
1575
+ <div class="paragraph">
1576
+ <p>Finally, let&#8217;s demonstrate that you can also reorder walks of all objects, not
1577
+ just walks of commits. First, we&#8217;ll make our handlers chattier - modify
1578
+ <code>walken_show_commit</code>() and <code>walken_show_object</code>() to print the object as they
1579
+ go:</p>
1580
+ </div>
1581
+ <div class="listingblock">
1582
+ <div class="content">
1583
+ <pre>#include "hex.h"
1584
+
1585
+ ...
1586
+
1587
+ static void walken_show_commit(struct commit *cmt, void *buf)
1588
+ {
1589
+ trace_printf("commit: %s\n", oid_to_hex(&amp;cmt-&gt;object.oid));
1590
+ commit_count++;
1591
+ }
1592
+
1593
+ static void walken_show_object(struct object *obj, const char *str, void *buf)
1594
+ {
1595
+ trace_printf("%s: %s\n", type_name(obj-&gt;type), oid_to_hex(&amp;obj-&gt;oid));
1596
+
1597
+ ...
1598
+ }</pre>
1599
+ </div>
1600
+ </div>
1601
+ <div class="admonitionblock note">
1602
+ <table>
1603
+ <tr>
1604
+ <td class="icon">
1605
+ <div class="title">Note</div>
1606
+ </td>
1607
+ <td class="content">
1608
+ Since we will be examining this output directly as humans, we&#8217;ll use
1609
+ <code>trace_printf</code>() here. Additionally, since this change introduces a significant
1610
+ number of printed lines, using <code>trace_printf</code>() will allow us to easily silence
1611
+ those lines without having to recompile.
1612
+ </td>
1613
+ </tr>
1614
+ </table>
1615
+ </div>
1616
+ <div class="paragraph">
1617
+ <p>(Leave the counter increment logic in place.)</p>
1618
+ </div>
1619
+ <div class="paragraph">
1620
+ <p>With only that change, run again (but save yourself some scrollback):</p>
1621
+ </div>
1622
+ <div class="listingblock">
1623
+ <div class="content">
1624
+ <pre>$ GIT_TRACE=1 ./bin-wrappers/git walken 2&gt;&amp;1 | head -n 10</pre>
1625
+ </div>
1626
+ </div>
1627
+ <div class="paragraph">
1628
+ <p>Take a look at the top commit with <code>git</code> <code>show</code> and the object ID you printed; it
1629
+ should be the same as the output of <code>git</code> <code>show</code> <code>HEAD</code>.</p>
1630
+ </div>
1631
+ <div class="paragraph">
1632
+ <p>Next, let&#8217;s change a setting on our <code>struct</code> <code>rev_info</code> within
1633
+ <code>walken_object_walk</code>(). Find where you&#8217;re changing the other settings on <code>rev</code>,
1634
+ such as <code>rev-</code>&gt;<code>tree_objects</code> and <code>rev-</code>&gt;<code>tree_blobs_in_commit_order</code>, and add the
1635
+ <code>reverse</code> setting at the bottom:</p>
1636
+ </div>
1637
+ <div class="listingblock">
1638
+ <div class="content">
1639
+ <pre> ...
1640
+
1641
+ rev-&gt;tree_objects = 1;
1642
+ rev-&gt;blob_objects = 1;
1643
+ rev-&gt;tag_objects = 1;
1644
+ rev-&gt;tree_blobs_in_commit_order = 1;
1645
+ rev-&gt;reverse = 1;
1646
+
1647
+ ...</pre>
1648
+ </div>
1649
+ </div>
1650
+ <div class="paragraph">
1651
+ <p>Now, run again, but this time, let&#8217;s grab the last handful of objects instead
1652
+ of the first handful:</p>
1653
+ </div>
1654
+ <div class="listingblock">
1655
+ <div class="content">
1656
+ <pre>$ make
1657
+ $ GIT_TRACE=1 ./bin-wrappers/git walken 2&gt;&amp;1 | tail -n 10</pre>
1658
+ </div>
1659
+ </div>
1660
+ <div class="paragraph">
1661
+ <p>The last commit object given should have the same OID as the one we saw at the
1662
+ top before, and running <code>git</code> <code>show</code> <em>&lt;oid&gt;</em> with that OID should give you again
1663
+ the same results as <code>git</code> <code>show</code> <code>HEAD</code>. Furthermore, if you run and examine the
1664
+ first ten lines again (with <code>head</code> instead of <code>tail</code> like we did before applying
1665
+ the <code>reverse</code> setting), you should see that now the first commit printed is the
1666
+ initial commit, <code>e83c5163</code>.</p>
1667
+ </div>
1668
+ </div>
1669
+ </div>
1670
+ </div>
1671
+ <div class="sect1">
1672
+ <h2 id="_wrapping_up">Wrapping Up</h2>
1673
+ <div class="sectionbody">
1674
+ <div class="paragraph">
1675
+ <p>Let&#8217;s review. In this tutorial, we:</p>
1676
+ </div>
1677
+ <div class="ulist">
1678
+ <ul>
1679
+ <li>
1680
+ <p>Built a commit walk from the ground up</p>
1681
+ </li>
1682
+ <li>
1683
+ <p>Enabled a grep filter for that commit walk</p>
1684
+ </li>
1685
+ <li>
1686
+ <p>Changed the sort order of that filtered commit walk</p>
1687
+ </li>
1688
+ <li>
1689
+ <p>Built an object walk (tags, commits, trees, and blobs) from the ground up</p>
1690
+ </li>
1691
+ <li>
1692
+ <p>Learned how to add a filter-spec to an object walk</p>
1693
+ </li>
1694
+ <li>
1695
+ <p>Changed the display order of the filtered object walk</p>
1696
+ </li>
1697
+ </ul>
1698
+ </div>
1699
+ </div>
1700
+ </div>
1701
+ </div>
1702
+ <div id="footer">
1703
+ <div id="footer-text">
1704
+ Last updated 2026-04-20 17:51:23 UTC
1705
+ </div>
1706
+ </div>
1707
+ </body>
1708
+ </html>
git/mingw64/share/doc/git-doc/RelNotes/1.5.0.1.adoc ADDED
@@ -0,0 +1,42 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.0.1 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.0
5
+ ------------------
6
+
7
+ * Documentation updates
8
+
9
+ - Clarifications and corrections to 1.5.0 release notes.
10
+
11
+ - The main documentation did not link to git-remote documentation.
12
+
13
+ - Clarified introductory text of git-rebase documentation.
14
+
15
+ - Converted remaining mentions of update-index on Porcelain
16
+ documents to git-add/git-rm.
17
+
18
+ - Some i18n.* configuration variables were incorrectly
19
+ described as core.*; fixed.
20
+
21
+ * Bugfixes
22
+
23
+ - git-add and git-update-index on a filesystem on which
24
+ executable bits are unreliable incorrectly reused st_mode
25
+ bits even when the path changed between symlink and regular
26
+ file.
27
+
28
+ - git-daemon marks the listening sockets with FD_CLOEXEC so
29
+ that it won't be leaked into the children.
30
+
31
+ - segfault from git-blame when the mandatory pathname
32
+ parameter was missing was fixed; usage() message is given
33
+ instead.
34
+
35
+ - git-rev-list did not read $GIT_DIR/config file, which means
36
+ that did not honor i18n.logoutputencoding correctly.
37
+
38
+ * Tweaks
39
+
40
+ - sliding mmap() inefficiently mmaped the same region of a
41
+ packfile with an access pattern that used objects in the
42
+ reverse order. This has been made more efficient.
git/mingw64/share/doc/git-doc/RelNotes/1.5.0.2.adoc ADDED
@@ -0,0 +1,65 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.0.2 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.0.1
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - Automated merge conflict handling when changes to symbolic
10
+ links conflicted were completely broken. The merge-resolve
11
+ strategy created a regular file with conflict markers in it
12
+ in place of the symbolic link. The default strategy,
13
+ merge-recursive was even more broken. It removed the path
14
+ that was pointed at by the symbolic link. Both of these
15
+ problems have been fixed.
16
+
17
+ - 'git diff maint master next' did not correctly give combined
18
+ diff across three trees.
19
+
20
+ - 'git fast-import' portability fix for Solaris.
21
+
22
+ - 'git show-ref --verify' without arguments did not error out
23
+ but segfaulted.
24
+
25
+ - 'git diff :tracked-file `pwd`/an-untracked-file' gave an extra
26
+ slashes after a/ and b/.
27
+
28
+ - 'git format-patch' produced too long filenames if the commit
29
+ message had too long line at the beginning.
30
+
31
+ - Running 'make all' and then without changing anything
32
+ running 'make install' still rebuilt some files. This
33
+ was inconvenient when building as yourself and then
34
+ installing as root (especially problematic when the source
35
+ directory is on NFS and root is mapped to nobody).
36
+
37
+ - 'git-rerere' failed to deal with two unconflicted paths that
38
+ sorted next to each other.
39
+
40
+ - 'git-rerere' attempted to open(2) a symlink and failed if
41
+ there was a conflict. Since a conflicting change to a
42
+ symlink would not benefit from rerere anyway, the command
43
+ now ignores conflicting changes to symlinks.
44
+
45
+ - 'git-repack' did not like to pass more than 64 arguments
46
+ internally to underlying 'rev-list' logic, which made it
47
+ impossible to repack after accumulating many (small) packs
48
+ in the repository.
49
+
50
+ - 'git-diff' to review the combined diff during a conflicted
51
+ merge were not reading the working tree version correctly
52
+ when changes to a symbolic link conflicted. It should have
53
+ read the data using readlink(2) but read from the regular
54
+ file the symbolic link pointed at.
55
+
56
+ - 'git-remote' did not like period in a remote's name.
57
+
58
+ * Documentation updates
59
+
60
+ - added and clarified core.bare, core.legacyheaders configurations.
61
+
62
+ - updated "git-clone --depth" documentation.
63
+
64
+
65
+ * Assorted git-gui fixes.
git/mingw64/share/doc/git-doc/RelNotes/1.5.0.3.adoc ADDED
@@ -0,0 +1,58 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.0.3 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.0.2
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - 'git.el' honors the commit coding system from the configuration.
10
+
11
+ - 'blameview' in contrib/ correctly digs deeper when a line is
12
+ clicked.
13
+
14
+ - 'http-push' correctly makes sure the remote side has leading
15
+ path. Earlier it started in the middle of the path, and
16
+ incorrectly.
17
+
18
+ - 'git-merge' did not exit with non-zero status when the
19
+ working tree was dirty and cannot fast forward. It does
20
+ now.
21
+
22
+ - 'cvsexportcommit' does not lose yet-to-be-used message file.
23
+
24
+ - int-vs-size_t typefix when running combined diff on files
25
+ over 2GB long.
26
+
27
+ - 'git apply --whitespace=strip' should not touch unmodified
28
+ lines.
29
+
30
+ - 'git-mailinfo' choke when a logical header line was too long.
31
+
32
+ - 'git show A..B' did not error out. Negative ref ("not A" in
33
+ this example) does not make sense for the purpose of the
34
+ command, so now it errors out.
35
+
36
+ - 'git fmt-merge-msg --file' without file parameter did not
37
+ correctly error out.
38
+
39
+ - 'git archimport' barfed upon encountering a commit without
40
+ summary.
41
+
42
+ - 'git index-pack' did not protect itself from getting a short
43
+ read out of pread(2).
44
+
45
+ - 'git http-push' had a few buffer overruns.
46
+
47
+ - Build dependency fixes to rebuild fetch.o when other headers
48
+ change.
49
+
50
+ * Documentation updates
51
+
52
+ - user-manual updates.
53
+
54
+ - Options to 'git remote add' were described insufficiently.
55
+
56
+ - Configuration format.suffix was not documented.
57
+
58
+ - Other formatting and spelling fixes.
git/mingw64/share/doc/git-doc/RelNotes/1.5.0.4.adoc ADDED
@@ -0,0 +1,22 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.0.4 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.0.3
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - git.el does not add duplicate sign-off lines.
10
+
11
+ - git-commit shows the full stat of the resulting commit, not
12
+ just about the files in the current directory, when run from
13
+ a subdirectory.
14
+
15
+ - "git-checkout -m '@{8 hours ago}'" had a funny failure from
16
+ eval; fixed.
17
+
18
+ - git-gui updates.
19
+
20
+ * Documentation updates
21
+
22
+ * User manual updates
git/mingw64/share/doc/git-doc/RelNotes/1.5.0.5.adoc ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.0.5 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.0.3
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - git-merge (hence git-pull) did not refuse fast-forwarding
10
+ when the working tree had local changes that would have
11
+ conflicted with it.
12
+
13
+ - git.el does not add duplicate sign-off lines.
14
+
15
+ - git-commit shows the full stat of the resulting commit, not
16
+ just about the files in the current directory, when run from
17
+ a subdirectory.
18
+
19
+ - "git-checkout -m '@{8 hours ago}'" had a funny failure from
20
+ eval; fixed.
21
+
22
+ - git-gui updates.
23
+
24
+ * Documentation updates
25
+
26
+ * User manual updates
git/mingw64/share/doc/git-doc/RelNotes/1.5.0.6.adoc ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.0.6 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.0.5
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - a handful small fixes to gitweb.
10
+
11
+ - build procedure for user-manual is fixed not to require locally
12
+ installed stylesheets.
13
+
14
+ - "git commit $paths" on paths whose earlier contents were
15
+ already updated in the index were failing out.
16
+
17
+ * Documentation
18
+
19
+ - user-manual has better cross references.
20
+
21
+ - gitweb installation/deployment procedure is now documented.
git/mingw64/share/doc/git-doc/RelNotes/1.5.0.7.adoc ADDED
@@ -0,0 +1,18 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.0.7 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.0.6
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - git-upload-pack failed to close unused pipe ends, resulting
10
+ in many zombies to hang around.
11
+
12
+ - git-rerere was recording the contents of earlier hunks
13
+ duplicated in later hunks. This prevented resolving the same
14
+ conflict when performing the same merge the other way around.
15
+
16
+ * Documentation
17
+
18
+ - a few documentation fixes from Debian package maintainer.
git/mingw64/share/doc/git-doc/RelNotes/1.5.0.adoc ADDED
@@ -0,0 +1,469 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.0 Release Notes
2
+ ========================
3
+
4
+ Old news
5
+ --------
6
+
7
+ This section is for people who are upgrading from ancient
8
+ versions of git. Although all of the changes in this section
9
+ happened before the current v1.4.4 release, they are summarized
10
+ here in the v1.5.0 release notes for people who skipped earlier
11
+ versions.
12
+
13
+ As of git v1.5.0 there are some optional features that changes
14
+ the repository to allow data to be stored and transferred more
15
+ efficiently. These features are not enabled by default, as they
16
+ will make the repository unusable with older versions of git.
17
+ Specifically, the available options are:
18
+
19
+ - There is a configuration variable core.legacyheaders that
20
+ changes the format of loose objects so that they are more
21
+ efficient to pack and to send out of the repository over git
22
+ native protocol, since v1.4.2. However, loose objects
23
+ written in the new format cannot be read by git older than
24
+ that version; people fetching from your repository using
25
+ older clients over dumb transports (e.g. http) using older
26
+ versions of git will also be affected.
27
+
28
+ To let git use the new loose object format, you have to
29
+ set core.legacyheaders to false.
30
+
31
+ - Since v1.4.3, configuration repack.usedeltabaseoffset allows
32
+ packfile to be created in more space efficient format, which
33
+ cannot be read by git older than that version.
34
+
35
+ To let git use the new format for packfiles, you have to
36
+ set repack.usedeltabaseoffset to true.
37
+
38
+ The above two new features are not enabled by default and you
39
+ have to explicitly ask for them, because they make repositories
40
+ unreadable by older versions of git, and in v1.5.0 we still do
41
+ not enable them by default for the same reason. We will change
42
+ this default probably 1 year after 1.4.2's release, when it is
43
+ reasonable to expect everybody to have new enough version of
44
+ git.
45
+
46
+ - 'git pack-refs' appeared in v1.4.4; this command allows tags
47
+ to be accessed much more efficiently than the traditional
48
+ 'one-file-per-tag' format. Older git-native clients can
49
+ still fetch from a repository that packed and pruned refs
50
+ (the server side needs to run the up-to-date version of git),
51
+ but older dumb transports cannot. Packing of refs is done by
52
+ an explicit user action, either by use of "git pack-refs
53
+ --prune" command or by use of "git gc" command.
54
+
55
+ - 'git -p' to paginate anything -- many commands do pagination
56
+ by default on a tty. Introduced between v1.4.1 and v1.4.2;
57
+ this may surprise old timers.
58
+
59
+ - 'git archive' superseded 'git tar-tree' in v1.4.3;
60
+
61
+ - 'git cvsserver' was new invention in v1.3.0;
62
+
63
+ - 'git repo-config', 'git grep', 'git rebase' and 'gitk' were
64
+ seriously enhanced during v1.4.0 timeperiod.
65
+
66
+ - 'gitweb' became part of git.git during v1.4.0 timeperiod and
67
+ seriously modified since then.
68
+
69
+ - reflog is an v1.4.0 invention. This allows you to name a
70
+ revision that a branch used to be at (e.g. "git diff
71
+ master@{yesterday} master" allows you to see changes since
72
+ yesterday's tip of the branch).
73
+
74
+
75
+ Updates in v1.5.0 since v1.4.4 series
76
+ -------------------------------------
77
+
78
+ * Index manipulation
79
+
80
+ - git-add is to add contents to the index (aka "staging area"
81
+ for the next commit), whether the file the contents happen to
82
+ be is an existing one or a newly created one.
83
+
84
+ - git-add without any argument does not add everything
85
+ anymore. Use 'git-add .' instead. Also you can add
86
+ otherwise ignored files with an -f option.
87
+
88
+ - git-add tries to be more friendly to users by offering an
89
+ interactive mode ("git-add -i").
90
+
91
+ - git-commit <path> used to refuse to commit if <path> was
92
+ different between HEAD and the index (i.e. update-index was
93
+ used on it earlier). This check was removed.
94
+
95
+ - git-rm is much saner and safer. It is used to remove paths
96
+ from both the index file and the working tree, and makes sure
97
+ you are not losing any local modification before doing so.
98
+
99
+ - git-reset <tree> <paths>... can be used to revert index
100
+ entries for selected paths.
101
+
102
+ - git-update-index is much less visible. Many suggestions to
103
+ use the command in git output and documentation have now been
104
+ replaced by simpler commands such as "git add" or "git rm".
105
+
106
+
107
+ * Repository layout and objects transfer
108
+
109
+ - The data for origin repository is stored in the configuration
110
+ file $GIT_DIR/config, not in $GIT_DIR/remotes/, for newly
111
+ created clones. The latter is still supported and there is
112
+ no need to convert your existing repository if you are
113
+ already comfortable with your workflow with the layout.
114
+
115
+ - git-clone always uses what is known as "separate remote"
116
+ layout for a newly created repository with a working tree.
117
+
118
+ A repository with the separate remote layout starts with only
119
+ one default branch, 'master', to be used for your own
120
+ development. Unlike the traditional layout that copied all
121
+ the upstream branches into your branch namespace (while
122
+ renaming their 'master' to your 'origin'), the new layout
123
+ puts upstream branches into local "remote-tracking branches"
124
+ with their own namespace. These can be referenced with names
125
+ such as "origin/$upstream_branch_name" and are stored in
126
+ .git/refs/remotes rather than .git/refs/heads where normal
127
+ branches are stored.
128
+
129
+ This layout keeps your own branch namespace less cluttered,
130
+ avoids name collision with your upstream, makes it possible
131
+ to automatically track new branches created at the remote
132
+ after you clone from it, and makes it easier to interact with
133
+ more than one remote repository (you can use "git remote" to
134
+ add other repositories to track). There might be some
135
+ surprises:
136
+
137
+ * 'git branch' does not show the remote tracking branches.
138
+ It only lists your own branches. Use '-r' option to view
139
+ the tracking branches.
140
+
141
+ * If you are forking off of a branch obtained from the
142
+ upstream, you would have done something like 'git branch
143
+ my-next next', because traditional layout dropped the
144
+ tracking branch 'next' into your own branch namespace.
145
+ With the separate remote layout, you say 'git branch next
146
+ origin/next', which allows you to use the matching name
147
+ 'next' for your own branch. It also allows you to track a
148
+ remote other than 'origin' (i.e. where you initially cloned
149
+ from) and fork off of a branch from there the same way
150
+ (e.g. "git branch mingw j6t/master").
151
+
152
+ Repositories initialized with the traditional layout continue
153
+ to work.
154
+
155
+ - New branches that appear on the origin side after a clone is
156
+ made are also tracked automatically. This is done with an
157
+ wildcard refspec "refs/heads/*:refs/remotes/origin/*", which
158
+ older git does not understand, so if you clone with 1.5.0,
159
+ you would need to downgrade remote.*.fetch in the
160
+ configuration file to specify each branch you are interested
161
+ in individually if you plan to fetch into the repository with
162
+ older versions of git (but why would you?).
163
+
164
+ - Similarly, wildcard refspec "refs/heads/*:refs/remotes/me/*"
165
+ can be given to "git-push" command to update the tracking
166
+ branches that is used to track the repository you are pushing
167
+ from on the remote side.
168
+
169
+ - git-branch and git-show-branch know remote tracking branches
170
+ (use the command line switch "-r" to list only tracked branches).
171
+
172
+ - git-push can now be used to delete a remote branch or a tag.
173
+ This requires the updated git on the remote side (use "git
174
+ push <remote> :refs/heads/<branch>" to delete "branch").
175
+
176
+ - git-push more aggressively keeps the transferred objects
177
+ packed. Earlier we recommended to monitor amount of loose
178
+ objects and repack regularly, but you should repack when you
179
+ accumulated too many small packs this way as well. Updated
180
+ git-count-objects helps you with this.
181
+
182
+ - git-fetch also more aggressively keeps the transferred objects
183
+ packed. This behavior of git-push and git-fetch can be
184
+ tweaked with a single configuration transfer.unpacklimit (but
185
+ usually there should not be any need for a user to tweak it).
186
+
187
+ - A new command, git-remote, can help you manage your remote
188
+ tracking branch definitions.
189
+
190
+ - You may need to specify explicit paths for upload-pack and/or
191
+ receive-pack due to your ssh daemon configuration on the
192
+ other end. This can now be done via remote.*.uploadpack and
193
+ remote.*.receivepack configuration.
194
+
195
+
196
+ * Bare repositories
197
+
198
+ - Certain commands change their behavior in a bare repository
199
+ (i.e. a repository without associated working tree). We use
200
+ a fairly conservative heuristic (if $GIT_DIR is ".git", or
201
+ ends with "/.git", the repository is not bare) to decide if a
202
+ repository is bare, but "core.bare" configuration variable
203
+ can be used to override the heuristic when it misidentifies
204
+ your repository.
205
+
206
+ - git-fetch used to complain updating the current branch but
207
+ this is now allowed for a bare repository. So is the use of
208
+ 'git-branch -f' to update the current branch.
209
+
210
+ - Porcelain-ish commands that require a working tree refuses to
211
+ work in a bare repository.
212
+
213
+
214
+ * Reflog
215
+
216
+ - Reflog records the history from the view point of the local
217
+ repository. In other words, regardless of the real history,
218
+ the reflog shows the history as seen by one particular
219
+ repository (this enables you to ask "what was the current
220
+ revision in _this_ repository, yesterday at 1pm?"). This
221
+ facility is enabled by default for repositories with working
222
+ trees, and can be accessed with the "branch@{time}" and
223
+ "branch@{Nth}" notation.
224
+
225
+ - "git show-branch" learned showing the reflog data with the
226
+ new -g option. "git log" has -g option to view reflog
227
+ entries in a more verbose manner.
228
+
229
+ - git-branch knows how to rename branches and moves existing
230
+ reflog data from the old branch to the new one.
231
+
232
+ - In addition to the reflog support in v1.4.4 series, HEAD
233
+ reference maintains its own log. "HEAD@{5.minutes.ago}"
234
+ means the commit you were at 5 minutes ago, which takes
235
+ branch switching into account. If you want to know where the
236
+ tip of your current branch was at 5 minutes ago, you need to
237
+ explicitly say its name (e.g. "master@{5.minutes.ago}") or
238
+ omit the refname altogether i.e. "@{5.minutes.ago}".
239
+
240
+ - The commits referred to by reflog entries are now protected
241
+ against pruning. The new command "git reflog expire" can be
242
+ used to truncate older reflog entries and entries that refer
243
+ to commits that have been pruned away previously with older
244
+ versions of git.
245
+
246
+ Existing repositories that have been using reflog may get
247
+ complaints from fsck-objects and may not be able to run
248
+ git-repack, if you had run git-prune from older git; please
249
+ run "git reflog expire --stale-fix --all" first to remove
250
+ reflog entries that refer to commits that are no longer in
251
+ the repository when that happens.
252
+
253
+
254
+ * Cruft removal
255
+
256
+ - We used to say "old commits are retrievable using reflog and
257
+ 'master@{yesterday}' syntax as long as you haven't run
258
+ git-prune". We no longer have to say the latter half of the
259
+ above sentence, as git-prune does not remove things reachable
260
+ from reflog entries.
261
+
262
+ - There is a toplevel garbage collector script, 'git-gc', that
263
+ runs periodic cleanup functions, including 'git-repack -a -d',
264
+ 'git-reflog expire', 'git-pack-refs --prune', and 'git-rerere
265
+ gc'.
266
+
267
+ - The output from fsck ("fsck-objects" is called just "fsck"
268
+ now, but the old name continues to work) was needlessly
269
+ alarming in that it warned missing objects that are reachable
270
+ only from dangling objects. This has been corrected and the
271
+ output is much more useful.
272
+
273
+
274
+ * Detached HEAD
275
+
276
+ - You can use 'git-checkout' to check out an arbitrary revision
277
+ or a tag as well, instead of named branches. This will
278
+ dissociate your HEAD from the branch you are currently on.
279
+
280
+ A typical use of this feature is to "look around". E.g.
281
+
282
+ $ git checkout v2.6.16
283
+ ... compile, test, etc.
284
+ $ git checkout v2.6.17
285
+ ... compile, test, etc.
286
+
287
+ - After detaching your HEAD, you can go back to an existing
288
+ branch with usual "git checkout $branch". Also you can
289
+ start a new branch using "git checkout -b $newbranch" to
290
+ start a new branch at that commit.
291
+
292
+ - You can even pull from other repositories, make merges and
293
+ commits while your HEAD is detached. Also you can use "git
294
+ reset" to jump to arbitrary commit, while still keeping your
295
+ HEAD detached.
296
+
297
+ Remember that a detached state is volatile, i.e. it will be forgotten
298
+ as soon as you move away from it with the checkout or reset command,
299
+ unless a branch is created from it as mentioned above. It is also
300
+ possible to rescue a lost detached state from the HEAD reflog.
301
+
302
+
303
+ * Packed refs
304
+
305
+ - Repositories with hundreds of tags have been paying large
306
+ overhead, both in storage and in runtime, due to the
307
+ traditional one-ref-per-file format. A new command,
308
+ git-pack-refs, can be used to "pack" them in more efficient
309
+ representation (you can let git-gc do this for you).
310
+
311
+ - Clones and fetches over dumb transports are now aware of
312
+ packed refs and can download from repositories that use
313
+ them.
314
+
315
+
316
+ * Configuration
317
+
318
+ - configuration related to color setting are consolidated under
319
+ color.* namespace (older diff.color.*, status.color.* are
320
+ still supported).
321
+
322
+ - 'git-repo-config' command is accessible as 'git-config' now.
323
+
324
+
325
+ * Updated features
326
+
327
+ - git-describe uses better criteria to pick a base ref. It
328
+ used to pick the one with the newest timestamp, but now it
329
+ picks the one that is topologically the closest (that is,
330
+ among ancestors of commit C, the ref T that has the shortest
331
+ output from "git-rev-list T..C" is chosen).
332
+
333
+ - git-describe gives the number of commits since the base ref
334
+ between the refname and the hash suffix. E.g. the commit one
335
+ before v2.6.20-rc6 in the kernel repository is:
336
+
337
+ v2.6.20-rc5-306-ga21b069
338
+
339
+ which tells you that its object name begins with a21b069,
340
+ v2.6.20-rc5 is an ancestor of it (meaning, the commit
341
+ contains everything -rc5 has), and there are 306 commits
342
+ since v2.6.20-rc5.
343
+
344
+ - git-describe with --abbrev=0 can be used to show only the
345
+ name of the base ref.
346
+
347
+ - git-blame learned a new option, --incremental, that tells it
348
+ to output the blames as they are assigned. A sample script
349
+ to use it is also included as contrib/blameview.
350
+
351
+ - git-blame starts annotating from the working tree by default.
352
+
353
+
354
+ * Less external dependency
355
+
356
+ - We no longer require the "merge" program from the RCS suite.
357
+ All 3-way file-level merges are now done internally.
358
+
359
+ - The original implementation of git-merge-recursive which was
360
+ in Python has been removed; we have a C implementation of it
361
+ now.
362
+
363
+ - git-shortlog is no longer a Perl script. It no longer
364
+ requires output piped from git-log; it can accept revision
365
+ parameters directly on the command line.
366
+
367
+
368
+ * I18n
369
+
370
+ - We have always encouraged the commit message to be encoded in
371
+ UTF-8, but the users are allowed to use legacy encoding as
372
+ appropriate for their projects. This will continue to be the
373
+ case. However, a non UTF-8 commit encoding _must_ be
374
+ explicitly set with i18n.commitencoding in the repository
375
+ where a commit is made; otherwise git-commit-tree will
376
+ complain if the log message does not look like a valid UTF-8
377
+ string.
378
+
379
+ - The value of i18n.commitencoding in the originating
380
+ repository is recorded in the commit object on the "encoding"
381
+ header, if it is not UTF-8. git-log and friends notice this,
382
+ and re-encodes the message to the log output encoding when
383
+ displaying, if they are different. The log output encoding
384
+ is determined by "git log --encoding=<encoding>",
385
+ i18n.logoutputencoding configuration, or i18n.commitencoding
386
+ configuration, in the decreasing order of preference, and
387
+ defaults to UTF-8.
388
+
389
+ - Tools for e-mailed patch application now default to -u
390
+ behavior; i.e. it always re-codes from the e-mailed encoding
391
+ to the encoding specified with i18n.commitencoding. This
392
+ unfortunately forces projects that have happily been using a
393
+ legacy encoding without setting i18n.commitencoding to set
394
+ the configuration, but taken with other improvement, please
395
+ excuse us for this very minor one-time inconvenience.
396
+
397
+
398
+ * e-mailed patches
399
+
400
+ - See the above I18n section.
401
+
402
+ - git-format-patch now enables --binary without being asked.
403
+ git-am does _not_ default to it, as sending binary patch via
404
+ e-mail is unusual and is harder to review than textual
405
+ patches and it is prudent to require the person who is
406
+ applying the patch to explicitly ask for it.
407
+
408
+ - The default suffix for git-format-patch output is now ".patch",
409
+ not ".txt". This can be changed with --suffix=.txt option,
410
+ or setting the config variable "format.suffix" to ".txt".
411
+
412
+
413
+ * Foreign SCM interfaces
414
+
415
+ - git-svn now requires the Perl SVN:: libraries, the
416
+ command-line backend was too slow and limited.
417
+
418
+ - the 'commit' subcommand of git-svn has been renamed to
419
+ 'set-tree', and 'dcommit' is the recommended replacement for
420
+ day-to-day work.
421
+
422
+ - git fast-import backend.
423
+
424
+
425
+ * User support
426
+
427
+ - Quite a lot of documentation updates.
428
+
429
+ - Bash completion scripts have been updated heavily.
430
+
431
+ - Better error messages for often used Porcelainish commands.
432
+
433
+ - Git GUI. This is a simple Tk based graphical interface for
434
+ common Git operations.
435
+
436
+
437
+ * Sliding mmap
438
+
439
+ - We used to assume that we can mmap the whole packfile while
440
+ in use, but with a large project this consumes huge virtual
441
+ memory space and truly huge ones would not fit in the
442
+ userland address space on 32-bit platforms. We now mmap huge
443
+ packfile in pieces to avoid this problem.
444
+
445
+
446
+ * Shallow clones
447
+
448
+ - There is a partial support for 'shallow' repositories that
449
+ keeps only recent history. A 'shallow clone' is created by
450
+ specifying how deep that truncated history should be
451
+ (e.g. "git clone --depth 5 git://some.where/repo.git").
452
+
453
+ Currently a shallow repository has number of limitations:
454
+
455
+ - Cloning and fetching _from_ a shallow clone are not
456
+ supported (nor tested -- so they might work by accident but
457
+ they are not expected to).
458
+
459
+ - Pushing from nor into a shallow clone are not expected to
460
+ work.
461
+
462
+ - Merging inside a shallow repository would work as long as a
463
+ merge base is found in the recent history, but otherwise it
464
+ will be like merging unrelated histories and may result in
465
+ huge conflicts.
466
+
467
+ but this would be more than adequate for people who want to
468
+ look at near the tip of a big project with a deep history and
469
+ send patches in e-mail format.
git/mingw64/share/doc/git-doc/RelNotes/1.5.1.1.adoc ADDED
@@ -0,0 +1,65 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.1.1 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.1
5
+ ------------------
6
+
7
+ * Documentation updates
8
+
9
+ - The --left-right option of rev-list and friends is documented.
10
+
11
+ - The documentation for cvsimport has been majorly improved.
12
+
13
+ - "git-show-ref --exclude-existing" was documented.
14
+
15
+ * Bugfixes
16
+
17
+ - The implementation of -p option in "git cvsexportcommit" had
18
+ the meaning of -C (context reduction) option wrong, and
19
+ loosened the context requirements when it was told to be
20
+ strict.
21
+
22
+ - "git cvsserver" did not behave like the real cvsserver when
23
+ client side removed a file from the working tree without
24
+ doing anything else on the path. In such a case, it should
25
+ restore it from the checked out revision.
26
+
27
+ - "git fsck" issued an alarming error message on detached
28
+ HEAD. It is not an error since at least 1.5.0.
29
+
30
+ - "git send-email" produced of References header of unbounded length;
31
+ fixed this with line-folding.
32
+
33
+ - "git archive" to download from remote site should not
34
+ require you to be in a git repository, but it incorrectly
35
+ did.
36
+
37
+ - "git apply" ignored -p<n> for "diff --git" formatted
38
+ patches.
39
+
40
+ - "git rerere" recorded a conflict that had one side empty
41
+ (the other side adds) incorrectly; this made merging in the
42
+ other direction fail to use previously recorded resolution.
43
+
44
+ - t4200 test was broken where "wc -l" pads its output with
45
+ spaces.
46
+
47
+ - "git branch -m old new" to rename branch did not work
48
+ without a configuration file in ".git/config".
49
+
50
+ - The sample hook for notification e-mail was misnamed.
51
+
52
+ - gitweb did not show type-changing patch correctly in the
53
+ blobdiff view.
54
+
55
+ - git-svn did not error out with incorrect command line options.
56
+
57
+ - git-svn fell into an infinite loop when insanely long commit
58
+ message was found.
59
+
60
+ - git-svn dcommit and rebase was confused by patches that were
61
+ merged from another branch that is managed by git-svn.
62
+
63
+ - git-svn used to get confused when globbing remote branch/tag
64
+ spec (e.g. "branches = proj/branches/*:refs/remotes/origin/*")
65
+ is used and there was a plain file that matched the glob.
git/mingw64/share/doc/git-doc/RelNotes/1.5.1.2.adoc ADDED
@@ -0,0 +1,50 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.1.2 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.1.1
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - "git clone" over http from a repository that has lost the
10
+ loose refs by running "git pack-refs" were broken (a code to
11
+ deal with this was added to "git fetch" in v1.5.0, but it
12
+ was missing from "git clone").
13
+
14
+ - "git diff a/ b/" incorrectly fell in "diff between two
15
+ filesystem objects" codepath, when the user most likely
16
+ wanted to limit the extent of output to two tracked
17
+ directories.
18
+
19
+ - git-quiltimport had the same bug as we fixed for
20
+ git-applymbox in v1.5.1.1 -- it gave an alarming "did not
21
+ have any patch" message (but did not actually fail and was
22
+ harmless).
23
+
24
+ - various git-svn fixes.
25
+
26
+ - Sample update hook incorrectly always refused requests to
27
+ delete branches through push.
28
+
29
+ - git-blame on a very long working tree path had buffer
30
+ overrun problem.
31
+
32
+ - git-apply did not like to be fed two patches in a row that created
33
+ and then modified the same file.
34
+
35
+ - git-svn was confused when a non-project was stored directly under
36
+ trunk/, branches/ and tags/.
37
+
38
+ - git-svn wants the Error.pm module that was at least as new
39
+ as what we ship as part of git; install ours in our private
40
+ installation location if the one on the system is older.
41
+
42
+ - An earlier update to command line integer parameter parser was
43
+ botched and made 'update-index --cacheinfo' completely useless.
44
+
45
+
46
+ * Documentation updates
47
+
48
+ - Various documentation updates from J. Bruce Fields, Frank
49
+ Lichtenheld, Alex Riesen and others. Andrew Ruder started a
50
+ war on undocumented options.
git/mingw64/share/doc/git-doc/RelNotes/1.5.1.3.adoc ADDED
@@ -0,0 +1,45 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.1.3 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.1.2
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - git-add tried to optimize by finding common leading
10
+ directories across its arguments but botched, causing very
11
+ confused behaviour.
12
+
13
+ - unofficial rpm.spec file shipped with git was letting
14
+ ETC_GITCONFIG set to /usr/etc/gitconfig. Tweak the official
15
+ Makefile to make it harder for distro people to make the
16
+ same mistake, by setting the variable to /etc/gitconfig if
17
+ prefix is set to /usr.
18
+
19
+ - git-svn inconsistently stripped away username from the URL
20
+ only when svnsync_props was in use.
21
+
22
+ - git-svn got confused when handling symlinks on Mac OS.
23
+
24
+ - git-send-email was not quoting recipient names that have
25
+ period '.' in them. Also it did not allow overriding
26
+ envelope sender, which made it impossible to send patches to
27
+ certain subscriber-only lists.
28
+
29
+ - built-in write_tree() routine had a sequence that renamed a
30
+ file that is still open, which some systems did not like.
31
+
32
+ - when memory is very tight, sliding mmap code to read
33
+ packfiles incorrectly closed the fd that was still being
34
+ used to read the pack.
35
+
36
+ - import-tars contributed front-end for fastimport was passing
37
+ wrong directory modes without checking.
38
+
39
+ - git-fastimport trusted its input too much and allowed to
40
+ create corrupt tree objects with entries without a name.
41
+
42
+ - git-fetch needlessly barfed when too long reflog action
43
+ description was given by the caller.
44
+
45
+ Also contains various documentation updates.
git/mingw64/share/doc/git-doc/RelNotes/1.5.1.4.adoc ADDED
@@ -0,0 +1,30 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.1.4 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.1.3
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - "git-http-fetch" did not work around a bug in libcurl
10
+ earlier than 7.16 (curl_multi_remove_handle() was broken).
11
+
12
+ - "git cvsserver" handles a file that was once removed and
13
+ then added again correctly.
14
+
15
+ - import-tars script (in contrib/) handles GNU tar archives
16
+ that contain pathnames longer than 100 bytes (long-link
17
+ extension) correctly.
18
+
19
+ - xdelta test program did not build correctly.
20
+
21
+ - gitweb sometimes tried incorrectly to apply function to
22
+ decode utf8 twice, resulting in corrupt output.
23
+
24
+ - "git blame -C" mishandled text at the end of a group of
25
+ lines.
26
+
27
+ - "git log/rev-list --boundary" did not produce output
28
+ correctly without --left-right option.
29
+
30
+ - Many documentation updates.
git/mingw64/share/doc/git-doc/RelNotes/1.5.1.5.adoc ADDED
@@ -0,0 +1,42 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.1.5 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.1.4
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - git-send-email did not understand aliases file for mutt, which
10
+ allows leading whitespaces.
11
+
12
+ - git-format-patch emitted Content-Type and Content-Transfer-Encoding
13
+ headers for non ASCII contents, but failed to add MIME-Version.
14
+
15
+ - git-name-rev had a buffer overrun with a deep history.
16
+
17
+ - contributed script import-tars did not get the directory in
18
+ tar archives interpreted correctly.
19
+
20
+ - git-svn was reported to segfault for many people on list and
21
+ #git; hopefully this has been fixed.
22
+
23
+ - "git-svn clone" does not try to minimize the URL
24
+ (i.e. connect to higher level hierarchy) by default, as this
25
+ can prevent clone to fail if only part of the repository
26
+ (e.g. 'trunk') is open to public.
27
+
28
+ - "git checkout branch^0" did not detach the head when you are
29
+ already on 'branch'; backported the fix from the 'master'.
30
+
31
+ - "git-config section.var" did not correctly work when
32
+ existing configuration file had both [section] and [section "name"]
33
+ next to each other.
34
+
35
+ - "git clone ../other-directory" was fooled if the current
36
+ directory $PWD points at is a symbolic link.
37
+
38
+ - (build) tree_entry_extract() function was both static inline
39
+ and extern, which caused trouble compiling with Forte12
40
+ compilers on Sun.
41
+
42
+ - Many many documentation fixes and updates.
git/mingw64/share/doc/git-doc/RelNotes/1.5.1.6.adoc ADDED
@@ -0,0 +1,45 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.1.6 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.1.4
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - git-send-email did not understand aliases file for mutt, which
10
+ allows leading whitespaces.
11
+
12
+ - git-format-patch emitted Content-Type and Content-Transfer-Encoding
13
+ headers for non ASCII contents, but failed to add MIME-Version.
14
+
15
+ - git-name-rev had a buffer overrun with a deep history.
16
+
17
+ - contributed script import-tars did not get the directory in
18
+ tar archives interpreted correctly.
19
+
20
+ - git-svn was reported to segfault for many people on list and
21
+ #git; hopefully this has been fixed.
22
+
23
+ - git-svn also had a bug to crash svnserve by sending a bad
24
+ sequence of requests.
25
+
26
+ - "git-svn clone" does not try to minimize the URL
27
+ (i.e. connect to higher level hierarchy) by default, as this
28
+ can prevent clone to fail if only part of the repository
29
+ (e.g. 'trunk') is open to public.
30
+
31
+ - "git checkout branch^0" did not detach the head when you are
32
+ already on 'branch'; backported the fix from the 'master'.
33
+
34
+ - "git-config section.var" did not correctly work when
35
+ existing configuration file had both [section] and [section "name"]
36
+ next to each other.
37
+
38
+ - "git clone ../other-directory" was fooled if the current
39
+ directory $PWD points at is a symbolic link.
40
+
41
+ - (build) tree_entry_extract() function was both static inline
42
+ and extern, which caused trouble compiling with Forte12
43
+ compilers on Sun.
44
+
45
+ - Many many documentation fixes and updates.
git/mingw64/share/doc/git-doc/RelNotes/1.5.1.adoc ADDED
@@ -0,0 +1,371 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.1 Release Notes
2
+ ========================
3
+
4
+ Updates since v1.5.0
5
+ --------------------
6
+
7
+ * Deprecated commands and options.
8
+
9
+ - git-diff-stages and git-resolve have been removed.
10
+
11
+ * New commands and options.
12
+
13
+ - "git log" and friends take --reverse, which instructs them
14
+ to give their output in the order opposite from their usual.
15
+ They typically output from new to old, but with this option
16
+ their output would read from old to new. "git shortlog"
17
+ usually lists older commits first, but with this option,
18
+ they are shown from new to old.
19
+
20
+ - "git log --pretty=format:<string>" to allow more flexible
21
+ custom log output.
22
+
23
+ - "git diff" learned --ignore-space-at-eol. This is a weaker
24
+ form of --ignore-space-change.
25
+
26
+ - "git diff --no-index pathA pathB" can be used as diff
27
+ replacement with git specific enhancements.
28
+
29
+ - "git diff --no-index" can read from '-' (standard input).
30
+
31
+ - "git diff" also learned --exit-code to exit with non-zero
32
+ status when it found differences. In the future we might
33
+ want to make this the default but that would be a rather big
34
+ backward incompatible change; it will stay as an option for
35
+ now.
36
+
37
+ - "git diff --quiet" is --exit-code with output turned off,
38
+ meant for scripted use to quickly determine if there is any
39
+ tree-level difference.
40
+
41
+ - Textual patch generation with "git diff" without -w/-b
42
+ option has been significantly optimized. "git blame" got
43
+ faster because of the same change.
44
+
45
+ - "git log" and "git rev-list" has been optimized
46
+ significantly when they are used with pathspecs.
47
+
48
+ - "git branch --track" can be used to set up configuration
49
+ variables to help it easier to base your work on branches
50
+ you track from a remote site.
51
+
52
+ - "git format-patch --attach" now emits attachments. Use
53
+ --inline to get an inlined multipart/mixed.
54
+
55
+ - "git name-rev" learned --refs=<pattern>, to limit the tags
56
+ used for naming the given revisions only to the ones
57
+ matching the given pattern.
58
+
59
+ - "git remote update" is to run "git fetch" for defined remotes
60
+ to update tracking branches.
61
+
62
+ - "git cvsimport" can now take '-d' to talk with a CVS
63
+ repository different from what are recorded in CVS/Root
64
+ (overriding it with environment CVSROOT does not work).
65
+
66
+ - "git bundle" can help sneaker-netting your changes between
67
+ repositories.
68
+
69
+ - "git mergetool" can help 3-way file-level conflict
70
+ resolution with your favorite graphical merge tools.
71
+
72
+ - A new configuration "core.symlinks" can be used to disable
73
+ symlinks on filesystems that do not support them; they are
74
+ checked out as regular files instead.
75
+
76
+ - You can name a commit object with its first line of the
77
+ message. The syntax to use is ':/message text'. E.g.
78
+
79
+ $ git show ":/object name: introduce ':/<oneline prefix>' notation"
80
+
81
+ means the same thing as:
82
+
83
+ $ git show 28a4d940443806412effa246ecc7768a21553ec7
84
+
85
+ - "git bisect" learned a new command "run" that takes a script
86
+ to run after each revision is checked out to determine if it
87
+ is good or bad, to automate the bisection process.
88
+
89
+ - "git log" family learned a new traversal option --first-parent,
90
+ which does what the name suggests.
91
+
92
+
93
+ * Updated behavior of existing commands.
94
+
95
+ - "git-merge-recursive" used to barf when there are more than
96
+ one common ancestors for the merge, and merging them had a
97
+ rename/rename conflict. This has been fixed.
98
+
99
+ - "git fsck" does not barf on corrupt loose objects.
100
+
101
+ - "git rm" does not remove newly added files without -f.
102
+
103
+ - "git archimport" allows remapping when coming up with git
104
+ branch names from arch names.
105
+
106
+ - git-svn got almost a rewrite.
107
+
108
+ - core.autocrlf configuration, when set to 'true', makes git
109
+ to convert CRLF at the end of lines in text files to LF when
110
+ reading from the filesystem, and convert in reverse when
111
+ writing to the filesystem. The variable can be set to
112
+ 'input', in which case the conversion happens only while
113
+ reading from the filesystem but files are written out with
114
+ LF at the end of lines. Currently, which paths to consider
115
+ 'text' (i.e. be subjected to the autocrlf mechanism) is
116
+ decided purely based on the contents, but the plan is to
117
+ allow users to explicitly override this heuristic based on
118
+ paths.
119
+
120
+ - The behavior of 'git-apply', when run in a subdirectory,
121
+ without --index nor --cached were inconsistent with that of
122
+ the command with these options. This was fixed to match the
123
+ behavior with --index. A patch that is meant to be applied
124
+ with -p1 from the toplevel of the project tree can be
125
+ applied with any custom -p<n> option. A patch that is not
126
+ relative to the toplevel needs to be applied with -p<n>
127
+ option with or without --index (or --cached).
128
+
129
+ - "git diff" outputs a trailing HT when pathnames have embedded
130
+ SP on +++/--- header lines, in order to help "GNU patch" to
131
+ parse its output. "git apply" was already updated to accept
132
+ this modified output format since ce74618d (Sep 22, 2006).
133
+
134
+ - "git cvsserver" runs hooks/update and honors its exit status.
135
+
136
+ - "git cvsserver" can be told to send everything with -kb.
137
+
138
+ - "git diff --check" also honors the --color output option.
139
+
140
+ - "git name-rev" used to stress the fact that a ref is a tag too
141
+ much, by saying something like "v1.2.3^0~22". It now says
142
+ "v1.2.3~22" in such a case (it still says "v1.2.3^0" if it does
143
+ not talk about an ancestor of the commit that is tagged, which
144
+ makes sense).
145
+
146
+ - "git rev-list --boundary" now shows boundary markers for the
147
+ commits omitted by --max-age and --max-count condition.
148
+
149
+ - The configuration mechanism now reads $(prefix)/etc/gitconfig.
150
+
151
+ - "git apply --verbose" shows what preimage lines were wanted
152
+ when it couldn't find them.
153
+
154
+ - "git status" in a read-only repository got a bit saner.
155
+
156
+ - "git fetch" (hence "git clone" and "git pull") are less
157
+ noisy when the output does not go to tty.
158
+
159
+ - "git fetch" between repositories with many refs were slow
160
+ even when there are not many changes that needed
161
+ transferring. This has been sped up by partially rewriting
162
+ the heaviest parts in C.
163
+
164
+ - "git mailinfo" which splits an e-mail into a patch and the
165
+ meta-information was rewritten, thanks to Don Zickus. It
166
+ handles nested multipart better. The command was broken for
167
+ a brief period on 'master' branch since 1.5.0 but the
168
+ breakage is fixed now.
169
+
170
+ - send-email learned configurable bcc and chain-reply-to.
171
+
172
+ - "git remote show $remote" also talks about branches that
173
+ would be pushed if you run "git push remote".
174
+
175
+ - Using objects from packs is now seriously optimized by clever
176
+ use of a cache. This should be most noticeable in git-log
177
+ family of commands that involve reading many tree objects.
178
+ In addition, traversing revisions while filtering changes
179
+ with pathspecs is made faster by terminating the comparison
180
+ between the trees as early as possible.
181
+
182
+
183
+ * Hooks
184
+
185
+ - The part to send out notification e-mails was removed from
186
+ the sample update hook, as it was not an appropriate place
187
+ to do so. The proper place to do this is the new post-receive
188
+ hook. An example hook has been added to contrib/hooks/.
189
+
190
+
191
+ * Others
192
+
193
+ - git-revert, git-gc and git-cherry-pick are now built-ins.
194
+
195
+ Fixes since v1.5.0
196
+ ------------------
197
+
198
+ These are all in v1.5.0.x series.
199
+
200
+ * Documentation updates
201
+
202
+ - Clarifications and corrections to 1.5.0 release notes.
203
+
204
+ - The main documentation did not link to git-remote documentation.
205
+
206
+ - Clarified introductory text of git-rebase documentation.
207
+
208
+ - Converted remaining mentions of update-index on Porcelain
209
+ documents to git-add/git-rm.
210
+
211
+ - Some i18n.* configuration variables were incorrectly
212
+ described as core.*; fixed.
213
+
214
+ - added and clarified core.bare, core.legacyheaders configurations.
215
+
216
+ - updated "git-clone --depth" documentation.
217
+
218
+ - user-manual updates.
219
+
220
+ - Options to 'git remote add' were described insufficiently.
221
+
222
+ - Configuration format.suffix was not documented.
223
+
224
+ - Other formatting and spelling fixes.
225
+
226
+ - user-manual has better cross references.
227
+
228
+ - gitweb installation/deployment procedure is now documented.
229
+
230
+
231
+ * Bugfixes
232
+
233
+ - git-upload-pack closes unused pipe ends; earlier this caused
234
+ many zombies to hang around.
235
+
236
+ - git-rerere was recording the contents of earlier hunks
237
+ duplicated in later hunks. This prevented resolving the same
238
+ conflict when performing the same merge the other way around.
239
+
240
+ - git-add and git-update-index on a filesystem on which
241
+ executable bits are unreliable incorrectly reused st_mode
242
+ bits even when the path changed between symlink and regular
243
+ file.
244
+
245
+ - git-daemon marks the listening sockets with FD_CLOEXEC so
246
+ that it won't be leaked into the children.
247
+
248
+ - segfault from git-blame when the mandatory pathname
249
+ parameter was missing was fixed; usage() message is given
250
+ instead.
251
+
252
+ - git-rev-list did not read $GIT_DIR/config file, which means
253
+ that did not honor i18n.logoutputencoding correctly.
254
+
255
+ - Automated merge conflict handling when changes to symbolic
256
+ links conflicted were completely broken. The merge-resolve
257
+ strategy created a regular file with conflict markers in it
258
+ in place of the symbolic link. The default strategy,
259
+ merge-recursive was even more broken. It removed the path
260
+ that was pointed at by the symbolic link. Both of these
261
+ problems have been fixed.
262
+
263
+ - 'git diff maint master next' did not correctly give combined
264
+ diff across three trees.
265
+
266
+ - 'git fast-import' portability fix for Solaris.
267
+
268
+ - 'git show-ref --verify' without arguments did not error out
269
+ but segfaulted.
270
+
271
+ - 'git diff :tracked-file `pwd`/an-untracked-file' gave an extra
272
+ slashes after a/ and b/.
273
+
274
+ - 'git format-patch' produced too long filenames if the commit
275
+ message had too long line at the beginning.
276
+
277
+ - Running 'make all' and then without changing anything
278
+ running 'make install' still rebuilt some files. This
279
+ was inconvenient when building as yourself and then
280
+ installing as root (especially problematic when the source
281
+ directory is on NFS and root is mapped to nobody).
282
+
283
+ - 'git-rerere' failed to deal with two unconflicted paths that
284
+ sorted next to each other.
285
+
286
+ - 'git-rerere' attempted to open(2) a symlink and failed if
287
+ there was a conflict. Since a conflicting change to a
288
+ symlink would not benefit from rerere anyway, the command
289
+ now ignores conflicting changes to symlinks.
290
+
291
+ - 'git-repack' did not like to pass more than 64 arguments
292
+ internally to underlying 'rev-list' logic, which made it
293
+ impossible to repack after accumulating many (small) packs
294
+ in the repository.
295
+
296
+ - 'git-diff' to review the combined diff during a conflicted
297
+ merge were not reading the working tree version correctly
298
+ when changes to a symbolic link conflicted. It should have
299
+ read the data using readlink(2) but read from the regular
300
+ file the symbolic link pointed at.
301
+
302
+ - 'git-remote' did not like period in a remote's name.
303
+
304
+ - 'git.el' honors the commit coding system from the configuration.
305
+
306
+ - 'blameview' in contrib/ correctly digs deeper when a line is
307
+ clicked.
308
+
309
+ - 'http-push' correctly makes sure the remote side has leading
310
+ path. Earlier it started in the middle of the path, and
311
+ incorrectly.
312
+
313
+ - 'git-merge' did not exit with non-zero status when the
314
+ working tree was dirty and cannot fast forward. It does
315
+ now.
316
+
317
+ - 'cvsexportcommit' does not lose yet-to-be-used message file.
318
+
319
+ - int-vs-size_t typefix when running combined diff on files
320
+ over 2GB long.
321
+
322
+ - 'git apply --whitespace=strip' should not touch unmodified
323
+ lines.
324
+
325
+ - 'git-mailinfo' choke when a logical header line was too long.
326
+
327
+ - 'git show A..B' did not error out. Negative ref ("not A" in
328
+ this example) does not make sense for the purpose of the
329
+ command, so now it errors out.
330
+
331
+ - 'git fmt-merge-msg --file' without file parameter did not
332
+ correctly error out.
333
+
334
+ - 'git archimport' barfed upon encountering a commit without
335
+ summary.
336
+
337
+ - 'git index-pack' did not protect itself from getting a short
338
+ read out of pread(2).
339
+
340
+ - 'git http-push' had a few buffer overruns.
341
+
342
+ - Build dependency fixes to rebuild fetch.o when other headers
343
+ change.
344
+
345
+ - git.el does not add duplicate sign-off lines.
346
+
347
+ - git-commit shows the full stat of the resulting commit, not
348
+ just about the files in the current directory, when run from
349
+ a subdirectory.
350
+
351
+ - "git-checkout -m '@{8 hours ago}'" had a funny failure from
352
+ eval; fixed.
353
+
354
+ - git-merge (hence git-pull) did not refuse fast-forwarding
355
+ when the working tree had local changes that would have
356
+ conflicted with it.
357
+
358
+ - a handful small fixes to gitweb.
359
+
360
+ - build procedure for user-manual is fixed not to require locally
361
+ installed stylesheets.
362
+
363
+ - "git commit $paths" on paths whose earlier contents were
364
+ already updated in the index were failing out.
365
+
366
+
367
+ * Tweaks
368
+
369
+ - sliding mmap() inefficiently mmaped the same region of a
370
+ packfile with an access pattern that used objects in the
371
+ reverse order. This has been made more efficient.
git/mingw64/share/doc/git-doc/RelNotes/1.5.2.1.adoc ADDED
@@ -0,0 +1,47 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.2.1 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.2
5
+ ------------------
6
+
7
+ * Bugfixes
8
+
9
+ - Temporary files that are used when invoking external diff
10
+ programs did not tolerate a long TMPDIR.
11
+
12
+ - git-daemon did not notice when it could not write into its
13
+ pid file.
14
+
15
+ - git-status did not honor core.excludesFile configuration like
16
+ git-add did.
17
+
18
+ - git-annotate did not work from a subdirectory while
19
+ git-blame did.
20
+
21
+ - git-cvsserver should have disabled access to a repository
22
+ with "gitcvs.pserver.enabled = false" set even when
23
+ "gitcvs.enabled = true" was set at the same time. It
24
+ didn't.
25
+
26
+ - git-cvsimport did not work correctly in a repository with
27
+ its branch heads were packed with pack-refs.
28
+
29
+ - ident unexpansion to squash "$Id: xxx $" that is in the
30
+ repository copy removed incorrect number of bytes.
31
+
32
+ - git-svn misbehaved when the subversion repository did not
33
+ provide MD5 checksums for files.
34
+
35
+ - git rebase (and git am) misbehaved on commits that have '\n'
36
+ (literally backslash and en, not a linefeed) in the title.
37
+
38
+ - code to decode base85 used in binary patches had one error
39
+ return codepath wrong.
40
+
41
+ - RFC2047 Q encoding output by git-format-patch used '_' for a
42
+ space, which is not understood by some programs. It uses =20
43
+ which is safer.
44
+
45
+ - git-fastimport --import-marks was broken; fixed.
46
+
47
+ - A lot of documentation updates, clarifications and fixes.
git/mingw64/share/doc/git-doc/RelNotes/1.5.2.2.adoc ADDED
@@ -0,0 +1,61 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.2.2 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.2.1
5
+ --------------------
6
+
7
+ * Usability fix
8
+
9
+ - git-gui is shipped with its updated blame interface. It is
10
+ rumored that the older one was not just unusable but was
11
+ active health hazard, but this one is actually pretty.
12
+ Please see for yourself.
13
+
14
+ * Bugfixes
15
+
16
+ - "git checkout fubar" was utterly confused when there is a
17
+ branch fubar and a tag fubar at the same time. It correctly
18
+ checks out the branch fubar now.
19
+
20
+ - "git clone /path/foo" to clone a local /path/foo.git
21
+ repository left an incorrect configuration.
22
+
23
+ - "git send-email" correctly unquotes RFC 2047 quoted names in
24
+ the patch-email before using their values.
25
+
26
+ - We did not accept number of seconds since epoch older than
27
+ year 2000 as a valid timestamp. We now interpret positive
28
+ integers more than 8 digits as such, which allows us to
29
+ express timestamps more recent than March 1973.
30
+
31
+ - git-cvsimport did not work when you have GIT_DIR to point
32
+ your repository at a nonstandard location.
33
+
34
+ - Some systems (notably, Solaris) lack hstrerror() to make
35
+ h_errno human readable; prepare a replacement
36
+ implementation.
37
+
38
+ - .gitignore file listed git-core.spec but what we generate is
39
+ git.spec, and nobody noticed for a long time.
40
+
41
+ - "git-merge-recursive" does not try to run file level merge
42
+ on binary files.
43
+
44
+ - "git-branch --track" did not create tracking configuration
45
+ correctly when the branch name had slash in it.
46
+
47
+ - The email address of the user specified with user.email
48
+ configuration was overridden by EMAIL environment variable.
49
+
50
+ - The tree parser did not warn about tree entries with
51
+ nonsense file modes, and assumed they must be blobs.
52
+
53
+ - "git log -z" without any other request to generate diff still
54
+ invoked the diff machinery, wasting cycles.
55
+
56
+ * Documentation
57
+
58
+ - Many updates to fix stale or missing documentation.
59
+
60
+ - Although our documentation was primarily meant to be formatted
61
+ with AsciiDoc7, formatting with AsciiDoc8 is supported better.
git/mingw64/share/doc/git-doc/RelNotes/1.5.2.3.adoc ADDED
@@ -0,0 +1,27 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.2.3 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.2.2
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - Version 2 pack index format was introduced in version 1.5.2
10
+ to support pack files that has offset that cannot be
11
+ represented in 32-bit. The runtime code to validate such
12
+ an index mishandled such an index for an empty pack.
13
+
14
+ - Commit walkers (most notably, fetch over http protocol)
15
+ tried to traverse commit objects contained in trees (aka
16
+ subproject); they shouldn't.
17
+
18
+ - A build option NO_R_TO_GCC_LINKER was not explained in Makefile
19
+ comment correctly.
20
+
21
+ * Documentation Fixes and Updates
22
+
23
+ - git-config --regexp was not documented properly.
24
+
25
+ - git-repack -a was not documented properly.
26
+
27
+ - git-remote -n was not documented properly.
git/mingw64/share/doc/git-doc/RelNotes/1.5.2.4.adoc ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.2.4 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.2.3
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - "git-gui" bugfixes, including a handful fixes to run it
10
+ better on Cygwin/MSYS.
11
+
12
+ - "git checkout" failed to switch back and forth between
13
+ branches, one of which has "frotz -> xyzzy" symlink and
14
+ file "xyzzy/filfre", while the other one has a file
15
+ "frotz/filfre".
16
+
17
+ - "git prune" used to segfault upon seeing a commit that is
18
+ referred to by a tree object (aka "subproject").
19
+
20
+ - "git diff --name-status --no-index" mishandled an added file.
21
+
22
+ - "git apply --reverse --whitespace=warn" still complained
23
+ about whitespaces that a forward application would have
24
+ introduced.
25
+
26
+ * Documentation Fixes and Updates
27
+
28
+ - A handful documentation updates.
git/mingw64/share/doc/git-doc/RelNotes/1.5.2.5.adoc ADDED
@@ -0,0 +1,30 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.2.5 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.2.4
5
+ --------------------
6
+
7
+ * Bugfixes
8
+
9
+ - "git add -u" had a serious data corruption problem in one
10
+ special case (when the changes to a subdirectory's files
11
+ consist only deletion of files).
12
+
13
+ - "git add -u <path>" did not work from a subdirectory.
14
+
15
+ - "git apply" left an empty directory after all its files are
16
+ renamed away.
17
+
18
+ - "git $anycmd foo/bar", when there is a file 'foo' in the
19
+ working tree, complained that "git $anycmd foo/bar --" form
20
+ should be used to disambiguate between revs and files,
21
+ which was completely bogus.
22
+
23
+ - "git checkout-index" and other commands that checks out
24
+ files to the work tree tried unlink(2) on directories,
25
+ which is a sane thing to do on sane systems, but not on
26
+ Solaris when you are root.
27
+
28
+ * Documentation Fixes and Updates
29
+
30
+ - A handful documentation fixes.
git/mingw64/share/doc/git-doc/RelNotes/1.5.2.adoc ADDED
@@ -0,0 +1,197 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.2 Release Notes
2
+ ========================
3
+
4
+ Updates since v1.5.1
5
+ --------------------
6
+
7
+ * Plumbing level superproject support.
8
+
9
+ You can include a subdirectory that has an independent git
10
+ repository in your index and tree objects of your project
11
+ ("superproject"). This plumbing (i.e. "core") level
12
+ superproject support explicitly excludes recursive behaviour.
13
+
14
+ The "subproject" entries in the index and trees of a superproject
15
+ are incompatible with older versions of git. Experimenting with
16
+ the plumbing level support is encouraged, but be warned that
17
+ unless everybody in your project updates to this release or
18
+ later, using this feature would make your project
19
+ inaccessible by people with older versions of git.
20
+
21
+ * Plumbing level gitattributes support.
22
+
23
+ The gitattributes mechanism allows you to add 'attributes' to
24
+ paths in your project, and affect the way certain git
25
+ operations work. Currently you can influence if a path is
26
+ considered a binary or text (the former would be treated by
27
+ 'git diff' not to produce textual output; the latter can go
28
+ through the line endings conversion process in repositories
29
+ with core.autocrlf set), expand and unexpand '$Id$' keyword
30
+ with blob object name, specify a custom 3-way merge driver,
31
+ and specify a custom diff driver. You can also apply
32
+ arbitrary filter to contents on check-in/check-out codepath
33
+ but this feature is an extremely sharp-edged razor and needs
34
+ to be handled with caution (do not use it unless you
35
+ understand the earlier mailing list discussion on keyword
36
+ expansion). These conversions apply when checking files in
37
+ or out, and exporting via git-archive.
38
+
39
+ * The packfile format now optionally supports 64-bit index.
40
+
41
+ This release supports the "version 2" format of the .idx
42
+ file. This is automatically enabled when a huge packfile
43
+ needs more than 32-bit to express offsets of objects in the
44
+ pack.
45
+
46
+ * Comes with an updated git-gui 0.7.1
47
+
48
+ * Updated gitweb:
49
+
50
+ - can show combined diff for merges;
51
+ - uses font size of user's preference, not hardcoded in pixels;
52
+ - can now 'grep';
53
+
54
+ * New commands and options.
55
+
56
+ - "git bisect start" can optionally take a single bad commit and
57
+ zero or more good commits on the command line.
58
+
59
+ - "git shortlog" can optionally be told to wrap its output.
60
+
61
+ - "subtree" merge strategy allows another project to be merged in as
62
+ your subdirectory.
63
+
64
+ - "git format-patch" learned a new --subject-prefix=<string>
65
+ option, to override the built-in "[PATCH]".
66
+
67
+ - "git add -u" is a quick way to do the first stage of "git
68
+ commit -a" (i.e. update the index to match the working
69
+ tree); it obviously does not make a commit.
70
+
71
+ - "git clean" honors a new configuration, "clean.requireforce". When
72
+ set to true, this makes "git clean" a no-op, preventing you
73
+ from losing files by typing "git clean" when you meant to
74
+ say "make clean". You can still say "git clean -f" to
75
+ override this.
76
+
77
+ - "git log" family of commands learned --date={local,relative,default}
78
+ option. --date=relative is synonym to the --relative-date.
79
+ --date=local gives the timestamp in local timezone.
80
+
81
+ * Updated behavior of existing commands.
82
+
83
+ - When $GIT_COMMITTER_EMAIL or $GIT_AUTHOR_EMAIL is not set
84
+ but $EMAIL is set, the latter is used as a substitute.
85
+
86
+ - "git diff --stat" shows size of preimage and postimage blobs
87
+ for binary contents. Earlier it only said "Bin".
88
+
89
+ - "git lost-found" shows stuff that are unreachable except
90
+ from reflogs.
91
+
92
+ - "git checkout branch^0" now detaches HEAD at the tip commit
93
+ on the named branch, instead of just switching to the
94
+ branch (use "git checkout branch" to switch to the branch,
95
+ as before).
96
+
97
+ - "git bisect next" can be used after giving only a bad commit
98
+ without giving a good one (this starts bisection half-way to
99
+ the root commit). We used to refuse to operate without a
100
+ good and a bad commit.
101
+
102
+ - "git push", when pushing into more than one repository, does
103
+ not stop at the first error.
104
+
105
+ - "git archive" does not insist you to give --format parameter
106
+ anymore; it defaults to "tar".
107
+
108
+ - "git cvsserver" can use backends other than sqlite.
109
+
110
+ - "gitview" (in contrib/ section) learned to better support
111
+ "git-annotate".
112
+
113
+ - "git diff $commit1:$path2 $commit2:$path2" can now report
114
+ mode changes between the two blobs.
115
+
116
+ - Local "git fetch" from a repository whose object store is
117
+ one of the alternates (e.g. fetching from the origin in a
118
+ repository created with "git clone -l -s") avoids
119
+ downloading objects unnecessarily.
120
+
121
+ - "git blame" uses .mailmap to canonicalize the author name
122
+ just like "git shortlog" does.
123
+
124
+ - "git pack-objects" pays attention to pack.depth
125
+ configuration variable.
126
+
127
+ - "git cherry-pick" and "git revert" does not use .msg file in
128
+ the working tree to prepare commit message; instead it uses
129
+ $GIT_DIR/MERGE_MSG as other commands do.
130
+
131
+ * Builds
132
+
133
+ - git-p4import has never been installed; now there is an
134
+ installation option to do so.
135
+
136
+ - gitk and git-gui can be configured out.
137
+
138
+ - Generated documentation pages automatically get version
139
+ information from GIT_VERSION.
140
+
141
+ - Parallel build with "make -j" descending into subdirectory
142
+ was fixed.
143
+
144
+ * Performance Tweaks
145
+
146
+ - Optimized "git-rev-list --bisect" (hence "git-bisect").
147
+
148
+ - Optimized "git-add $path" in a large directory, most of
149
+ whose contents are ignored.
150
+
151
+ - Optimized "git-diff-tree" for reduced memory footprint.
152
+
153
+ - The recursive merge strategy updated a worktree file that
154
+ was changed identically in two branches, when one of them
155
+ renamed it. We do not do that when there is no rename, so
156
+ match that behaviour. This avoids excessive rebuilds.
157
+
158
+ - The default pack depth has been increased to 50, as the
159
+ recent addition of delta_base_cache makes deeper delta chains
160
+ much less expensive to access. Depending on the project, it was
161
+ reported that this reduces the resulting pack file by 10%
162
+ or so.
163
+
164
+
165
+ Fixes since v1.5.1
166
+ ------------------
167
+
168
+ All of the fixes in v1.5.1 maintenance series are included in
169
+ this release, unless otherwise noted.
170
+
171
+ * Bugfixes
172
+
173
+ - Switching branches with "git checkout" refused to work when
174
+ a path changes from a file to a directory between the
175
+ current branch and the new branch, in order not to lose
176
+ possible local changes in the directory that is being turned
177
+ into a file with the switch. We now allow such a branch
178
+ switch after making sure that there is no locally modified
179
+ file nor un-ignored file in the directory. This has not
180
+ been backported to 1.5.1.x series, as it is rather an
181
+ intrusive change.
182
+
183
+ - Merging branches that have a file in one and a directory in
184
+ another at the same path used to get quite confused. We
185
+ handle such a case a bit more carefully, even though that is
186
+ still left as a conflict for the user to sort out. This
187
+ will not be backported to 1.5.1.x series, as it is rather an
188
+ intrusive change.
189
+
190
+ - git-fetch had trouble with a remote with insanely large number
191
+ of refs.
192
+
193
+ - "git clean -d -X" now does not remove non-excluded directories.
194
+
195
+ - rebasing (without -m) a series that changes a symlink to a directory
196
+ in the middle of a path confused git-apply greatly and refused to
197
+ operate.
git/mingw64/share/doc/git-doc/RelNotes/1.5.3.1.adoc ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.3.1 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.3
5
+ ------------------
6
+
7
+ This is solely to fix the generated RPM's dependencies. We used
8
+ to have git-p4 package but we do not anymore. As suggested on
9
+ the mailing list, this release makes git-core "Obsolete" git-p4,
10
+ so that yum update would not complain.
git/mingw64/share/doc/git-doc/RelNotes/1.5.3.2.adoc ADDED
@@ -0,0 +1,58 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.3.2 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.3.1
5
+ --------------------
6
+
7
+ * git-push sent thin packs by default, which was not good for
8
+ the public distribution server (no point in saving transfer
9
+ while pushing; no point in making the resulting pack less
10
+ optimum).
11
+
12
+ * git-svn sometimes terminated with "Malformed network data" when
13
+ talking over svn:// protocol.
14
+
15
+ * git-send-email re-issued the same message-id about 10% of the
16
+ time if you fired off 30 messages within a single second.
17
+
18
+ * git-stash was not terminating the log message of commits it
19
+ internally creates with LF.
20
+
21
+ * git-apply failed to check the size of the patch hunk when its
22
+ beginning part matched the remainder of the preimage exactly,
23
+ even though the preimage recorded in the hunk was much larger
24
+ (therefore the patch should not have applied), leading to a
25
+ segfault.
26
+
27
+ * "git rm foo && git commit foo" complained that 'foo' needs to
28
+ be added first, instead of committing the removal, which was a
29
+ nonsense.
30
+
31
+ * git grep -c said "/dev/null: 0".
32
+
33
+ * git-add -u failed to recognize a blob whose type changed
34
+ between the index and the work tree.
35
+
36
+ * The limit to rename detection has been tightened a lot to
37
+ reduce performance problems with a huge change.
38
+
39
+ * cvsimport and svnimport barfed when the input tried to move
40
+ a tag.
41
+
42
+ * "git apply -pN" did not chop the right number of directories.
43
+
44
+ * "git svnimport" did not like SVN tags with funny characters in them.
45
+
46
+ * git-gui 0.8.3, with assorted fixes, including:
47
+
48
+ - font-chooser on X11 was unusable with large number of fonts;
49
+ - a diff that contained a deleted symlink made it barf;
50
+ - an untracked symbolic link to a directory made it fart;
51
+ - a file with % in its name made it vomit;
52
+
53
+
54
+ Documentation updates
55
+ ---------------------
56
+
57
+ User manual has been somewhat restructured. I think the new
58
+ organization is much easier to read.
git/mingw64/share/doc/git-doc/RelNotes/1.5.3.3.adoc ADDED
@@ -0,0 +1,31 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.3.3 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.3.2
5
+ --------------------
6
+
7
+ * git-quiltimport did not like it when a patch described in the
8
+ series file does not exist.
9
+
10
+ * p4 importer missed executable bit in some cases.
11
+
12
+ * The default shell on some FreeBSD did not execute the
13
+ argument parsing code correctly and made git unusable.
14
+
15
+ * git-svn incorrectly spawned pager even when the user
16
+ explicitly asked not to.
17
+
18
+ * sample post-receive hook overquoted the envelope sender
19
+ value.
20
+
21
+ * git-am got confused when the patch contained a change that is
22
+ only about type and not contents.
23
+
24
+ * git-mergetool did not show our and their version of the
25
+ conflicted file when started from a subdirectory of the
26
+ project.
27
+
28
+ * git-mergetool did not pass correct options when invoking diff3.
29
+
30
+ * git-log sometimes invoked underlying "diff" machinery
31
+ unnecessarily.
git/mingw64/share/doc/git-doc/RelNotes/1.5.3.4.adoc ADDED
@@ -0,0 +1,35 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.3.4 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.3.3
5
+ --------------------
6
+
7
+ * Change to "git-ls-files" in v1.5.3.3 that was introduced to support
8
+ partial commit of removal better had a segfaulting bug, which was
9
+ diagnosed and fixed by Keith and Carl.
10
+
11
+ * Performance improvements for rename detection has been backported
12
+ from the 'master' branch.
13
+
14
+ * "git-for-each-ref --format='%(numparent)'" was not working
15
+ correctly at all, and --format='%(parent)' was not working for
16
+ merge commits.
17
+
18
+ * Sample "post-receive-hook" incorrectly sent out push
19
+ notification e-mails marked as "From: " the committer of the
20
+ commit that happened to be at the tip of the branch that was
21
+ pushed, not from the person who pushed.
22
+
23
+ * "git-remote" did not exit non-zero status upon error.
24
+
25
+ * "git-add -i" did not respond very well to EOF from tty nor
26
+ bogus input.
27
+
28
+ * "git-rebase -i" squash subcommand incorrectly made the
29
+ author of later commit the author of resulting commit,
30
+ instead of taking from the first one in the squashed series.
31
+
32
+ * "git-stash apply --index" was not documented.
33
+
34
+ * autoconfiguration learned that "ar" command is found as "gas" on
35
+ some systems.
git/mingw64/share/doc/git-doc/RelNotes/1.5.3.5.adoc ADDED
@@ -0,0 +1,94 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.3.5 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.3.4
5
+ --------------------
6
+
7
+ * Comes with git-gui 0.8.4.
8
+
9
+ * "git-config" silently ignored options after --list; now it will
10
+ error out with a usage message.
11
+
12
+ * "git-config --file" failed if the argument used a relative path
13
+ as it changed directories before opening the file.
14
+
15
+ * "git-config --file" now displays a proper error message if it
16
+ cannot read the file specified on the command line.
17
+
18
+ * "git-config", "git-diff", "git-apply" failed if run from a
19
+ subdirectory with relative GIT_DIR and GIT_WORK_TREE set.
20
+
21
+ * "git-blame" crashed if run during a merge conflict.
22
+
23
+ * "git-add -i" did not handle single line hunks correctly.
24
+
25
+ * "git-rebase -i" and "git-stash apply" failed if external diff
26
+ drivers were used for one or more files in a commit. They now
27
+ avoid calling the external diff drivers.
28
+
29
+ * "git-log --follow" did not work unless diff generation (e.g. -p)
30
+ was also requested.
31
+
32
+ * "git-log --follow -B" did not work at all. Fixed.
33
+
34
+ * "git-log -M -B" did not correctly handle cases of very large files
35
+ being renamed and replaced by very small files in the same commit.
36
+
37
+ * "git-log" printed extra newlines between commits when a diff
38
+ was generated internally (e.g. -S or --follow) but not displayed.
39
+
40
+ * "git-push" error message is more helpful when pushing to a
41
+ repository with no matching refs and none specified.
42
+
43
+ * "git-push" now respects + (force push) on wildcard refspecs,
44
+ matching the behavior of git-fetch.
45
+
46
+ * "git-filter-branch" now updates the working directory when it
47
+ has finished filtering the current branch.
48
+
49
+ * "git-instaweb" no longer fails on Mac OS X.
50
+
51
+ * "git-cvsexportcommit" didn't always create new parent directories
52
+ before trying to create new child directories. Fixed.
53
+
54
+ * "git-fetch" printed a scary (but bogus) error message while
55
+ fetching a tag that pointed to a tree or blob. The error did
56
+ not impact correctness, only user perception. The bogus error
57
+ is no longer printed.
58
+
59
+ * "git-ls-files --ignored" did not properly descend into non-ignored
60
+ directories that themselves contained ignored files if d_type
61
+ was not supported by the filesystem. This bug impacted systems
62
+ such as AFS. Fixed.
63
+
64
+ * Git segfaulted when reading an invalid .gitattributes file. Fixed.
65
+
66
+ * post-receive-email example hook was fixed for non-fast-forward
67
+ updates.
68
+
69
+ * Documentation updates for supported (but previously undocumented)
70
+ options of "git-archive" and "git-reflog".
71
+
72
+ * "make clean" no longer deletes the configure script that ships
73
+ with the git tarball, making multiple architecture builds easier.
74
+
75
+ * "git-remote show origin" spewed a warning message from Perl
76
+ when no remote is defined for the current branch via
77
+ branch.<name>.remote configuration settings.
78
+
79
+ * Building with NO_PERL_MAKEMAKER excessively rebuilt contents
80
+ of perl/ subdirectory by rewriting perl.mak.
81
+
82
+ * http.sslVerify configuration settings were not used in scripted
83
+ Porcelains.
84
+
85
+ * "git-add" leaked a bit of memory while scanning for files to add.
86
+
87
+ * A few workarounds to squelch false warnings from recent gcc have
88
+ been added.
89
+
90
+ * "git-send-pack $remote frotz" segfaulted when there is nothing
91
+ named 'frotz' on the local end.
92
+
93
+ * "git-rebase --interactive" did not handle its "--strategy" option
94
+ properly.
git/mingw64/share/doc/git-doc/RelNotes/1.5.3.6.adoc ADDED
@@ -0,0 +1,48 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.3.6 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.3.5
5
+ --------------------
6
+
7
+ * git-cvsexportcommit handles root commits better.
8
+
9
+ * git-svn dcommit used to clobber when sending a series of
10
+ patches.
11
+
12
+ * git-svn dcommit failed after attempting to rebase when
13
+ started with a dirty index; now it stops upfront.
14
+
15
+ * git-grep sometimes refused to work when your index was
16
+ unmerged.
17
+
18
+ * "git-grep -A1 -B2" acted as if it was told to run "git -A1 -B21".
19
+
20
+ * git-hash-object did not honor configuration variables, such as
21
+ core.compression.
22
+
23
+ * git-index-pack choked on a huge pack on 32-bit machines, even when
24
+ large file offsets are supported.
25
+
26
+ * atom feeds from git-web said "10" for the month of November.
27
+
28
+ * a memory leak in commit walker was plugged.
29
+
30
+ * When git-send-email inserted the original author's From:
31
+ address in body, it did not mark the message with
32
+ Content-type: as needed.
33
+
34
+ * git-revert and git-cherry-pick incorrectly refused to start
35
+ when the work tree was dirty.
36
+
37
+ * git-clean did not honor core.excludesfile configuration.
38
+
39
+ * git-add mishandled ".gitignore" files when applying them to
40
+ subdirectories.
41
+
42
+ * While importing a too branchy history, git-fastimport did not
43
+ honor delta depth limit properly.
44
+
45
+ * Support for zlib implementations that lack ZLIB_VERNUM and definition
46
+ of deflateBound() has been added.
47
+
48
+ * Quite a lot of documentation clarifications.
git/mingw64/share/doc/git-doc/RelNotes/1.5.3.7.adoc ADDED
@@ -0,0 +1,45 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.3.7 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.3.6
5
+ --------------------
6
+
7
+ * git-send-email added 8-bit contents to the payload without
8
+ marking it as 8-bit in a CTE header.
9
+
10
+ * "git-bundle create a.bndl HEAD" dereferenced the symref and
11
+ did not record the ref as 'HEAD'; this prevented a bundle
12
+ from being used as a normal source of git-clone.
13
+
14
+ * The code to reject nonsense command line of the form
15
+ "git-commit -a paths..." and "git-commit --interactive
16
+ paths..." were broken.
17
+
18
+ * Adding a signature that is not ASCII-only to an original
19
+ commit that is ASCII-only would make the result non-ASCII.
20
+ "git-format-patch -s" did not mark such a message correctly
21
+ with MIME encoding header.
22
+
23
+ * git-add sometimes did not mark the resulting index entry
24
+ stat-clean. This affected only cases when adding the
25
+ contents with the same length as the previously staged
26
+ contents, and the previous staging made the index entry
27
+ "racily clean".
28
+
29
+ * git-commit did not honor GIT_INDEX_FILE the user had in the
30
+ environment.
31
+
32
+ * When checking out a revision, git-checkout did not report where the
33
+ updated HEAD is if you happened to have a file called HEAD in the
34
+ work tree.
35
+
36
+ * "git-rev-list --objects" mishandled a tree that points at a
37
+ submodule.
38
+
39
+ * "git cvsimport" was not ready for packed refs that "git gc" can
40
+ produce and gave incorrect results.
41
+
42
+ * Many scripted Porcelains were confused when you happened to have a
43
+ file called "HEAD" in your work tree.
44
+
45
+ Also it contains updates to the user manual and documentation.
git/mingw64/share/doc/git-doc/RelNotes/1.5.3.8.adoc ADDED
@@ -0,0 +1,25 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.3.8 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.3.7
5
+ --------------------
6
+
7
+ * Some documentation used "email.com" as an example domain.
8
+
9
+ * git-svn fix to handle funky branch and project names going over
10
+ http/https correctly.
11
+
12
+ * git-svn fix to tone down a needlessly alarming warning message.
13
+
14
+ * git-clone did not correctly report errors while fetching over http.
15
+
16
+ * git-send-email added redundant Message-Id: header to the outgoing
17
+ e-mail when the patch text already had one.
18
+
19
+ * a read-beyond-end-of-buffer bug in configuration file updater was fixed.
20
+
21
+ * git-grep used to show the same hit repeatedly for unmerged paths.
22
+
23
+ * After amending the patch title in "git-am -i", the command did not
24
+ report the patch it applied with the updated title.
25
+
git/mingw64/share/doc/git-doc/RelNotes/1.5.3.adoc ADDED
@@ -0,0 +1,366 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.3 Release Notes
2
+ ========================
3
+
4
+ Updates since v1.5.2
5
+ --------------------
6
+
7
+ * The commit walkers other than http are officially deprecated,
8
+ but still supported for now.
9
+
10
+ * The submodule support has Porcelain layer.
11
+
12
+ Note that the current submodule support is minimal and this is
13
+ deliberately so. A design decision we made is that operations
14
+ at the supermodule level do not recurse into submodules by
15
+ default. The expectation is that later we would add a
16
+ mechanism to tell git which submodules the user is interested
17
+ in, and this information might be used to determine the
18
+ recursive behaviour of certain commands (e.g. "git checkout"
19
+ and "git diff"), but currently we haven't agreed on what that
20
+ mechanism should look like. Therefore, if you use submodules,
21
+ you would probably need "git submodule update" on the
22
+ submodules you care about after running a "git checkout" at
23
+ the supermodule level.
24
+
25
+ * There are a handful pack-objects changes to help you cope better
26
+ with repositories with pathologically large blobs in them.
27
+
28
+ * For people who need to import from Perforce, a front-end for
29
+ fast-import is in contrib/fast-import/.
30
+
31
+ * Comes with git-gui 0.8.2.
32
+
33
+ * Comes with updated gitk.
34
+
35
+ * New commands and options.
36
+
37
+ - "git log --date=<format>" can use more formats: iso8601, rfc2822.
38
+
39
+ - The hunk header output from "git diff" family can be customized
40
+ with the attributes mechanism. See gitattributes(5) for details.
41
+
42
+ - "git stash" allows you to quickly save away your work in
43
+ progress and replay it later on an updated state.
44
+
45
+ - "git rebase" learned an "interactive" mode that let you
46
+ pick and reorder which commits to rebuild.
47
+
48
+ - "git fsck" can save its findings in $GIT_DIR/lost-found, without a
49
+ separate invocation of "git lost-found" command. The blobs stored by
50
+ lost-found are stored in plain format to allow you to grep in them.
51
+
52
+ - $GIT_WORK_TREE environment variable can be used together with
53
+ $GIT_DIR to work in a subdirectory of a working tree that is
54
+ not located at "$GIT_DIR/..".
55
+
56
+ - Giving "--file=<file>" option to "git config" is the same as
57
+ running the command with GIT_CONFIG=<file> environment.
58
+
59
+ - "git log" learned a new option "--follow", to follow
60
+ renaming history of a single file.
61
+
62
+ - "git filter-branch" lets you rewrite the revision history of
63
+ specified branches. You can specify a number of filters to
64
+ modify the commits, files and trees.
65
+
66
+ - "git cvsserver" learned new options (--base-path, --export-all,
67
+ --strict-paths) inspired by "git daemon".
68
+
69
+ - "git daemon --base-path-relaxed" can help migrating a repository URL
70
+ that did not use to use --base-path to use --base-path.
71
+
72
+ - "git commit" can use "-t templatefile" option and commit.template
73
+ configuration variable to prime the commit message given to you in the
74
+ editor.
75
+
76
+ - "git submodule" command helps you manage the projects from
77
+ the superproject that contain them.
78
+
79
+ - In addition to core.compression configuration option,
80
+ core.loosecompression and pack.compression options can
81
+ independently tweak zlib compression levels used for loose
82
+ and packed objects.
83
+
84
+ - "git ls-tree -l" shows size of blobs pointed at by the
85
+ tree entries, similar to "/bin/ls -l".
86
+
87
+ - "git rev-list" learned --regexp-ignore-case and
88
+ --extended-regexp options to tweak its matching logic used
89
+ for --grep filtering.
90
+
91
+ - "git describe --contains" is a handier way to call more
92
+ obscure command "git name-rev --tags".
93
+
94
+ - "git gc --aggressive" tells the command to spend more cycles
95
+ to optimize the repository harder.
96
+
97
+ - "git repack" learned a "window-memory" limit which
98
+ dynamically reduces the window size to stay within the
99
+ specified memory usage.
100
+
101
+ - "git repack" can be told to split resulting packs to avoid
102
+ exceeding limit specified with "--max-pack-size".
103
+
104
+ - "git fsck" gained --verbose option. This is really really
105
+ verbose but it might help you identify exact commit that is
106
+ corrupt in your repository.
107
+
108
+ - "git format-patch" learned --numbered-files option. This
109
+ may be useful for MH users.
110
+
111
+ - "git format-patch" learned format.subjectprefix configuration
112
+ variable, which serves the same purpose as "--subject-prefix"
113
+ option.
114
+
115
+ - "git tag -n -l" shows tag annotations while listing tags.
116
+
117
+ - "git cvsimport" can optionally use the separate-remote layout.
118
+
119
+ - "git blame" can be told to see through commits that change
120
+ whitespaces and indentation levels with "-w" option.
121
+
122
+ - "git send-email" can be told not to thread the messages when
123
+ sending out more than one patches.
124
+
125
+ - "git send-email" can also be told how to find whom to cc the
126
+ message to for each message via --cc-cmd.
127
+
128
+ - "git config" learned NUL terminated output format via -z to
129
+ help scripts.
130
+
131
+ - "git add" learned "--refresh <paths>..." option to selectively refresh
132
+ the cached stat information.
133
+
134
+ - "git init -q" makes the command quieter.
135
+
136
+ - "git -p command" now has a cousin of opposite sex, "git --no-pager
137
+ command".
138
+
139
+ * Updated behavior of existing commands.
140
+
141
+ - "gitweb" can offer multiple snapshot formats.
142
+
143
+ ***NOTE*** Unfortunately, this changes the format of the
144
+ $feature{snapshot}{default} entry in the per-site
145
+ configuration file 'gitweb_config.perl'. It used to be a
146
+ three-element tuple that describe a single format; with the
147
+ new configuration item format, you only have to say the name
148
+ of the format ('tgz', 'tbz2' or 'zip'). Please update the
149
+ your configuration file accordingly.
150
+
151
+ - "git clone" uses -l (hardlink files under .git) by default when
152
+ cloning locally.
153
+
154
+ - URL used for "git clone" and friends can specify nonstandard SSH port
155
+ by using ssh://host:port/path/to/repo syntax.
156
+
157
+ - "git bundle create" can now create a bundle without negative refs,
158
+ i.e. "everything since the beginning up to certain points".
159
+
160
+ - "git diff" (but not the plumbing level "git diff-tree") now
161
+ recursively descends into trees by default.
162
+
163
+ - "git diff" does not show differences that come only from
164
+ stat-dirtiness in the form of "diff --git" header anymore.
165
+ It runs "update-index --refresh" silently as needed.
166
+
167
+ - "git tag -l" used to match tags by globbing its parameter as if it
168
+ has wildcard '*' on both ends, which made "git tag -l gui" to match
169
+ tag 'gitgui-0.7.0'; this was very annoying. You now have to add
170
+ asterisk on the sides you want to wildcard yourself.
171
+
172
+ - The editor to use with many interactive commands can be
173
+ overridden with GIT_EDITOR environment variable, or if it
174
+ does not exist, with core.editor configuration variable. As
175
+ before, if you have neither, environment variables VISUAL
176
+ and EDITOR are consulted in this order, and then finally we
177
+ fall back on "vi".
178
+
179
+ - "git rm --cached" does not complain when removing a newly
180
+ added file from the index anymore.
181
+
182
+ - Options to "git log" to affect how --grep/--author options look for
183
+ given strings now have shorter abbreviations. -i is for ignore case,
184
+ and -E is for extended regexp.
185
+
186
+ - "git log" learned --log-size to show the number of bytes in
187
+ the log message part of the output to help qgit.
188
+
189
+ - "git log --name-status" does not require you to give "-r" anymore.
190
+ As a general rule, Porcelain commands should recurse when showing
191
+ diff.
192
+
193
+ - "git format-patch --root A" can be used to format everything
194
+ since the beginning up to A. This was supported with
195
+ "git format-patch --root A A" for a long time, but was not
196
+ properly documented.
197
+
198
+ - "git svn dcommit" retains local merge information.
199
+
200
+ - "git svnimport" allows an empty string to be specified as the
201
+ trunk/ directory. This is necessary to suck data from a SVN
202
+ repository that doe not have trunk/ branches/ and tags/ organization
203
+ at all.
204
+
205
+ - "git config" to set values also honors type flags like --bool
206
+ and --int.
207
+
208
+ - core.quotepath configuration can be used to make textual git
209
+ output to emit most of the characters in the path literally.
210
+
211
+ - "git mergetool" chooses its backend more wisely, taking
212
+ notice of its environment such as use of X, Gnome/KDE, etc.
213
+
214
+ - "gitweb" shows merge commits a lot nicer than before. The
215
+ default view uses more compact --cc format, while the UI
216
+ allows to choose normal diff with any parent.
217
+
218
+ - snapshot files "gitweb" creates from a repository at
219
+ $path/$project/.git are more useful. We use $project part
220
+ in the filename, which we used to discard.
221
+
222
+ - "git cvsimport" creates lightweight tags; there is no
223
+ interesting information we can record in an annotated tag,
224
+ and the handcrafted ones the old code created was not
225
+ properly formed anyway.
226
+
227
+ - "git push" pretends that you immediately fetched back from
228
+ the remote by updating corresponding remote tracking
229
+ branches if you have any.
230
+
231
+ - The diffstat given after a merge (or a pull) honors the
232
+ color.diff configuration.
233
+
234
+ - "git commit --amend" is now compatible with various message source
235
+ options such as -m/-C/-c/-F.
236
+
237
+ - "git apply --whitespace=strip" removes blank lines added at
238
+ the end of the file.
239
+
240
+ - "git fetch" over git native protocols with "-v" option shows
241
+ connection status, and the IP address of the other end, to
242
+ help diagnosing problems.
243
+
244
+ - We used to have core.legacyheaders configuration, when
245
+ set to false, allowed git to write loose objects in a format
246
+ that mimics the format used by objects stored in packs. It
247
+ turns out that this was not so useful. Although we will
248
+ continue to read objects written in that format, we do not
249
+ honor that configuration anymore and create loose objects in
250
+ the legacy/traditional format.
251
+
252
+ - "--find-copies-harder" option to diff family can now be
253
+ spelled as "-C -C" for brevity.
254
+
255
+ - "git mailsplit" (hence "git am") can read from Maildir
256
+ formatted mailboxes.
257
+
258
+ - "git cvsserver" does not barf upon seeing "cvs login"
259
+ request.
260
+
261
+ - "pack-objects" honors "delta" attribute set in
262
+ .gitattributes. It does not attempt to deltify blobs that
263
+ come from paths with delta attribute set to false.
264
+
265
+ - "new-workdir" script (in contrib) can now be used with a
266
+ bare repository.
267
+
268
+ - "git mergetool" learned to use gvimdiff.
269
+
270
+ - "gitview" (in contrib) has a better blame interface.
271
+
272
+ - "git log" and friends did not handle a commit log message
273
+ that is larger than 16kB; they do now.
274
+
275
+ - "--pretty=oneline" output format for "git log" and friends
276
+ deals with "malformed" commit log messages that have more
277
+ than one lines in the first paragraph better. We used to
278
+ show the first line, cutting the title at mid-sentence; we
279
+ concatenate them into a single line and treat the result as
280
+ "oneline".
281
+
282
+ - "git p4import" has been demoted to contrib status. For
283
+ a superior option, checkout the "git p4" front end to
284
+ "git fast-import" (also in contrib). The man page and p4
285
+ rpm have been removed as well.
286
+
287
+ - "git mailinfo" (hence "am") now tries to see if the message
288
+ is in utf-8 first, instead of assuming iso-8859-1, if
289
+ incoming e-mail does not say what encoding it is in.
290
+
291
+ * Builds
292
+
293
+ - old-style function definitions (most notably, a function
294
+ without parameter defined with "func()", not "func(void)")
295
+ have been eradicated.
296
+
297
+ - "git tag" and "git verify-tag" have been rewritten in C.
298
+
299
+ * Performance Tweaks
300
+
301
+ - "git pack-objects" avoids re-deltification cost by caching
302
+ small enough delta results it creates while looking for the
303
+ best delta candidates.
304
+
305
+ - "git pack-objects" learned a new heuristic to prefer delta
306
+ that is shallower in depth over the smallest delta
307
+ possible. This improves both overall packfile access
308
+ performance and packfile density.
309
+
310
+ - diff-delta code that is used for packing has been improved
311
+ to work better on big files.
312
+
313
+ - when there are more than one pack files in the repository,
314
+ the runtime used to try finding an object always from the
315
+ newest packfile; it now tries the same packfile as we found
316
+ the object requested the last time, which exploits the
317
+ locality of references.
318
+
319
+ - verifying pack contents done by "git fsck --full" got boost
320
+ by carefully choosing the order to verify objects in them.
321
+
322
+ - "git read-tree -m" to read into an already populated index
323
+ has been optimized vastly. The effect of this can be seen
324
+ when switching branches that have differences in only a
325
+ handful paths.
326
+
327
+ - "git add paths..." and "git commit paths..." has also been
328
+ heavily optimized.
329
+
330
+ Fixes since v1.5.2
331
+ ------------------
332
+
333
+ All of the fixes in v1.5.2 maintenance series are included in
334
+ this release, unless otherwise noted.
335
+
336
+ * Bugfixes
337
+
338
+ - "gitweb" had trouble handling non UTF-8 text with older
339
+ Encode.pm Perl module.
340
+
341
+ - "git svn" misparsed the data from the commits in the repository when
342
+ the user had "color.diff = true" in the configuration. This has been
343
+ fixed.
344
+
345
+ - There was a case where "git svn dcommit" clobbered changes made on the
346
+ SVN side while committing multiple changes.
347
+
348
+ - "git-write-tree" had a bad interaction with racy-git avoidance and
349
+ gitattributes mechanisms.
350
+
351
+ - "git --bare command" overrode existing GIT_DIR setting and always
352
+ made it treat the current working directory as GIT_DIR.
353
+
354
+ - "git ls-files --error-unmatch" does not complain if you give the
355
+ same path pattern twice by mistake.
356
+
357
+ - "git init" autodetected core.filemode but not core.symlinks, which
358
+ made a new directory created automatically by "git clone" cumbersome
359
+ to use on filesystems that require these configurations to be set.
360
+
361
+ - "git log" family of commands behaved differently when run as "git
362
+ log" (no pathspec) and as "git log --" (again, no pathspec). This
363
+ inconsistency was introduced somewhere in v1.3.0 series but now has
364
+ been corrected.
365
+
366
+ - "git rebase -m" incorrectly displayed commits that were skipped.
git/mingw64/share/doc/git-doc/RelNotes/1.5.4.1.adoc ADDED
@@ -0,0 +1,17 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.4.1 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.4
5
+ ------------------
6
+
7
+ * "git-commit -C $tag" used to work but rewrite in C done in
8
+ 1.5.4 broke it.
9
+
10
+ * An entry in the .gitattributes file that names a pattern in a
11
+ subdirectory of the directory it is in did not match
12
+ correctly (e.g. pattern "b/*.c" in "a/.gitattributes" should
13
+ match "a/b/foo.c" but it didn't).
14
+
15
+ * Customized color specification was parsed incorrectly when
16
+ numeric color values are used. This was fixed in 1.5.4.1.
17
+
git/mingw64/share/doc/git-doc/RelNotes/1.5.4.2.adoc ADDED
@@ -0,0 +1,43 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.4.2 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.4
5
+ ------------------
6
+
7
+ * The configuration parser was not prepared to see string
8
+ valued variables misspelled as boolean and segfaulted.
9
+
10
+ * Temporary files left behind due to interrupted object
11
+ transfers were not cleaned up with "git prune".
12
+
13
+ * "git config --unset" was confused when the unset variables
14
+ were spelled with continuation lines in the config file.
15
+
16
+ * The merge message detection in "git cvsimport" did not catch
17
+ a message that began with "Merge...".
18
+
19
+ * "git status" suggests "git rm --cached" for unstaging the
20
+ earlier "git add" before the initial commit.
21
+
22
+ * "git status" output was incorrect during a partial commit.
23
+
24
+ * "git bisect" refused to start when the HEAD was detached.
25
+
26
+ * "git bisect" allowed a wildcard character in the commit
27
+ message expanded while writing its log file.
28
+
29
+ * Manual pages were not formatted correctly with docbook xsl
30
+ 1.72; added a workaround.
31
+
32
+ * "git-commit -C $tag" used to work but rewrite in C done in
33
+ 1.5.4 broke it. This was fixed in 1.5.4.1.
34
+
35
+ * An entry in the .gitattributes file that names a pattern in a
36
+ subdirectory of the directory it is in did not match
37
+ correctly (e.g. pattern "b/*.c" in "a/.gitattributes" should
38
+ match "a/b/foo.c" but it didn't). This was fixed in 1.5.4.1.
39
+
40
+ * Customized color specification was parsed incorrectly when
41
+ numeric color values are used. This was fixed in 1.5.4.1.
42
+
43
+ * http transport misbehaved when linked with curl-gnutls.
git/mingw64/share/doc/git-doc/RelNotes/1.5.4.3.adoc ADDED
@@ -0,0 +1,27 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.4.3 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.4.2
5
+ --------------------
6
+
7
+ * RPM spec used to pull in everything with 'git'. This has been
8
+ changed so that 'git' package contains just the core parts,
9
+ and we now supply 'git-all' metapackage to slurp in everything.
10
+ This should match end user's expectation better.
11
+
12
+ * When some refs failed to update, git-push reported "failure"
13
+ which was unclear if some other refs were updated or all of
14
+ them failed atomically (the answer is the former). Reworded
15
+ the message to clarify this.
16
+
17
+ * "git clone" from a repository whose HEAD was misconfigured
18
+ did not set up the remote properly. Now it tries to do
19
+ better.
20
+
21
+ * Updated git-push documentation to clarify what "matching"
22
+ means, in order to reduce user confusion.
23
+
24
+ * Updated git-add documentation to clarify "add -u" operates in
25
+ the current subdirectory you are in, just like other commands.
26
+
27
+ * git-gui updates to work on OSX and Windows better.
git/mingw64/share/doc/git-doc/RelNotes/1.5.4.4.adoc ADDED
@@ -0,0 +1,66 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.4.4 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.4.3
5
+ --------------------
6
+
7
+ * Building and installing with an overtight umask such as 077 made
8
+ installed templates unreadable by others, while the rest of the install
9
+ are done in a way that is friendly to umask 022.
10
+
11
+ * "git cvsexportcommit -w $cvsdir" misbehaved when GIT_DIR is set to a
12
+ relative directory.
13
+
14
+ * "git http-push" had an invalid memory access that could lead it to
15
+ segfault.
16
+
17
+ * When "git rebase -i" gave control back to the user for a commit that is
18
+ marked to be edited, it just said "modify it with commit --amend",
19
+ without saying what to do to continue after modifying it. Give an
20
+ explicit instruction to run "rebase --continue" to be more helpful.
21
+
22
+ * "git send-email" in 1.5.4.3 issued a bogus empty In-Reply-To: header.
23
+
24
+ * "git bisect" showed mysterious "won't bisect on seeked tree" error message.
25
+ This was leftover from Cogito days to prevent "bisect" starting from a
26
+ cg-seeked state. We still keep the Cogito safety, but running "git bisect
27
+ start" when another bisect was in effect will clean up and start over.
28
+
29
+ * "git push" with an explicit PATH to receive-pack did not quite work if
30
+ receive-pack was not on usual PATH. We earlier fixed the same issue
31
+ with "git fetch" and upload-pack, but somehow forgot to do so in the
32
+ other direction.
33
+
34
+ * git-gui's info dialog was not displayed correctly when the user tries
35
+ to commit nothing (i.e. without staging anything).
36
+
37
+ * "git revert" did not properly fail when attempting to run with a
38
+ dirty index.
39
+
40
+ * "git merge --no-commit --no-ff <other>" incorrectly made commits.
41
+
42
+ * "git merge --squash --no-ff <other>", which is a nonsense combination
43
+ of options, was not rejected.
44
+
45
+ * "git ls-remote" and "git remote show" against an empty repository
46
+ failed, instead of just giving an empty result (regression).
47
+
48
+ * "git fast-import" did not handle a renamed path whose name needs to be
49
+ quoted, due to a bug in unquote_c_style() function.
50
+
51
+ * "git cvsexportcommit" was confused when multiple files with the same
52
+ basename needed to be pushed out in the same commit.
53
+
54
+ * "git daemon" did not send early errors to syslog.
55
+
56
+ * "git log --merge" did not work well with --left-right option.
57
+
58
+ * "git svn" prompted for client cert password every time it accessed the
59
+ server.
60
+
61
+ * The reset command in "git fast-import" data stream was documented to
62
+ end with an optional LF, but it actually required one.
63
+
64
+ * "git svn dcommit/rebase" did not honor --rewrite-root option.
65
+
66
+ Also included are a handful documentation updates.
git/mingw64/share/doc/git-doc/RelNotes/1.5.4.5.adoc ADDED
@@ -0,0 +1,56 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.4.5 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.4.4
5
+ --------------------
6
+
7
+ * "git fetch there" when the URL information came from the Cogito style
8
+ branches/there file did not update refs/heads/there (regression in
9
+ 1.5.4).
10
+
11
+ * Bogus refspec configuration such as "remote.there.fetch = =" were not
12
+ detected as errors (regression in 1.5.4).
13
+
14
+ * You couldn't specify a custom editor whose path contains a whitespace
15
+ via GIT_EDITOR (and core.editor).
16
+
17
+ * The subdirectory filter to "git filter-branch" mishandled a history
18
+ where the subdirectory becomes empty and then later becomes non-empty.
19
+
20
+ * "git shortlog" gave an empty line if the original commit message was
21
+ malformed (e.g. a botched import from foreign SCM). Now it finds the
22
+ first non-empty line and uses it for better information.
23
+
24
+ * When the user fails to give a revision parameter to "git svn", an error
25
+ from the Perl interpreter was issued because the script lacked proper
26
+ error checking.
27
+
28
+ * After "git rebase" stopped due to conflicts, if the user played with
29
+ "git reset" and friends, "git rebase --abort" failed to go back to the
30
+ correct commit.
31
+
32
+ * Additional work trees prepared with git-new-workdir (in contrib/) did
33
+ not share git-svn metadata directory .git/svn with the original.
34
+
35
+ * "git-merge-recursive" did not mark addition of the same path with
36
+ different filemodes correctly as a conflict.
37
+
38
+ * "gitweb" gave malformed URL when pathinfo stype paths are in use.
39
+
40
+ * "-n" stands for "--no-tags" again for "git fetch".
41
+
42
+ * "git format-patch" did not detect the need to add 8-bit MIME header
43
+ when the user used format.header configuration.
44
+
45
+ * "rev~" revision specifier used to mean "rev", which was inconsistent
46
+ with how "rev^" worked. Now "rev~" is the same as "rev~1" (hence it
47
+ also is the same as "rev^1"), and "rev~0" is the same as "rev^0"
48
+ (i.e. it has to be a commit).
49
+
50
+ * "git quiltimport" did not grok empty lines, lines in "file -pNNN"
51
+ format to specify the prefix levels and lines with trailing comments.
52
+
53
+ * "git rebase -m" triggered pre-commit verification, which made
54
+ "rebase --continue" impossible.
55
+
56
+ As usual, it also comes with many documentation fixes and clarifications.
git/mingw64/share/doc/git-doc/RelNotes/1.5.4.6.adoc ADDED
@@ -0,0 +1,43 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.4.6 Release Notes
2
+ ==========================
3
+
4
+ I personally do not think there is any reason anybody should want to
5
+ run v1.5.4.X series these days, because 'master' version is always
6
+ more stable than any tagged released version of git.
7
+
8
+ This is primarily to futureproof "git-shell" to accept requests
9
+ without a dash between "git" and subcommand name (e.g. "git
10
+ upload-pack") which the newer client will start to make sometime in
11
+ the future.
12
+
13
+ Fixes since v1.5.4.5
14
+ --------------------
15
+
16
+ * Command line option "-n" to "git-repack" was not correctly parsed.
17
+
18
+ * Error messages from "git-apply" when the patchfile cannot be opened
19
+ have been improved.
20
+
21
+ * Error messages from "git-bisect" when given nonsense revisions have
22
+ been improved.
23
+
24
+ * reflog syntax that uses time e.g. "HEAD@{10 seconds ago}:path" did not
25
+ stop parsing at the closing "}".
26
+
27
+ * "git rev-parse --symbolic-full-name ^master^2" printed solitary "^",
28
+ but it should print nothing.
29
+
30
+ * "git apply" did not enforce "match at the beginning" correctly.
31
+
32
+ * a path specification "a/b" in .gitattributes file should not match
33
+ "sub/a/b", but it did.
34
+
35
+ * "git log --date-order --topo-order" did not override the earlier
36
+ date-order with topo-order as expected.
37
+
38
+ * "git fast-export" did not export octopus merges correctly.
39
+
40
+ * "git archive --prefix=$path/" mishandled gitattributes.
41
+
42
+ As usual, it also comes with many documentation fixes and clarifications.
43
+
git/mingw64/share/doc/git-doc/RelNotes/1.5.4.7.adoc ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.4.7 Release Notes
2
+ ==========================
3
+
4
+ Fixes since 1.5.4.7
5
+ -------------------
6
+
7
+ * Removed support for an obsolete gitweb request URI, whose
8
+ implementation ran "git diff" Porcelain, instead of using plumbing,
9
+ which would have run an external diff command specified in the
10
+ repository configuration as the gitweb user.
git/mingw64/share/doc/git-doc/RelNotes/1.5.4.adoc ADDED
@@ -0,0 +1,377 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.4 Release Notes
2
+ ========================
3
+
4
+ Removal
5
+ -------
6
+
7
+ * "git svnimport" was removed in favor of "git svn". It is still there
8
+ in the source tree (contrib/examples) but unsupported.
9
+
10
+ * As git-commit and git-status have been rewritten, "git runstatus"
11
+ helper script lost all its users and has been removed.
12
+
13
+
14
+ Temporarily disabled
15
+ --------------------
16
+
17
+ * "git http-push" is known not to work well with cURL library older
18
+ than 7.16, and we had reports of repository corruption. It is
19
+ disabled on such platforms for now. Unfortunately, 1.5.3.8 shares
20
+ the same issue. In other words, this does not mean you will be
21
+ fine if you stick to an older git release. For now, please do not
22
+ use http-push from older git with cURL older than 7.16 if you
23
+ value your data. A proper fix will hopefully materialize in
24
+ later versions.
25
+
26
+
27
+ Deprecation notices
28
+ -------------------
29
+
30
+ * From v1.6.0, git will by default install dashed form of commands
31
+ (e.g. "git-commit") outside of users' normal $PATH, and will install
32
+ only selected commands ("git" itself, and "gitk") in $PATH. This
33
+ implies:
34
+
35
+ - Using dashed forms of git commands (e.g. "git-commit") from the
36
+ command line has been informally deprecated since early 2006, but
37
+ now it officially is, and will be removed in the future. Use
38
+ dash-less forms (e.g. "git commit") instead.
39
+
40
+ - Using dashed forms from your scripts, without first prepending the
41
+ return value from "git --exec-path" to the scripts' PATH, has been
42
+ informally deprecated since early 2006, but now it officially is.
43
+
44
+ - Use of dashed forms with "PATH=$(git --exec-path):$PATH; export
45
+ PATH" early in your script is not deprecated with this change.
46
+
47
+ Users are strongly encouraged to adjust their habits and scripts now
48
+ to prepare for this change.
49
+
50
+ * The post-receive hook was introduced in March 2007 to supersede
51
+ the post-update hook, primarily to overcome the command line length
52
+ limitation of the latter. Use of post-update hook will be deprecated
53
+ in future versions of git, starting from v1.6.0.
54
+
55
+ * "git lost-found" was deprecated in favor of "git fsck"'s --lost-found
56
+ option, and will be removed in the future.
57
+
58
+ * "git peek-remote" is deprecated, as "git ls-remote" was written in C
59
+ and works for all transports; "git peek-remote" will be removed in
60
+ the future.
61
+
62
+ * "git repo-config" which was an old name for "git config" command
63
+ has been supported without being advertised for a long time. The
64
+ next feature release will remove it.
65
+
66
+ * From v1.6.0, the repack.usedeltabaseoffset config option will default
67
+ to true, which will give denser packfiles (i.e. more efficient storage).
68
+ The downside is that git older than version 1.4.4 will not be able
69
+ to directly use a repository packed using this setting.
70
+
71
+ * From v1.6.0, the pack.indexversion config option will default to 2,
72
+ which is slightly more efficient, and makes repacking more immune to
73
+ data corruptions. Git older than version 1.5.2 may revert to version 1
74
+ of the pack index with a manual "git index-pack" to be able to directly
75
+ access corresponding pack files.
76
+
77
+
78
+ Updates since v1.5.3
79
+ --------------------
80
+
81
+ * Comes with much improved gitk, with i18n.
82
+
83
+ * Comes with git-gui 0.9.2 with i18n.
84
+
85
+ * gitk is now merged as a subdirectory of git.git project, in
86
+ preparation for its i18n.
87
+
88
+ * progress displays from many commands are a lot nicer to the eye.
89
+ Transfer commands show throughput data.
90
+
91
+ * many commands that pay attention to per-directory .gitignore now do
92
+ so lazily, which makes the usual case go much faster.
93
+
94
+ * Output processing for '--pretty=format:<user format>' has been
95
+ optimized.
96
+
97
+ * Rename detection of diff family while detecting exact matches has
98
+ been greatly optimized.
99
+
100
+ * Rename detection of diff family tries to make more natural looking
101
+ pairing. Earlier, if multiple identical rename sources were
102
+ found in the preimage, the source used was picked pretty much at random.
103
+
104
+ * Value "true" for color.diff and color.status configuration used to
105
+ mean "always" (even when the output is not going to a terminal).
106
+ This has been corrected to mean the same thing as "auto".
107
+
108
+ * "git diff" Porcelain now respects diff.external configuration, which
109
+ is another way to specify GIT_EXTERNAL_DIFF.
110
+
111
+ * "git diff" can be told to use different prefixes other than
112
+ "a/" and "b/" e.g. "git diff --src-prefix=l/ --dst-prefix=k/".
113
+
114
+ * "git diff" sometimes did not quote paths with funny
115
+ characters properly.
116
+
117
+ * "git log" (and any revision traversal commands) misbehaved
118
+ when --diff-filter is given but was not asked to actually
119
+ produce diff.
120
+
121
+ * HTTP proxy can be specified per remote repository using
122
+ remote.*.httpproxy configuration, or global http.proxy configuration
123
+ variable.
124
+
125
+ * Various Perforce importer updates.
126
+
127
+ * Example update and post-receive hooks have been improved.
128
+
129
+ * Any command that wants to take a commit object name can now use
130
+ ":/string" syntax to name a commit.
131
+
132
+ * "git reset" is now built-in and its output can be squelched with -q.
133
+
134
+ * "git reset --hard" does not make any sense in a bare
135
+ repository, but did not error out; fixed.
136
+
137
+ * "git send-email" can optionally talk over ssmtp and use SMTP-AUTH.
138
+
139
+ * "git rebase" learned --whitespace option.
140
+
141
+ * In "git rebase", when you decide not to replay a particular change
142
+ after the command stopped with a conflict, you can say "git rebase
143
+ --skip" without first running "git reset --hard", as the command now
144
+ runs it for you.
145
+
146
+ * "git rebase --interactive" mode can now work on detached HEAD.
147
+
148
+ * Other minor to serious bugs in "git rebase -i" have been fixed.
149
+
150
+ * "git rebase" now detaches head during its operation, so after a
151
+ successful "git rebase" operation, the reflog entry branch@{1} for
152
+ the current branch points at the commit before the rebase was
153
+ started.
154
+
155
+ * "git rebase -i" also triggers rerere to help your repeated merges.
156
+
157
+ * "git merge" can call the "post-merge" hook.
158
+
159
+ * "git pack-objects" can optionally run deltification with multiple
160
+ threads.
161
+
162
+ * "git archive" can optionally substitute keywords in files marked with
163
+ export-subst attribute.
164
+
165
+ * "git cherry-pick" made a misguided attempt to repeat the original
166
+ command line in the generated log message, when told to cherry-pick a
167
+ commit by naming a tag that points at it. It does not anymore.
168
+
169
+ * "git for-each-ref" learned %(xxxdate:<date-format>) syntax to show the
170
+ various date fields in different formats.
171
+
172
+ * "git gc --auto" is a low-impact way to automatically run a variant of
173
+ "git repack" that does not lose unreferenced objects (read: safer
174
+ than the usual one) after the user accumulates too many loose
175
+ objects.
176
+
177
+ * "git clean" has been rewritten in C.
178
+
179
+ * You need to explicitly set clean.requireForce to "false" to allow
180
+ "git clean" without -f to do any damage (lack of the configuration
181
+ variable used to mean "do not require -f option to lose untracked
182
+ files", but we now use the safer default).
183
+
184
+ * The kinds of whitespace errors "git diff" and "git apply" notice (and
185
+ fix) can be controlled via 'core.whitespace' configuration variable
186
+ and 'whitespace' attribute in .gitattributes file.
187
+
188
+ * "git push" learned --dry-run option to show what would happen if a
189
+ push is run.
190
+
191
+ * "git push" does not update a tracking ref on the local side when the
192
+ remote refused to update the corresponding ref.
193
+
194
+ * "git push" learned --mirror option. This is to push the local refs
195
+ one-to-one to the remote, and deletes refs from the remote that do
196
+ not exist anymore in the repository on the pushing side.
197
+
198
+ * "git push" can remove a corrupt ref at the remote site with the usual
199
+ ":ref" refspec.
200
+
201
+ * "git remote" knows --mirror mode. This is to set up configuration to
202
+ push into a remote repository to store local branch heads to the same
203
+ branch on the remote side, and remove branch heads locally removed
204
+ from local repository at the same time. Suitable for pushing into a
205
+ back-up repository.
206
+
207
+ * "git remote" learned "rm" subcommand.
208
+
209
+ * "git cvsserver" can be run via "git shell". Also, "cvs" is
210
+ recognized as a synonym for "git cvsserver", so that CVS users
211
+ can be switched to git just by changing their login shell.
212
+
213
+ * "git cvsserver" acts more like receive-pack by running post-receive
214
+ and post-update hooks.
215
+
216
+ * "git am" and "git rebase" are far less verbose.
217
+
218
+ * "git pull" learned to pass --[no-]ff option to underlying "git
219
+ merge".
220
+
221
+ * "git pull --rebase" is a different way to integrate what you fetched
222
+ into your current branch.
223
+
224
+ * "git fast-export" produces data-stream that can be fed to fast-import
225
+ to reproduce the history recorded in a git repository.
226
+
227
+ * "git add -i" takes pathspecs to limit the set of files to work on.
228
+
229
+ * "git add -p" is a short-hand to go directly to the selective patch
230
+ subcommand in the interactive command loop and to exit when done.
231
+
232
+ * "git add -i" UI has been colorized. The interactive prompt
233
+ and menu can be colored by setting color.interactive
234
+ configuration. The diff output (including the hunk picker)
235
+ are colored with color.diff configuration.
236
+
237
+ * "git commit --allow-empty" allows you to create a single-parent
238
+ commit that records the same tree as its parent, overriding the usual
239
+ safety valve.
240
+
241
+ * "git commit --amend" can amend a merge that does not change the tree
242
+ from its first parent.
243
+
244
+ * "git commit" used to unconditionally strip comment lines that
245
+ began with '#' and removed excess blank lines. This behavior has
246
+ been made configurable.
247
+
248
+ * "git commit" has been rewritten in C.
249
+
250
+ * "git stash random-text" does not create a new stash anymore. It was
251
+ a UI mistake. Use "git stash save random-text", or "git stash"
252
+ (without extra args) for that.
253
+
254
+ * "git stash clear extra-text" does not clear the whole stash
255
+ anymore. It is tempting to expect "git stash clear stash@{2}"
256
+ to drop only a single named stash entry, and it is rude to
257
+ discard everything when that is asked (but not provided).
258
+
259
+ * "git prune --expire <time>" can exempt young loose objects from
260
+ getting pruned.
261
+
262
+ * "git branch --contains <commit>" can list branches that are
263
+ descendants of a given commit.
264
+
265
+ * "git log" learned --early-output option to help interactive GUI
266
+ implementations.
267
+
268
+ * "git bisect" learned "skip" action to mark untestable commits.
269
+
270
+ * "git bisect visualize" learned a shorter synonym "git bisect view".
271
+
272
+ * "git bisect visualize" runs "git log" in a non-windowed
273
+ environments. It also can be told what command to run (e.g. "git
274
+ bisect visualize tig").
275
+
276
+ * "git format-patch" learned "format.numbered" configuration variable
277
+ to automatically turn --numbered option on when more than one commits
278
+ are formatted.
279
+
280
+ * "git ls-files" learned "--exclude-standard" to use the canned set of
281
+ exclude files.
282
+
283
+ * "git tag -a -f existing" begins the editor session using the existing
284
+ annotation message.
285
+
286
+ * "git tag -m one -m bar" (multiple -m options) behaves similarly to
287
+ "git commit"; the parameters to -m options are formatted as separate
288
+ paragraphs.
289
+
290
+ * The format "git show" outputs an annotated tag has been updated to
291
+ include "Tagger: " and "Date: " lines from the tag itself. Strictly
292
+ speaking this is a backward incompatible change, but this is a
293
+ reasonable usability fix and people's scripts shouldn't have been
294
+ relying on the exact output from "git show" Porcelain anyway.
295
+
296
+ * "git cvsimport" did not notice errors from underlying "cvsps"
297
+ and produced a corrupt import silently.
298
+
299
+ * "git cvsexportcommit" learned -w option to specify and switch to the
300
+ CVS working directory.
301
+
302
+ * "git checkout" from a subdirectory learned to use "../path" to allow
303
+ checking out a path outside the current directory without cd'ing up.
304
+
305
+ * "git checkout" from and to detached HEAD leaves a bit more
306
+ information in the reflog.
307
+
308
+ * "git send-email --dry-run" shows full headers for easier diagnosis.
309
+
310
+ * "git merge-ours" is now built-in.
311
+
312
+ * "git svn" learned "info" and "show-externals" subcommands.
313
+
314
+ * "git svn" run from a subdirectory failed to read settings from the
315
+ .git/config.
316
+
317
+ * "git svn" learned --use-log-author option, which picks up more
318
+ descriptive name from From: and Signed-off-by: lines in the commit
319
+ message.
320
+
321
+ * "git svn" wasted way too much disk to record revision mappings
322
+ between svn and git; a new representation that is much more compact
323
+ for this information has been introduced to correct this.
324
+
325
+ * "git svn" left temporary index files it used without cleaning them
326
+ up; this was corrected.
327
+
328
+ * "git status" from a subdirectory now shows relative paths, which
329
+ makes copy-and-pasting for git-checkout/git-add/git-rm easier. The
330
+ traditional behavior to show the full path relative to the top of
331
+ the work tree can be had by setting status.relativepaths
332
+ configuration variable to false.
333
+
334
+ * "git blame" kept text for each annotated revision in core needlessly;
335
+ this has been corrected.
336
+
337
+ * "git shortlog" learned to default to HEAD when the standard input is
338
+ a terminal and the user did not give any revision parameter.
339
+
340
+ * "git shortlog" learned "-e" option to show e-mail addresses as well as
341
+ authors' names.
342
+
343
+ * "git help" learned "-w" option to show documentation in browsers.
344
+
345
+ * In addition there are quite a few internal clean-ups. Notably:
346
+
347
+ - many fork/exec have been replaced with run-command API,
348
+ brought from the msysgit effort.
349
+
350
+ - introduction and more use of the option parser API.
351
+
352
+ - enhancement and more use of the strbuf API.
353
+
354
+ * Makefile tweaks to support HP-UX is in.
355
+
356
+ Fixes since v1.5.3
357
+ ------------------
358
+
359
+ All of the fixes in v1.5.3 maintenance series are included in
360
+ this release, unless otherwise noted.
361
+
362
+ These fixes are only in v1.5.4 and not backported to v1.5.3 maintenance
363
+ series.
364
+
365
+ * The way "git diff --check" behaves is much more consistent with the way
366
+ "git apply --whitespace=warn" works.
367
+
368
+ * "git svn" talking with the SVN over HTTP will correctly quote branch
369
+ and project names.
370
+
371
+ * "git config" did not work correctly on platforms that define
372
+ REG_NOMATCH to an even number.
373
+
374
+ * Recent versions of AsciiDoc 8 has a change to break our
375
+ documentation; a workaround has been implemented.
376
+
377
+ * "git diff --color-words" colored context lines in a wrong color.
git/mingw64/share/doc/git-doc/RelNotes/1.5.5.1.adoc ADDED
@@ -0,0 +1,44 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.5.1 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.5
5
+ ------------------
6
+
7
+ * "git archive --prefix=$path/" mishandled gitattributes.
8
+
9
+ * "git fetch -v" that fetches into FETCH_HEAD did not report the summary
10
+ the same way as done for updating the tracking refs.
11
+
12
+ * "git svn" misbehaved when the configuration file customized the "git
13
+ log" output format using format.pretty.
14
+
15
+ * "git submodule status" leaked an unnecessary error message.
16
+
17
+ * "git log --date-order --topo-order" did not override the earlier
18
+ date-order with topo-order as expected.
19
+
20
+ * "git bisect good $this" did not check the validity of the revision
21
+ given properly.
22
+
23
+ * "url.<there>.insteadOf" did not work correctly.
24
+
25
+ * "git clean" ran inside subdirectory behaved as if the directory was
26
+ explicitly specified for removal by the end user from the top level.
27
+
28
+ * "git bisect" from a detached head leaked an unnecessary error message.
29
+
30
+ * "git bisect good $a $b" when $a is Ok but $b is bogus should have
31
+ atomically failed before marking $a as good.
32
+
33
+ * "git fmt-merge-msg" did not clean up leading empty lines from commit
34
+ log messages like "git log" family does.
35
+
36
+ * "git am" recorded a commit with empty Subject: line without
37
+ complaining.
38
+
39
+ * when given a commit log message whose first paragraph consists of
40
+ multiple lines, "git rebase" squashed it into a single line.
41
+
42
+ * "git remote add $bogus_name $url" did not complain properly.
43
+
44
+ Also comes with various documentation updates.
git/mingw64/share/doc/git-doc/RelNotes/1.5.5.2.adoc ADDED
@@ -0,0 +1,27 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.5.2 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.5.1
5
+ --------------------
6
+
7
+ * "git repack -n" was mistakenly made no-op earlier.
8
+
9
+ * "git imap-send" wanted to always have imap.host even when use of
10
+ imap.tunnel made it unnecessary.
11
+
12
+ * reflog syntax that uses time e.g. "HEAD@{10 seconds ago}:path" did not
13
+ stop parsing at the closing "}".
14
+
15
+ * "git rev-parse --symbolic-full-name ^master^2" printed solitary "^",
16
+ but it should print nothing.
17
+
18
+ * "git commit" did not detect when it failed to write tree objects.
19
+
20
+ * "git fetch" sometimes transferred too many objects unnecessarily.
21
+
22
+ * a path specification "a/b" in .gitattributes file should not match
23
+ "sub/a/b".
24
+
25
+ * various gitweb fixes.
26
+
27
+ Also comes with various documentation updates.
git/mingw64/share/doc/git-doc/RelNotes/1.5.5.3.adoc ADDED
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.5.3 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.5.2
5
+ --------------------
6
+
7
+ * "git send-email --compose" did not notice that non-ascii contents
8
+ needed some MIME magic.
9
+
10
+ * "git fast-export" did not export octopus merges correctly.
11
+
12
+ Also comes with various documentation updates.
git/mingw64/share/doc/git-doc/RelNotes/1.5.5.4.adoc ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ GIT v1.5.5.4 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.5.4
5
+ --------------------
6
+
7
+ * "git name-rev --all" used to segfault.
git/mingw64/share/doc/git-doc/RelNotes/1.5.5.5.adoc ADDED
@@ -0,0 +1,11 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.5.5 Release Notes
2
+ ==========================
3
+
4
+ I personally do not think there is any reason anybody should want to
5
+ run v1.5.5.X series these days, because 'master' version is always
6
+ more stable than any tagged released version of git.
7
+
8
+ This is primarily to futureproof "git-shell" to accept requests
9
+ without a dash between "git" and subcommand name (e.g. "git
10
+ upload-pack") which the newer client will start to make sometime in
11
+ the future.
git/mingw64/share/doc/git-doc/RelNotes/1.5.5.6.adoc ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.5.6 Release Notes
2
+ ==========================
3
+
4
+ Fixes since 1.5.5.5
5
+ -------------------
6
+
7
+ * Removed support for an obsolete gitweb request URI, whose
8
+ implementation ran "git diff" Porcelain, instead of using plumbing,
9
+ which would have run an external diff command specified in the
10
+ repository configuration as the gitweb user.
git/mingw64/share/doc/git-doc/RelNotes/1.5.5.adoc ADDED
@@ -0,0 +1,207 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.5 Release Notes
2
+ ========================
3
+
4
+ Updates since v1.5.4
5
+ --------------------
6
+
7
+ (subsystems)
8
+
9
+ * Comes with git-gui 0.10.1
10
+
11
+ (portability)
12
+
13
+ * We shouldn't ask for BSD group ownership semantics by setting g+s bit
14
+ on directories on older BSD systems that refuses chmod() by non root
15
+ users. BSD semantics is the default there anyway.
16
+
17
+ * Bunch of portability improvement patches coming from an effort to port
18
+ to Solaris has been applied.
19
+
20
+ (performance)
21
+
22
+ * On platforms with suboptimal qsort(3) implementation, there
23
+ is an option to use more reasonable substitute we ship with
24
+ our software.
25
+
26
+ * New configuration variable "pack.packsizelimit" can be used
27
+ in place of command line option --max-pack-size.
28
+
29
+ * "git fetch" over the native git protocol used to make a
30
+ connection to find out the set of current remote refs and
31
+ another to actually download the pack data. We now use only
32
+ one connection for these tasks.
33
+
34
+ * "git commit" does not run lstat(2) more than necessary
35
+ anymore.
36
+
37
+ (usability, bells and whistles)
38
+
39
+ * Bash completion script (in contrib) are aware of more commands and
40
+ options.
41
+
42
+ * You can be warned when core.autocrlf conversion is applied in
43
+ such a way that results in an irreversible conversion.
44
+
45
+ * A catch-all "color.ui" configuration variable can be used to
46
+ enable coloring of all color-capable commands, instead of
47
+ individual ones such as "color.status" and "color.branch".
48
+
49
+ * The commands refused to take absolute pathnames where they
50
+ require pathnames relative to the work tree or the current
51
+ subdirectory. They now can take absolute pathnames in such a
52
+ case as long as the pathnames do not refer outside of the
53
+ work tree. E.g. "git add $(pwd)/foo" now works.
54
+
55
+ * Error messages used to be sent to stderr, only to get hidden,
56
+ when $PAGER was in use. They now are sent to stdout along
57
+ with the command output to be shown in the $PAGER.
58
+
59
+ * A pattern "foo/" in .gitignore file now matches a directory
60
+ "foo". Pattern "foo" also matches as before.
61
+
62
+ * bash completion's prompt helper function can talk about
63
+ operation in-progress (e.g. merge, rebase, etc.).
64
+
65
+ * Configuration variables "url.<usethis>.insteadof = <otherurl>" can be
66
+ used to tell "git-fetch" and "git-push" to use different URL than what
67
+ is given from the command line.
68
+
69
+ * "git add -i" behaves better even before you make an initial commit.
70
+
71
+ * "git am" refused to run from a subdirectory without a good reason.
72
+
73
+ * After "git apply --whitespace=fix" fixes whitespace errors in a patch,
74
+ a line before the fix can appear as a context or preimage line in a
75
+ later patch, causing the patch not to apply. The command now knows to
76
+ see through whitespace fixes done to context lines to successfully
77
+ apply such a patch series.
78
+
79
+ * "git branch" (and "git checkout -b") to branch from a local branch can
80
+ optionally set "branch.<name>.merge" to mark the new branch to build on
81
+ the other local branch, when "branch.autosetupmerge" is set to
82
+ "always", or when passing the command line option "--track" (this option
83
+ was ignored when branching from local branches). By default, this does
84
+ not happen when branching from a local branch.
85
+
86
+ * "git checkout" to switch to a branch that has "branch.<name>.merge" set
87
+ (i.e. marked to build on another branch) reports how much the branch
88
+ and the other branch diverged.
89
+
90
+ * When "git checkout" has to update a lot of paths, it used to be silent
91
+ for 4 seconds before it showed any progress report. It is now a bit
92
+ more impatient and starts showing progress report early.
93
+
94
+ * "git commit" learned a new hook "prepare-commit-msg" that can
95
+ inspect what is going to be committed and prepare the commit
96
+ log message template to be edited.
97
+
98
+ * "git cvsimport" can now take more than one -M options.
99
+
100
+ * "git describe" learned to limit the tags to be used for
101
+ naming with --match option.
102
+
103
+ * "git describe --contains" now barfs when the named commit
104
+ cannot be described.
105
+
106
+ * "git describe --exact-match" describes only commits that are tagged.
107
+
108
+ * "git describe --long" describes a tagged commit as $tag-0-$sha1,
109
+ instead of just showing the exact tagname.
110
+
111
+ * "git describe" warns when using a tag whose name and path contradict
112
+ with each other.
113
+
114
+ * "git diff" learned "--relative" option to limit and output paths
115
+ relative to the current directory when working in a subdirectory.
116
+
117
+ * "git diff" learned "--dirstat" option to show birds-eye-summary of
118
+ changes more concisely than "--diffstat".
119
+
120
+ * "git format-patch" learned --cover-letter option to generate a cover
121
+ letter template.
122
+
123
+ * "git gc" learned --quiet option.
124
+
125
+ * "git gc" now automatically prunes unreachable objects that are two
126
+ weeks old or older.
127
+
128
+ * "git gc --auto" can be disabled more easily by just setting gc.auto
129
+ to zero. It also tolerates more packfiles by default.
130
+
131
+ * "git grep" now knows "--name-only" is a synonym for the "-l" option.
132
+
133
+ * "git help <alias>" now reports "'git <alias>' is alias to <what>",
134
+ instead of saying "No manual entry for git-<alias>".
135
+
136
+ * "git help" can use different backends to show manual pages and this can
137
+ be configured using "man.viewer" configuration.
138
+
139
+ * "gitk" does not restore window position from $HOME/.gitk anymore (it
140
+ still restores the size).
141
+
142
+ * "git log --grep=<what>" learned "--fixed-strings" option to look for
143
+ <what> without treating it as a regular expression.
144
+
145
+ * "git gui" learned an auto-spell checking.
146
+
147
+ * "git push <somewhere> HEAD" and "git push <somewhere> +HEAD" works as
148
+ expected; they push the current branch (and only the current branch).
149
+ In addition, HEAD can be written as the value of "remote.<there>.push"
150
+ configuration variable.
151
+
152
+ * When the configuration variable "pack.threads" is set to 0, "git
153
+ repack" auto detects the number of CPUs and uses that many threads.
154
+
155
+ * "git send-email" learned to prompt for passwords
156
+ interactively.
157
+
158
+ * "git send-email" learned an easier way to suppress CC
159
+ recipients.
160
+
161
+ * "git stash" learned "pop" command, that applies the latest stash and
162
+ removes it from the stash, and "drop" command to discard the named
163
+ stash entry.
164
+
165
+ * "git submodule" learned a new subcommand "summary" to show the
166
+ symmetric difference between the HEAD version and the work tree version
167
+ of the submodule commits.
168
+
169
+ * Various "git cvsimport", "git cvsexportcommit", "git cvsserver",
170
+ "git svn" and "git p4" improvements.
171
+
172
+ (internal)
173
+
174
+ * Duplicated code between git-help and git-instaweb that
175
+ launches user's preferred browser has been refactored.
176
+
177
+ * It is now easier to write test scripts that records known
178
+ breakages.
179
+
180
+ * "git checkout" is rewritten in C.
181
+
182
+ * "git remote" is rewritten in C.
183
+
184
+ * Two conflict hunks that are separated by a very short span of common
185
+ lines are now coalesced into one larger hunk, to make the result easier
186
+ to read.
187
+
188
+ * Run-command API's use of file descriptors is documented clearer and
189
+ is more consistent now.
190
+
191
+ * diff output can be sent to FILE * that is different from stdout. This
192
+ will help reimplementing more things in C.
193
+
194
+ Fixes since v1.5.4
195
+ ------------------
196
+
197
+ All of the fixes in v1.5.4 maintenance series are included in
198
+ this release, unless otherwise noted.
199
+
200
+ * "git-http-push" did not allow deletion of remote ref with the usual
201
+ "push <remote> :<branch>" syntax.
202
+
203
+ * "git-rebase --abort" did not go back to the right location if
204
+ "git-reset" was run during the "git-rebase" session.
205
+
206
+ * "git imap-send" without setting imap.host did not error out but
207
+ segfaulted.
git/mingw64/share/doc/git-doc/RelNotes/1.5.6.1.adoc ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GIT v1.5.6.1 Release Notes
2
+ ==========================
3
+
4
+ Fixes since v1.5.6
5
+ ------------------
6
+
7
+ * Last minute change broke loose object creation on AIX.
8
+
9
+ * (performance fix) We used to make $GIT_DIR absolute path early in the
10
+ programs but keeping it relative to the current directory internally
11
+ gives 1-3 per-cent performance boost.
12
+
13
+ * bash completion knows the new --graph option to git-log family.
14
+
15
+
16
+ * git-diff -c/--cc showed unnecessary "deletion" lines at the context
17
+ boundary.
18
+
19
+ * git-for-each-ref ignored %(object) and %(type) requests for tag
20
+ objects.
21
+
22
+ * git-merge usage had a typo.
23
+
24
+ * Rebuilding of git-svn metainfo database did not take rewriteRoot
25
+ option into account.
26
+
27
+ * Running "git-rebase --continue/--skip/--abort" before starting a
28
+ rebase gave nonsense error messages.