[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Doc: CG: itemize section on commit message prefixes (issue 296810043 by
From: |
paulwmorris |
Subject: |
Doc: CG: itemize section on commit message prefixes (issue 296810043 by address@hidden) |
Date: |
Sat, 02 Apr 2016 19:30:12 +0000 |
Reviewers: ,
Message:
Please review, thanks, -Paul
Description:
Doc: CG: itemize section on commit message prefixes
Please review this at https://codereview.appspot.com/296810043/
Affected files (+20, -8 lines):
M Documentation/contributor/source-code.itexi
Index: Documentation/contributor/source-code.itexi
diff --git a/Documentation/contributor/source-code.itexi
b/Documentation/contributor/source-code.itexi
index
19b835a0ef959caac542cedae29d10b82cfa88cb..b961a82cf6c65897090fd5736731974ac19096b4
100644
--- a/Documentation/contributor/source-code.itexi
+++ b/Documentation/contributor/source-code.itexi
@@ -1235,17 +1235,29 @@ high-res images, fixed cropping on Finale example.
@end example
Commit messages often start with a short prefix describing the
-general location of the changes. If a commit affects the
+general location of the changes.
+
address@hidden
address@hidden
+Doc: and address@hidden: If a commit affects the
documentation in English (or in several languages simultaneously)
-the commit message should be prefixed with @qq{Doc:@tie{}}. If
-the commit affects only one of the translations, the commit
+the commit message should be prefixed with @qq{Doc:@tie{}}. If the
+commit affects only one of the translations, the commit
message should be prefixed with @address@hidden:@tie{}}, where
address@hidden is the two-letter language code. Commits that affect the
address@hidden is the two-letter language code.
+
address@hidden
+Web: and address@hidden: Commits that affect the
website should use @qq{Web:@tie{}} for English, and
address@hidden@var{**}:@tie{}} for the other languages. Also, changes
-to a single file are often prefixed with the name of the file
-involved. Visit the links listed in @ref{Understanding commits}
-for examples.
address@hidden@var{**}:@tie{}} for other languages.
+
address@hidden
+Changes to a single file are often prefixed with the name of the file
+involved.
address@hidden itemize
+
+Visit the links listed in @ref{Understanding commits} for examples.
+
@node Patches
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- Doc: CG: itemize section on commit message prefixes (issue 296810043 by address@hidden),
paulwmorris <=