git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v4 02/26] refs: make repack_without_refs and is_branch public

From
Michael Haggerty <mhagger@alum.mit.edu>
Date
Oct 16, 2015, 06:34 UTC
Message-ID
<56209A81.1060706@alum.mit.edu>
In-Reply-To
<1444938410-2345-3-git-send-email-dturner@twopensource.com>
On 10/15/2015 09:46 PM, David Turner wrote:
> is_branch was already non-static, but this patch declares it in the
> header.
The commit message no longer reflects the patch.
Show 21 quoted lines
> Signed-off-by: Ronnie Sahlberg <sahlberg@google.com>
> Signed-off-by: David Turner <dturner@twopensource.com>
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  refs.c | 5 +++--
>  refs.h | 2 ++
>  2 files changed, 5 insertions(+), 2 deletions(-)
> 
> diff --git a/refs.c b/refs.c
> index fe71ea0..84abc82 100644
> --- a/refs.c
> +++ b/refs.c
> @@ -2816,8 +2816,9 @@ int pack_refs(unsigned int flags)
>  
>  /*
>   * Rewrite the packed-refs file, omitting any refs listed in
> - * 'refnames'. On error, leave packed-refs unchanged, write an error
> - * message to 'err', and return a nonzero value.
> + * 'refnames'. On error, packed-refs will be unchanged, the return
> + * value is nonzero, and a message about the error is written to the
> + * 'err' strbuf.
^^^ ?

It is preferable for docstrings to be written in imperative form, so in my opinion this is a step backwards...

...literally. Your "new" version comes from an older version of Git; it was changed in

    79e4d8a9b8 repack_without_refs(): make function private (2015-06-22)
to the imperative form.

Assuming you are using `git-format-patch` to prepare your patches, it is always a good idea to read over the prepared email files before sending them to the ML, to check for bloopers like this.

Show 17 quoted lines
>   *
>   * The refs in 'refnames' needn't be sorted. `err` must not be NULL.
>   */
> diff --git a/refs.h b/refs.h
> index 7367a7f..8408bef 100644
> --- a/refs.h
> +++ b/refs.h
> @@ -237,6 +237,8 @@ int pack_refs(unsigned int flags);
>  int verify_refname_available(const char *newname, struct string_list *extra,
>  			     struct string_list *skip, struct strbuf *err);
>  
> +extern int is_branch(const char *refname);
> +
>  /*
>   * Flags controlling ref_transaction_update(), ref_transaction_create(), etc.
>   * REF_NODEREF: act on the ref directly, instead of dereferencing
> 
Michael
-- 
Michael Haggerty
mhagger@alum.mit.edu
Previous: David TurnerNext: David Turner
Message 4 of 35 in “refs backend pre-vtable patches”
  1. 00/26 refs backend pre-vtable patchesDavid Turner, Oct 15, 2015
  2. 01/26 refs.c: create a public version of verify_refname_availableDavid Turner, Oct 15, 2015
  3. 02/26 refs: make repack_without_refs and is_branch publicDavid Turner, Oct 15, 2015
  4. Michael HaggertyOct 16, 2015
  5. David TurnerOct 19, 2015
  6. 03/26 refs-be-files.c: rename refs to refs-be-filesDavid Turner, Oct 15, 2015
  7. Michael HaggertyOct 16, 2015
  8. 04/26 refs.c: add a new refs.c file to hold all common refs codeDavid Turner, Oct 15, 2015
  9. 05/26 refs.c: move update_ref to refs.cDavid Turner, Oct 15, 2015
  10. David TurnerOct 21, 2015
  11. 06/26 refs.c: move delete_pseudoref and delete_ref to the common codeDavid Turner, Oct 15, 2015
  12. David TurnerOct 21, 2015
  13. 07/26 refs.c: move read_ref_at to the common refs fileDavid Turner, Oct 15, 2015
  14. 08/26 refs.c: move the hidden refs functions to the common codeDavid Turner, Oct 15, 2015
  15. 09/26 refs.c: move dwim and friend functions to the common refs codeDavid Turner, Oct 15, 2015
  16. 10/26 refs.c: move warn_if_dangling_symref* to the common codeDavid Turner, Oct 15, 2015
  17. 11/26 refs.c: move read_ref, read_ref_full and ref_exists to the common codeDavid Turner, Oct 15, 2015
  18. 12/26 refs.c: move resolve_refdup to commonDavid Turner, Oct 15, 2015
  19. 13/26 refs.c: move check_refname_format to the common codeDavid Turner, Oct 15, 2015
  20. 14/26 refs.c: move is_branch to the common codeDavid Turner, Oct 15, 2015
  21. 15/26 refs.c: move prettify_refname to the common codeDavid Turner, Oct 15, 2015
  22. 16/26 refs.c: move ref iterators to the common codeDavid Turner, Oct 15, 2015
  23. 17/26 refs.c: move head_ref_namespaced to the common codeDavid Turner, Oct 15, 2015
  24. 18/26 refs: move transaction functions into common codeDavid Turner, Oct 15, 2015
  25. 19/26 refs.c: move refname_is_safe to the common codeDavid Turner, Oct 15, 2015
  26. 20/26 refs.c: move copy_msg to the common codeDavid Turner, Oct 15, 2015
  27. 21/26 refs.c: move peel_object to the common codeDavid Turner, Oct 15, 2015
  28. 22/26 refs.c: move should_autocreate_reflog to common codeDavid Turner, Oct 15, 2015
  29. 23/26 initdb: move safe_create_dir into common codeDavid Turner, Oct 15, 2015
  30. Junio C HamanoOct 21, 2015
  31. David TurnerOct 21, 2015
  32. 24/26 refs: make files_log_ref_write functions publicDavid Turner, Oct 15, 2015
  33. 25/26 refs: break out ref conflict checksDavid Turner, Oct 15, 2015
  34. 26/26 introduce "extensions" form of core.repositoryformatversionDavid Turner, Oct 15, 2015
  35. Junio C HamanoOct 21, 2015

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.