[PATCH] Documentation: Mention comment syntax in gitattributes.txt

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



gitattributes documentation does not specify how to include comments in
gitattribute files. According to parse_attr_line() in attr.c, # can be
used to start a comment. This patch add this to the documentation.

Signed-off-by: Michal Sojka <sojkam1@xxxxxxxxxxx>
---
 Documentation/gitattributes.txt | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt
index c892ffa..0a61a71 100644
--- a/Documentation/gitattributes.txt
+++ b/Documentation/gitattributes.txt
@@ -16,10 +16,16 @@ DESCRIPTION
 A `gitattributes` file is a simple text file that gives
 `attributes` to pathnames.
 
-Each line in `gitattributes` file is of form:
+Lines in `gitattributes` have one of the following forms:
 
+- A blank line can serve as a separator for readability.
+
+- A line starting with # serves as a comment.
+
+- An attribute specification line:
++
 	pattern	attr1 attr2 ...
-
++
 That is, a pattern followed by an attributes list,
 separated by whitespaces.  When the pattern matches the
 path in question, the attributes listed on the line are given to
-- 
2.1.3

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]