freshlybakedca.ke
Git fork
Merge branch 'kj/my-first-contribution-updates'
Doc updates.
* kj/my-first-contribution-updates:
docs: replace git_config to repo_config
docs: clarify cmd_psuh signature and explain UNUSED macro
docs: remove unused mentoring mailing list reference
+33
-22
Documentation/MyFirstContribution.adoc
+33
-22
Documentation/MyFirstContribution.adoc
···
40
40
The https://lore.kernel.org/git[archive] of this mailing list is
41
41
available to view in a browser.
42
42
43
-
==== https://groups.google.com/forum/#!forum/git-mentoring[git-mentoring@googlegroups.com]
44
-
45
-
This mailing list is targeted to new contributors and was created as a place to
46
-
post questions and receive answers outside of the public eye of the main list.
47
-
Veteran contributors who are especially interested in helping mentor newcomers
48
-
are present on the list. In order to avoid search indexers, group membership is
49
-
required to view messages; anyone can join and no approval is required.
50
-
51
43
==== https://web.libera.chat/#git-devel[#git-devel] on Libera Chat
52
44
53
45
This IRC channel is for conversations between Git contributors. If someone is
···
150
142
point for your command in a function matching the style and signature:
151
143
152
144
----
153
-
int cmd_psuh(int argc, const char **argv, const char *prefix)
145
+
int cmd_psuh(int argc UNUSED, const char **argv UNUSED,
146
+
const char *prefix UNUSED, struct repository *repo UNUSED)
154
147
----
155
148
149
+
A few things to note:
150
+
151
+
* A subcommand implementation takes its command line arguments
152
+
in `int argc` + `const char **argv`, like `main()` would.
153
+
154
+
* It also takes two extra parameters, `prefix` and `repo`. What
155
+
they mean will not be discussed until much later.
156
+
157
+
* Because this first example will not use any of the parameters,
158
+
your compiler will give warnings on unused parameters. As the
159
+
list of these four parameters is mandated by the API to add
160
+
new built-in commands, you cannot omit them. Instead, you add
161
+
`UNUSED` to each of them to tell the compiler that you *know*
162
+
you are not (yet) using it.
163
+
156
164
We'll also need to add the declaration of psuh; open up `builtin.h`, find the
157
165
declaration for `cmd_pull`, and add a new line for `psuh` immediately before it,
158
166
in order to keep the declarations alphabetically sorted:
159
167
160
168
----
161
-
int cmd_psuh(int argc, const char **argv, const char *prefix);
169
+
int cmd_psuh(int argc, const char **argv, const char *prefix, struct repository *repo);
162
170
----
163
171
164
172
Be sure to `#include "builtin.h"` in your `psuh.c`. You'll also need to
···
174
182
should also do so when writing your user-facing commands in the future.
175
183
176
184
----
177
-
int cmd_psuh(int argc, const char **argv, const char *prefix)
185
+
int cmd_psuh(int argc UNUSED, const char **argv UNUSED,
186
+
const char *prefix UNUSED, struct repository *repo UNUSED)
178
187
{
179
188
printf(_("Pony saying hello goes here.\n"));
180
189
return 0;
···
287
296
It's probably useful to do at least something besides printing out a string.
288
297
Let's start by having a look at everything we get.
289
298
290
-
Modify your `cmd_psuh` implementation to dump the args you're passed, keeping
291
-
existing `printf()` calls in place:
299
+
Modify your `cmd_psuh` implementation to dump the args you're passed,
300
+
keeping existing `printf()` calls in place; because the args are now
301
+
used, remove the `UNUSED` macro from them:
292
302
293
303
----
294
304
int i;
···
312
322
for you, try `cd Documentation/ && ../bin-wrappers/git psuh`). That's not so
313
323
helpful. So what other context can we get?
314
324
315
-
Add a line to `#include "config.h"`. Then, add the following bits to the
325
+
Add a line to `#include "config.h"` and `#include "repository.h"`.
326
+
Then, add the following bits to the function body:
316
327
function body:
317
328
318
329
----
···
320
331
321
332
...
322
333
323
-
git_config(git_default_config, NULL);
324
-
if (git_config_get_string_tmp("user.name", &cfg_name) > 0)
334
+
repo_config(repo, git_default_config, NULL);
335
+
if (repo_config_get_string_tmp(repo, "user.name", &cfg_name))
325
336
printf(_("No name is found in config\n"));
326
337
else
327
338
printf(_("Your name: %s\n"), cfg_name);
328
339
----
329
340
330
-
`git_config()` will grab the configuration from config files known to Git and
331
-
apply standard precedence rules. `git_config_get_string_tmp()` will look up
341
+
`repo_config()` will grab the configuration from config files known to Git and
342
+
apply standard precedence rules. `repo_config_get_string_tmp()` will look up
332
343
a specific key ("user.name") and give you the value. There are a number of
333
344
single-key lookup functions like this one; you can see them all (and more info
334
-
about how to use `git_config()`) in `Documentation/technical/api-config.adoc`.
345
+
about how to use `repo_config()`) in `Documentation/technical/api-config.adoc`.
335
346
336
347
You should see that the name printed matches the one you see when you run:
337
348
···
364
375
----
365
376
366
377
But as we drill down, we can find that `status_init_config()` wraps a call
367
-
to `git_config()`. Let's modify the code we wrote in the previous commit.
378
+
to `repo_config()`. Let's modify the code we wrote in the previous commit.
368
379
369
380
Be sure to include the header to allow you to use `struct wt_status`:
370
381
···
380
391
381
392
...
382
393
383
-
wt_status_prepare(the_repository, &status);
384
-
git_config(git_default_config, &status);
394
+
wt_status_prepare(repo, &status);
395
+
repo_config(repo, git_default_config, &status);
385
396
386
397
...
387
398