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

From: John Cai via GitGitGadget <gitgitgadget@gmail.com>
Date: Jan 22, 2023, 03:06 UTC
Message-ID: <pull.1441.git.git.1674356774172.gitgitgadget@gmail.com>

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