Autogenerated HTML docs for v2.49.0-720-g34673c

Author: gitster

MyFirstContribution.adoc

@@ -40,14 +40,6 @@ the list by sending an email to <[email protected]>
 The https://lore.kernel.org/git[archive] of this mailing list is
 available to view in a browser.
 
-==== https://groups.google.com/forum/#!forum/git-mentoring[[email protected]]
-
-This mailing list is targeted to new contributors and was created as a place to
-post questions and receive answers outside of the public eye of the main list.
-Veteran contributors who are especially interested in helping mentor newcomers
-are present on the list. In order to avoid search indexers, group membership is
-required to view messages; anyone can join and no approval is required.
-
 ==== https://web.libera.chat/#git-devel[#git-devel] on Libera Chat
 
 This IRC channel is for conversations between Git contributors. If someone is
@@ -150,15 +142,31 @@ command in `builtin/psuh.c`. Create that file, and within it, write the entry
 point for your command in a function matching the style and signature:
 
 ----
-int cmd_psuh(int argc, const char **argv, const char *prefix)
+int cmd_psuh(int argc UNUSED, const char **argv UNUSED,
+	     const char *prefix UNUSED, struct repository *repo UNUSED)
 ----
 
+A few things to note:
+
+* A subcommand implementation takes its command line arguments
+  in `int argc` + `const char **argv`, like `main()` would.
+
+* It also takes two extra parameters, `prefix` and `repo`. What
+  they mean will not be discussed until much later.
+
+* Because this first example will not use any of the parameters,
+  your compiler will give warnings on unused parameters. As the
+  list of these four parameters is mandated by the API to add
+  new built-in commands, you cannot omit them. Instead, you add
+  `UNUSED` to each of them to tell the compiler that you *know*
+  you are not (yet) using it.
+
 We'll also need to add the declaration of psuh; open up `builtin.h`, find the
 declaration for `cmd_pull`, and add a new line for `psuh` immediately before it,
 in order to keep the declarations alphabetically sorted:
 
 ----
-int cmd_psuh(int argc, const char **argv, const char *prefix);
+int cmd_psuh(int argc, const char **argv, const char *prefix, struct repository *repo);
 ----
 
 Be sure to `#include "builtin.h"` in your `psuh.c`. You'll also need to
@@ -174,7 +182,8 @@ Throughout the tutorial, we will mark strings for translation as necessary; you
 should also do so when writing your user-facing commands in the future.
 
 ----
-int cmd_psuh(int argc, const char **argv, const char *prefix)
+int cmd_psuh(int argc UNUSED, const char **argv UNUSED,
+	     const char *prefix UNUSED, struct repository *repo UNUSED)
 {
 	printf(_("Pony saying hello goes here.\n"));
 	return 0;
@@ -287,8 +296,9 @@ on the reference implementation linked at the top of this document.
 It's probably useful to do at least something besides printing out a string.
 Let's start by having a look at everything we get.
 
-Modify your `cmd_psuh` implementation to dump the args you're passed, keeping
-existing `printf()` calls in place:
+Modify your `cmd_psuh` implementation to dump the args you're passed,
+keeping existing `printf()` calls in place; because the args are now
+used, remove the `UNUSED` macro from them:
 
 ----
 	int i;
@@ -312,26 +322,27 @@ on the command line, including the name of our command. (If `prefix` is empty
 for you, try `cd Documentation/ && ../bin-wrappers/git psuh`). That's not so
 helpful. So what other context can we get?
 
-Add a line to `#include "config.h"`. Then, add the following bits to the
+Add a line to `#include "config.h"` and `#include "repository.h"`.
+Then, add the following bits to the function body:
 function body:
 
 ----
 	const char *cfg_name;
 
 ...
 
-	git_config(git_default_config, NULL);
-	if (git_config_get_string_tmp("user.name", &cfg_name) > 0)
+	repo_config(repo, git_default_config, NULL);
+	if (repo_config_get_string_tmp(repo, "user.name", &cfg_name))
 		printf(_("No name is found in config\n"));
 	else
 		printf(_("Your name: %s\n"), cfg_name);
 ----
 
-`git_config()` will grab the configuration from config files known to Git and
-apply standard precedence rules. `git_config_get_string_tmp()` will look up
+`repo_config()` will grab the configuration from config files known to Git and
+apply standard precedence rules. `repo_config_get_string_tmp()` will look up
 a specific key ("user.name") and give you the value. There are a number of
 single-key lookup functions like this one; you can see them all (and more info
-about how to use `git_config()`) in `Documentation/technical/api-config.adoc`.
+about how to use `repo_config()`) in `Documentation/technical/api-config.adoc`.
 
 You should see that the name printed matches the one you see when you run:
 
@@ -364,7 +375,7 @@ status_init_config(&s, git_status_config);
 ----
 
 But as we drill down, we can find that `status_init_config()` wraps a call
-to `git_config()`. Let's modify the code we wrote in the previous commit.
+to `repo_config()`. Let's modify the code we wrote in the previous commit.
 
 Be sure to include the header to allow you to use `struct wt_status`:
 
@@ -380,8 +391,8 @@ prepare it, and print its contents:
 
 ...
 
-	wt_status_prepare(the_repository, &status);
-	git_config(git_default_config, &status);
+	wt_status_prepare(repo, &status);
+	repo_config(repo, git_default_config, &status);
 
 ...
 

MyFirstContribution.html

@@ -495,16 +495,6 @@ <h4 id="_gitvger_kernel_org"><a class="anchor" href="#_gitvger_kernel_org"></a><
 </div>
 </div>
 <div class="sect3">
-<h4 id="_git_mentoringgooglegroups_com"><a class="anchor" href="#_git_mentoringgooglegroups_com"></a><a href="https://groups.google.com/forum/#!forum/git-mentoring">[email protected]</a></h4>
-<div class="paragraph">
-<p>This mailing list is targeted to new contributors and was created as a place to
-post questions and receive answers outside of the public eye of the main list.
-Veteran contributors who are especially interested in helping mentor newcomers
-are present on the list. In order to avoid search indexers, group membership is
-required to view messages; anyone can join and no approval is required.</p>
-</div>
-</div>
-<div class="sect3">
 <h4 id="_git_devel_on_libera_chat"><a class="anchor" href="#_git_devel_on_libera_chat"></a><a href="https://web.libera.chat/#git-devel">#git-devel</a> on Libera Chat</h4>
 <div class="paragraph">
 <p>This IRC channel is for conversations between Git contributors. If someone is
@@ -642,17 +632,41 @@ <h3 id="add-new-command"><a class="anchor" href="#add-new-command"></a>Adding a
 </div>
 <div class="listingblock">
 <div class="content">
-<pre>int cmd_psuh(int argc, const char **argv, const char *prefix)</pre>
+<pre>int cmd_psuh(int argc UNUSED, const char **argv UNUSED,
+             const char *prefix UNUSED, struct repository *repo UNUSED)</pre>
 </div>
 </div>
 <div class="paragraph">
+<p>A few things to note:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>A subcommand implementation takes its command line arguments
+in <code>int</code> <code>argc</code> + <code>const</code> <code>char</code> <code>**argv</code>, like <code>main</code>() would.</p>
+</li>
+<li>
+<p>It also takes two extra parameters, <code>prefix</code> and <code>repo</code>. What
+they mean will not be discussed until much later.</p>
+</li>
+<li>
+<p>Because this first example will not use any of the parameters,
+your compiler will give warnings on unused parameters. As the
+list of these four parameters is mandated by the API to add
+new built-in commands, you cannot omit them. Instead, you add
+<code>UNUSED</code> to each of them to tell the compiler that you <strong>know</strong>
+you are not (yet) using it.</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
 <p>We&#8217;ll also need to add the declaration of psuh; open up <code>builtin.h</code>, find the
 declaration for <code>cmd_pull</code>, and add a new line for <code>psuh</code> immediately before it,
 in order to keep the declarations alphabetically sorted:</p>
 </div>
 <div class="listingblock">
 <div class="content">
-<pre>int cmd_psuh(int argc, const char **argv, const char *prefix);</pre>
+<pre>int cmd_psuh(int argc, const char **argv, const char *prefix, struct repository *repo);</pre>
 </div>
 </div>
 <div class="paragraph">
@@ -681,7 +695,8 @@ <h3 id="add-new-command"><a class="anchor" href="#add-new-command"></a>Adding a
 </div>
 <div class="listingblock">
 <div class="content">
-<pre>int cmd_psuh(int argc, const char **argv, const char *prefix)
+<pre>int cmd_psuh(int argc UNUSED, const char **argv UNUSED,
+             const char *prefix UNUSED, struct repository *repo UNUSED)
 {
         printf(_("Pony saying hello goes here.\n"));
         return 0;
@@ -822,8 +837,9 @@ <h3 id="implementation"><a class="anchor" href="#implementation"></a>Implementat
 Let&#8217;s start by having a look at everything we get.</p>
 </div>
 <div class="paragraph">
-<p>Modify your <code>cmd_psuh</code> implementation to dump the args you&#8217;re passed, keeping
-existing <code>printf</code>() calls in place:</p>
+<p>Modify your <code>cmd_psuh</code> implementation to dump the args you&#8217;re passed,
+keeping existing <code>printf</code>() calls in place; because the args are now
+used, remove the <code>UNUSED</code> macro from them:</p>
 </div>
 <div class="listingblock">
 <div class="content">
@@ -849,7 +865,8 @@ <h3 id="implementation"><a class="anchor" href="#implementation"></a>Implementat
 helpful. So what other context can we get?</p>
 </div>
 <div class="paragraph">
-<p>Add a line to #include "config.<code>h</code>". Then, add the following bits to the
+<p>Add a line to #include "config.<code>h</code>" and #include "repository.<code>h</code>".
+Then, add the following bits to the function body:
 function body:</p>
 </div>
 <div class="listingblock">
@@ -858,19 +875,19 @@ <h3 id="implementation"><a class="anchor" href="#implementation"></a>Implementat
 
 ...
 
-        git_config(git_default_config, NULL);
-        if (git_config_get_string_tmp("user.name", &amp;cfg_name) &gt; 0)
+        repo_config(repo, git_default_config, NULL);
+        if (repo_config_get_string_tmp(repo, "user.name", &amp;cfg_name))
                 printf(_("No name is found in config\n"));
         else
                 printf(_("Your name: %s\n"), cfg_name);</pre>
 </div>
 </div>
 <div class="paragraph">
-<p><code>git_config</code>() will grab the configuration from config files known to Git and
-apply standard precedence rules. <code>git_config_get_string_tmp</code>() will look up
+<p><code>repo_config</code>() will grab the configuration from config files known to Git and
+apply standard precedence rules. <code>repo_config_get_string_tmp</code>() will look up
 a specific key ("user.name") and give you the value. There are a number of
 single-key lookup functions like this one; you can see them all (and more info
-about how to use <code>git_config</code>()) in <code>Documentation/technical/api-config.adoc</code>.</p>
+about how to use <code>repo_config</code>()) in <code>Documentation/technical/api-config.adoc</code>.</p>
 </div>
 <div class="paragraph">
 <p>You should see that the name printed matches the one you see when you run:</p>
@@ -921,7 +938,7 @@ <h3 id="implementation"><a class="anchor" href="#implementation"></a>Implementat
 </div>
 <div class="paragraph">
 <p>But as we drill down, we can find that <code>status_init_config</code>() wraps a call
-to <code>git_config</code>(). Let&#8217;s modify the code we wrote in the previous commit.</p>
+to <code>repo_config</code>(). Let&#8217;s modify the code we wrote in the previous commit.</p>
 </div>
 <div class="paragraph">
 <p>Be sure to include the header to allow you to use <code>struct</code> <code>wt_status</code>:</p>
@@ -941,8 +958,8 @@ <h3 id="implementation"><a class="anchor" href="#implementation"></a>Implementat
 
 ...
 
-        wt_status_prepare(the_repository, &amp;status);
-        git_config(git_default_config, &amp;status);
+        wt_status_prepare(repo, &amp;status);
+        repo_config(repo, git_default_config, &amp;status);
 
 ...
 
@@ -2239,7 +2256,7 @@ <h3 id="after-approval"><a class="anchor" href="#after-approval"></a>After Revie
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-03-26 00:41:02 -0700
+Last updated 2025-05-27 15:29:51 -0700
 </div>
 </div>
 </body>

RelNotes/2.50.0.adoc

@@ -76,6 +76,15 @@ UI, Workflows & Features
    been under "scalar"'s control are taught an option not to enable the
    scheduled maintenance on it.
 
+ * The userdiff pattern for shell scripts has been updated to cope
+   with more bash-isms.
+
+ * "git merge-tree" learned an option to see if it resolves cleanly
+   without actually creating a result.
+
+ * The commit title in the "rebase -i" todo file are now prefixed with
+   '#', just like a merge commit being replayed.
+
 
 Performance, Internal Implementation, Development Support etc.
 --------------------------------------------------------------
@@ -167,6 +176,15 @@ Performance, Internal Implementation, Development Support etc.
  * The dependency on the_repository variable has been reduced from the
    code paths in "git replay".
 
+ * Support to create a loose object file with unknown object type has
+   been dropped.
+
+ * The code path to access the "packed-refs" file while "fsck" is
+   taught to mmap the file, instead of reading the whole file in the
+   memory.
+
+ * Assorted fixes for issues found with CodeQL.
+
 
 Fixes since v2.49
 -----------------
@@ -325,6 +343,10 @@ Fixes since v2.49
    automatically (as opposed to be done only upon manual request).
    (merge 6389579b2f ps/ci-gitlab-enable-msvc-meson-job later to maint).
 
+ * "git apply" and "git add -i/-p" code paths no longer unnecessarily
+   expand sparse-index while working.
+   (merge ecf9ba20e3 ds/sparse-apply-add-p later to maint).
+
  * Other code cleanup, docfix, build fix, etc.
    (merge 227c4f33a0 ja/doc-block-delimiter-markup-fix later to maint).
    (merge 2bfd3b3685 ab/decorate-code-cleanup later to maint).
@@ -355,3 +377,5 @@ Fixes since v2.49
    (merge e5dd0a05ed ly/am-split-stgit-leakfix later to maint).
    (merge bac220e154 rc/t1001-test-path-is-file later to maint).
    (merge 91db6c735d ly/reftable-writer-leakfix later to maint).
+   (merge 20e4e9ad0b jc/doc-synopsis-option-markup later to maint).
+   (merge cddcee7f64 es/meson-configure-build-options-fix later to maint).

fsck-msgids.adoc

@@ -59,6 +59,12 @@
 `emptyName`::
 	(WARN) A path contains an empty name.
 
+`emptyPackedRefsFile`::
+	(INFO) "packed-refs" file is empty. Report to the
+	[email protected] mailing list if you see this error. As only
+	very early versions of Git would create such an empty
+	"packed_refs" file, we might tighten this rule in the future.
+
 `extraHeaderEntry`::
 	(IGNORE) Extra headers found after `tagger`.
 

git-cat-file.adoc

@@ -9,8 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'git cat-file' <type> <object>
-'git cat-file' (-e | -p) <object>
-'git cat-file' (-t | -s) [--allow-unknown-type] <object>
+'git cat-file' (-e | -p | -t | -s) <object>
 'git cat-file' (--textconv | --filters)
 	     [<rev>:<path|tree-ish> | --path=<path|tree-ish> <rev>]
 'git cat-file' (--batch | --batch-check | --batch-command) [--batch-all-objects]
@@ -202,9 +201,6 @@ flush::
 	only once, even if it is stored multiple times in the
 	repository.
 
---allow-unknown-type::
-	Allow `-s` or `-t` to query broken/corrupt objects of unknown type.
-
 --follow-symlinks::
 	With `--batch` or `--batch-check`, follow symlinks inside the
 	repository when requesting objects with extended SHA-1

git-cat-file.html

@@ -453,8 +453,7 @@ <h2 id="_synopsis">SYNOPSIS</h2>
 <div class="sectionbody">
 <div class="verseblock">
 <pre class="content"><em>git cat-file</em> &lt;type&gt; &lt;object&gt;
-<em>git cat-file</em> (-e | -p) &lt;object&gt;
-<em>git cat-file</em> (-t | -s) [--allow-unknown-type] &lt;object&gt;
+<em>git cat-file</em> (-e | -p | -t | -s) &lt;object&gt;
 <em>git cat-file</em> (--textconv | --filters)
              [&lt;rev&gt;:&lt;path|tree-ish&gt; | --path=&lt;path|tree-ish&gt; &lt;rev&gt;]
 <em>git cat-file</em> (--batch | --batch-check | --batch-command) [--batch-all-objects]
@@ -711,10 +710,6 @@ <h2 id="_options">OPTIONS</h2>
 only once, even if it is stored multiple times in the
 repository.</p>
 </dd>
-<dt class="hdlist1">--allow-unknown-type</dt>
-<dd>
-<p>Allow <code>-s</code> or <code>-t</code> to query broken/corrupt objects of unknown type.</p>
-</dd>
 <dt class="hdlist1">--follow-symlinks</dt>
 <dd>
 <p>With <code>--batch</code> or <code>--batch-check</code>, follow symlinks inside the
@@ -1046,7 +1041,7 @@ <h2 id="_git">GIT</h2>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-04-16 14:42:40 -0700
+Last updated 2025-05-27 15:29:51 -0700
 </div>
 </div>
 </body>