[v3] attr: fix instructions on how to check attrs

Commit Message

John Cai Jan. 26, 2023, 9:21 p.m. UTC

From: John Cai <[e-mail]>

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 <[e-mail]>
---
    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 [e-mail]

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


base-commit: 5dec958dcf965fc75e0f459f8e8ccf9c9f495b15

Comments

Junio C Hamano Jan. 26, 2023, 10:17 p.m. UTC | #1

"John Cai via GitGitGadget" <[e-mail]> 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.

Patch

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[]`: