git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
* [PATCH] attr: fix instructions on how to check attrs
@ 2023-01-22  3:06 John Cai via GitGitGadget
  2023-01-22 16:10 ` Junio C Hamano
  2023-01-23  4:22 ` [PATCH v2] " John Cai via GitGitGadget
  0 siblings, 2 replies; 6+ messages in thread
From: John Cai via GitGitGadget @ 2023-01-22  3:06 UTC (permalink / raw)
  To: git; +Cc: John Cai, John Cai

From: John Cai <johncai86@gmail.com>

The instructions in attr.h describing what functions to call to check
attributes is missing the index as the first argument to git_check_attr.

Fix this to make it consistent with the actual function signature.

Signed-off-by: John Cai <johncai86@gmail.com>
---
    attr: fix instructions on how to check attrs
    
    The instructions in attr.h describing what functions to call to check
    attributes is missing the index as the first argument to git_check_attr.
    
    Fix this to make it consistent with the actual function signature.
    
    Signed-off-by: John Cai johncai86@gmail.com

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1441%2Fjohn-cai%2Fjc%2Ffix-attr-docs-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1441/john-cai/jc/fix-attr-docs-v1
Pull-Request: https://github.com/git/git/pull/1441

 attr.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/attr.h b/attr.h
index 2f22dffadb3..47f1111f391 100644
--- a/attr.h
+++ b/attr.h
@@ -45,7 +45,7 @@
  * const char *path;
  *
  * setup_check();
- * git_check_attr(path, check);
+ * git_check_attr(&the_index, path, check);
  * ------------
  *
  * - Act on `.value` member of the result, left in `check->items[]`:

base-commit: 904d404274fef6695c78a6b055edd184b72e2f9b
-- 
gitgitgadget

^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [PATCH] attr: fix instructions on how to check attrs
  2023-01-22  3:06 [PATCH] attr: fix instructions on how to check attrs John Cai via GitGitGadget
@ 2023-01-22 16:10 ` Junio C Hamano
  2023-01-23  4:07   ` John Cai
  2023-01-23  4:22 ` [PATCH v2] " John Cai via GitGitGadget
  1 sibling, 1 reply; 6+ messages in thread
From: Junio C Hamano @ 2023-01-22 16:10 UTC (permalink / raw)
  To: John Cai via GitGitGadget; +Cc: git, John Cai

"John Cai via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: John Cai <johncai86@gmail.com>
>
> The instructions in attr.h describing what functions to call to check
> attributes is missing the index as the first argument to git_check_attr.
>
> Fix this to make it consistent with the actual function signature.

Sounds quite sensible.  It would have been very good to explain some
research in the above, like

    When 7a400a2c (attr: remove an implicit dependency on the_index,
    2018-08-13) started passing an index_state instance to
    git_check_attr(), it forgot to update the API documentation that
    was in Documentation/technical/api-gitattributes.txt.  Later,
    3a1b3415 (attr: move doc to attr.h, 2019-11-17) moved the API
    documentation to attr.h and made it to a comment, without
    realizing the earlier mistake.
    
or something like that.

Thanks.

> diff --git a/attr.h b/attr.h
> index 2f22dffadb3..47f1111f391 100644
> --- a/attr.h
> +++ b/attr.h
> @@ -45,7 +45,7 @@
>   * const char *path;
>   *
>   * setup_check();
> - * git_check_attr(path, check);
> + * git_check_attr(&the_index, path, check);
>   * ------------
>   *
>   * - Act on `.value` member of the result, left in `check->items[]`:
>
> base-commit: 904d404274fef6695c78a6b055edd184b72e2f9b

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] attr: fix instructions on how to check attrs
  2023-01-22 16:10 ` Junio C Hamano
@ 2023-01-23  4:07   ` John Cai
  0 siblings, 0 replies; 6+ messages in thread
From: John Cai @ 2023-01-23  4:07 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: John Cai via GitGitGadget, git

Hi Junio,

On 22 Jan 2023, at 11:10, Junio C Hamano wrote:

> "John Cai via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
>> From: John Cai <johncai86@gmail.com>
>>
>> The instructions in attr.h describing what functions to call to check
>> attributes is missing the index as the first argument to git_check_attr.
>>
>> Fix this to make it consistent with the actual function signature.
>
> Sounds quite sensible.  It would have been very good to explain some
> research in the above, like
>
>     When 7a400a2c (attr: remove an implicit dependency on the_index,
>     2018-08-13) started passing an index_state instance to
>     git_check_attr(), it forgot to update the API documentation that
>     was in Documentation/technical/api-gitattributes.txt.  Later,
>     3a1b3415 (attr: move doc to attr.h, 2019-11-17) moved the API
>     documentation to attr.h and made it to a comment, without
>     realizing the earlier mistake.
>
> or something like that.

good tip about including some history. I'll include that in the re-roll

thanks!

>
> Thanks.
>
>> diff --git a/attr.h b/attr.h
>> index 2f22dffadb3..47f1111f391 100644
>> --- a/attr.h
>> +++ b/attr.h
>> @@ -45,7 +45,7 @@
>>   * const char *path;
>>   *
>>   * setup_check();
>> - * git_check_attr(path, check);
>> + * git_check_attr(&the_index, path, check);
>>   * ------------
>>   *
>>   * - Act on `.value` member of the result, left in `check->items[]`:
>>
>> base-commit: 904d404274fef6695c78a6b055edd184b72e2f9b

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH v2] attr: fix instructions on how to check attrs
  2023-01-22  3:06 [PATCH] attr: fix instructions on how to check attrs John Cai via GitGitGadget
  2023-01-22 16:10 ` Junio C Hamano
@ 2023-01-23  4:22 ` John Cai via GitGitGadget
  2023-01-26 21:21   ` [PATCH v3] " John Cai via GitGitGadget
  1 sibling, 1 reply; 6+ messages in thread
From: John Cai via GitGitGadget @ 2023-01-23  4:22 UTC (permalink / raw)
  To: git; +Cc: John Cai, John Cai

From: John Cai <johncai86@gmail.com>

The instructions in attr.h describing what functions to call to check
attributes is missing the index as the first argument to
git_check_attr().

When 7a400a2c (attr: remove an implicit dependency on the_index,
2018-08-13) started passing an index_state instance to git_check_attr(),
it forgot to update the API documentation in
Documentation/technical/api-gitattributes.txt. Later, 3a1b3415
(attr: move doc to attr.h, 2019-11-17) moved the API documentation to
attr.h as a comment, but still left out the index_state as an argument.

Fix this to make the documentation in the comment consistent with the
actual function signature.

Signed-off-by: John Cai <johncai86@gmail.com>
---
    attr: fix instructions on how to check attrs
    
    The instructions in attr.h describing what functions to call to check
    attributes is missing the index as the first argument to git_check_attr.
    
    Fix this to make it consistent with the actual function signature.
    
    Changes since V1:
    
     * updated commit message to include some history
    
    Signed-off-by: John Cai johncai86@gmail.com

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1441%2Fjohn-cai%2Fjc%2Ffix-attr-docs-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1441/john-cai/jc/fix-attr-docs-v2
Pull-Request: https://github.com/git/git/pull/1441

Range-diff vs v1:

 1:  63bb84db487 ! 1:  8cfee55e48f attr: fix instructions on how to check attrs
     @@ Commit message
          attr: fix instructions on how to check attrs
      
          The instructions in attr.h describing what functions to call to check
     -    attributes is missing the index as the first argument to git_check_attr.
     +    attributes is missing the index as the first argument to
     +    git_check_attr().
      
     -    Fix this to make it consistent with the actual function signature.
     +    When 7a400a2c (attr: remove an implicit dependency on the_index,
     +    2018-08-13) started passing an index_state instance to git_check_attr(),
     +    it forgot to update the API documentation in
     +    Documentation/technical/api-gitattributes.txt. Later, 3a1b3415
     +    (attr: move doc to attr.h, 2019-11-17) moved the API documentation to
     +    attr.h as a comment, but still left out the index_state as an argument.
     +
     +    Fix this to make the documentation in the comment consistent with the
     +    actual function signature.
      
          Signed-off-by: John Cai <johncai86@gmail.com>
      


 attr.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/attr.h b/attr.h
index 2f22dffadb3..47f1111f391 100644
--- a/attr.h
+++ b/attr.h
@@ -45,7 +45,7 @@
  * const char *path;
  *
  * setup_check();
- * git_check_attr(path, check);
+ * git_check_attr(&the_index, path, check);
  * ------------
  *
  * - Act on `.value` member of the result, left in `check->items[]`:

base-commit: 904d404274fef6695c78a6b055edd184b72e2f9b
-- 
gitgitgadget

^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH v3] attr: fix instructions on how to check attrs
  2023-01-23  4:22 ` [PATCH v2] " John Cai via GitGitGadget
@ 2023-01-26 21:21   ` John Cai via GitGitGadget
  2023-01-26 22:17     ` Junio C Hamano
  0 siblings, 1 reply; 6+ messages in thread
From: John Cai via GitGitGadget @ 2023-01-26 21:21 UTC (permalink / raw)
  To: git; +Cc: John Cai, John Cai

From: John Cai <johncai86@gmail.com>

The instructions in attr.h describing what functions to call to check
attributes is missing the index as the first argument to
git_check_attr(), as well as tree_oid as the second argument.

When 7a400a2c (attr: remove an implicit dependency on the_index,
2018-08-13) started passing an index_state instance to git_check_attr(),
it forgot to update the API documentation in
Documentation/technical/api-gitattributes.txt. Later, 3a1b3415
(attr: move doc to attr.h, 2019-11-17) moved the API documentation to
attr.h as a comment, but still left out the index_state as an argument.

In 47cfc9b (attr: add flag `--source` to work with tree-ish 2023-01-14)
added tree_oid as an optional parameter but was not added to the docs in
attr.h

Fix this to make the documentation in the comment consistent with the
actual function signature.

Signed-off-by: John Cai <johncai86@gmail.com>
---
    attr: fix instructions on how to check attrs
    
    The instructions in attr.h describing what functions to call to check
    attributes is missing the index as the first argument to git_check_attr.
    
    Fix this to make it consistent with the actual function signature.
    
    Changes since V2:
    
     * updated with adding second argument after rebasing against master
    
    Changes since V1:
    
     * updated commit message to include some history
    
    Signed-off-by: John Cai johncai86@gmail.com

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1441%2Fjohn-cai%2Fjc%2Ffix-attr-docs-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1441/john-cai/jc/fix-attr-docs-v3
Pull-Request: https://github.com/git/git/pull/1441

Range-diff vs v2:

 1:  8cfee55e48f ! 1:  cf6f456af47 attr: fix instructions on how to check attrs
     @@ Commit message
      
          The instructions in attr.h describing what functions to call to check
          attributes is missing the index as the first argument to
     -    git_check_attr().
     +    git_check_attr(), as well as tree_oid as the second argument.
      
          When 7a400a2c (attr: remove an implicit dependency on the_index,
          2018-08-13) started passing an index_state instance to git_check_attr(),
     @@ Commit message
          (attr: move doc to attr.h, 2019-11-17) moved the API documentation to
          attr.h as a comment, but still left out the index_state as an argument.
      
     +    In 47cfc9b (attr: add flag `--source` to work with tree-ish 2023-01-14)
     +    added tree_oid as an optional parameter but was not added to the docs in
     +    attr.h
     +
          Fix this to make the documentation in the comment consistent with the
          actual function signature.
      
     @@ attr.h
        *
        * setup_check();
      - * git_check_attr(path, check);
     -+ * git_check_attr(&the_index, path, check);
     ++ * git_check_attr(&the_index, tree_oid, path, check);
        * ------------
        *
        * - Act on `.value` member of the result, left in `check->items[]`:


 attr.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/attr.h b/attr.h
index 58a2bc1344f..9884ea2bc60 100644
--- a/attr.h
+++ b/attr.h
@@ -45,7 +45,7 @@
  * const char *path;
  *
  * setup_check();
- * git_check_attr(path, check);
+ * git_check_attr(&the_index, tree_oid, path, check);
  * ------------
  *
  * - Act on `.value` member of the result, left in `check->items[]`:

base-commit: 5dec958dcf965fc75e0f459f8e8ccf9c9f495b15
-- 
gitgitgadget

^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [PATCH v3] attr: fix instructions on how to check attrs
  2023-01-26 21:21   ` [PATCH v3] " John Cai via GitGitGadget
@ 2023-01-26 22:17     ` Junio C Hamano
  0 siblings, 0 replies; 6+ messages in thread
From: Junio C Hamano @ 2023-01-26 22:17 UTC (permalink / raw)
  To: John Cai via GitGitGadget; +Cc: git, John Cai

"John Cai via GitGitGadget" <gitgitgadget@gmail.com> writes:

>     Changes since V2:
>     
>      * updated with adding second argument after rebasing against master

Ahh, thanks for being so careful.  I forgot all about that other
topic changing the function signature.

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2023-01-26 22:17 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-01-22  3:06 [PATCH] attr: fix instructions on how to check attrs John Cai via GitGitGadget
2023-01-22 16:10 ` Junio C Hamano
2023-01-23  4:07   ` John Cai
2023-01-23  4:22 ` [PATCH v2] " John Cai via GitGitGadget
2023-01-26 21:21   ` [PATCH v3] " John Cai via GitGitGadget
2023-01-26 22:17     ` Junio C Hamano

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).