From 98e840663251fc99055265b9bd4710e398310eb7 Mon Sep 17 00:00:00 2001 From: Michael Haggerty Date: Wed, 3 Aug 2011 15:41:29 +0200 Subject: gitattributes: Clarify discussion of attribute macros In particular, make it clear that attribute macros are themselves recorded as attributes in addition to setting other attributes. Signed-off-by: Michael Haggerty Signed-off-by: Junio C Hamano diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt index 412c55b..ccb3f3f 100644 --- a/Documentation/gitattributes.txt +++ b/Documentation/gitattributes.txt @@ -879,16 +879,19 @@ produced for, any binary file you track. You would need to specify e.g. ------------ but that may become cumbersome, when you have many attributes. Using -attribute macros, you can specify groups of attributes set or unset at -the same time. The system knows a built-in attribute macro, `binary`: +attribute macros, you can define an attribute that, when set, also +sets or unsets a number of other attributes at the same time. The +system knows a built-in attribute macro, `binary`: ------------ *.jpg binary ------------ -which is equivalent to the above. Note that the attribute macros can only -be "Set" (see the above example that sets "binary" macro as if it were an -ordinary attribute --- setting it in turn unsets "text" and "diff"). +Setting the "binary" attribute also unsets the "text" and "diff" +attributes as above. Note that attribute macros can only be "Set", +though setting one might have the effect of setting or unsetting other +attributes or even returning other attributes to the "Unspecified" +state. DEFINING ATTRIBUTE MACROS -- cgit v0.10.2-6-g49f6 From 0922570c76ae407e30477d27d72bb9d72c4b65f9 Mon Sep 17 00:00:00 2001 From: Michael Haggerty Date: Wed, 3 Aug 2011 15:41:30 +0200 Subject: gitattributes: Reword "attribute macro" to "macro attribute" The new wording makes it clearer that such a beast is an attribute in addition to being a macro (as opposed to being only a macro that is used for attributes). Signed-off-by: Michael Haggerty Signed-off-by: Junio C Hamano diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt index ccb3f3f..2bbe76b 100644 --- a/Documentation/gitattributes.txt +++ b/Documentation/gitattributes.txt @@ -79,7 +79,7 @@ Attributes for all users on a system should be placed in the `$(prefix)/etc/gitattributes` file. Sometimes you would need to override an setting of an attribute -for a path to `unspecified` state. This can be done by listing +for a path to `Unspecified` state. This can be done by listing the name of the attribute prefixed with an exclamation point `!`. @@ -868,7 +868,7 @@ If this attribute is not set or has an invalid value, the value of the (See linkgit:git-config[1]). -USING ATTRIBUTE MACROS +USING MACRO ATTRIBUTES ---------------------- You do not want any end-of-line conversions applied to, nor textual diffs @@ -879,27 +879,27 @@ produced for, any binary file you track. You would need to specify e.g. ------------ but that may become cumbersome, when you have many attributes. Using -attribute macros, you can define an attribute that, when set, also +macro attributes, you can define an attribute that, when set, also sets or unsets a number of other attributes at the same time. The -system knows a built-in attribute macro, `binary`: +system knows a built-in macro attribute, `binary`: ------------ *.jpg binary ------------ Setting the "binary" attribute also unsets the "text" and "diff" -attributes as above. Note that attribute macros can only be "Set", +attributes as above. Note that macro attributes can only be "Set", though setting one might have the effect of setting or unsetting other attributes or even returning other attributes to the "Unspecified" state. -DEFINING ATTRIBUTE MACROS +DEFINING MACRO ATTRIBUTES ------------------------- -Custom attribute macros can be defined only in the `.gitattributes` file -at the toplevel (i.e. not in any subdirectory). The built-in attribute -macro "binary" is equivalent to: +Custom macro attributes can be defined only in the `.gitattributes` +file at the toplevel (i.e. not in any subdirectory). The built-in +macro attribute "binary" is equivalent to: ------------ [attr]binary -diff -text -- cgit v0.10.2-6-g49f6 From e9e0643fe64b613b6596b79b59df8ff10746f1a1 Mon Sep 17 00:00:00 2001 From: Heiko Voigt Date: Wed, 3 Aug 2011 20:06:17 +0200 Subject: add gitignore entry to description about how to write a builtin If the author forgets the gitignore entry the built result will show up as new file in the git working directory. Signed-off-by: Heiko Voigt Signed-off-by: Junio C Hamano diff --git a/Documentation/technical/api-builtin.txt b/Documentation/technical/api-builtin.txt index 5cb2b05..b0cafe8 100644 --- a/Documentation/technical/api-builtin.txt +++ b/Documentation/technical/api-builtin.txt @@ -49,6 +49,8 @@ Additionally, if `foo` is a new command, there are 3 more things to do: . Add an entry for `git-foo` to `command-list.txt`. +. Add an entry for `/git-foo` to `.gitignore`. + How a built-in is called ------------------------ -- cgit v0.10.2-6-g49f6