[PATCH] Documentation: correct typo in example

Stefan Beller· May 12, 2016, 21:30 UTC · lore

The example want's to explain how 'To see how attributes "crlf" and "indent" are set for different paths.'

Spell the selected attribute correctly.

Signed-off-by: Stefan Beller <sbeller@google.com>
---
 Documentation/technical/api-gitattributes.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to Documentation/technical/api-gitattributes.txt +1 −1

diff --git a/Documentation/technical/api-gitattributes.txt b/Documentation/technical/api-gitattributes.txt
index 2602668..0d7e98c 100644
--- a/Documentation/technical/api-gitattributes.txt
+++ b/Documentation/technical/api-gitattributes.txt
@@ -74,7 +74,7 @@ static void setup_check(void)
 	if (check[0].attr)
 		return; /* already done */
 	check[0].attr = git_attr("crlf");
-	check[1].attr = git_attr("ident");
+	check[1].attr = git_attr("indent");
 }
 ------------

-- 
2.8.2.397.g23dc3dd.dirty

Junio C Hamano· May 12, 2016, 21:52 UTC · re: Stefan Beller · lore

Re: [PATCH] Documentation: correct typo in example

Stefan Beller <sbeller@google.com> writes:

Show 22 quoted lines

> The example want's to explain how 'To see how attributes "crlf" and
> "indent" are set for different paths.'
>
> Spell the selected attribute correctly.
>
> Signed-off-by: Stefan Beller <sbeller@google.com>
> ---
>  Documentation/technical/api-gitattributes.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/technical/api-gitattributes.txt b/Documentation/technical/api-gitattributes.txt
> index 2602668..0d7e98c 100644
> --- a/Documentation/technical/api-gitattributes.txt
> +++ b/Documentation/technical/api-gitattributes.txt
> @@ -74,7 +74,7 @@ static void setup_check(void)
>  	if (check[0].attr)
>  		return; /* already done */
>  	check[0].attr = git_attr("crlf");
> -	check[1].attr = git_attr("ident");
> +	check[1].attr = git_attr("indent");
>  }
>  ------------

Technically the text and code after this patch is more "correct".

Back when I wrote the original, 530e741c (Start preparing the API documents., 2007-11-24), however, I did mean to use "ident", iow, the introductory text has typo, and the code sample is correct. There wasn't any "indent" attribute that is natively recognised by Git back then for git_attr("indent") would have made sense, either.

So perhaps update the introductory text instead?

patchDocumentation: correct typo in example