git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Stefan Beller <sbeller@google.com>
To: Ramsay Jones <ramsay@ramsayjones.plus.com>
Cc: Junio C Hamano <gitster@pobox.com>,
	"git@vger.kernel.org" <git@vger.kernel.org>,
	Brandon Williams <bmwill@google.com>,
	Duy Nguyen <pclouds@gmail.com>
Subject: Re: [PATCH 17/36] attr: expose validity check for attribute names
Date: Mon, 24 Oct 2016 14:07:09 -0700	[thread overview]
Message-ID: <CAGZ79ka_zr_NXKoxC45swFrj168fP6S7_nQ1jjcfPOtTN4Jd1A@mail.gmail.com> (raw)
In-Reply-To: <0425fea3-3419-c265-b964-f5a309b867fa@ramsayjones.plus.com>

On Sun, Oct 23, 2016 at 8:07 AM, Ramsay Jones
<ramsay@ramsayjones.plus.com> wrote:
>
>
> On 23/10/16 00:32, Stefan Beller wrote:
>> From: Junio C Hamano <gitster@pobox.com>
>>
>> Export attr_name_valid() function, and a helper function that
>> returns the message to be given when a given <name, len> pair
>> is not a good name for an attribute.
>>
>> We could later update the message to exactly spell out what the
>> rules for a good attribute name are, etc.
>>
>> Signed-off-by: Junio C Hamano <gitster@pobox.com>
>> Signed-off-by: Stefan Beller <sbeller@google.com>
>> ---
>
> [snip]
>
>> +extern int attr_name_valid(const char *name, size_t namelen);
>> +extern void invalid_attr_name_message(struct strbuf *, const char *, int);
>> +
>
> The symbol 'attr_name_valid()' is not used outside of attr.c, even
> by the end of this series. Do you expect this function to be used
> in any future series? (The export is deliberate and it certainly
> seems like it should be part of the public interface, but ...)
>
> In contrast, the 'invalid_attr_name_message()' function is called
> from code in pathspec.c, which relies on 'git_attr_counted()' to
> call 'attr_name_valid()' internally to check for validity. :-D

Yeah, I am taking over Junios patches and do not quite implement
what Junio thought I would. ;) So I guess it is a communication mismatch.

git_attr_counted is a wrapper around attr_name_valid in the way that
it either returns NULL when the attr name is invalid or it does extra work
and returns a pointer to an attr.

So I think for API completeness we'd want to keep attr_name_valid around,
as otherwise the API looks strange. But that doesn't seem like a compelling
reason, so I'll drop it from the header file and make it static.

Thanks,
Stefan

  reply	other threads:[~2016-10-24 21:07 UTC|newest]

Thread overview: 81+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-22 23:31 [PATCHv2 00/36] Revamping the attr subsystem! Stefan Beller
2016-10-22 23:31 ` [PATCH 01/36] commit.c: use strchrnul() to scan for one line Stefan Beller
2016-10-22 23:31 ` [PATCH 02/36] attr.c: " Stefan Beller
2016-10-22 23:31 ` [PATCH 03/36] attr.c: update a stale comment on "struct match_attr" Stefan Beller
2016-10-22 23:31 ` [PATCH 04/36] attr.c: explain the lack of attr-name syntax check in parse_attr() Stefan Beller
2016-10-22 23:31 ` [PATCH 05/36] attr.c: complete a sentence in a comment Stefan Beller
2016-10-22 23:31 ` [PATCH 06/36] attr.c: mark where #if DEBUG ends more clearly Stefan Beller
2016-10-22 23:31 ` [PATCH 07/36] attr.c: simplify macroexpand_one() Stefan Beller
2016-10-22 23:31 ` [PATCH 08/36] attr.c: tighten constness around "git_attr" structure Stefan Beller
2016-10-22 23:31 ` [PATCH 09/36] attr.c: plug small leak in parse_attr_line() Stefan Beller
2016-10-22 23:31 ` [PATCH 10/36] attr: rename function and struct related to checking attributes Stefan Beller
2016-10-22 23:32 ` [PATCH 11/36] attr: (re)introduce git_check_attr() and struct git_attr_check Stefan Beller
2016-10-22 23:32 ` [PATCH 12/36] attr: convert git_all_attrs() to use "struct git_attr_check" Stefan Beller
2016-10-22 23:32 ` [PATCH 13/36] attr: convert git_check_attrs() callers to use the new API Stefan Beller
2016-10-22 23:32 ` [PATCH 14/36] attr: retire git_check_attrs() API Stefan Beller
2016-10-22 23:32 ` [PATCH 15/36] attr: add counted string version of git_check_attr() Stefan Beller
2016-10-22 23:32 ` [PATCH 16/36] attr: add counted string version of git_attr() Stefan Beller
2016-10-22 23:32 ` [PATCH 17/36] attr: expose validity check for attribute names Stefan Beller
2016-10-23 15:07   ` Ramsay Jones
2016-10-24 21:07     ` Stefan Beller [this message]
2016-10-27 20:57       ` Stefan Beller
2016-10-26 21:20     ` [PATCH] attr: expose error reporting function for invalid " Stefan Beller
2016-10-22 23:32 ` [PATCH 18/36] attr: support quoting pathname patterns in C style Stefan Beller
2016-10-22 23:32 ` [PATCH 19/36] attr.c: add push_stack() helper Stefan Beller
2016-10-22 23:32 ` [PATCH 20/36] attr.c: pass struct git_attr_check down the callchain Stefan Beller
2016-10-22 23:32 ` [PATCH 21/36] attr.c: rename a local variable check Stefan Beller
2016-10-22 23:32 ` [PATCH 22/36] attr.c: correct ugly hack for git_all_attrs() Stefan Beller
2016-10-22 23:32 ` [PATCH 23/36] attr.c: introduce empty_attr_check_elems() Stefan Beller
2016-10-22 23:32 ` [PATCH 24/36] attr.c: always pass check[] to collect_some_attrs() Stefan Beller
2016-10-22 23:32 ` [PATCH 25/36] attr.c: outline the future plans by heavily commenting Stefan Beller
2016-10-22 23:32 ` [PATCH 26/36] attr: make git_check_attr_counted static Stefan Beller
2016-10-22 23:32 ` [PATCH 27/36] attr: convert to new threadsafe API Stefan Beller
2016-10-24 18:55   ` Junio C Hamano
2016-10-24 19:18     ` Stefan Beller
2016-10-26 14:06       ` Duy Nguyen
2016-10-26  8:52   ` Johannes Schindelin
2016-10-26  9:35     ` Simon Ruderich
2016-10-26 12:15       ` Jeff King
2016-10-26 19:51         ` Stefan Beller
2016-10-26 20:20           ` Jeff King
2016-10-26 20:25           ` Johannes Sixt
2016-10-26 20:26             ` Jeff King
2016-10-26 20:40               ` Johannes Sixt
2016-10-26 20:46                 ` Stefan Beller
2016-10-26 22:41                   ` [PATCHv2 1/2] " Stefan Beller
2016-10-26 23:14                     ` Junio C Hamano
2016-10-27  0:08                       ` Stefan Beller
2016-10-27  0:16                         ` Junio C Hamano
2016-10-27  0:22                           ` Stefan Beller
2016-10-27  0:50                             ` Junio C Hamano
2016-10-27  0:49                     ` Junio C Hamano
2016-10-27  2:19                       ` Stefan Beller
2016-10-27  4:13                         ` Junio C Hamano
2016-10-27  5:44                           ` Junio C Hamano
2016-10-27 22:15                             ` [PATCH] " Stefan Beller
2016-10-28  8:55                               ` Johannes Schindelin
2016-10-28 17:20                               ` Junio C Hamano
2016-10-28 17:30                                 ` Junio C Hamano
2016-10-28 18:16                               ` Johannes Sixt
2016-10-26 20:43               ` [PATCH 27/36] " Stefan Beller
2016-10-26 13:52   ` Duy Nguyen
2016-10-22 23:32 ` [PATCH 28/36] attr: keep attr stack for each check Stefan Beller
2016-10-23 15:10   ` Ramsay Jones
2016-10-26 23:10     ` Stefan Beller
2016-10-24 19:07   ` Junio C Hamano
2016-10-24 19:32     ` Stefan Beller
2016-10-24 20:29       ` Junio C Hamano
2016-10-22 23:32 ` [PATCH 29/36] Documentation: fix a typo Stefan Beller
2016-10-22 23:32 ` [PATCH 30/36] pathspec: move long magic parsing out of prefix_pathspec Stefan Beller
2016-10-22 23:32 ` [PATCH 31/36] pathspec: move prefix check out of the inner loop Stefan Beller
2016-10-22 23:32 ` [PATCH 32/36] pathspec: allow querying for attributes Stefan Beller
2016-10-26 13:33   ` Duy Nguyen
2016-10-27 21:32     ` Stefan Beller
2016-10-27 18:29   ` Junio C Hamano
2016-11-09  9:45     ` Duy Nguyen
2016-11-09 18:08       ` Stefan Beller
2016-11-09 22:25         ` Junio C Hamano
2016-10-22 23:32 ` [PATCH 33/36] pathspec: allow escaped query values Stefan Beller
2016-10-22 23:32 ` [PATCH 34/36] submodule update: add `--init-default-path` switch Stefan Beller
2016-10-22 23:32 ` [PATCH 35/36] clone: add --init-submodule=<pathspec> switch Stefan Beller
2016-10-22 23:32 ` [PATCH 36/36] completion: clone can initialize specific submodules Stefan Beller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAGZ79ka_zr_NXKoxC45swFrj168fP6S7_nQ1jjcfPOtTN4Jd1A@mail.gmail.com \
    --to=sbeller@google.com \
    --cc=bmwill@google.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=pclouds@gmail.com \
    --cc=ramsay@ramsayjones.plus.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).