Re: [GSoC PATCH 1/2] MyFirstContribution: use struct repository in examples
Lucas Seiki Oshiro <lucasseikioshiro@gmail.com> writes:
> Add the parameter `struct repository *repo` to the cmd_walken function.
>
> Since commit 9b1cb50, all the cmd_* have the `repo` parameter and new
When referencing commits, we stick to a particular format. From 'Documentation/SubmittingPatches', we have:
When you reference a commit on a more stable branch (like `master`,
`maint` and `next`), use the format "abbreviated hash (subject,
date)", like this:
....
Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)
noticed that ...
....
The document also states that `git show -s --pretty=reference <commit>` can be used to obtain this format.
Show 5 quoted lines
> commands must follow this convention, so the documentation should also
> be changed.
>
> Also change the `git_config` calls to `repo_config`, also passing the
> `repo` parameter.
Nit: Okay this makes sense, but It would be nice, if you also elaborate
a bit here, about why you want to make that change. The context being
that since 036876a106 (config: hide functions using `the_repository` by
default, 2024-08-13) the non-repo config functions are no longer
recommended as they use the global 'repository' variable.
Show 67 quoted lines
>
> Signed-off-by: Lucas Seiki Oshiro <lucasseikioshiro@gmail.com>
> ---
> Documentation/MyFirstObjectWalk.adoc | 18 +++++++++---------
> 1 file changed, 9 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/MyFirstObjectWalk.adoc b/Documentation/MyFirstObjectWalk.adoc
> index f03753dfc0..29d26abb47 100644
> --- a/Documentation/MyFirstObjectWalk.adoc
> +++ b/Documentation/MyFirstObjectWalk.adoc
> @@ -43,7 +43,7 @@ Open up a new file `builtin/walken.c` and set up the command handler:
> #include "builtin.h"
> #include "trace.h"
>
> -int cmd_walken(int argc, const char **argv, const char *prefix)
> +int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo)
> {
> trace_printf(_("cmd_walken incoming...\n"));
> return 0;
> @@ -86,7 +86,7 @@ int cmd_walken(int argc, const char **argv, const char *prefix)
> Also add the relevant line in `builtin.h` near `cmd_version()`:
>
> ----
> -int cmd_walken(int argc, const char **argv, const char *prefix);
> +int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo);
> ----
>
> Include the command in `git.c` in `commands[]` near the entry for `version`,
> @@ -193,7 +193,7 @@ initialization functions.
>
> Next, we should have a look at any relevant configuration settings (i.e.,
> settings readable and settable from `git config`). This is done by providing a
> -callback to `git_config()`; within that callback, you can also invoke methods
> +callback to `repo_config()`; within that callback, you can also invoke methods
> from other components you may need that need to intercept these options. Your
> callback will be invoked once per each configuration value which Git knows about
> (global, local, worktree, etc.).
> @@ -221,14 +221,14 @@ static int git_walken_config(const char *var, const char *value,
> }
> ----
>
> -Make sure to invoke `git_config()` with it in your `cmd_walken()`:
> +Make sure to invoke `repo_config()` with it in your `cmd_walken()`:
>
> ----
> -int cmd_walken(int argc, const char **argv, const char *prefix)
> +int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo)
> {
> ...
>
> - git_config(git_walken_config, NULL);
> + repo_config(repo, git_walken_config, NULL);
>
> ...
> }
> @@ -250,14 +250,14 @@ We'll also need to include the `revision.h` header:
>
> ...
>
> -int cmd_walken(int argc, const char **argv, const char *prefix)
> +int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo)
> {
> /* This can go wherever you like in your declarations.*/
> struct rev_info rev;
> ...
>
> /* This should go after the git_config() call. */Shouldn't this be s/git_config/repo_config ?
Show 16 quoted lines
> - repo_init_revisions(the_repository, &rev, prefix);
> + repo_init_revisions(repo, the_repository, &rev, prefix);
>
> ...
> }
> @@ -305,7 +305,7 @@ Then let's invoke `final_rev_info_setup()` after the call to
> `repo_init_revisions()`:
>
> ----
> -int cmd_walken(int argc, const char **argv, const char *prefix)
> +int cmd_walken(int argc, const char **argv, const char *prefix, struct repository *repo)
> {
> ...
>
> --
> 2.39.5 (Apple Git-154)
Lucas Seiki Oshiro
